Package org.forgerock.openam.authentication.callbacks

Class KbaCreateCallback

java.lang.Object
org.forgerock.openam.authentication.callbacks.KbaCreateCallback
All Implemented Interfaces:
Serializable, Callback
@Supported public class KbaCreateCallback extends Object implements Callback, Serializable
A callback to collect a user's choice of security question and their answer to that question.
See Also:

  • Method Details

    • getPrompt

      @Supported public String getPrompt()
      Get the prompt for this callback.
      Returns:
      this callback's prompt

    • getPredefinedQuestions

      @Supported public List<String> getPredefinedQuestions()
      Get the predefined questions available to the user to choose from.
      Returns:
      the list of predefined questions

    • getSelectedQuestion

      @Supported public String getSelectedQuestion()
      Set the user's choice of predefined question or their own custom question.
      Returns:
      the user's chosen question

    • setSelectedQuestion

      @Supported public KbaCreateCallback setSelectedQuestion(String selectedQuestion)
      Set the user's chosen question.
      Parameters:
      selectedQuestion - the user's chosen question
      Returns:
      this callback

    • getSelectedAnswer

      @Supported public String getSelectedAnswer()
      Get the user's chosen response to their chosen question.
      Returns:
      the user's chosen response

    • setSelectedAnswer

      @Supported public KbaCreateCallback setSelectedAnswer(String selectedAnswer)
      Set the user's chosen response to their chosen question.
      Parameters:
      selectedAnswer - the user's chosen response
      Returns:
      this callback

    • isAllowUserDefinedQuestions

      @Supported public boolean isAllowUserDefinedQuestions()
      Get whether the user is allowed to define their own question.
      Returns:
      whether the user is allowed to define their own question

    • builder

      @Supported public static KbaCreateCallback.Builder builder()
      Get a builder for constructing a new KbaCreateCallback.
      Returns:
      a new builder