com.helger.photon.basic.auth.token

Class AuthTokenRegistry

java.lang.Object

com.helger.commons.scope.singleton.AbstractSingleton

com.helger.commons.scope.singleton.AbstractGlobalSingleton

com.helger.photon.basic.auth.token.AuthTokenRegistry

All Implemented Interfaces:

com.helger.commons.scope.IScopeDestructionAware

@ThreadSafe
public final class AuthTokenRegistry
extends com.helger.commons.scope.singleton.AbstractGlobalSingleton

This class manages all the currently available authentications tokens.

Author:

Philip Helger

Field Summary

Fields inherited from class com.helger.commons.scope.singleton.AbstractSingleton

m_aRWLock

Constructor Summary

Constructors

Constructor and Description
AuthTokenRegistry() Deprecated.

Method Summary

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

Methods inherited from class com.helger.commons.scope.singleton.AbstractGlobalSingleton

getAllGlobalSingletons, getGlobalSingleton, getGlobalSingletonIfInstantiated, isGlobalSingletonInstantiated

Methods inherited from class com.helger.commons.scope.singleton.AbstractSingleton

getAllSingletons, getSingleton, getSingletonIfInstantiated, getSingletonScopeKey, isDestroyed, isInDestruction, isInInstantiation, isInPreDestruction, isInstantiated, isSingletonInstantiated, isUsableObject, onAfterInstantiation, onBeforeDestroy, onBeforeScopeDestruction, onDestroy, onScopeDestruction, readAbstractSingletonFields, setDestroyed, setInDestruction, setInInstantiation, setInPreDestruction, setInstantiated, toString, writeAbstractSingletonFields

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthTokenRegistry

@Deprecated
 @UsedViaReflection
public AuthTokenRegistry()

Deprecated.

Method Detail

getInstance

@Nonnull
public static AuthTokenRegistry getInstance()

createToken

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

removeToken

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

getValidToken

@Nullable
public IAuthToken getValidToken(@Nullable
                                           String sTokenID)

validateTokenAndUpdateLastAccess

@Nullable
public IAuthToken validateTokenAndUpdateLastAccess(@Nullable
                                                              String sTokenID)

getAllTokensOfSubject

@Nonnull
public com.helger.commons.collection.ext.ICommonsList<? extends 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 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.