Package io.smallrye.jwt.build.spi

Class JwtProvider

java.lang.Object

io.smallrye.jwt.build.spi.JwtProvider

Direct Known Subclasses:

JwtProviderImpl

public abstract class JwtProvider
extends Object

Service provider for JWT Claims Builder objects.

See Also:

• ServiceLoader

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JwtProvider()

Method Summary

Modifier and Type	Method	Description
abstract JwtClaimsBuilder	claims()	Creates a new instance of JwtClaimsBuilder
abstract JwtClaimsBuilder	claims(jakarta.json.JsonObject jsonObject)	Creates a new instance of JwtClaimsBuilder from JsonObject
abstract JwtClaimsBuilder	claims(String jsonLocation)	Creates a new instance of JwtClaimsBuilder from a JSON resource.
abstract JwtClaimsBuilder	claims(Map<String,Object> claims)	Creates a new instance of JwtClaimsBuilder from a map of claims.
abstract JwtClaimsBuilder	claims(org.eclipse.microprofile.jwt.JsonWebToken jwt)	Creates a new instance of JwtClaimsBuilder from JsonWebToken.
abstract JwtClaimsBuilder	claimsJson(String json)	Creates a new instance of JwtClaimsBuilder from a JSON string.
static JwtProvider	provider()	Creates a JWT provider object.

Methods inherited from class java.lang.Object

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

Constructor Details

JwtProvider

protected JwtProvider()

Method Details

provider

public static JwtProvider provider()

Creates a JWT provider object. The provider is loaded using the ServiceLoader.load(Class) method. If there are no available service providers, this method returns the default service provider. Users are recommended to cache the result of this method.

Returns:

a JWT provider

See Also:

• ServiceLoader

claims

public abstract JwtClaimsBuilder claims()

Creates a new instance of JwtClaimsBuilder

Returns:

JwtClaimsBuilder

claims

public abstract JwtClaimsBuilder claims(Map<String,Object> claims)

Creates a new instance of JwtClaimsBuilder from a map of claims.

Parameters:

claims - the map with the claim name and value pairs. Claim value is converted to String unless it is an instance of Boolean, Number, Collection, Map, JsonObject or JsonArray.

Returns:

JwtClaimsBuilder

claims

public abstract JwtClaimsBuilder claims(jakarta.json.JsonObject jsonObject)

Creates a new instance of JwtClaimsBuilder from JsonObject

Parameters:

jsonObject - JsonObject containing the claims.

Returns:

JwtClaimsBuilder

claims

public abstract JwtClaimsBuilder claims(String jsonLocation)

Creates a new instance of JwtClaimsBuilder from a JSON resource.

Parameters:

jsonLocation - JSON resource location

Returns:

JwtClaimsBuilder

claimsJson

public abstract JwtClaimsBuilder claimsJson(String json)

Creates a new instance of JwtClaimsBuilder from a JSON string.

Parameters:

json - JSON string

Returns:

JwtClaimsBuilder

claims

public abstract JwtClaimsBuilder claims(org.eclipse.microprofile.jwt.JsonWebToken jwt)

Creates a new instance of JwtClaimsBuilder from JsonWebToken.

Parameters:

jwt - JsonWebToken token.

Returns:

JwtClaimsBuilder