com.sun.identity.authentication
Class AuthContext.Status

java.lang.Object
  |
  +--com.sun.identity.authentication.AuthContext.Status

Enclosing class:

AuthContext

public static class AuthContext.Status

extends java.lang.Object

The class Status defines the possible authentication states during the login process.

Field Summary

static AuthContext.Status	COMPLETED The COMPLETED indicates that the user has been successfully logged out.
static AuthContext.Status	FAILED The FAILED indicates that the login process has failed.
static AuthContext.Status	IN_PROGRESS The IN_PROGRESS status indicates that the login process is in progress.
static AuthContext.Status	NOT_STARTED The NOT_STARTED status indicates that the login process has not yet started.
static AuthContext.Status	SUCCESS The SUCCESS indicates that the login process has succeeded.

Method Summary

boolean	equals(java.lang.Object authStatus) Checks if two authentication status objects are equal.
java.lang.String	toString() Returns the string representation of the authentication status.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

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.

Method Detail

toString

public java.lang.String toString()

Returns the string representation of the authentication status.

Overrides:

toString in class java.lang.Object

Returns:

String string representation of authentication status

equals

public boolean equals(java.lang.Object authStatus)

Checks if two authentication status objects are equal.

Overrides:

equals in class java.lang.Object

Parameters:

authStatus - the reference object with which to compare

Returns:

true if the objects are same; false otherwise