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

Class AuthorizationServerSettings

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

public final class AuthorizationServerSettings
extends AbstractSettings

A facility for authorization server configuration settings.

Since:

0.1.0

See Also:

• AbstractSettings
• ConfigurationSettingNames.AuthorizationServer
• Serialized Form

Nested Class Summary

Nested Classes

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

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 AuthorizationServerSettings.Builder	builder()	Constructs a new AuthorizationServerSettings.Builder with the default settings.
String	getAuthorizationEndpoint()	Returns the OAuth 2.0 Authorization endpoint.
String	getDeviceAuthorizationEndpoint()	Returns the OAuth 2.0 Device Authorization endpoint.
String	getDeviceVerificationEndpoint()	Returns the OAuth 2.0 Device Verification endpoint.
String	getIssuer()	Returns the URL of the Authorization Server's Issuer Identifier.
String	getJwkSetEndpoint()	Returns the JWK Set endpoint.
String	getOidcClientRegistrationEndpoint()	Returns the OpenID Connect 1.0 Client Registration endpoint.
String	getOidcLogoutEndpoint()	Returns the OpenID Connect 1.0 Logout endpoint.
String	getOidcUserInfoEndpoint()	Returns the OpenID Connect 1.0 UserInfo endpoint.
String	getTokenEndpoint()	Returns the OAuth 2.0 Token endpoint.
String	getTokenIntrospectionEndpoint()	Returns the OAuth 2.0 Token Introspection endpoint.
String	getTokenRevocationEndpoint()	Returns the OAuth 2.0 Token Revocation endpoint.
boolean	isMultipleIssuersAllowed()	Returns true if multiple issuers are allowed per host.
static AuthorizationServerSettings.Builder	withSettings(Map<String,Object> settings)	Constructs a new AuthorizationServerSettings.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

getIssuer

public String getIssuer()

Returns the URL of the Authorization Server's Issuer Identifier.

Returns:

the URL of the Authorization Server's Issuer Identifier

isMultipleIssuersAllowed

public boolean isMultipleIssuersAllowed()

Returns true if multiple issuers are allowed per host. The default is false. Using path components in the URL of the issuer identifier enables supporting multiple issuers per host in a multi-tenant hosting configuration.

For example:

• https://example.com/issuer1
• https://example.com/authz/issuer2

Returns:

true if multiple issuers are allowed per host, false otherwise

Since:

1.3

See Also:

• AuthorizationServerContext.getIssuer()

getAuthorizationEndpoint

public String getAuthorizationEndpoint()

Returns the OAuth 2.0 Authorization endpoint. The default is /oauth2/authorize.

Returns:

the Authorization endpoint

getDeviceAuthorizationEndpoint

public String getDeviceAuthorizationEndpoint()

Returns the OAuth 2.0 Device Authorization endpoint. The default is /oauth2/device_authorization.

Returns:

the Device Authorization endpoint

Since:

1.1

getDeviceVerificationEndpoint

public String getDeviceVerificationEndpoint()

Returns the OAuth 2.0 Device Verification endpoint. The default is /oauth2/device_verification.

Returns:

the Device Verification endpoint

Since:

1.1

getTokenEndpoint

public String getTokenEndpoint()

Returns the OAuth 2.0 Token endpoint. The default is /oauth2/token.

Returns:

the Token endpoint

getJwkSetEndpoint

public String getJwkSetEndpoint()

Returns the JWK Set endpoint. The default is /oauth2/jwks.

Returns:

the JWK Set endpoint

getTokenRevocationEndpoint

public String getTokenRevocationEndpoint()

Returns the OAuth 2.0 Token Revocation endpoint. The default is /oauth2/revoke.

Returns:

the Token Revocation endpoint

getTokenIntrospectionEndpoint

public String getTokenIntrospectionEndpoint()

Returns the OAuth 2.0 Token Introspection endpoint. The default is /oauth2/introspect.

Returns:

the Token Introspection endpoint

getOidcClientRegistrationEndpoint

public String getOidcClientRegistrationEndpoint()

Returns the OpenID Connect 1.0 Client Registration endpoint. The default is /connect/register.

Returns:

the OpenID Connect 1.0 Client Registration endpoint

getOidcUserInfoEndpoint

public String getOidcUserInfoEndpoint()

Returns the OpenID Connect 1.0 UserInfo endpoint. The default is /userinfo.

Returns:

the OpenID Connect 1.0 UserInfo endpoint

getOidcLogoutEndpoint

public String getOidcLogoutEndpoint()

Returns the OpenID Connect 1.0 Logout endpoint. The default is /connect/logout.

Returns:

the OpenID Connect 1.0 Logout endpoint

Since:

1.1

builder

public static AuthorizationServerSettings.Builder builder()

Constructs a new AuthorizationServerSettings.Builder with the default settings.

Returns:

the AuthorizationServerSettings.Builder

withSettings

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

Constructs a new AuthorizationServerSettings.Builder with the provided settings.

Parameters:

settings - the settings to initialize the builder

Returns:

the AuthorizationServerSettings.Builder