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

Class AuthorizationServerSettings.Builder

java.lang.Object

org.springframework.security.oauth2.server.authorization.settings.AbstractSettings.AbstractBuilder<AuthorizationServerSettings,AuthorizationServerSettings.Builder>

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

Enclosing class:

AuthorizationServerSettings

public static final class AuthorizationServerSettings.Builder
extends AbstractSettings.AbstractBuilder<AuthorizationServerSettings,AuthorizationServerSettings.Builder>

A builder for AuthorizationServerSettings.

Method Summary

Modifier and Type	Method	Description
AuthorizationServerSettings.Builder	authorizationEndpoint(String authorizationEndpoint)	Sets the OAuth 2.0 Authorization endpoint.
AuthorizationServerSettings	build()	Builds the AuthorizationServerSettings.
AuthorizationServerSettings.Builder	deviceAuthorizationEndpoint(String deviceAuthorizationEndpoint)	Sets the OAuth 2.0 Device Authorization endpoint.
AuthorizationServerSettings.Builder	deviceVerificationEndpoint(String deviceVerificationEndpoint)	Sets the OAuth 2.0 Device Verification endpoint.
AuthorizationServerSettings.Builder	issuer(String issuer)	Sets the URL the Authorization Server uses as its Issuer Identifier.
AuthorizationServerSettings.Builder	jwkSetEndpoint(String jwkSetEndpoint)	Sets the JWK Set endpoint.
AuthorizationServerSettings.Builder	multipleIssuersAllowed(boolean multipleIssuersAllowed)	Set to true if multiple issuers are allowed per host.
AuthorizationServerSettings.Builder	oidcClientRegistrationEndpoint(String oidcClientRegistrationEndpoint)	Sets the OpenID Connect 1.0 Client Registration endpoint.
AuthorizationServerSettings.Builder	oidcLogoutEndpoint(String oidcLogoutEndpoint)	Sets the OpenID Connect 1.0 Logout endpoint.
AuthorizationServerSettings.Builder	oidcUserInfoEndpoint(String oidcUserInfoEndpoint)	Sets the OpenID Connect 1.0 UserInfo endpoint.
AuthorizationServerSettings.Builder	tokenEndpoint(String tokenEndpoint)	Sets the OAuth 2.0 Token endpoint.
AuthorizationServerSettings.Builder	tokenIntrospectionEndpoint(String tokenIntrospectionEndpoint)	Sets the OAuth 2.0 Token Introspection endpoint.
AuthorizationServerSettings.Builder	tokenRevocationEndpoint(String tokenRevocationEndpoint)	Sets the OAuth 2.0 Token Revocation endpoint.

Methods inherited from class org.springframework.security.oauth2.server.authorization.settings.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 Details

issuer

public AuthorizationServerSettings.Builder issuer(String issuer)

Sets the URL the Authorization Server uses as its Issuer Identifier.

Parameters:

issuer - the URL the Authorization Server uses as its Issuer Identifier.

Returns:

the AuthorizationServerSettings.Builder for further configuration

multipleIssuersAllowed

public AuthorizationServerSettings.Builder multipleIssuersAllowed(boolean multipleIssuersAllowed)

Set to true if multiple issuers are allowed per host. 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

NOTE: Explicitly configuring the issuer identifier via issuer(String) forces to a single-tenant configuration. Avoid configuring the issuer identifier when using a multi-tenant hosting configuration, allowing the issuer identifier to be resolved from the "current" request.

Parameters:

multipleIssuersAllowed - true if multiple issuers are allowed per host, false otherwise

Returns:

the AuthorizationServerSettings.Builder for further configuration

Since:

1.3

See Also:

• AuthorizationServerContext.getIssuer()

authorizationEndpoint

public AuthorizationServerSettings.Builder authorizationEndpoint(String authorizationEndpoint)

Sets the OAuth 2.0 Authorization endpoint.

Parameters:

authorizationEndpoint - the Authorization endpoint

Returns:

the AuthorizationServerSettings.Builder for further configuration

deviceAuthorizationEndpoint

public AuthorizationServerSettings.Builder deviceAuthorizationEndpoint(String deviceAuthorizationEndpoint)

Sets the OAuth 2.0 Device Authorization endpoint.

Parameters:

deviceAuthorizationEndpoint - the Device Authorization endpoint

Returns:

the AuthorizationServerSettings.Builder for further configuration

Since:

1.1

deviceVerificationEndpoint

public AuthorizationServerSettings.Builder deviceVerificationEndpoint(String deviceVerificationEndpoint)

Sets the OAuth 2.0 Device Verification endpoint.

Parameters:

deviceVerificationEndpoint - the Device Verification endpoint

Returns:

the AuthorizationServerSettings.Builder for further configuration

Since:

1.1

tokenEndpoint

public AuthorizationServerSettings.Builder tokenEndpoint(String tokenEndpoint)

Sets the OAuth 2.0 Token endpoint.

Parameters:

tokenEndpoint - the Token endpoint

Returns:

the AuthorizationServerSettings.Builder for further configuration

jwkSetEndpoint

public AuthorizationServerSettings.Builder jwkSetEndpoint(String jwkSetEndpoint)

Sets the JWK Set endpoint.

Parameters:

jwkSetEndpoint - the JWK Set endpoint

Returns:

the AuthorizationServerSettings.Builder for further configuration

tokenRevocationEndpoint

public AuthorizationServerSettings.Builder tokenRevocationEndpoint(String tokenRevocationEndpoint)

Sets the OAuth 2.0 Token Revocation endpoint.

Parameters:

tokenRevocationEndpoint - the Token Revocation endpoint

Returns:

the AuthorizationServerSettings.Builder for further configuration

tokenIntrospectionEndpoint

public AuthorizationServerSettings.Builder tokenIntrospectionEndpoint(String tokenIntrospectionEndpoint)

Sets the OAuth 2.0 Token Introspection endpoint.

Parameters:

tokenIntrospectionEndpoint - the Token Introspection endpoint

Returns:

the AuthorizationServerSettings.Builder for further configuration

oidcClientRegistrationEndpoint

public AuthorizationServerSettings.Builder oidcClientRegistrationEndpoint(String oidcClientRegistrationEndpoint)

Sets the OpenID Connect 1.0 Client Registration endpoint.

Parameters:

oidcClientRegistrationEndpoint - the OpenID Connect 1.0 Client Registration endpoint

Returns:

the AuthorizationServerSettings.Builder for further configuration

oidcUserInfoEndpoint

public AuthorizationServerSettings.Builder oidcUserInfoEndpoint(String oidcUserInfoEndpoint)

Sets the OpenID Connect 1.0 UserInfo endpoint.

Parameters:

oidcUserInfoEndpoint - the OpenID Connect 1.0 UserInfo endpoint

Returns:

the AuthorizationServerSettings.Builder for further configuration

oidcLogoutEndpoint

public AuthorizationServerSettings.Builder oidcLogoutEndpoint(String oidcLogoutEndpoint)

Sets the OpenID Connect 1.0 Logout endpoint.

Parameters:

oidcLogoutEndpoint - the OpenID Connect 1.0 Logout endpoint

Returns:

the AuthorizationServerSettings.Builder for further configuration

Since:

1.1

build

public AuthorizationServerSettings build()

Builds the AuthorizationServerSettings.

Specified by:

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

Returns:

the AuthorizationServerSettings