public interface IAuthSubsystem extends ISubsystem
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CERTUSERDB_AUTHMGR_ID
Constant for certificate based authentication manager ID.
|
static java.lang.String |
CERTUSERDB_PLUGIN_ID
Constant for certificate based authentication plugin ID.
|
static java.lang.String |
CHALLENGE_AUTHMGR_ID
Constant for challenge based authentication manager ID.
|
static java.lang.String |
CHALLENGE_PLUGIN_ID
Constant for challenge based authentication plugin ID.
|
static java.lang.String |
CMCAUTH_AUTHMGR_ID
Constant for CMC authentication manager ID.
|
static java.lang.String |
CMCAUTH_PLUGIN_ID
Constant for CMC authentication plugin ID.
|
static java.lang.String |
ID
Constant for auths.
|
static java.lang.String |
NULL_AUTHMGR_ID
Constant for null authentication manager ID.
|
static java.lang.String |
NULL_PLUGIN_ID
Constant for null authentication plugin ID.
|
static java.lang.String |
PASSWDUSERDB_AUTHMGR_ID
Constant for password based authentication manager ID.
|
static java.lang.String |
PASSWDUSERDB_PLUGIN_ID
Constant for password based authentication plugin ID.
|
static java.lang.String |
PROP_CLASS
Constant for class.
|
static java.lang.String |
PROP_IMPL
Constant for impl
|
static java.lang.String |
PROP_INSTANCE
Constant for instance.
|
static java.lang.String |
PROP_PLUGIN
Constant for pluginName.
|
static java.lang.String |
SSLCLIENTCERT_AUTHMGR_ID
Constant for ssl client authentication manager ID.
|
static java.lang.String |
SSLCLIENTCERT_PLUGIN_ID
Constant for ssl client authentication plugin ID.
|
Modifier and Type | Method and Description |
---|---|
void |
add(java.lang.String name,
IAuthManager authMgr)
Adds (registers) the given authentication manager.
|
IAuthToken |
authenticate(IAuthCredentials authCred,
java.lang.String authMgrName)
Authenticate the given credentials using the given manager name.
|
void |
delete(java.lang.String name)
Deletes (deregisters) the given authentication manager.
|
IAuthManager |
get(java.lang.String name)
Get an authentication manager interface for the given name.
|
IAuthManager |
getAuthManager(java.lang.String name)
Gets the Authentication manager instance of the specified name.
|
IAuthManager |
getAuthManagerPlugin(java.lang.String name)
Gets a single authentication manager plugin implementation
|
AuthMgrPlugin |
getAuthManagerPluginImpl(java.lang.String name)
Get an authentication manager plugin impl for the given name.
|
java.util.Enumeration |
getAuthManagerPlugins()
Gets an enumeration of authentication manager plugins.
|
java.util.Enumeration |
getAuthManagers()
Gets an enumeration of authentication managers registered to the
authentication subsystem.
|
java.lang.String[] |
getConfigParams(java.lang.String implName)
Get configuration parameters for a authentication mgr plugin.
|
java.util.Hashtable |
getInstances()
Get a hashtable containing all authentication instances.
|
java.util.Hashtable |
getPlugins()
Get a hashtable containing all authentication plugins.
|
java.lang.String[] |
getRequiredCreds(java.lang.String authMgrName)
Gets the required credential attributes for the given authentication
manager.
|
void |
log(int level,
java.lang.String msg)
Log error message.
|
getConfigStore, getId, init, setId, shutdown, startup
static final java.lang.String ID
static final java.lang.String PROP_CLASS
static final java.lang.String PROP_IMPL
static final java.lang.String PROP_PLUGIN
static final java.lang.String PROP_INSTANCE
static final java.lang.String PASSWDUSERDB_PLUGIN_ID
static final java.lang.String CERTUSERDB_PLUGIN_ID
static final java.lang.String CHALLENGE_PLUGIN_ID
static final java.lang.String NULL_PLUGIN_ID
static final java.lang.String SSLCLIENTCERT_PLUGIN_ID
static final java.lang.String PASSWDUSERDB_AUTHMGR_ID
static final java.lang.String CERTUSERDB_AUTHMGR_ID
static final java.lang.String CHALLENGE_AUTHMGR_ID
static final java.lang.String NULL_AUTHMGR_ID
static final java.lang.String SSLCLIENTCERT_AUTHMGR_ID
static final java.lang.String CMCAUTH_PLUGIN_ID
static final java.lang.String CMCAUTH_AUTHMGR_ID
IAuthToken authenticate(IAuthCredentials authCred, java.lang.String authMgrName) throws EMissingCredential, EInvalidCredentials, EBaseException
authCred
- The authentication credentialsauthMgrName
- The authentication manager nameEMissingCredential
- when missing credential during authenticationEInvalidCredentials
- when the credential is invalidEBaseException
- If an error occurs during authentication.java.lang.String[] getRequiredCreds(java.lang.String authMgrName) throws EBaseException
authMgrName
- The authentication manager nameEBaseException
- If the required credential is missingvoid add(java.lang.String name, IAuthManager authMgr)
name
- The authentication manager nameauthMgr
- The authentication manager instance.void delete(java.lang.String name)
name
- The authentication manager name to delete.IAuthManager getAuthManager(java.lang.String name) throws EBaseException
name
- The authentication manager's name.EBaseException
- when internal error occurs.java.util.Enumeration getAuthManagers()
java.util.Enumeration getAuthManagerPlugins()
IAuthManager getAuthManagerPlugin(java.lang.String name)
name
- given authentication plugin namejava.lang.String[] getConfigParams(java.lang.String implName) throws EAuthMgrPluginNotFound, EBaseException
implName
- The plugin name.EAuthMgrPluginNotFound
- If the authentication manager
plugin is not found.EBaseException
- If an internal error occurred.void log(int level, java.lang.String msg)
level
- log levelmsg
- error messagejava.util.Hashtable getPlugins()
java.util.Hashtable getInstances()
IAuthManager get(java.lang.String name)
name
- given authentication manager name.AuthMgrPlugin getAuthManagerPluginImpl(java.lang.String name)
name
- given authentication manager name.