Package eu.webtoolkit.jwt.auth

Class AuthTokenResult

java.lang.Object

eu.webtoolkit.jwt.auth.AuthTokenResult

public class AuthTokenResult
extends java.lang.Object

The result of processing an authentication token.

An authentication token is usually taken from a browser cookie, and used to identify (and possibly authenticate) a user across sessions.

See Also:

AuthService.processAuthToken(String token, AbstractUserDatabase users), AuthService.createAuthToken(User user, int authTokenValidity)

Constructor Summary

Constructors

Constructor	Description
AuthTokenResult(AuthTokenState state)	Constructor.
AuthTokenResult(AuthTokenState state, User user)	Constructor.
AuthTokenResult(AuthTokenState state, User user, java.lang.String newToken)	Constructor.
AuthTokenResult(AuthTokenState state, User user, java.lang.String newToken, int newTokenValidity)	Constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getNewToken()	Returns a new token for this user.
int	getNewTokenValidity()	Returns the validity of the new token.
AuthTokenState	getState()	Returns the result.
User	getUser()	Returns the identified user.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthTokenResult

public AuthTokenResult(AuthTokenState state,
                       User user,
                       java.lang.String newToken,
                       int newTokenValidity)

Constructor.

Creates an authentication token result.

AuthTokenResult

public AuthTokenResult(AuthTokenState state)

Constructor.

Calls this(state, new User(), "", - 1)

AuthTokenResult

public AuthTokenResult(AuthTokenState state,
                       User user)

Constructor.

Calls this(state, user, "", - 1)

AuthTokenResult

public AuthTokenResult(AuthTokenState state,
                       User user,
                       java.lang.String newToken)

Constructor.

Calls this(state, user, newToken, - 1)

Method Detail

getState

public AuthTokenState getState()

Returns the result.

getUser

public User getUser()

Returns the identified user.

The user is valid only if the the getState() == AuthTokenState.Valid.

getNewToken

public java.lang.String getNewToken()

Returns a new token for this user.

Returns the empty string if there is no new token. See AuthService.isAuthTokenUpdateEnabled().

The returned token is valid only if the getState() == AuthTokenState.Valid.

getNewTokenValidity

public int getNewTokenValidity()

Returns the validity of the new token.

This returns the token validity in seconds.

Returns -1 if there is no new token, or result() != Valid.

See Also:

getNewToken()