Package org.exoplatform.web.security.security

Class CookieTokenService

java.lang.Object

org.exoplatform.web.security.security.AbstractTokenService<PortalToken,String>

org.exoplatform.web.security.security.CookieTokenService

All Implemented Interfaces:

TokenStore, org.picocontainer.Startable

Direct Known Subclasses:

RemindPasswordTokenService

public class CookieTokenService
extends AbstractTokenService<PortalToken,String>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EMAIL_VALIDATION_TOKEN
static final String	EXTERNAL_REGISTRATION_TOKEN
static final String	FORGOT_PASSWORD_TOKEN
static final String	HASH_SERVICE_INIT_PARAM
static final String	LIFECYCLE_NAME
static final String	ONBOARD_TOKEN
static final String	SEPARATOR_CHAR

Fields inherited from class org.exoplatform.web.security.security.AbstractTokenService

CLEANUP_PERIOD_TIME, DEFAULT_TOKEN_BYTE_LENGTH, delayTime, log, name, SERVICE_CONFIG, tokenByteLength, validityMillis

Constructor Summary

Constructors

Constructor	Description
CookieTokenService(org.exoplatform.container.xml.InitParams initParams, PortalTokenStorage tokenStore)

Method Summary

Modifier and Type	Method	Description
void	cleanExpiredTokens()
String	createToken(String username)	Create a token and returns it.
String	createToken(String username, String type)
protected String	decodeKey(String stringKey)	Decode a key from its string representation.
void	deleteAll()	Removes all stored tokens
PortalToken	deleteToken(String cookieTokenString)
PortalToken	deleteToken(String cookieTokenString, String tokenType)
void	deleteTokensByUsernameAndType(String username, String tokenType)	The UI should offer a way to delete all existing tokens of the current user.
void	deleteTokensOfUser(String user)	The UI should offer a way to delete all existing tokens of the current user.
PortalToken	getToken(String id)
PortalToken	getToken(String cookieTokenString, String tokenType)
protected String	nextTokenId()
long	size()

Methods inherited from class org.exoplatform.web.security.security.AbstractTokenService

getInstance, getName, getPeriodTime, getValidityTime, nextRandom, start, stop, validateToken

Methods inherited from class java.lang.Object

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

Field Details

LIFECYCLE_NAME

public static final String LIFECYCLE_NAME

See Also:

• Constant Field Values

HASH_SERVICE_INIT_PARAM

public static final String HASH_SERVICE_INIT_PARAM

See Also:

• Constant Field Values

ONBOARD_TOKEN

public static final String ONBOARD_TOKEN

See Also:

• Constant Field Values

EMAIL_VALIDATION_TOKEN

public static final String EMAIL_VALIDATION_TOKEN

See Also:

• Constant Field Values

FORGOT_PASSWORD_TOKEN

public static final String FORGOT_PASSWORD_TOKEN

See Also:

• Constant Field Values

EXTERNAL_REGISTRATION_TOKEN

public static final String EXTERNAL_REGISTRATION_TOKEN

See Also:

• Constant Field Values

SEPARATOR_CHAR

public static final String SEPARATOR_CHAR

See Also:

• Constant Field Values

Constructor Details

CookieTokenService

public CookieTokenService(org.exoplatform.container.xml.InitParams initParams,
 PortalTokenStorage tokenStore)

Method Details

createToken

public String createToken(String username)

Description copied from interface: TokenStore

Create a token and returns it. The store state is modified as it retains the token until it is removed either explicitely or because the token validity is expired.

Parameters:

username - the username related to the token

Returns:

the token key

createToken

public String createToken(String username,
 String type)

nextTokenId

protected String nextTokenId()

Overrides:

nextTokenId in class AbstractTokenService<PortalToken,String>

getToken

public PortalToken getToken(String cookieTokenString,
 String tokenType)

Specified by:

getToken in class AbstractTokenService<PortalToken,String>

getToken

public PortalToken getToken(String id)

Specified by:

getToken in class AbstractTokenService<PortalToken,String>

deleteToken

public PortalToken deleteToken(String cookieTokenString)

Specified by:

deleteToken in class AbstractTokenService<PortalToken,String>

deleteToken

public PortalToken deleteToken(String cookieTokenString,
 String tokenType)

Specified by:

deleteToken in class AbstractTokenService<PortalToken,String>

deleteTokensOfUser

public void deleteTokensOfUser(String user)

The UI should offer a way to delete all existing tokens of the current user.

Parameters:

user -

deleteTokensByUsernameAndType

public void deleteTokensByUsernameAndType(String username,
 String tokenType)

The UI should offer a way to delete all existing tokens of the current user.

Parameters:

username - username Target username

tokenType - tokenType of the username

deleteAll

public void deleteAll()

Removes all stored tokens

cleanExpiredTokens

public void cleanExpiredTokens()

Specified by:

cleanExpiredTokens in class AbstractTokenService<PortalToken,String>

size

public long size()

Specified by:

size in class AbstractTokenService<PortalToken,String>

decodeKey

protected String decodeKey(String stringKey)

Description copied from class: AbstractTokenService

Decode a key from its string representation.

Specified by:

decodeKey in class AbstractTokenService<PortalToken,String>

Parameters:

stringKey - the key a s a string

Returns:

the typed key