com.ibm.itim.authentication.system
Class SystemAuthenticationAuthority

java.lang.Object
  |
  +--com.ibm.itim.authentication.system.SystemAuthenticationAuthority
All Implemented Interfaces:
Authenticator

public class SystemAuthenticationAuthority
extends java.lang.Object
implements Authenticator

SystemAuthenticationAuthority is a class that provides a central interface for authenticating users by supporting a wide variety of authentication mechanisms. The type of authentication to be used must be supplied with the user credentials at the time of authentication. This class is a singleton to make it convenient for a client to access an instance without the burden of construction.


Field Summary
static java.lang.String CREDENTIALS_TYPE
          Constant that holds the name of the credential property for specifying the type of credentials being supplied.
 
Fields inherited from interface com.ibm.itim.authentication.Authenticator
KEY, PRINCIPAL, TENANT
 
Method Summary
 SystemUser authenticate(Credentials userCredentials)
          Authenticates a user using the supplied user credentials.
static SystemAuthenticationAuthority getInstance()
          Returns the single instance of the SystemAuthenticationAuthority in the system.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CREDENTIALS_TYPE

public static final java.lang.String CREDENTIALS_TYPE
Constant that holds the name of the credential property for specifying the type of credentials being supplied.

See Also:
Constant Field Values
Method Detail

authenticate

public SystemUser authenticate(Credentials userCredentials)
                        throws AuthenticationFailedException,
                               ConfigurationException
Authenticates a user using the supplied user credentials. The type of credentials being supplied indicate the type of authentication to be performed. The type of credentials must be provided in the Credentials for the authentication to be successful. If the user credentials are invalid an AuthenticationFailedException is thrown.

Specified by:
authenticate in interface Authenticator
Parameters:
userCredentials - the user's credentials and the type of the credentials.
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, or the type credentials are not supported.

getInstance

public static final SystemAuthenticationAuthority getInstance()
                                                       throws ConfigurationException
Returns the single instance of the SystemAuthenticationAuthority in the system.

Returns:
the single instance of the SystemAuthenticationAuthority.
Throws:
ConfigurationException - thrown if the instance could not be accessed, possibly due to construction errors.


IBM Tivoli Identity Manager 4.6
© Copyright International Business Machines Corporation 2005. All rights reserved. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.