info.magnolia.cms.security.auth.login

Class LoginResult

java.lang.Object

info.magnolia.cms.security.auth.login.LoginResult

public class LoginResult
extends Object

The result of a login operation.

Field Summary

Fields

Modifier and Type	Field and Description
static LoginResult	NO_LOGIN Returned if a login handler was able to perform the operation but the authentication failed.
static LoginResult	NOT_HANDLED Returned if a login handler is not able to perform the operation.
static int	STATUS_FAILED
static int	STATUS_IN_PROCESS
static int	STATUS_NO_LOGIN
static int	STATUS_NOT_HANDLED
static int	STATUS_SUCCEEDED
static int	STATUS_SUCCEEDED_REDIRECT_REQUIRED Special status indicating that login was successful but was done via a method that requires redirection, e.g. via form from POST request in order to prevent logging in via Back button after logout.

Constructor Summary

Constructors

Constructor and Description
LoginResult(int status)
LoginResult(int status, LoginException loginException)
LoginResult(int status, Subject subject)

Method Summary

Modifier and Type	Method and Description
static LoginResult	getCurrentLoginResult()
LoginException	getLoginException()
int	getStatus()
Subject	getSubject()
static void	setCurrentLoginResult(LoginResult loginResult) Used by the login filter to depose the login result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STATUS_NO_LOGIN

public static final int STATUS_NO_LOGIN

See Also:

Constant Field Values

NOT_HANDLED

public static LoginResult NOT_HANDLED

Returned if a login handler is not able to perform the operation.

NO_LOGIN

public static LoginResult NO_LOGIN

Returned if a login handler was able to perform the operation but the authentication failed.

STATUS_IN_PROCESS

public static final int STATUS_IN_PROCESS

See Also:

Constant Field Values

STATUS_NOT_HANDLED

public static final int STATUS_NOT_HANDLED

See Also:

Constant Field Values

STATUS_FAILED

public static final int STATUS_FAILED

See Also:

Constant Field Values

STATUS_SUCCEEDED

public static final int STATUS_SUCCEEDED

See Also:

Constant Field Values

STATUS_SUCCEEDED_REDIRECT_REQUIRED

public static final int STATUS_SUCCEEDED_REDIRECT_REQUIRED

Special status indicating that login was successful but was done via a method that requires redirection, e.g. via form from POST request in order to prevent logging in via Back button after logout.

See Also:

, Constant Field Values

Constructor Detail

LoginResult

public LoginResult(int status)

LoginResult

public LoginResult(int status,
                   LoginException loginException)

LoginResult

public LoginResult(int status,
                   Subject subject)

Method Detail

getStatus

public int getStatus()

getSubject

public Subject getSubject()

getLoginException

public LoginException getLoginException()

Returns:

an instance of LoginException. Warning: it can be null.

setCurrentLoginResult

public static void setCurrentLoginResult(LoginResult loginResult)

Used by the login filter to depose the login result.

getCurrentLoginResult

public static LoginResult getCurrentLoginResult()