org.apache.streams.util.oauth.tokens.tokenmanager.impl

Class BasicTokenManager<T>

java.lang.Object

org.apache.streams.util.oauth.tokens.tokenmanager.impl.BasicTokenManager<T>

All Implemented Interfaces:

SimpleTokenManager<T>

public class BasicTokenManager<T>
extends Object
implements SimpleTokenManager<T>

Manages a pool of tokens the most basic possible way. If all tokens are added to the manager before getNextAvailableToken is called tokens are issued in the order they were added to the manager, FIFO. The BasicTokenManager acts as a circular queue of tokens. Once the manager issues all available tokens it will cycle back to the first token and start issuing tokens again.

When adding tokens to the pool of available tokens, the manager will not add tokens that are already in the pool.

The manager class is thread safe.

Constructor Summary

Constructors

Constructor and Description
BasicTokenManager()
BasicTokenManager(Collection<T> tokens) BasicTokenManager constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addAllTokensToPool(Collection<T> tokens) Adds a Collection of tokens to the available token pool.
boolean	addTokenToPool(T token) Adds a token to the available token pool.
T	getNextAvailableToken() Get an available token.
int	numAvailableTokens() Get the number of available tokens.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicTokenManager

public BasicTokenManager()

BasicTokenManager

public BasicTokenManager(Collection<T> tokens)

BasicTokenManager constructor.

Parameters:

tokens - Collection of tokens

Method Detail

addTokenToPool

public boolean addTokenToPool(T token)

Description copied from interface: SimpleTokenManager

Adds a token to the available token pool.

Specified by:

addTokenToPool in interface SimpleTokenManager<T>

Parameters:

token - Token to be added

Returns:

true, if token was successfully added to the pool and false otherwise.

addAllTokensToPool

public boolean addAllTokensToPool(Collection<T> tokens)

Description copied from interface: SimpleTokenManager

Adds a Collection of tokens to the available token pool.

Specified by:

addAllTokensToPool in interface SimpleTokenManager<T>

Parameters:

tokens - Tokens to be added

Returns:

true, if the token pool size increased after adding the tokens, and false otherwise.

getNextAvailableToken

public T getNextAvailableToken()

Description copied from interface: SimpleTokenManager

Get an available token. If no tokens are available it returns null.

Specified by:

getNextAvailableToken in interface SimpleTokenManager<T>

Returns:

next available token

numAvailableTokens

public int numAvailableTokens()

Description copied from interface: SimpleTokenManager

Get the number of available tokens.

Specified by:

numAvailableTokens in interface SimpleTokenManager<T>

Returns:

number of available tokens