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

public class OpenIDConnectClientConfiguration
extends OAuth2ClientConfiguration

Configuration used for OpenID Connect Client Implementations.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_CONN_TIMEOUT Default connection timeout, in milliseconds, for HTTP connections.
protected static int	DEFAULT_READ_TIMEOUT Default read timeout, in milliseconds, for HTTP connections.

Fields inherited from class org.forgerock.oauth.OAuthClientConfiguration

PROVIDER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Class<?>	getClientClass() Gets the class name of the client implementation consuming the OpenIDConnectClientConfiguration.
int	getConnectionTimeout() Gets the http connection timeout used to configure the OpenIdResolverService.
String	getIssuer() Gets the issuer.
URI	getJwkSetEndpoint() Gets jwk set endpoint used to configure the OpenIdResolverService.
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.
int	getReadTimeout() Gets the http read timeout used to configure the OpenIdResolverService.
URI	getWellKnownEndpoint() Gets the well-known endpoint.
static OpenIDConnectClientConfiguration.Builder<? extends OpenIDConnectClientConfiguration.Builder,OpenIDConnectClientConfiguration>	openIdConnectClientConfiguration() Creates a new builder for OpenIDConnectClientConfiguration.

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

getAuthorizationEndpoint, getClientId, getClientSecret, getPkceMethod, getRedirectUri, getScope, getScopeDelimiter, getTokenEndpoint, getUserInfoEndpoint, oauth2ClientConfiguration, usesBasicAuth

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

Field Detail

DEFAULT_READ_TIMEOUT

protected static final int DEFAULT_READ_TIMEOUT

Default read timeout, in milliseconds, for HTTP connections.

See Also:

Constant Field Values

DEFAULT_CONN_TIMEOUT

protected static final int DEFAULT_CONN_TIMEOUT

Default connection timeout, in milliseconds, for HTTP connections.

See Also:

Constant Field Values

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.

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.

getReadTimeout

public int getReadTimeout()

Gets the http read timeout used to configure the OpenIdResolverService.

Returns:

read timeout.

getConnectionTimeout

public int getConnectionTimeout()

Gets the http connection timeout used to configure the OpenIdResolverService.

Returns:

connection timeout.

getIssuer

public String getIssuer()

Gets the issuer.

Returns:

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

getOpenIdResolverServiceConfig

protected Map<String,String> getOpenIdResolverServiceConfig()

Returns the configuration needed to configure OpenIdResolverService.

Returns:

Map of configuration.