Package com.predic8.membrane.core.interceptor.oauth2.tokengenerators

Class BearerJwtTokenGenerator

java.lang.Object

com.predic8.membrane.core.interceptor.oauth2.tokengenerators.BearerJwtTokenGenerator

All Implemented Interfaces:

TokenGenerator

public class BearerJwtTokenGenerator
extends Object
implements TokenGenerator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BearerJwtTokenGenerator.Jwk

Constructor Summary

Constructors

Constructor	Description
BearerJwtTokenGenerator()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAdditionalClaims(String token)	Checks the token for validity.
String	getClientId(String token)	Checks the token for validity.
long	getExpiration()
JwtSessionManager.Jwk	getJwk()
String	getJwkIfAvailable()
String	getToken(String username, String clientId, String clientSecret, Map<String,Object> additionalClaims)
String	getTokenType()
String	getUsername(String token)	Checks the token for validity.
void	init(Router router)
void	invalidateToken(String token, String clientId, String clientSecret)	Revokes a token.
boolean	isWarningGeneratedKey()
void	setExpiration(long expiration)
void	setJwk(JwtSessionManager.Jwk jwk)
void	setWarningGeneratedKey(boolean warningGeneratedKey)
boolean	supportsRevocation()
org.jose4j.jwt.JwtClaims	verify(String token)

Methods inherited from class java.lang.Object

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

Constructor Details

BearerJwtTokenGenerator

public BearerJwtTokenGenerator()

Method Details

init

public void init(Router router)
          throws Exception

Specified by:

init in interface TokenGenerator

Throws:

Exception

getTokenType

public String getTokenType()

Specified by:

getTokenType in interface TokenGenerator

Returns:

the token type used, probably "Bearer".

getToken

public String getToken(String username,
 String clientId,
 String clientSecret,
 Map<String,Object> additionalClaims)

Specified by:

getToken in interface TokenGenerator

Returns:

a new token for the specified user and client.

verify

public org.jose4j.jwt.JwtClaims verify(String token)
                                throws org.jose4j.jwt.consumer.InvalidJwtException

Throws:

org.jose4j.jwt.consumer.InvalidJwtException

getUsername

public String getUsername(String token)
                   throws NoSuchElementException

Description copied from interface: TokenGenerator

Checks the token for validity. Returns the username the token was generated for.

Specified by:

getUsername in interface TokenGenerator

Parameters:

token - The token.

Returns:

The username.

Throws:

NoSuchElementException - if the token is not valid or no username is contained in the token.

getAdditionalClaims

public Map<String,Object> getAdditionalClaims(String token)
                                       throws NoSuchElementException

Description copied from interface: TokenGenerator

Checks the token for validity. Returns the additional claims the token was generated for.

Specified by:

getAdditionalClaims in interface TokenGenerator

Parameters:

token - The token.

Returns:

The additional claims.

Throws:

NoSuchElementException - if the token is not valid.

getClientId

public String getClientId(String token)
                   throws NoSuchElementException

Description copied from interface: TokenGenerator

Checks the token for validity. Returns the clientId the token was generated for.

Specified by:

getClientId in interface TokenGenerator

Parameters:

token - The token.

Returns:

The clientId.

Throws:

NoSuchElementException - if the token is not valid or no clientId is contained in the token.

invalidateToken

public void invalidateToken(String token,
 String clientId,
 String clientSecret)
                     throws NoSuchElementException

Description copied from interface: TokenGenerator

Revokes a token.

Specified by:

invalidateToken in interface TokenGenerator

Throws:

NoSuchElementException

supportsRevocation

public boolean supportsRevocation()

Specified by:

supportsRevocation in interface TokenGenerator

Returns:

whether this token manager supports revocation (also known as "invalidation")

getExpiration

public long getExpiration()

Specified by:

getExpiration in interface TokenGenerator

Returns:

token expiration in seconds, or 0 if there is no expiration

setExpiration

public void setExpiration(long expiration)

Default

0

Description

Token expiration in seconds (or 0 to use no token expiration).

getJwk

public JwtSessionManager.Jwk getJwk()

setJwk

public void setJwk(JwtSessionManager.Jwk jwk)

isWarningGeneratedKey

public boolean isWarningGeneratedKey()

setWarningGeneratedKey

public void setWarningGeneratedKey(boolean warningGeneratedKey)

getJwkIfAvailable

public String getJwkIfAvailable()

Specified by:

getJwkIfAvailable in interface TokenGenerator

Returns:

the JWK representation of the key used to sign the tokens or null, if there is no such key (e.g. because the tokens are randomly generated strings)