Package org.forgerock.oauth.clients.oidc

Class OpenIDConnectClientConfiguration.Builder<T extends OpenIDConnectClientConfiguration.Builder<T,C>,C extends OAuth2ClientConfiguration>

java.lang.Object

org.forgerock.oauth.OAuthClientConfiguration.Builder<T,C>

org.forgerock.oauth.clients.oauth2.OAuth2ClientConfiguration.Builder<T,C>

org.forgerock.oauth.clients.oidc.OpenIDConnectClientConfiguration.Builder<T,C>

Type Parameters:

T - the type of OAuthClientConfiguration builder to build.

C - the type of OAuthClientConfiguration to build.

Direct Known Subclasses:

AppleClientConfiguration.Builder

Enclosing class:

OpenIDConnectClientConfiguration

public abstract static class OpenIDConnectClientConfiguration.Builder<T extends OpenIDConnectClientConfiguration.Builder<T,C>,C extends OAuth2ClientConfiguration>
extends OAuth2ClientConfiguration.Builder<T,C>

Builder class for creating the OpenIDConnectClientConfiguration.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(Function<T,C> builder)	Limit visibility.

Method Summary

Modifier and Type	Method	Description
T	withAcrValues(List<String> acrValues)	Set the acr values.
T	withClaims(Claims claims)	Sets the request "claims" parameter value.
T	withEncryptedIdTokens(boolean encryptedIdTokens)	Sets whether the client should expect received ID tokens to be encrypted.
T	withIssuer(String issuer)	Set the issuer.
T	withJwk(String jwkSetEndpoint)	Set the JWK Set URL Endpoint.
T	withJwtRequestParameterOption(JwtRequestParameterOption jwtRequestParameterOption)	Set the request parameter jwt option.
T	withKeyAlias(String keyAlias)	Set the keyAlias.
T	withKeystoreLocation(String keystoreLocation)	Set the keystoreLocation.
T	withKeystorePassword(String keystorePassword)	Set the keystorePassword.
T	withKeystoreType(String keystoreType)	Set the keystoreType.
T	withWellKnownEndpoint(String wellKnownEndpoint)	Set the wellKnownEndpoint.

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

withAuthorizationEndpoint, withBasicAuth, withClientAuthenticationFilter, withClientId, withClientSecret, withClientSecret, withIntrospectEndpoint, withPkceMethod, withRedirectUri, withResponseMode, withScope, withScopeDelimiter, withTokenEndpoint, withUserInfoEndpoint

Methods inherited from class org.forgerock.oauth.OAuthClientConfiguration.Builder

build, self, withAuthenticationIdKey, withProvider

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder(Function<T,C> builder)

Limit visibility.

Parameters:

builder - OpenIDConnectClientConfiguration builder

Method Details

withWellKnownEndpoint

public T withWellKnownEndpoint(String wellKnownEndpoint)

Set the wellKnownEndpoint.

Parameters:

wellKnownEndpoint - well-known url.

Returns:

Builder

withKeyAlias

public T withKeyAlias(String keyAlias)

Set the keyAlias.

Parameters:

keyAlias - the name under which the key is stored in the trust store.

Returns:

Builder

withJwk

public T withJwk(String jwkSetEndpoint)

Set the JWK Set URL Endpoint.

Parameters:

jwkSetEndpoint - the URL of the configuration to use to generate the resolver.

Returns:

Builder

withKeystoreLocation

public T withKeystoreLocation(String keystoreLocation)

Set the keystoreLocation.

Parameters:

keystoreLocation - the location of the trust store file.

Returns:

Builder

withKeystorePassword

public T withKeystorePassword(String keystorePassword)

Set the keystorePassword.

Parameters:

keystorePassword - the password to the keystore.

Returns:

Builder

withKeystoreType

public T withKeystoreType(String keystoreType)

Set the keystoreType.

Parameters:

keystoreType - the type of keystore to which the location param points.

Returns:

Builder

withIssuer

public T withIssuer(String issuer)

Set the issuer.

Parameters:

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

Returns:

Builder

withAcrValues

public T withAcrValues(List<String> acrValues)

Set the acr values.

Parameters:

acrValues - the acr values.

Returns:

Builder

withEncryptedIdTokens

public T withEncryptedIdTokens(boolean encryptedIdTokens)

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

Parameters:

encryptedIdTokens - whether the client should expect received ID tokens to be encrypted

Returns:

Builder

withJwtRequestParameterOption

public T withJwtRequestParameterOption(JwtRequestParameterOption jwtRequestParameterOption)

Set the request parameter jwt option.

Parameters:

jwtRequestParameterOption - the request parameter jwt option.

Returns:

Builder

withClaims

public T withClaims(Claims claims)

Sets the request "claims" parameter value.

Parameters:

claims - the request "claims" parameter.

Returns:

Builder.