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
A facility for client configuration settings.
- Since:
- 0.0.2
- See Also:
-
Nested Class Summary
Nested ClassesNested 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 TypeMethodDescriptionstatic ClientSettings.Builder
builder()
Constructs a newClientSettings.Builder
with the default settings.Returns theURL
for the Client's JSON Web Key Set.org.springframework.security.oauth2.jose.jws.JwsAlgorithm
Returns theJWS
algorithm that must be used for signing theJWT
used to authenticate the Client at the Token Endpoint for theprivate_key_jwt
andclient_secret_jwt
authentication methods.boolean
Returnstrue
if authorization consent is required when the client requests access.boolean
Returnstrue
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 newClientSettings.Builder
with the provided settings.Methods inherited from class org.springframework.security.oauth2.server.authorization.settings.AbstractSettings
equals, getSetting, getSettings, hashCode, toString
-
Method Details
-
isRequireProofKey
public boolean isRequireProofKey()Returnstrue
if the client is required to provide a proof key challenge and verifier when performing the Authorization Code Grant flow. The default isfalse
.- Returns:
true
if the client is required to provide a proof key challenge and verifier,false
otherwise
-
isRequireAuthorizationConsent
public boolean isRequireAuthorizationConsent()Returnstrue
if authorization consent is required when the client requests access. The default isfalse
.- Returns:
true
if authorization consent is required when the client requests access,false
otherwise
-
getJwkSetUrl
Returns theURL
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 theJWS
algorithm that must be used for signing theJWT
used to authenticate the Client at the Token Endpoint for theprivate_key_jwt
andclient_secret_jwt
authentication methods.- Returns:
- the
JWS
algorithm that must be used for signing theJWT
used to authenticate the Client at the Token Endpoint - Since:
- 0.2.2
-
builder
Constructs a newClientSettings.Builder
with the default settings.- Returns:
- the
ClientSettings.Builder
-
withSettings
Constructs a newClientSettings.Builder
with the provided settings.- Parameters:
settings
- the settings to initialize the builder- Returns:
- the
ClientSettings.Builder
-