oracle.iam.passwordmgmt.api

Interface ChallengeResponseService

public interface ChallengeResponseService

This Service provides functionality related to ChallengeResponse management and validation. The capabilities include the following

• Retrieve the Challenge Questions to be presented to the user
• Sets the ChallengeResponses for an user
• Validate the responses to challenges

Since:

OIM 11gR1

Method Summary

Modifier and Type	Method and Description
java.util.Set	getChallenges(java.util.Locale locale) Gets the System Default Challenge Questions
java.util.Set	getChallengesForLoggedInUser(java.util.Locale locale) Returns the ChallengeResponses for the logged-in user
java.util.Set	getChallengesForUser(java.lang.String userName, java.util.Locale locale) Returns the only Challenge questions (not responses) for unauthenticated user.
void	setChallengeResponsesForLoggedInUser(java.util.Set challenges) Sets the Challenge Responses for the logged-in user.

Method Detail

getChallenges

java.util.Set getChallenges(java.util.Locale locale)
                     throws ChallengeResponseException

Gets the System Default Challenge Questions

Parameters:

locale - the locale in which the challenge questions should be translated. If this parameter is null, no translation is done

Returns:

the set of system default Challenge Questions

Throws:

ChallengeResponseException - if the challenges cannot be retrieved for any reason

setChallengeResponsesForLoggedInUser

void setChallengeResponsesForLoggedInUser(java.util.Set challenges)
                                   throws ChallengeResponseException

Sets the Challenge Responses for the logged-in user.

Parameters:

challenges - the challenges containing the responses.

Throws:

ChallengeResponseException - if challenge-responses could not be set for some reason

getChallengesForLoggedInUser

java.util.Set getChallengesForLoggedInUser(java.util.Locale locale)
                                    throws ChallengeResponseException

Returns the ChallengeResponses for the logged-in user

Returns:

the ChallengeResponses for the logged-in user

Throws:

ChallengeResponseException - if challenge-responses could not be retrieved for some reason

getChallengesForUser

java.util.Set getChallengesForUser(java.lang.String userName,
                                   java.util.Locale locale)
                            throws ChallengeResponseException

Returns the only Challenge questions (not responses) for unauthenticated user. Mainly used in case of forgot password operation where user is not logged in

Parameters:

userName - , user login

locale - the locale in which the challenge questions should be translated. If this parameter is null, no translation is done

Returns:

the set of Challenge Questions for an unauthenticated user.

Throws:

ChallengeResponseException - if challenge-responses could not be retrieved for some reason