Package org.forgerock.oauth2.core

Class TrustedJwtIssuerConfig

java.lang.Object

org.forgerock.oauth2.core.TrustedJwtIssuerConfig

@SupportedAll
public class TrustedJwtIssuerConfig
extends Object

A trusted JWT issuer for use in validating a JWT bearer grant.

Constructor Summary

Constructors

Constructor	Description
TrustedJwtIssuerConfig(String issuer, String resourceOwnerIdentityClaim, String consentedScopesClaim, String[] allowedSubjects, String jwkSet, String jwksUri, String jwksCacheTimeout, String jwksCacheMissTimeout)	A script-friendly constructor to create configuration for a Trusted JWT Issuer.
TrustedJwtIssuerConfig(String issuer, String resourceOwnerIdentityClaim, String consentedScopesClaim, Set<String> allowedSubjects, String jwkSet, String jwksUri, Duration jwksCacheTimeout, Duration jwksCacheMissTimeout)	Create configuration for a Trusted JWT Issuer.

Method Summary

Modifier and Type	Method	Description
Set<String>	getAllowedSubjects()	The set of subject identifiers that are allowed to be asserted by this JWT issuer.
String	getConsentedScopesClaim()	The claim in the JWT that indicates which scopes have been consented by the resource owner.
String	getIssuer()	The allowed issuer of the JWT.
Duration	getJwksCacheMissTimeout()	The duration to retain the failure to obtain a JWK Set from the getJwksUri() in the cache.
Duration	getJwksCacheTimeout()	The duration to retain the JWK Set obtained from the getJwksUri() in the cache.
String	getJwkSet()	A JWK encoded set of public keys that are valid for the JWT issuer to use in signing JWTs.
String	getJwksUri()	A URI for a JWK encoded set of public keys that are valid for the JWT issuer to use in signing JWTs.
String	getResourceOwnerIdentityClaim()	The claim in the JWT that will contain the resource owner identifier.

Methods inherited from class java.lang.Object

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

Constructor Details

TrustedJwtIssuerConfig

public TrustedJwtIssuerConfig(String issuer,
 String resourceOwnerIdentityClaim,
 String consentedScopesClaim,
 Set<String> allowedSubjects,
 String jwkSet,
 String jwksUri,
 Duration jwksCacheTimeout,
 Duration jwksCacheMissTimeout)

Create configuration for a Trusted JWT Issuer.

Parameters:

issuer - the value for getIssuer()

resourceOwnerIdentityClaim - the value for getResourceOwnerIdentityClaim()

consentedScopesClaim - the value for getConsentedScopesClaim()

allowedSubjects - the value for getAllowedSubjects()

jwkSet - the value for getJwkSet()

jwksUri - the value for getJwksUri()

jwksCacheTimeout - the value for getJwksCacheTimeout()

jwksCacheMissTimeout - the value for getJwksCacheMissTimeout()

TrustedJwtIssuerConfig

public TrustedJwtIssuerConfig(String issuer,
 String resourceOwnerIdentityClaim,
 String consentedScopesClaim,
 String[] allowedSubjects,
 String jwkSet,
 String jwksUri,
 String jwksCacheTimeout,
 String jwksCacheMissTimeout)

A script-friendly constructor to create configuration for a Trusted JWT Issuer.

Parameters:

issuer - the value for getIssuer()

resourceOwnerIdentityClaim - the value for getResourceOwnerIdentityClaim()

consentedScopesClaim - the value for getConsentedScopesClaim()

allowedSubjects - the value for getAllowedSubjects()

jwkSet - the value for getJwkSet()

jwksUri - the value for getJwksUri()

jwksCacheTimeout - the value for getJwksCacheTimeout()

jwksCacheMissTimeout - the value for getJwksCacheMissTimeout()

Method Details

getIssuer

public String getIssuer()

The allowed issuer of the JWT.

Returns:

the issuer string

getResourceOwnerIdentityClaim

public String getResourceOwnerIdentityClaim()

The claim in the JWT that will contain the resource owner identifier.

Returns:

the claim name

getConsentedScopesClaim

public String getConsentedScopesClaim()

The claim in the JWT that indicates which scopes have been consented by the resource owner.

Returns:

the claim name

getAllowedSubjects

public Set<String> getAllowedSubjects()

The set of subject identifiers that are allowed to be asserted by this JWT issuer. If empty, all subjects are allowed.

Returns:

the set of subject identifiers

getJwkSet

public String getJwkSet()

A JWK encoded set of public keys that are valid for the JWT issuer to use in signing JWTs. Either this or getJwksUri() must return a value.

Returns:

a string representation of a JWK Set

getJwksUri

public String getJwksUri()

A URI for a JWK encoded set of public keys that are valid for the JWT issuer to use in signing JWTs. Either this or getJwkSet() must return a value.

Returns:

a string representation of a JWK Set

getJwksCacheTimeout

public Duration getJwksCacheTimeout()

The duration to retain the JWK Set obtained from the getJwksUri() in the cache.

Returns:

a cache timeout duration

getJwksCacheMissTimeout

public Duration getJwksCacheMissTimeout()

The duration to retain the failure to obtain a JWK Set from the getJwksUri() in the cache.

Returns:

a cache timeout duration