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

Interface SimpleTokenManager<T>

All Known Implementing Classes:

BasicTokenManager

public interface SimpleTokenManager<T>

Manages access to oauth tokens. Allows a caller to add tokens to the token pool and receive an available token.

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.

Method Detail

addTokenToPool

boolean addTokenToPool(T token)

Adds a token to the available token pool.

Parameters:

token - Token to be added

Returns:

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

addAllTokensToPool

boolean addAllTokensToPool(Collection<T> tokens)

Adds a Collection of tokens to the available token pool.

Parameters:

tokens - Tokens to be added

Returns:

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

getNextAvailableToken

T getNextAvailableToken()

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

Returns:

next available token

numAvailableTokens

int numAvailableTokens()

Get the number of available tokens.

Returns:

number of available tokens