com.ibm.itim.authentication
Interface Authenticator

All Known Implementing Classes:
AuthenticationAuthority, SystemAuthenticationAuthority

public interface Authenticator

Authenticator is an interface for authenticating a user given a set of user credentials.

Author:
Tony Gullotta

Field Summary
static java.lang.String KEY
          Constant that holds the name of the environment property for specifying the authenticating user's key, such as a password, certificate, etc..
static java.lang.String PRINCIPAL
          Constant that holds the name of the environment property for specifying the authenticating user's identifier or name.
static java.lang.String TENANT
          Constant that holds the name of the environment property for specifying the authenticating user's tenant DN.
 
Method Summary
 SystemUser authenticate(Credentials userCredentials)
          Authenticates a user with the given Credentials.
 

Field Detail

PRINCIPAL

public static final java.lang.String PRINCIPAL
Constant that holds the name of the environment property for specifying the authenticating user's identifier or name.

KEY

public static final java.lang.String KEY
Constant that holds the name of the environment property for specifying the authenticating user's key, such as a password, certificate, etc..

TENANT

public static final java.lang.String TENANT
Constant that holds the name of the environment property for specifying the authenticating user's tenant DN.
Method Detail

authenticate

public SystemUser authenticate(Credentials userCredentials)
                        throws AuthenticationFailedException,
                               ConfigurationException
Authenticates a user with the given Credentials. If the user's credentials are invalid, an AuthenticationFailureException is thrown.
Parameters:
userCredentials - the user's credentials to be authenticated.
Returns:
SystemUser object representing authenticated user
Throws:
AuthenticationFailedException - thrown if the authentication attempt failed to invalid user credentials.
ConfigurationException - thrown if the required credentials are not provided or the provided credentials are malformed.