com.ibm.security.access.mobile.authentication

Class ChallengeResult

  • java.lang.Object
    • com.ibm.security.access.mobile.authentication.ChallengeResult
  • All Implemented Interfaces:
    IResult


    public final class ChallengeResult
    extends java.lang.Object
    implements IResult
    Holds the result of the challenge verification.
    Since:
    1.2.0
    Version:
    1.2.8
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getErrorDescription()
      Returns detailed information about the error.
      MobileKitException getMobileKitException()
      Returns the mobileKitException object, representing the error.
      IChallenge getNextChallenge()
      Returns next challenge mechanism dictated by policy.
      boolean getStatus()
      Returns whether to indicate the status of the verification result
      boolean hasError()
      Returns whether to indicate an error.
      java.lang.String toString()
      Returns a textually representation of the instance with attribute names and values.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ChallengeResult

        public ChallengeResult(boolean status,
                               MobileKitException mobileKitException,
                               IChallenge nextChallenge)
        Returns a new ChallengeResult, containing a flag to indicate the challenge status, a message associated with the status and the next challenge.
        Parameters:
        status - flag to indicate is the verification
        mobileKitException - the MobileKitException that was thrown
        nextChallenge - next challenge mechanism dictated by policy
      • ChallengeResult

        public ChallengeResult(MobileKitException mobileKitException,
                               IChallenge nextChallenge)
        Returns a new ChallengeResult, containing a message associated with the status and the next challenge.
        Parameters:
        mobileKitException - the MobileKitException that was thrown
        nextChallenge - next challenge mechanism dictated by policy
      • ChallengeResult

        public ChallengeResult(IChallenge nextChallenge)
        Returns a new ChallengeResult, containing the next challenge.
        Parameters:
        nextChallenge - next challenge mechanism dictated by policy
      • ChallengeResult

        public ChallengeResult(MobileKitException mobileKitException)
        Returns a new ChallengeResult in case an error was returned
        Parameters:
        mobileKitException - the MobileKitException that was thrown
    • Method Detail

      • getStatus

        public boolean getStatus()
        Returns whether to indicate the status of the verification result
        Returns:
        true if the verification was successful
        false otherwise
      • hasError

        public boolean hasError()
        Returns whether to indicate an error.
        Returns:
        true if there has been an error,
        false otherwise
      • getErrorDescription

        public java.lang.String getErrorDescription()
        Returns detailed information about the error.
        Specified by:
        getErrorDescription in interface IResult
        Returns:
        the detailed information of the error or null if unknown.
      • getNextChallenge

        public IChallenge getNextChallenge()
        Returns next challenge mechanism dictated by policy.
        Returns:
        next challenge
      • toString

        public java.lang.String toString()
        Returns a textually representation of the instance with attribute names and values.
        Overrides:
        toString in class java.lang.Object
        Returns:
        textually representation of the instance