diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/authentication/IAuthSubsystem.java')
-rw-r--r-- | pki/base/common/src/com/netscape/certsrv/authentication/IAuthSubsystem.java | 35 |
1 files changed, 24 insertions, 11 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/authentication/IAuthSubsystem.java b/pki/base/common/src/com/netscape/certsrv/authentication/IAuthSubsystem.java index 2de8ed266..329b6802e 100644 --- a/pki/base/common/src/com/netscape/certsrv/authentication/IAuthSubsystem.java +++ b/pki/base/common/src/com/netscape/certsrv/authentication/IAuthSubsystem.java @@ -26,7 +26,7 @@ import com.netscape.certsrv.base.ISubsystem; /** * An interface that represents an authentication component * <P> - * + * * @version $Revision$, $Date$ */ public interface IAuthSubsystem extends ISubsystem { @@ -39,17 +39,17 @@ public interface IAuthSubsystem extends ISubsystem { /** * Constant for class. */ - public static final String PROP_CLASS = "class"; + public static final String PROP_CLASS = "class"; /** * Constant for impl */ - public static final String PROP_IMPL = "impl"; + public static final String PROP_IMPL = "impl"; /** * Constant for pluginName. */ - public static final String PROP_PLUGIN = "pluginName"; + public static final String PROP_PLUGIN = "pluginName"; /** * Constant for instance. @@ -120,6 +120,7 @@ public interface IAuthSubsystem extends ISubsystem { /** * Authenticate the given credentials using the given manager name. + * * @param authCred The authentication credentials * @param authMgrName The authentication manager name * @return a authentication token. @@ -128,11 +129,12 @@ public interface IAuthSubsystem extends ISubsystem { * @exception EBaseException If an error occurs during authentication. */ public IAuthToken authenticate(IAuthCredentials authCred, String authMgrName) - throws EMissingCredential, EInvalidCredentials, EBaseException; + throws EMissingCredential, EInvalidCredentials, EBaseException; /** * Gets the required credential attributes for the given authentication * manager. + * * @param authMgrName The authentication manager name * @return a Vector of required credential attribute names. * @exception EBaseException If the required credential is missing @@ -141,6 +143,7 @@ public interface IAuthSubsystem extends ISubsystem { /** * Adds (registers) the given authentication manager. + * * @param name The authentication manager name * @param authMgr The authentication manager instance. */ @@ -148,12 +151,14 @@ public interface IAuthSubsystem extends ISubsystem { /** * Deletes (deregisters) the given authentication manager. + * * @param name The authentication manager name to delete. */ public void delete(String name); /** * Gets the Authentication manager instance of the specified name. + * * @param name The authentication manager's name. * @exception EBaseException when internal error occurs. */ @@ -162,18 +167,21 @@ public interface IAuthSubsystem extends ISubsystem { /** * Gets an enumeration of authentication managers registered to the * authentication subsystem. + * * @return a list of authentication managers */ public Enumeration<IAuthManager> getAuthManagers(); /** * Gets an enumeration of authentication manager plugins. + * * @return a list of authentication plugins */ public Enumeration<AuthMgrPlugin> getAuthManagerPlugins(); /** * Gets a single authentication manager plugin implementation + * * @param name given authentication plugin name * @return the given authentication plugin */ @@ -181,17 +189,19 @@ public interface IAuthSubsystem extends ISubsystem { /** * Get configuration parameters for a authentication mgr plugin. + * * @param implName The plugin name. * @return configuration parameters for the given authentication manager plugin - * @exception EAuthMgrPluginNotFound If the authentication manager - * plugin is not found. + * @exception EAuthMgrPluginNotFound If the authentication manager + * plugin is not found. * @exception EBaseException If an internal error occurred. */ - public String[] getConfigParams(String implName) - throws EAuthMgrPluginNotFound, EBaseException; + public String[] getConfigParams(String implName) + throws EAuthMgrPluginNotFound, EBaseException; /** * Log error message. + * * @param level log level * @param msg error message */ @@ -199,28 +209,31 @@ public interface IAuthSubsystem extends ISubsystem { /** * Get a hashtable containing all authentication plugins. + * * @return all authentication plugins. */ public Hashtable<String, AuthMgrPlugin> getPlugins(); /** * Get a hashtable containing all authentication instances. + * * @return all authentication instances. */ public Hashtable<?, ?> getInstances(); /** * Get an authentication manager interface for the given name. + * * @param name given authentication manager name. * @return an authentication manager for the given manager name. */ public IAuthManager get(String name); /** - * Get an authentication manager plugin impl for the given name. + * Get an authentication manager plugin impl for the given name. + * * @param name given authentication manager name. * @return an authentication manager plugin */ public AuthMgrPlugin getAuthManagerPluginImpl(String name); } - |