diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/cmscore/authorization/AuthzSubsystem.java')
-rw-r--r-- | pki/base/common/src/com/netscape/cmscore/authorization/AuthzSubsystem.java | 110 |
1 files changed, 55 insertions, 55 deletions
diff --git a/pki/base/common/src/com/netscape/cmscore/authorization/AuthzSubsystem.java b/pki/base/common/src/com/netscape/cmscore/authorization/AuthzSubsystem.java index 62351f1ac..aa7e496ad 100644 --- a/pki/base/common/src/com/netscape/cmscore/authorization/AuthzSubsystem.java +++ b/pki/base/common/src/com/netscape/cmscore/authorization/AuthzSubsystem.java @@ -17,7 +17,6 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.cmscore.authorization; - import java.util.Enumeration; import java.util.Hashtable; import java.util.Vector; @@ -38,11 +37,10 @@ import com.netscape.certsrv.base.ISubsystem; import com.netscape.certsrv.logging.ILogger; import com.netscape.cmscore.util.Debug; - /** * Default authorization subsystem * <P> - * + * * @author cfu * @version $Revision$, $Date$ */ @@ -72,12 +70,13 @@ public class AuthzSubsystem implements IAuthzSubsystem { /** * Initializes the authorization subsystem from the config store. * Load Authorization manager plugins, create and initialize - * initialize authorization manager instances. + * initialize authorization manager instances. + * * @param owner The owner of this module. * @param config The configuration store. */ public void init(ISubsystem owner, IConfigStore config) - throws EBaseException { + throws EBaseException { try { mLogger = CMS.getLogger(); mConfig = config; @@ -90,7 +89,7 @@ public class AuthzSubsystem implements IAuthzSubsystem { while (mImpls.hasMoreElements()) { String id = (String) mImpls.nextElement(); String pluginPath = c.getString(id + "." + PROP_CLASS); - + AuthzMgrPlugin plugin = new AuthzMgrPlugin(id, pluginPath); mAuthzMgrPlugins.put(id, plugin); @@ -107,16 +106,16 @@ public class AuthzSubsystem implements IAuthzSubsystem { while (instances.hasMoreElements()) { String insName = (String) instances.nextElement(); String implName = c.getString(insName + "." + PROP_PLUGIN); - AuthzMgrPlugin plugin = - (AuthzMgrPlugin) mAuthzMgrPlugins.get(implName); + AuthzMgrPlugin plugin = + (AuthzMgrPlugin) mAuthzMgrPlugins.get(implName); if (plugin == null) { - log(ILogger.LL_FAILURE, - CMS.getLogMessage("CMSCORE_AUTHZ_PLUGIN_NOT_FOUND", implName)); + log(ILogger.LL_FAILURE, + CMS.getLogMessage("CMSCORE_AUTHZ_PLUGIN_NOT_FOUND", implName)); throw new EAuthzMgrPluginNotFound(CMS.getUserMessage("CMS_AUTHORIZATION_AUTHZMGR_PLUGIN_NOT_FOUND", implName)); } else { CMS.debug( - CMS.getLogMessage("CMSCORE_AUTHZ_PLUGIN_FOUND", implName)); + CMS.getLogMessage("CMSCORE_AUTHZ_PLUGIN_FOUND", implName)); } String className = plugin.getClassPath(); @@ -126,33 +125,30 @@ public class AuthzSubsystem implements IAuthzSubsystem { IAuthzManager authzMgrInst = null; try { - authzMgrInst = (IAuthzManager) - Class.forName(className).newInstance(); + authzMgrInst = (IAuthzManager) + Class.forName(className).newInstance(); IConfigStore authzMgrConfig = c.getSubStore(insName); authzMgrInst.init(insName, implName, authzMgrConfig); isEnable = true; - log(ILogger.LL_INFO, - CMS.getLogMessage("CMSCORE_AUTHZ_INSTANCE_ADDED", insName)); + log(ILogger.LL_INFO, + CMS.getLogMessage("CMSCORE_AUTHZ_INSTANCE_ADDED", insName)); } catch (ClassNotFoundException e) { String errMsg = "AuthzSubsystem:: init()-" + e.toString(); log(ILogger.LL_FAILURE, CMS.getLogMessage("OPERATION_ERROR", errMsg)); - throw new - EAuthzException(CMS.getUserMessage("CMS_AUTHORIZATION_LOAD_CLASS_FAIL", className)); + throw new EAuthzException(CMS.getUserMessage("CMS_AUTHORIZATION_LOAD_CLASS_FAIL", className)); } catch (IllegalAccessException e) { String errMsg = "AuthzSubsystem:: init()-" + e.toString(); log(ILogger.LL_FAILURE, CMS.getLogMessage("OPERATION_ERROR", errMsg)); - throw new - EAuthzException(CMS.getUserMessage("CMS_AUTHORIZATION_LOAD_CLASS_FAIL", className)); + throw new EAuthzException(CMS.getUserMessage("CMS_AUTHORIZATION_LOAD_CLASS_FAIL", className)); } catch (InstantiationException e) { String errMsg = "AuthzSubsystem: init()-" + e.toString(); log(ILogger.LL_FAILURE, CMS.getLogMessage("OPERATION_ERROR", errMsg)); - throw new - EAuthzException(CMS.getUserMessage("CMS_AUTHORIZATION_LOAD_CLASS_FAIL", className)); + throw new EAuthzException(CMS.getUserMessage("CMS_AUTHORIZATION_LOAD_CLASS_FAIL", className)); } catch (EBaseException e) { log(ILogger.LL_FAILURE, CMS.getLogMessage("CMSCORE_AUTHZ_PLUGIN_INIT_FAILED", insName, e.toString())); // it is mis-configurated. This give @@ -166,8 +162,8 @@ public class AuthzSubsystem implements IAuthzSubsystem { // fix the problem via console } // add manager instance to list. - mAuthzMgrInsts.put(insName, new - AuthzManagerProxy(isEnable, authzMgrInst)); + mAuthzMgrInsts.put(insName, new + AuthzManagerProxy(isEnable, authzMgrInst)); if (Debug.ON) { Debug.trace("loaded authz instance " + insName + " impl " + implName); } @@ -183,15 +179,16 @@ public class AuthzSubsystem implements IAuthzSubsystem { /** * authMgrzAccessInit is for servlets who want to initialize their - * own authorization information before full operation. It is supposed + * own authorization information before full operation. It is supposed * to be called during the init() method of a servlet. + * * @param authzMgrName The authorization manager name - * @param accessInfo the access information to be initialized. currently it's acl string in the format specified in the authorization manager + * @param accessInfo the access information to be initialized. currently it's acl string in the format specified in the authorization manager */ public void authzMgrAccessInit(String authzMgrInstName, String accessInfo) - throws EAuthzMgrNotFound, EBaseException { + throws EAuthzMgrNotFound, EBaseException { AuthzManagerProxy proxy = (AuthzManagerProxy) - mAuthzMgrInsts.get(authzMgrInstName); + mAuthzMgrInsts.get(authzMgrInstName); if (proxy == null) { throw new EAuthzMgrNotFound(CMS.getUserMessage("CMS_AUTHORIZATION_AUTHZMGR_NOT_FOUND", authzMgrInstName)); @@ -210,21 +207,22 @@ public class AuthzSubsystem implements IAuthzSubsystem { /** * Authorization to the named authorization manager instance + * * @param authzMgrName The authorization manager name * @param authToken the authenticaton token associated with a user * @param resource the resource protected by the authorization system * @param operation the operation for resource protected by the authoriz - n system + * n system * @exception EBaseException If an error occurs during authorization. * @return a authorization token. */ public AuthzToken authorize( - String authzMgrInstName, IAuthToken authToken, - String resource, String operation) - throws EAuthzMgrNotFound, EBaseException { + String authzMgrInstName, IAuthToken authToken, + String resource, String operation) + throws EAuthzMgrNotFound, EBaseException { AuthzManagerProxy proxy = (AuthzManagerProxy) - mAuthzMgrInsts.get(authzMgrInstName); + mAuthzMgrInsts.get(authzMgrInstName); if (proxy == null) { throw new EAuthzMgrNotFound(CMS.getUserMessage("CMS_AUTHORIZATION_AUTHZMGR_NOT_FOUND", authzMgrInstName)); @@ -241,15 +239,15 @@ public class AuthzSubsystem implements IAuthzSubsystem { } public AuthzToken authorize( - String authzMgrInstName, IAuthToken authToken, String exp) - throws EAuthzMgrNotFound, EBaseException { + String authzMgrInstName, IAuthToken authToken, String exp) + throws EAuthzMgrNotFound, EBaseException { AuthzManagerProxy proxy = (AuthzManagerProxy) - mAuthzMgrInsts.get(authzMgrInstName); + mAuthzMgrInsts.get(authzMgrInstName); if (proxy == null) { throw new EAuthzMgrNotFound(CMS.getUserMessage("CMS_AUTHORIZATION_AUTHZMGR_NOT_FOUND", authzMgrInstName)); - } + } if (!proxy.isEnable()) { throw new EAuthzMgrNotFound(CMS.getUserMessage("CMS_AUTHORIZATION_AUTHZMGR_NOT_FOUND", authzMgrInstName)); } @@ -262,13 +260,14 @@ public class AuthzSubsystem implements IAuthzSubsystem { } /** - * Gets configuration parameters for the given + * Gets configuration parameters for the given * authorization manager plugin. + * * @param implName Name of the authorization plugin. * @return Hashtable of required parameters. */ public String[] getConfigParams(String implName) - throws EAuthzMgrPluginNotFound, EBaseException { + throws EAuthzMgrPluginNotFound, EBaseException { // is this a registered implname? AuthzMgrPlugin plugin = (AuthzMgrPlugin) mAuthzMgrPlugins.get(implName); @@ -287,21 +286,19 @@ public class AuthzSubsystem implements IAuthzSubsystem { return (authzMgrInst.getConfigParams()); } catch (InstantiationException e) { log(ILogger.LL_FAILURE, CMS.getLogMessage("CMSCORE_AUTHZ_PLUGIN_NOT_CREATED", e.toString())); - throw new - EAuthzException(CMS.getUserMessage("CMS_AUTHORIZATION_LOAD_CLASS_FAIL", className)); + throw new EAuthzException(CMS.getUserMessage("CMS_AUTHORIZATION_LOAD_CLASS_FAIL", className)); } catch (ClassNotFoundException e) { log(ILogger.LL_FAILURE, CMS.getLogMessage("CMSCORE_AUTHZ_PLUGIN_NOT_CREATED", e.toString())); - throw new - EAuthzException(CMS.getUserMessage("CMS_AUTHORIZATION_LOAD_CLASS_FAIL", className)); + throw new EAuthzException(CMS.getUserMessage("CMS_AUTHORIZATION_LOAD_CLASS_FAIL", className)); } catch (IllegalAccessException e) { log(ILogger.LL_FAILURE, CMS.getLogMessage("CMSCORE_AUTHZ_PLUGIN_NOT_CREATED", e.toString())); - throw new - EAuthzException(CMS.getUserMessage("CMS_AUTHORIZATION_LOAD_CLASS_FAIL", className)); + throw new EAuthzException(CMS.getUserMessage("CMS_AUTHORIZATION_LOAD_CLASS_FAIL", className)); } } /** * Add an authorization manager instance. + * * @param name name of the authorization manager instance * @param authzMgr the authorization manager instance to be added */ @@ -319,6 +316,7 @@ public class AuthzSubsystem implements IAuthzSubsystem { /** * Gets the authorization manager instance of the specified name. + * * @param name name of the authorization manager instance * @return the named authorization manager instance */ @@ -362,9 +360,9 @@ public class AuthzSubsystem implements IAuthzSubsystem { } /** - * Retrieve a single authz manager instance + * Retrieve a single authz manager instance */ - + /* getconfigparams above should be recoded to use this func */ public IAuthzManager getAuthzManagerPlugin(String name) { AuthzMgrPlugin plugin = (AuthzMgrPlugin) mAuthzMgrPlugins.get(name); @@ -382,16 +380,18 @@ public class AuthzSubsystem implements IAuthzSubsystem { /** * Retrieves id (name) of this subsystem. + * * @return name of the authorization subsystem */ public String getId() { return (mId); } - + /** * Sets id string to this subsystem. * <p> - * Use with caution. Should not do it when sharing with others + * Use with caution. Should not do it when sharing with others + * * @param id name to be applied to an authorization sybsystem */ public void setId(String id) throws EBaseException { @@ -408,17 +408,16 @@ public class AuthzSubsystem implements IAuthzSubsystem { } /** - * shuts down authorization managers one by one. + * shuts down authorization managers one by one. * <P> */ public void shutdown() { - for (Enumeration<String> e = mAuthzMgrInsts.keys(); - e.hasMoreElements();) { + for (Enumeration<String> e = mAuthzMgrInsts.keys(); e.hasMoreElements();) { IAuthzManager mgr = (IAuthzManager) get((String) e.nextElement()); - String infoMsg = - "Shutting down authz manager instance " + mgr.getName(); + String infoMsg = + "Shutting down authz manager instance " + mgr.getName(); //log(ILogger.LL_INFO, infoMsg); @@ -441,7 +440,7 @@ public class AuthzSubsystem implements IAuthzSubsystem { /** * Returns the root configuration storage of this system. * <P> - * + * * @return configuration store of this subsystem */ public IConfigStore getConfigStore() { @@ -450,6 +449,7 @@ public class AuthzSubsystem implements IAuthzSubsystem { /** * gets the named authorization manager + * * @param name of the authorization manager * @return the named authorization manager */ @@ -464,7 +464,7 @@ public class AuthzSubsystem implements IAuthzSubsystem { if (mLogger == null) return; mLogger.log(ILogger.EV_SYSTEM, null, ILogger.S_AUTHORIZATION, - level, msg); + level, msg); } } |