Class AuthContext.Status

  • Enclosing class:
    AuthContext

    @SupportedAll
    public static class AuthContext.Status
    extends Object
    The class Status defines the possible authentication states during the login process.
    • Field Detail

      • NOT_STARTED

        public static final AuthContext.Status NOT_STARTED
        The NOT_STARTED status indicates that the login process has not yet started. Basically, it means that the method login has not been called.
      • IN_PROGRESS

        public static final AuthContext.Status IN_PROGRESS
        The IN_PROGRESS status indicates that the login process is in progress. Basically, it means that the login method has been called and that this object is waiting for the user to send authentication information.
      • SUCCESS

        public static final AuthContext.Status SUCCESS
        The SUCCESS indicates that the login process has succeeded.
      • FAILED

        public static final AuthContext.Status FAILED
        The FAILED indicates that the login process has failed.
      • COMPLETED

        public static final AuthContext.Status COMPLETED
        The COMPLETED indicates that the user has been successfully logged out.
      • RESET

        public static final AuthContext.Status RESET
        The RESET indicates that the login process has been reset or re-initialized.
      • ORG_MISMATCH

        public static final AuthContext.Status ORG_MISMATCH
        The ORG_MISMATCH indicates that the framework org and the org required by the user do not match.
    • Method Detail

      • toString

        public String toString()
        Returns the string representation of the authentication status.
        Overrides:
        toString in class Object
        Returns:
        String representation of authentication status.
      • equals

        public boolean equals​(Object authStatus)
        Checks if two authentication status objects are equal.
        Overrides:
        equals in class Object
        Parameters:
        authStatus - Reference object with which to compare.
        Returns:
        true if the objects are same.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object