Package org.forgerock.oauth.clients.oidc

Class OpenIDConnectClientConfiguration

java.lang.Object

org.forgerock.oauth.OAuthClientConfiguration

org.forgerock.oauth.clients.oauth2.OAuth2ClientConfiguration

org.forgerock.oauth.clients.oidc.OpenIDConnectClientConfiguration

Direct Known Subclasses:

AppleClientConfiguration

public class OpenIDConnectClientConfiguration
extends OAuth2ClientConfiguration

Configuration used for OpenID Connect Client Implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenIDConnectClientConfiguration.Builder<T extends OpenIDConnectClientConfiguration.Builder<T,C>,C extends OAuth2ClientConfiguration>	Builder class for creating the OpenIDConnectClientConfiguration.

Field Summary

Fields inherited from class org.forgerock.oauth.OAuthClientConfiguration

PROVIDER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OpenIDConnectClientConfiguration(OpenIDConnectClientConfiguration.Builder<?,?> builder)	Creates an OpenIDConnectClientConfiguration instance.

Method Summary

Modifier and Type	Method	Description
List<String>	getAcrValues()	Gets the acr values.
Claims	getClaims()	Gets the request "claims" parameter value.
Class<?>	getClientClass()	Gets the class name of the client implementation consuming the OpenIDConnectClientConfiguration.
String	getIssuer()	Gets the issuer.
URI	getJwkSetEndpoint()	Gets jwk set endpoint used to configure the OpenIdResolverService.
JwtRequestParameterOption	getJwtRequestParameterOption()	Gets the means by which request parameter jwt would be sent to OIDC provider.
String	getKeyAlias()	Gets the key alias used to configure the OpenIdResolverService.
String	getKeystoreLocation()	Gets the keystore location used to configure the OpenIdResolverService.
String	getKeystorePassword()	Gets the keystore password used to configure the OpenIdResolverService.
String	getKeystoreType()	Gets the keystore type used to configure the OpenIdResolverService.
protected Map<String,String>	getOpenIdResolverServiceConfig()	Returns the configuration needed to configure OpenIdResolverService.
URI	getWellKnownEndpoint()	Gets the well-known endpoint.
boolean	hasEncryptedIdTokens()	Determines whether the client should expect received ID tokens to be encrypted.
static OpenIDConnectClientConfiguration.Builder<? extends OpenIDConnectClientConfiguration.Builder,OpenIDConnectClientConfiguration>	openIdConnectClientConfiguration()	Creates a new builder for OpenIDConnectClientConfiguration.

Methods inherited from class org.forgerock.oauth.clients.oauth2.OAuth2ClientConfiguration

getAuthenticationFilter, getAuthorizationEndpoint, getClientId, getClientSecret, getClientSecretReference, getIntrospectEndpoint, getPkceMethod, getRedirectUri, getResponseMode, getScope, getScopeDelimiter, getTokenEndpoint, getUserInfoEndpoint, oauth2ClientConfiguration

Methods inherited from class org.forgerock.oauth.OAuthClientConfiguration

getAuthenticationIdKey, getProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenIDConnectClientConfiguration

protected OpenIDConnectClientConfiguration(OpenIDConnectClientConfiguration.Builder<?,?> builder)

Creates an OpenIDConnectClientConfiguration instance.

Parameters:

builder - OpenIDConnectClientConfiguration instance builder.

Method Detail

openIdConnectClientConfiguration

public static OpenIDConnectClientConfiguration.Builder<? extends OpenIDConnectClientConfiguration.Builder,OpenIDConnectClientConfiguration> openIdConnectClientConfiguration()

Creates a new builder for OpenIDConnectClientConfiguration.

Returns:

new OpenIDConnectClientConfiguration builder instance.

getClientClass

public Class<?> getClientClass()

Gets the class name of the client implementation consuming the OpenIDConnectClientConfiguration.

Overrides:

getClientClass in class OAuth2ClientConfiguration

Returns:

the client implementation class name.

getWellKnownEndpoint

public URI getWellKnownEndpoint()

Gets the well-known endpoint.

Returns:

well-known endpoint.

getAcrValues

public List<String> getAcrValues()

Gets the acr values.

Returns:

the acr values.

getKeyAlias

public String getKeyAlias()

Gets the key alias used to configure the OpenIdResolverService.

Returns:

key alias.

getJwkSetEndpoint

public URI getJwkSetEndpoint()

Gets jwk set endpoint used to configure the OpenIdResolverService.

Returns:

jwkSetEndpoint.

getKeystoreLocation

public String getKeystoreLocation()

Gets the keystore location used to configure the OpenIdResolverService.

Returns:

keystore location.

getKeystorePassword

public String getKeystorePassword()

Gets the keystore password used to configure the OpenIdResolverService.

Returns:

keystore password.

getKeystoreType

public String getKeystoreType()

Gets the keystore type used to configure the OpenIdResolverService.

Returns:

keystore type.

getIssuer

public String getIssuer()

Gets the issuer.

Returns:

issuer's name - the OpenID Connect "iss" field.

hasEncryptedIdTokens

public boolean hasEncryptedIdTokens()

Determines whether the client should expect received ID tokens to be encrypted.

Returns:

whether the client should expect received ID tokens to be encrypted

getJwtRequestParameterOption

public JwtRequestParameterOption getJwtRequestParameterOption()

Gets the means by which request parameter jwt would be sent to OIDC provider.

Returns:

the request object options.

getClaims

public Claims getClaims()

Gets the request "claims" parameter value.

Returns:

the request claims.

getOpenIdResolverServiceConfig

protected Map<String,String> getOpenIdResolverServiceConfig()

Returns the configuration needed to configure OpenIdResolverService.

Returns:

Map of configuration.