Class NullAuthentication
- java.lang.Object
-
- com.netscape.cmscore.authentication.NullAuthentication
-
- All Implemented Interfaces:
AuthManager
public class NullAuthentication extends java.lang.Object implements AuthManager
This authentication does nothing but just returns an empty authToken.- Version:
- $Revision$, $Date$
- Author:
- chrisho
-
-
Field Summary
Fields Modifier and Type Field Description static org.slf4j.Loggerloggerprotected static java.lang.String[]mConfigParamsprotected static java.lang.String[]mRequiredCred-
Fields inherited from interface org.dogtagpki.server.authentication.AuthManager
CRED_CERT_SERIAL_TO_REVOKE, CRED_CMC_SELF_SIGNED, CRED_CMC_SIGNING_CERT, CRED_HOST_NAME, CRED_SESSION_ID, CRED_SSL_CLIENT_CERT
-
-
Constructor Summary
Constructors Constructor Description NullAuthentication()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IAuthTokenauthenticate(IAuthCredentials authCred)authenticates nothingAuthenticationConfiggetAuthenticationConfig()java.lang.String[]getConfigParams()Get the list of configuration parameter names required by this authentication manager.AuthManagerConfiggetConfigStore()gets the configuration substore used by this authentication managerjava.lang.StringgetImplName()gets the name of the authentication manager pluginjava.lang.StringgetName()gets the name of this authentication manager instancejava.lang.String[]getRequiredCreds()get the list of authentication credential attribute names required by this authentication manager.voidinit(java.lang.String name, java.lang.String implName, AuthManagerConfig config)initializes the NullAuthentication auth managervoidsetAuthenticationConfig(AuthenticationConfig authenticationConfig)voidshutdown()disconnects the member connection
-
-
-
Method Detail
-
getAuthenticationConfig
public AuthenticationConfig getAuthenticationConfig()
-
setAuthenticationConfig
public void setAuthenticationConfig(AuthenticationConfig authenticationConfig)
-
init
public void init(java.lang.String name, java.lang.String implName, AuthManagerConfig config) throws EBaseExceptioninitializes the NullAuthentication auth managercalled by AuthSubsystem init() method, when initializing all available authentication managers.
- Specified by:
initin interfaceAuthManager- Parameters:
name- - Name assigned to this authentication manager instance.implName- - Name of the authentication plugin.config- - The configuration store used by the authentication subsystem.- Throws:
EBaseException- If an initialization error occurred.
-
authenticate
public IAuthToken authenticate(IAuthCredentials authCred) throws EMissingCredential, EInvalidCredentials, EBaseException
authenticates nothingcalled by other subsystems or their servlets to authenticate administrators
- Specified by:
authenticatein interfaceAuthManager- Parameters:
authCred- Authentication credentials. "uid" and "pwd" are required.- Returns:
- the authentication token (authToken) that contains the following
userdn = [userdn, in case of success]
authMgrName = [authMgrName] - Throws:
com.netscape.certsrv.base.MissingCredential- If either "uid" or "pwd" is missing from the given credentials.com.netscape.certsrv.base.InvalidCredentials- If the the credentials failed to authenticate.EBaseException- If an internal error occurred.EMissingCredential- If a required credential for this authentication manager is missing.EInvalidCredentials- If credentials cannot be authenticated.
-
getName
public java.lang.String getName()
gets the name of this authentication manager instance- Specified by:
getNamein interfaceAuthManager- Returns:
- the name of this authentication manager.
-
getImplName
public java.lang.String getImplName()
gets the name of the authentication manager plugin- Specified by:
getImplNamein interfaceAuthManager- Returns:
- the name of the authentication manager plugin.
-
getRequiredCreds
public java.lang.String[] getRequiredCreds()
get the list of authentication credential attribute names required by this authentication manager. Generally used by servlets that use this authentication manager, to retrieve required credentials from the user (e.g. Javascript form data)- Specified by:
getRequiredCredsin interfaceAuthManager- Returns:
- attribute names in Vector
-
getConfigParams
public java.lang.String[] getConfigParams()
Get the list of configuration parameter names required by this authentication manager. In this case, an empty list.- Specified by:
getConfigParamsin interfaceAuthManager- Returns:
- String array of configuration parameters.
-
shutdown
public void shutdown()
disconnects the member connection- Specified by:
shutdownin interfaceAuthManager
-
getConfigStore
public AuthManagerConfig getConfigStore()
gets the configuration substore used by this authentication manager- Specified by:
getConfigStorein interfaceAuthManager- Returns:
- configuration store
-
-