org.apache.knox.gateway.services.security.token

Interface TokenStateService

All Superinterfaces:

Service

public interface TokenStateService
extends Service

Service providing authentication token state management.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_SERVER_MANAGED

Method Summary

Modifier and Type	Method and Description
void	addMetadata(String tokenId, TokenMetadata metadata) Adds metadata to the token identified by the given ID
void	addToken(JWTToken token, long issueTime) Add state for the specified token.
void	addToken(String tokenId, long issueTime, long expiration) Add state for the specified token.
void	addToken(String tokenId, long issueTime, long expiration, long maxLifetimeDuration) Add state for the specified token.
long	getDefaultMaxLifetimeDuration()
long	getDefaultRenewInterval()
long	getTokenExpiration(JWT token) Get the token expiration.
long	getTokenExpiration(String tokenId) Get the token expiration.
long	getTokenExpiration(String tokenId, boolean validate) Get the expiration for the specified token, optionally validating the token prior to accessing its expiration.
long	getTokenIssueTime(String tokenId)
TokenMetadata	getTokenMetadata(String tokenId)
Collection<KnoxToken>	getTokens(String userName)
boolean	isExpired(JWTToken token) Checks if the token is expired.
long	renewToken(JWTToken token) Extend the lifetime of the specified token by the default amount of time.
long	renewToken(JWTToken token, long renewInterval) Extend the lifetime of the specified token by the specified amount of time.
long	renewToken(String tokenId) Extend the lifetime of the specified token by the default amount of time.
long	renewToken(String tokenId, long renewInterval) Extend the lifetime of the specified token by the specified amount of time.
void	revokeToken(JWTToken token) Disable any subsequent use of the specified token.
void	revokeToken(String tokenId) Disable any subsequent use of the specified token.

Methods inherited from interface org.apache.knox.gateway.services.Service

init, start, stop

Field Detail

CONFIG_SERVER_MANAGED

static final String CONFIG_SERVER_MANAGED

See Also:

Constant Field Values

Method Detail

getDefaultRenewInterval

long getDefaultRenewInterval()

Returns:

The default duration (in milliseconds) for which a token's life will be extended when it is renewed.

getDefaultMaxLifetimeDuration

long getDefaultMaxLifetimeDuration()

Returns:

The default maximum lifetime duration (in milliseconds) of a token.

addToken

void addToken(JWTToken token,
              long issueTime)

Add state for the specified token.

Parameters:

token - The token.

issueTime - The time the token was issued.

addToken

void addToken(String tokenId,
              long issueTime,
              long expiration)

Add state for the specified token.

Parameters:

tokenId - The token unique identifier.

issueTime - The time the token was issued.

expiration - The token expiration time.

addToken

void addToken(String tokenId,
              long issueTime,
              long expiration,
              long maxLifetimeDuration)

Add state for the specified token.

Parameters:

tokenId - The token unique identifier.

issueTime - The time the token was issued.

expiration - The token expiration time.

maxLifetimeDuration - The maximum allowed lifetime for the token.

getTokenIssueTime

long getTokenIssueTime(String tokenId)
                throws UnknownTokenException

Parameters:

tokenId - The token unique identifier.

Returns:

The time the token was issued.

Throws:

UnknownTokenException - if token is not found.

isExpired

boolean isExpired(JWTToken token)
           throws UnknownTokenException

Checks if the token is expired.

Parameters:

token - The token.

Returns:

true, if the token has expired; Otherwise, false.

Throws:

UnknownTokenException - Exception if token is not found.

revokeToken

void revokeToken(JWTToken token)
          throws UnknownTokenException

Disable any subsequent use of the specified token.

Parameters:

token - The token.

Throws:

UnknownTokenException - Exception if token is not found.

revokeToken

void revokeToken(String tokenId)
          throws UnknownTokenException

Disable any subsequent use of the specified token.

Parameters:

tokenId - The token unique identifier.

Throws:

UnknownTokenException - Exception if token is not found.

renewToken

long renewToken(JWTToken token)
         throws UnknownTokenException

Extend the lifetime of the specified token by the default amount of time.

Parameters:

token - The token.

Returns:

The token's updated expiration time in milliseconds.

Throws:

UnknownTokenException - Exception if token is not found.

renewToken

long renewToken(JWTToken token,
                long renewInterval)
         throws UnknownTokenException

Extend the lifetime of the specified token by the specified amount of time.

Parameters:

token - The token.

renewInterval - The amount of time that should be added to the token's lifetime.

Returns:

The token's updated expiration time in milliseconds.

Throws:

UnknownTokenException - Exception if token is not found.

renewToken

long renewToken(String tokenId)
         throws UnknownTokenException

Extend the lifetime of the specified token by the default amount of time.

Parameters:

tokenId - The token unique identifier.

Returns:

The token's updated expiration time in milliseconds.

Throws:

UnknownTokenException - Exception if token is not found.

renewToken

long renewToken(String tokenId,
                long renewInterval)
         throws UnknownTokenException

Extend the lifetime of the specified token by the specified amount of time.

Parameters:

tokenId - The token unique identifier.

renewInterval - The amount of time that should be added to the token's lifetime.

Returns:

The token's updated expiration time in milliseconds.

Throws:

UnknownTokenException - Exception if token is not found.

getTokenExpiration

long getTokenExpiration(JWT token)
                 throws UnknownTokenException

Get the token expiration.

Parameters:

token - The token.

Returns:

The token's expiration time in milliseconds.

Throws:

UnknownTokenException - Exception if token is not found.

getTokenExpiration

long getTokenExpiration(String tokenId)
                 throws UnknownTokenException

Get the token expiration.

Parameters:

tokenId - The token unique identifier.

Returns:

The token's expiration time in milliseconds.

Throws:

UnknownTokenException - Exception if token is not found.

getTokenExpiration

long getTokenExpiration(String tokenId,
                        boolean validate)
                 throws UnknownTokenException

Get the expiration for the specified token, optionally validating the token prior to accessing its expiration. In some cases, the token has already been validated, and skipping an additional unnecessary validation improves performance.

Parameters:

tokenId - The token unique identifier.

validate - Flag indicating whether the token needs to be validated.

Returns:

The token's expiration time in milliseconds.

Throws:

UnknownTokenException - Exception if token is not found.

addMetadata

void addMetadata(String tokenId,
                 TokenMetadata metadata)

Adds metadata to the token identified by the given ID

Parameters:

tokenId - The token's unique identifier.

metadata - The metadata to be added

getTokenMetadata

TokenMetadata getTokenMetadata(String tokenId)
                        throws UnknownTokenException

Parameters:

tokenId - The token's unique identifier.

Returns:

The associated token metadata

Throws:

UnknownTokenException

getTokens

Collection<KnoxToken> getTokens(String userName)

Parameters:

userName - The name of the user to get tokens for

Returns:

a collection of tokens associated to the given user; it's an empty collection if there is no associated token found in the underlying token management backend