org.springframework.security.oauth2.server.authorization.config

Class ClientSettings.Builder

java.lang.Object

org.springframework.security.oauth2.server.authorization.config.AbstractSettings.AbstractBuilder<ClientSettings,ClientSettings.Builder>

org.springframework.security.oauth2.server.authorization.config.ClientSettings.Builder

Enclosing class:

ClientSettings

public static class ClientSettings.Builder
extends AbstractSettings.AbstractBuilder<ClientSettings,ClientSettings.Builder>

A builder for ClientSettings.

Method Summary

Modifier and Type	Method and Description
ClientSettings	build() Builds the ClientSettings.
ClientSettings.Builder	jwkSetUrl(java.lang.String jwkSetUrl) Sets the URL for the Client's JSON Web Key Set.
ClientSettings.Builder	requireAuthorizationConsent(boolean requireAuthorizationConsent) Set to true if authorization consent is required when the client requests access.
ClientSettings.Builder	requireProofKey(boolean requireProofKey) Set to true if the client is required to provide a proof key challenge and verifier when performing the Authorization Code Grant flow.
ClientSettings.Builder	tokenEndpointAuthenticationSigningAlgorithm(org.springframework.security.oauth2.jose.jws.JwsAlgorithm authenticationSigningAlgorithm) Sets the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods.

Methods inherited from class org.springframework.security.oauth2.server.authorization.config.AbstractSettings.AbstractBuilder

getSettings, getThis, setting, settings

Methods inherited from class java.lang.Object

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

Method Detail

requireProofKey

public ClientSettings.Builder requireProofKey(boolean requireProofKey)

Set to true if the client is required to provide a proof key challenge and verifier when performing the Authorization Code Grant flow.

Parameters:

requireProofKey - true if the client is required to provide a proof key challenge and verifier, false otherwise

Returns:

the ClientSettings.Builder for further configuration

requireAuthorizationConsent

public ClientSettings.Builder requireAuthorizationConsent(boolean requireAuthorizationConsent)

Set to true if authorization consent is required when the client requests access. This applies to all interactive flows (e.g. authorization_code and device_code).

Parameters:

requireAuthorizationConsent - true if authorization consent is required when the client requests access, false otherwise

Returns:

the ClientSettings.Builder for further configuration

jwkSetUrl

public ClientSettings.Builder jwkSetUrl(java.lang.String jwkSetUrl)

Sets the URL for the Client's JSON Web Key Set.

Parameters:

jwkSetUrl - the URL for the Client's JSON Web Key Set

Returns:

the ClientSettings.Builder for further configuration

Since:

0.2.2

tokenEndpointAuthenticationSigningAlgorithm

public ClientSettings.Builder tokenEndpointAuthenticationSigningAlgorithm(org.springframework.security.oauth2.jose.jws.JwsAlgorithm authenticationSigningAlgorithm)

Sets the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods.

Parameters:

authenticationSigningAlgorithm - the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint

Returns:

the ClientSettings.Builder for further configuration

Since:

0.2.2

build

public ClientSettings build()

Builds the ClientSettings.

Specified by:

build in class AbstractSettings.AbstractBuilder<ClientSettings,ClientSettings.Builder>

Returns:

the ClientSettings