Package com.netscape.cms.profile
Interface ProfileAuthenticator
- All Superinterfaces:
AuthManager
- All Known Implementing Classes:
AgentCertAuthentication
,CMCAuth
,FlatFileAuth
,SessionAuthentication
,SSLclientCertAuthentication
,TokenAuthentication
,UidPwdDirAuthentication
,UidPwdPinDirAuthentication
,UserPwdDirAuthentication
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$, $Date$
-
Field Summary
FieldsFields 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
-
Method Summary
Modifier and TypeMethodDescriptionRetrieves the configuration store.Retrieves the localizable name of this policy.Retrieves the localizable description of this policy.getValueDescriptor
(Locale locale, String name) Retrieves the descriptor of the given value property by name.Retrieves a list of names of the property.void
init
(Profile profile, ConfigStore config) Initializes this default policy.boolean
Checks if this authenticator requires SSL client authentication.boolean
isValueWriteable
(String name) Checks if the value of the given property should be serializable into the request.void
populate
(IAuthToken token, Request request) Populates authentication specific information into the request for auditing purposes.Methods inherited from interface org.dogtagpki.server.authentication.AuthManager
authenticate, getConfigParams, getImplName, getName, getRequiredCreds, init, shutdown
-
Field Details
-
AUTHENTICATED_NAME
- See Also:
-
-
Method Details
-
init
Initializes this default policy.- Parameters:
profile
- owner of this authenticatorconfig
- configuration store- Throws:
EProfileException
- failed to initialize
-
getConfigStore
AuthManagerConfig getConfigStore()Retrieves the configuration store.- Specified by:
getConfigStore
in interfaceAuthManager
- Returns:
- configuration store
-
populate
Populates authentication specific information into the request for auditing purposes.- Parameters:
token
- authentication tokenrequest
- request- Throws:
EProfileException
- failed to populate
-
getName
Retrieves the localizable name of this policy.- Parameters:
locale
- end user locale- Returns:
- localized authenticator name
-
getText
Retrieves the localizable description of this policy.- Parameters:
locale
- end user locale- Returns:
- localized authenticator description
-
getValueNames
Enumeration<String> getValueNames()Retrieves a list of names of the property.- Returns:
- a list of property names
-
isValueWriteable
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
Retrieves the descriptor of the given value property by name.- Parameters:
locale
- user localename
- 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
-