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 Modifier and Type Field Description static java.lang.String
CRED_CERT_SERIAL_TO_REVOKE
Standard credential for client cert's serial number from revocation.static java.lang.String
CRED_CMC_SELF_SIGNED
static java.lang.String
CRED_CMC_SIGNING_CERT
static java.lang.String
CRED_HOST_NAME
static java.lang.String
CRED_SESSION_ID
static java.lang.String
CRED_SSL_CLIENT_CERT
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IAuthToken
authenticate(IAuthCredentials authCred)
Authenticate the given credentials.java.lang.String[]
getConfigParams()
Get configuration parameters for this implementation.AuthManagerConfig
getConfigStore()
Get the configuration store for this authentication manager.java.lang.String
getImplName()
Get name of authentication manager plugin.java.lang.String
getName()
Get the name of this authentication manager instance.java.lang.String[]
getRequiredCreds()
Gets a list of the required credentials for this authentication manager.void
init(java.lang.String name, java.lang.String implName, AuthManagerConfig config)
Initialize this authentication manager.void
shutdown()
Prepare this authentication manager for a shutdown.
-
-
-
Field Detail
-
CRED_SSL_CLIENT_CERT
static final java.lang.String CRED_SSL_CLIENT_CERT
- See Also:
- Constant Field Values
-
CRED_CMC_SIGNING_CERT
static final java.lang.String CRED_CMC_SIGNING_CERT
- See Also:
- Constant Field Values
-
CRED_CMC_SELF_SIGNED
static final java.lang.String CRED_CMC_SELF_SIGNED
- See Also:
- Constant Field Values
-
CRED_CERT_SERIAL_TO_REVOKE
static final java.lang.String CRED_CERT_SERIAL_TO_REVOKE
Standard credential for client cert's serial number from revocation.- See Also:
- Constant Field Values
-
CRED_SESSION_ID
static final java.lang.String CRED_SESSION_ID
- See Also:
- Constant Field Values
-
CRED_HOST_NAME
static final java.lang.String CRED_HOST_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
java.lang.String getName()
Get the name of this authentication manager instance.- Returns:
- the name of this authentication manager.
-
getImplName
java.lang.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
void init(java.lang.String name, java.lang.String implName, AuthManagerConfig 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.
-
shutdown
void shutdown()
Prepare this authentication manager for a shutdown. Called when the server is exiting for any cleanup needed.
-
getRequiredCreds
java.lang.String[] getRequiredCreds()
Gets a list of the required credentials for this authentication manager.- Returns:
- The required credential attributes.
-
getConfigParams
java.lang.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.- 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.
-
-