com.netscape.certsrv.profile
Interface IProfileAuthenticator

All Superinterfaces:
IAuthManager
All Known Implementing Classes:
AgentCertAuthentication, CMCAuth, FlatFileAuth, SSLclientCertAuthentication, TokenAuthentication, UidPwdDirAuthentication, UidPwdPinDirAuthentication, UserPwdDirAuthentication

public interface IProfileAuthenticator
extends IAuthManager

This interface represents an authenticator for profile. An authenticator is responsibile for authenting the end-user. If authentication is successful, request can be processed immediately. Otherwise, the request will be defered and manual approval is then required.

Version:
$Revision: 1211 $, $Date: 2010-08-18 10:15:37 -0700 (Wed, 18 Aug 2010) $

Field Summary
static java.lang.String AUTHENTICATED_NAME
           
 
Fields inherited from interface com.netscape.certsrv.authentication.IAuthManager
CRED_CERT_SERIAL_TO_REVOKE, CRED_HOST_NAME, CRED_SESSION_ID, CRED_SSL_CLIENT_CERT
 
Method Summary
 IConfigStore getConfigStore()
          Retrieves the configuration store.
 java.lang.String getName(java.util.Locale locale)
          Retrieves the localizable name of this policy.
 java.lang.String getText(java.util.Locale locale)
          Retrieves the localizable description of this policy.
 IDescriptor getValueDescriptor(java.util.Locale locale, java.lang.String name)
          Retrieves the descriptor of the given value property by name.
 java.util.Enumeration getValueNames()
          Retrieves a list of names of the property.
 void init(IProfile profile, IConfigStore config)
          Initializes this default policy.
 boolean isSSLClientRequired()
          Checks if this authenticator requires SSL client authentication.
 boolean isValueWriteable(java.lang.String name)
          Checks if the value of the given property should be serializable into the request.
 void populate(IAuthToken token, IRequest request)
          Populates authentication specific information into the request for auditing purposes.
 
Methods inherited from interface com.netscape.certsrv.authentication.IAuthManager
authenticate, getConfigParams, getImplName, getName, getRequiredCreds, init, shutdown
 

Field Detail

AUTHENTICATED_NAME

static final java.lang.String AUTHENTICATED_NAME
See Also:
Constant Field Values
Method Detail

init

void init(IProfile profile,
          IConfigStore config)
          throws EProfileException
Initializes this default policy.

Parameters:
profile - owner of this authenticator
config - configuration store
Throws:
EProfileException - failed to initialize

getConfigStore

IConfigStore getConfigStore()
Retrieves the configuration store.

Specified by:
getConfigStore in interface IAuthManager
Returns:
configuration store

populate

void populate(IAuthToken token,
              IRequest request)
              throws EProfileException
Populates authentication specific information into the request for auditing purposes.

Parameters:
token - authentication token
request - request
Throws:
EProfileException - failed to populate

getName

java.lang.String getName(java.util.Locale locale)
Retrieves the localizable name of this policy.

Parameters:
locale - end user locale
Returns:
localized authenticator name

getText

java.lang.String getText(java.util.Locale locale)
Retrieves the localizable description of this policy.

Parameters:
locale - end user locale
Returns:
localized authenticator description

getValueNames

java.util.Enumeration getValueNames()
Retrieves a list of names of the property.

Returns:
a list of property names

isValueWriteable

boolean isValueWriteable(java.lang.String name)
Checks if the value of the given property should be serializable into the request. Passsword or other security-related value may not be desirable for storage.

Parameters:
name - property name
Returns:
true if the property is not security related

getValueDescriptor

IDescriptor getValueDescriptor(java.util.Locale locale,
                               java.lang.String name)
Retrieves the descriptor of the given value property by name.

Parameters:
locale - user locale
name - property name
Returns:
descriptor of the requested property

isSSLClientRequired

boolean isSSLClientRequired()
Checks if this authenticator requires SSL client authentication.

Returns:
client authentication required or not