tenduke.sdk.core.service.JwtServiceProvider Interface Reference

Detailed Description

Service interface to implement for providing instances of JwtService.

Inheritance diagram for tenduke.sdk.core.service.JwtServiceProvider:

Public Member Functions
JwtServiceProvider	withTypHeaderValidationDisabled ()
	Option to disable JWT typ header claim validation for the provided JwtService instances.
JwtService	provide (String jwt)
	Provides a JwtService and initializes it to handle the given JWT.
JwtMetadataParser	provideMetadataParser ()
	Provides JwtMetadataParser to use for inspecting and analyzing JWT's before signature verification.
boolean	supportsJwksUrlLoad ()
	Returns flag that tells if this service provider supports loading token signing keys from a JWKS endpoint.
void	loadJwks (URI jwksUrl)
	Request this service provider to load token signing keys from a JWKS endpoint.
boolean	supportsJwksPersistence ()
	Returns flag that tells if this service provider supports loading token signing keys from a JWKS persistence provider.
void	loadPersistentJwks ()
	Request this service provider to load token signing keys from a JWKS persistence provider.

Member Function Documentation

loadJwks()

void tenduke.sdk.core.service.JwtServiceProvider.loadJwks

(

URI

jwksUrl

)

Request this service provider to load token signing keys from a JWKS endpoint.

NOTE: use supportsJwksUrlLoad() first to check that loading keys is supported.

Parameters

jwksUrl

The JWKS endpoint to load public keys from.

Implemented in tenduke.sdk.core.service.impl.DefaultJwtServiceProvider.

loadPersistentJwks()

void tenduke.sdk.core.service.JwtServiceProvider.loadPersistentJwks

(

)

Request this service provider to load token signing keys from a JWKS persistence provider.

NOTE: use supportsJwksPersistence() first to check that loading persistent keys is supported.

Implemented in tenduke.sdk.core.service.impl.DefaultJwtServiceProvider.

provide()

JwtService tenduke.sdk.core.service.JwtServiceProvider.provide

(

String

jwt

)

Provides a JwtService and initializes it to handle the given JWT.

Parameters

jwt	A JWT in String form.

Returns

an instance of JwtServie that can handle the given JWT.

Implemented in tenduke.sdk.core.service.impl.DefaultJwtServiceProvider.

provideMetadataParser()

JwtMetadataParser tenduke.sdk.core.service.JwtServiceProvider.provideMetadataParser

(

)

Provides JwtMetadataParser to use for inspecting and analyzing JWT's before signature verification.

Returns

an instance of JwtMetadataParser.

Implemented in tenduke.sdk.core.service.impl.DefaultJwtServiceProvider.

supportsJwksPersistence()

boolean tenduke.sdk.core.service.JwtServiceProvider.supportsJwksPersistence

(

)

Returns flag that tells if this service provider supports loading token signing keys from a JWKS persistence provider.

Returns

true if loading keys from JWKS persistence provider is supported, false otherwise.

Implemented in tenduke.sdk.core.service.impl.DefaultJwtServiceProvider.

supportsJwksUrlLoad()

boolean tenduke.sdk.core.service.JwtServiceProvider.supportsJwksUrlLoad

(

)

Returns flag that tells if this service provider supports loading token signing keys from a JWKS endpoint.

Returns

true if loading keys from JWKS endpoint is supported, false otherwise.

Implemented in tenduke.sdk.core.service.impl.DefaultJwtServiceProvider.

withTypHeaderValidationDisabled()

JwtServiceProvider tenduke.sdk.core.service.JwtServiceProvider.withTypHeaderValidationDisabled

(

)

Option to disable JWT typ header claim validation for the provided JwtService instances.

Returns

this instance.

Implemented in tenduke.sdk.core.service.impl.DefaultJwtServiceProvider.

---

The documentation for this interface was generated from the following file:

• service/src/main/java/tenduke/sdk/core/service/JwtServiceProvider.java