All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.netscape.certsrv.authentication.IAuthManager

public interface IAuthManager
Authentication Manager interface.


Variable Index

 o CRED_SSL_CLIENT_CERT

Method Index

 o authenticate(IAuthCredentials)
Authenticate the given credentials.
 o getConfigParams()
Get configuration parameters for this implementation.
 o getConfigStore()
Get the configuration store for this authentication manager.
 o getImplName()
Get name of authentication manager plugin.
 o getName()
Get the name of this authentication manager instance.
 o getRequiredCreds()
Gets a list of the required credentials for this authentication manager.
 o init(String, String, IConfigStore)
Initialize this authentication manager.
 o shutdown()
Prepare this authentication manager for a shutdown.

Variables

 o CRED_SSL_CLIENT_CERT
 public static final String CRED_SSL_CLIENT_CERT

Methods

 o getName
 public abstract String getName()
Get the name of this authentication manager instance.

Returns:
String the name of this authentication manager.
 o getImplName
 public abstract String getImplName()
Get name of authentication manager plugin.

Returns:
The name of the authentication manager plugin.
 o authenticate
 public abstract AuthToken authenticate(IAuthCredentials authCred) throws EMissingCredential, EInvalidCredentials, EBaseException
Authenticate the given credentials.

Parameters:
authCred - The authentication credentials
Throws: EMissingCredential
If a required credential for this authentication manager is missing.
Throws: EInvalidCredentials
If credentials cannot be authenticated.
Throws: EBaseException
If an internal error occurred.
 o init
 public abstract void init(String name,
                           String implName,
                           IConfigStore config) throws EBaseException
Initialize this authentication manager.

Parameters:
name - The name of this authentication manager instance.
implName - The name of the authentication manager plugin.
config - The configuration store for this authentication manager.
Throws: EBaseException
If an initialization error occurred.
 o shutdown
 public abstract void shutdown()
Prepare this authentication manager for a shutdown. Called when the server is exiting for any cleanup needed.

 o getRequiredCreds
 public abstract String[] getRequiredCreds()
Gets a list of the required credentials for this authentication manager.

Returns:
The required credential attributes.
 o getConfigParams
 public abstract String[] getConfigParams() throws EBaseException
Get configuration parameters for this implementation. The configuration parameters returned is passed to the configuration console so configuration for instances of this implementation can be made through the console.

Parameters:
implName - The authentication manager plugin name.
Throws: EBaseException
If an internal error occurred
 o getConfigStore
 public abstract IConfigStore getConfigStore()
Get the configuration store for this authentication manager.

Returns:
The configuration store of this authentication manager.

All Packages  Class Hierarchy  This Package  Previous  Next  Index