Interface AuthManager
- All Known Subinterfaces:
ProfileAuthenticator
- All Known Implementing Classes:
AgentCertAuthentication
,CertUserDBAuthentication
,ChallengePhraseAuthentication
,CMCAuth
,DirBasedAuthentication
,FlatFileAuth
,HashAuthentication
,NullAuthentication
,PasswdUserDBAuthentication
,PortalEnroll
,SessionAuthentication
,SharedSecret
,SSLclientCertAuthentication
,SSLClientCertAuthentication
,TokenAuthentication
,UidPwdDirAuthentication
,UidPwdPinDirAuthentication
,UserPwdDirAuthentication
public interface AuthManager
Authentication Manager interface.
- Version:
- $Revision$, $Date$
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionauthenticate
(IAuthCredentials authCred) Authenticate the given credentials.String[]
Get configuration parameters for this implementation.Get the configuration store for this authentication manager.Get name of authentication manager plugin.getName()
Get the name of this authentication manager instance.String[]
Gets a list of the required credentials for this authentication manager.void
init
(String name, String implName, AuthManagerConfig config) Initialize this authentication manager.void
shutdown()
Prepare this authentication manager for a shutdown.
-
Field Details
-
CRED_SSL_CLIENT_CERT
- See Also:
-
CRED_CMC_SIGNING_CERT
- See Also:
-
CRED_CMC_SELF_SIGNED
- See Also:
-
CRED_CERT_SERIAL_TO_REVOKE
Standard credential for client cert's serial number from revocation.- See Also:
-
CRED_SESSION_ID
- See Also:
-
CRED_HOST_NAME
- See Also:
-
-
Method Details
-
getName
String getName()Get the name of this authentication manager instance.- Returns:
- the name of this authentication manager.
-
getImplName
String getImplName()Get name of authentication manager plugin.- Returns:
- the name of the authentication manager plugin.
-
authenticate
IAuthToken authenticate(IAuthCredentials authCred) throws EMissingCredential, EInvalidCredentials, EBaseException Authenticate the given credentials.- Parameters:
authCred
- The authentication credentials- Returns:
- authentication token
- Throws:
EMissingCredential
- If a required credential for this authentication manager is missing.EInvalidCredentials
- If credentials cannot be authenticated.EBaseException
- If an internal error occurred.
-
init
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.
-
shutdown
void shutdown()Prepare this authentication manager for a shutdown. Called when the server is exiting for any cleanup needed. -
getRequiredCreds
String[] getRequiredCreds()Gets a list of the required credentials for this authentication manager.- Returns:
- The required credential attributes.
-
getConfigParams
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.- Returns:
- a list of configuration parameters.
- Throws:
EBaseException
- If an internal error occurred
-
getConfigStore
AuthManagerConfig getConfigStore()Get the configuration store for this authentication manager.- Returns:
- The configuration store of this authentication manager.
-