Package 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
- Version:
- $Header: iam/iam-product/features/passwordmgmt/src/main/oracle/iam/passwordmgmt/api/ChallengeResponseService.java /main/6 2015/03/12 05:00:27 anurkkum Exp $
- Author:
- sidhdas
-
Method Summary
Modifier and TypeMethodDescriptiongetChallenges
(Locale locale) Gets the System Default Challenge QuestionsgetChallengesForLoggedInUser
(Locale locale) Returns the ChallengeResponses for the logged-in usergetChallengesForUser
(String userName, Locale locale) Returns the only Challenge questions (not responses) for unauthenticated user.void
setChallengeResponsesForLoggedInUser
(Set<Challenge> challenges) Sets the Challenge Responses for the logged-in user.
-
Method Details
-
getChallenges
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(Set<Challenge> 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
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
Set<Challenge> getChallengesForUser(String userName, 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 loginlocale
- 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
-