public class TokenAuthentication extends java.lang.Object implements IAuthManager, IProfileAuthenticator
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CRED_SESSION_ID |
protected static java.lang.String[] |
mConfigParams |
protected java.lang.String[] |
mRequiredCreds |
static java.lang.String |
TOKEN_GID |
static java.lang.String |
TOKEN_UID |
AUTHENTICATED_NAME
CRED_CERT_SERIAL_TO_REVOKE, CRED_HOST_NAME, CRED_SSL_CLIENT_CERT
Constructor and Description |
---|
TokenAuthentication() |
Modifier and Type | Method and Description |
---|---|
IAuthToken |
authenticate(IAuthCredentials authCred)
authenticates user(agent) by certificate
|
java.lang.String[] |
getConfigParams()
get the list of configuration parameter names
required by this authentication manager.
|
IConfigStore |
getConfigStore()
gets the configuretion substore used by this authentication
manager
|
java.lang.String |
getImplName()
Gets the plugin name of authentication manager.
|
java.lang.String |
getName()
Gets the name of this authentication manager.
|
java.lang.String |
getName(java.util.Locale locale)
Retrieves the localizable name of this policy.
|
java.lang.String[] |
getRequiredCreds()
get the list of authentication credential attribute names
required by this authentication manager.
|
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
parameter by name.
|
java.util.Enumeration |
getValueNames()
Retrieves a list of names of the value parameter.
|
void |
init(IProfile profile,
IConfigStore config)
Initializes this default policy.
|
void |
init(java.lang.String name,
java.lang.String implName,
IConfigStore config)
initializes the TokenAuthentication auth manager
|
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.
|
void |
shutdown()
prepare this authentication manager for shutdown.
|
public static final java.lang.String TOKEN_UID
public static final java.lang.String TOKEN_GID
public static final java.lang.String CRED_SESSION_ID
protected java.lang.String[] mRequiredCreds
protected static java.lang.String[] mConfigParams
public void init(java.lang.String name, java.lang.String implName, IConfigStore config) throws EBaseException
called by AuthSubsystem init() method, when initializing all available authentication managers.
init
in interface IAuthManager
name
- The name of this authentication manager instance.implName
- The name of the authentication manager plugin.config
- The configuration store for this authentication manager.EBaseException
- If an initialization error occurred.public java.lang.String getName()
getName
in interface IAuthManager
public java.lang.String getImplName()
getImplName
in interface IAuthManager
public boolean isSSLClientRequired()
IProfileAuthenticator
isSSLClientRequired
in interface IProfileAuthenticator
public IAuthToken authenticate(IAuthCredentials authCred) throws EMissingCredential, EInvalidCredentials, EBaseException
called by other subsystems or their servlets to authenticate users (agents)
authenticate
in interface IAuthManager
authCred
- - authentication credential that contains
an usrgrp.Certificates of the user (agent)EMissingCredential
- If a required credential for this
authentication manager is missing.EInvalidCredentials
- If credentials cannot be authenticated.EBaseException
- If an internal error occurred.AuthToken
,
Certificates
public java.lang.String[] getRequiredCreds()
getRequiredCreds
in interface IAuthManager
public java.lang.String[] getConfigParams()
getConfigParams
in interface IAuthManager
public void shutdown()
shutdown
in interface IAuthManager
public IConfigStore getConfigStore()
getConfigStore
in interface IAuthManager
getConfigStore
in interface IProfileAuthenticator
public void init(IProfile profile, IConfigStore config) throws EProfileException
IProfileAuthenticator
init
in interface IProfileAuthenticator
profile
- owner of this authenticatorconfig
- configuration storeEProfileException
- failed to initializepublic java.lang.String getName(java.util.Locale locale)
getName
in interface IProfileAuthenticator
locale
- end user localepublic java.lang.String getText(java.util.Locale locale)
getText
in interface IProfileAuthenticator
locale
- end user localepublic java.util.Enumeration getValueNames()
getValueNames
in interface IProfileAuthenticator
public boolean isValueWriteable(java.lang.String name)
IProfileAuthenticator
isValueWriteable
in interface IProfileAuthenticator
name
- property namepublic IDescriptor getValueDescriptor(java.util.Locale locale, java.lang.String name)
getValueDescriptor
in interface IProfileAuthenticator
locale
- user localename
- property namepublic void populate(IAuthToken token, IRequest request) throws EProfileException
IProfileAuthenticator
populate
in interface IProfileAuthenticator
token
- authentication tokenrequest
- requestEProfileException
- failed to populate