Class NullAuthentication

java.lang.Object

com.netscape.cmscore.authentication.NullAuthentication

All Implemented Interfaces:

AuthManager

public class NullAuthentication
extends 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.Logger	logger
protected static String[]	mConfigParams
protected static 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

Modifier and Type	Method	Description
IAuthToken	authenticate(IAuthCredentials authCred)	authenticates nothing
AuthenticationConfig	getAuthenticationConfig()
String[]	getConfigParams()	Get the list of configuration parameter names required by this authentication manager.
AuthManagerConfig	getConfigStore()	gets the configuration substore used by this authentication manager
String	getImplName()	gets the name of the authentication manager plugin
String	getName()	gets the name of this authentication manager instance
String[]	getRequiredCreds()	get the list of authentication credential attribute names required by this authentication manager.
void	init(String name, String implName, AuthManagerConfig config)	initializes the NullAuthentication auth manager
void	setAuthenticationConfig(AuthenticationConfig authenticationConfig)
void	shutdown()	disconnects the member connection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

public static org.slf4j.Logger logger

mConfigParams

protected static String[] mConfigParams

mRequiredCred

protected static String[] mRequiredCred

Constructor Details

NullAuthentication

public NullAuthentication()

Method Details

getAuthenticationConfig

public AuthenticationConfig getAuthenticationConfig()

setAuthenticationConfig

public void setAuthenticationConfig(AuthenticationConfig authenticationConfig)

init

public void init(String name,
 String implName,
 AuthManagerConfig config)
          throws EBaseException

initializes the NullAuthentication auth manager

called by AuthSubsystem init() method, when initializing all available authentication managers.

Specified by:

init in interface AuthManager

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 nothing

called by other subsystems or their servlets to authenticate administrators

Specified by:

authenticate in interface AuthManager

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]

getName

public String getName()

gets the name of this authentication manager instance

Specified by:

getName in interface AuthManager

Returns:

the name of this authentication manager.

getImplName

public String getImplName()

gets the name of the authentication manager plugin

Specified by:

getImplName in interface AuthManager

Returns:

the name of the authentication manager plugin.

getRequiredCreds

public 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:

getRequiredCreds in interface AuthManager

Returns:

attribute names in Vector

getConfigParams

public String[] getConfigParams()

Get the list of configuration parameter names required by this authentication manager. In this case, an empty list.

Specified by:

getConfigParams in interface AuthManager

Returns:

String array of configuration parameters.

shutdown

public void shutdown()

disconnects the member connection

Specified by:

shutdown in interface AuthManager

getConfigStore

public AuthManagerConfig getConfigStore()

gets the configuration substore used by this authentication manager

Specified by:

getConfigStore in interface AuthManager

Returns:

configuration store