Package com.helger.security.authentication.result

Class AuthTokenRegistry

java.lang.Object

com.helger.security.authentication.result.AuthTokenRegistry

@ThreadSafe
public final class AuthTokenRegistry
extends Object

This class manages all the currently available authentications tokens.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
static IAuthToken	createToken(IAuthIdentification aIdentification, int nExpirationSeconds)
static com.helger.commons.collection.impl.ICommonsList<IAuthToken>	getAllTokensOfSubject(IAuthSubject aSubject)	Get all tokens of the specified auth subject.
static IAuthToken	getValidToken(String sTokenID)
static int	removeAllTokensOfSubject(IAuthSubject aSubject)	Remove all tokens of the given subject
static com.helger.commons.state.ESuccess	removeToken(String sTokenID)
static IAuthToken	validateTokenAndUpdateLastAccess(String sTokenID)

Methods inherited from class java.lang.Object

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

Method Detail

createToken

@Nonnull
public static IAuthToken createToken(@Nonnull
                                     IAuthIdentification aIdentification,
                                     @Nonnegative
                                     int nExpirationSeconds)

removeToken

@Nonnull
public static com.helger.commons.state.ESuccess removeToken(@Nonnull
                                                            String sTokenID)

getValidToken

@Nullable
public static IAuthToken getValidToken(@Nullable
                                       String sTokenID)

validateTokenAndUpdateLastAccess

@Nullable
public static IAuthToken validateTokenAndUpdateLastAccess(@Nullable
                                                          String sTokenID)

getAllTokensOfSubject

@Nonnull
public static com.helger.commons.collection.impl.ICommonsList<IAuthToken> getAllTokensOfSubject(@Nonnull
                                                                                                IAuthSubject aSubject)

Get all tokens of the specified auth subject. All tokens are returned, no matter whether they are expired or not.

Parameters:

aSubject - The subject to query. May not be null.

Returns:

The list and never null.

removeAllTokensOfSubject

@Nonnegative
public static int removeAllTokensOfSubject(@Nonnull
                                           IAuthSubject aSubject)

Remove all tokens of the given subject

Parameters:

aSubject - The subject for which the tokens should be removed.

Returns:

The number of removed tokens. Always ≥ 0.