Package org.springframework.security.oauth2.server.authorization.settings

Class ClientSettings

java.lang.Object

org.springframework.security.oauth2.server.authorization.settings.AbstractSettings

org.springframework.security.oauth2.server.authorization.settings.ClientSettings

All Implemented Interfaces:

Serializable

public final class ClientSettings
extends AbstractSettings

A facility for client configuration settings.

Since:

0.0.2

See Also:

• AbstractSettings
• ConfigurationSettingNames.Client
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ClientSettings.Builder	A builder for ClientSettings.

Nested classes/interfaces inherited from class org.springframework.security.oauth2.server.authorization.settings.AbstractSettings

AbstractSettings.AbstractBuilder<T extends AbstractSettings,B extends AbstractSettings.AbstractBuilder<T,B>>

Method Summary

Modifier and Type	Method	Description
static ClientSettings.Builder	builder()	Constructs a new ClientSettings.Builder with the default settings.
String	getJwkSetUrl()	Returns the URL for the Client's JSON Web Key Set.
org.springframework.security.oauth2.jose.jws.JwsAlgorithm	getTokenEndpointAuthenticationSigningAlgorithm()	Returns 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.
boolean	isRequireAuthorizationConsent()	Returns true if authorization consent is required when the client requests access.
boolean	isRequireProofKey()	Returns true if the client is required to provide a proof key challenge and verifier when performing the Authorization Code Grant flow.
static ClientSettings.Builder	withSettings(Map<String,Object> settings)	Constructs a new ClientSettings.Builder with the provided settings.

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

equals, getSetting, getSettings, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

isRequireProofKey

public boolean isRequireProofKey()

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

Returns:

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

isRequireAuthorizationConsent

public boolean isRequireAuthorizationConsent()

Returns true if authorization consent is required when the client requests access. The default is false.

Returns:

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

getJwkSetUrl

public String getJwkSetUrl()

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

Returns:

the URL for the Client's JSON Web Key Set

Since:

0.2.2

getTokenEndpointAuthenticationSigningAlgorithm

public org.springframework.security.oauth2.jose.jws.JwsAlgorithm getTokenEndpointAuthenticationSigningAlgorithm()

Returns 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.

Returns:

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

Since:

0.2.2

builder

public static ClientSettings.Builder builder()

Constructs a new ClientSettings.Builder with the default settings.

Returns:

the ClientSettings.Builder

withSettings

public static ClientSettings.Builder withSettings(Map<String,Object> settings)

Constructs a new ClientSettings.Builder with the provided settings.

Parameters:

settings - the settings to initialize the builder

Returns:

the ClientSettings.Builder