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.

Version:

$Id: LoginResult.java 41137 2011-01-06 18:19:25Z gjoseph $

Field Summary

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

Constructor Summary

LoginResult(int status)

LoginResult(int status, LoginException loginException)

LoginResult(int status, User user)

Method Summary

static LoginResult	getCurrentLoginResult()
LoginException	getLoginException()
int	getStatus()
User	getUser()
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

Constructor Detail

LoginResult

public LoginResult(int status)

LoginResult

public LoginResult(int status,
                   LoginException loginException)

LoginResult

public LoginResult(int status,
                   User user)

Method Detail

getStatus

public int getStatus()

getUser

public User getUser()

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()