com.ibm.itim.apps.identity

Class ChallengeResponseManager

java.lang.Object

com.ibm.itim.apps.identity.ChallengeResponseManager

public class ChallengeResponseManager
extends java.lang.Object

Provides aggregate identity challenge response management capabilities.

Constructor Summary

Constructors

Constructor and Description
ChallengeResponseManager(PlatformContext platform, javax.security.auth.Subject subject) Constructs the manager with a platform context and a subject.

Method Summary

Modifier and Type	Method and Description
ChallengeResponseConfiguration	getChallengeResonseConfiguration() Gets the ChallengeResonseConfiguration for the subject.
ChallengeResponseConfiguration	getChallengeResonseConfiguration(java.util.Locale locale) Gets the ChallengeResponseConfiguration for the subject.
ChallengesAndResponses	getChallengesAndResponses() Returns the challenges that are configured for the user.
boolean	isEnforceChallengeResponse() Returns true if Challenge/Response is enforced (enabled).
void	setChallengesAndResponses(ChallengesAndResponses cAndr) Sets the challenges and responses for the subject as specified in the Map.
void	setChallengesAndResponses(ChallengesAndResponses cAndr, java.util.Locale locale) Sets the challenges and responses for the subject as specified in the Map.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChallengeResponseManager

public ChallengeResponseManager(PlatformContext platform,
                                javax.security.auth.Subject subject)

Constructs the manager with a platform context and a subject.

Parameters:

platform - PlatformContext holding platform connection information.

subject - Subject representing the authenticated caller.

Method Detail

getChallengeResonseConfiguration

public ChallengeResponseConfiguration getChallengeResonseConfiguration()
                                                                throws java.rmi.RemoteException,
                                                                       ApplicationException

Gets the ChallengeResonseConfiguration for the subject.

Returns:

ChallengeResponseConfiguration for default locale(no locale).

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with the platform.

ApplicationException - Thrown if an application-level exception prevents returning a ChallengeResponseConfiguration

getChallengeResonseConfiguration

public ChallengeResponseConfiguration getChallengeResonseConfiguration(java.util.Locale locale)
                                                                throws java.rmi.RemoteException,
                                                                       ApplicationException

Gets the ChallengeResponseConfiguration for the subject.

Parameters:

locale - Locale for which to return a ChallengeResponseConfiguration

Returns:

ChallengeResponseConfiguration for the specified locale.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with the platform.

ApplicationException - Thrown if an application-level exception prevents returning a ChallengeResponseConfiguration

getChallengesAndResponses

public ChallengesAndResponses getChallengesAndResponses()
                                                 throws java.rmi.RemoteException,
                                                        ApplicationException

Returns the challenges that are configured for the user.

Returns:

Collection of the user's challenges.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with the platform.

ApplicationException - Thrown if an application-level exception prevents returning a ChallengeResponseConfiguration

setChallengesAndResponses

public void setChallengesAndResponses(ChallengesAndResponses cAndr)
                               throws java.rmi.RemoteException,
                                      ApplicationException

Sets the challenges and responses for the subject as specified in the Map. Note: The number of challenge and responses in the Map must match the reqiured number of challenges and responses that was set by an administrator. Note: it is not an error to set challenges when c/r isn't enabled. It just may be a wasted effort.

Parameters:

cAndr - ChallengesAndResponses containing the challenges and responses for the subject.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

ApplicationException - Thrown if challenge response is not enabled for the user.

setChallengesAndResponses

public void setChallengesAndResponses(ChallengesAndResponses cAndr,
                                      java.util.Locale locale)
                               throws java.rmi.RemoteException,
                                      ApplicationException

Sets the challenges and responses for the subject as specified in the Map. Note: The number of challenge and responses in the Map must match the reqiured number of challenges and responses that was set by an administrator. Note: it is not an error to set challenges when c/r isn't enabled. It just may be a wasted effort. Note: The loacale used here is to find the common the challenges in the default locale and in this locale.

Parameters:

cAndr - ChallengesAndResponses containing the challenges and responses for the subject.

locale - user locale

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

ApplicationException - Thrown if challenge response is not enabled for the user.

isEnforceChallengeResponse

public boolean isEnforceChallengeResponse()
                                   throws ApplicationException

Returns true if Challenge/Response is enforced (enabled).

Returns:

true if Challenge/Response is enforced (enabled), false otherwise.

Throws:

ApplicationException - Thrown if an application-level error occurs.