Package org.opencms.security

Class CmsPersistentLoginTokenHandler.Token

java.lang.Object

org.opencms.security.CmsPersistentLoginTokenHandler.Token

Enclosing class:

CmsPersistentLoginTokenHandler

public static class CmsPersistentLoginTokenHandler.Token
extends Object

Bean representing the data encoded in a login token (user name and key).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SEPARATOR	Separator to use for the encoded token string.

Constructor Summary

Constructors

Constructor	Description
Token(String token)	Creates a new token object from the encoded representation.
Token(String name, String key)	Creates a token object from the given name and key.

Method Summary

Modifier and Type	Method	Description
String	encode()	Gets the encoded token string representation.
String	getAdditionalInfoKey()	Gets the additional info key to use for this token.
String	getKey()	Gets the key for this token.
String	getName()	Gets the user name for this token.
boolean	isValid()	Checks if this token is valid.

Methods inherited from class java.lang.Object

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

Field Details

SEPARATOR

public static final String SEPARATOR

Separator to use for the encoded token string.

See Also:

• Constant Field Values

Constructor Details

Token

public Token(String token)

Creates a new token object from the encoded representation.

Parameters:

token - a string containing the token data

Token

public Token(String name,
 String key)

Creates a token object from the given name and key.

Parameters:

name - the name

key - the key

Method Details

encode

public String encode()

Gets the encoded token string representation.

Returns:

the token string

getAdditionalInfoKey

public String getAdditionalInfoKey()

Gets the additional info key to use for this token.

Returns:

the additional info key

getKey

public String getKey()

Gets the key for this token.

Returns:

the key

getName

public String getName()

Gets the user name for this token.

Returns:

the user name

isValid

public boolean isValid()

Checks if this token is valid.

Returns:

true if this token is valid