Package org.springframework.security.oauth2.server.resource

Class OAuth2ProtectedResourceMetadata.Builder

java.lang.Object

org.springframework.security.oauth2.server.resource.OAuth2ProtectedResourceMetadata.Builder

Enclosing class:

OAuth2ProtectedResourceMetadata

public static final class OAuth2ProtectedResourceMetadata.Builder
extends Object

Helps configure an OAuth2ProtectedResourceMetadata.

Method Summary

Modifier and Type	Method	Description
OAuth2ProtectedResourceMetadata.Builder	authorizationServer(String authorizationServer)	Add the issuer identifier for an authorization server, OPTIONAL.
OAuth2ProtectedResourceMetadata.Builder	authorizationServers(Consumer<List<String>> authorizationServersConsumer)	A Consumer of the issuer identifier values for the authorization servers, allowing the ability to add, replace, or remove, OPTIONAL.
OAuth2ProtectedResourceMetadata.Builder	bearerMethod(String bearerMethod)	Add a supported method for sending an OAuth 2.0 bearer token to the protected resource, OPTIONAL.
OAuth2ProtectedResourceMetadata.Builder	bearerMethods(Consumer<List<String>> bearerMethodsConsumer)	A Consumer of the supported methods for sending an OAuth 2.0 bearer token to the protected resource, allowing the ability to add, replace, or remove, OPTIONAL.
OAuth2ProtectedResourceMetadata	build()	Validate the claims and build the OAuth2ProtectedResourceMetadata.
OAuth2ProtectedResourceMetadata.Builder	claim(String name, Object value)	Sets the claim.
OAuth2ProtectedResourceMetadata.Builder	claims(Consumer<Map<String,Object>> claimsConsumer)	Provides access to every claim(String, Object) declared so far allowing the ability to add, replace, or remove.
OAuth2ProtectedResourceMetadata.Builder	resource(String resource)	Sets the resource identifier for the protected resource, REQUIRED.
OAuth2ProtectedResourceMetadata.Builder	resourceName(String resourceName)	Sets the name of the protected resource intended for display to the end user, RECOMMENDED.
OAuth2ProtectedResourceMetadata.Builder	scope(String scope)	Add a scope supported in authorization requests to the protected resource, RECOMMENDED.
OAuth2ProtectedResourceMetadata.Builder	scopes(Consumer<List<String>> scopesConsumer)	A Consumer of the scope values supported in authorization requests to the protected resource, allowing the ability to add, replace, or remove, RECOMMENDED.
OAuth2ProtectedResourceMetadata.Builder	tlsClientCertificateBoundAccessTokens(boolean tlsClientCertificateBoundAccessTokens)	Set to true to indicate protected resource support for mutual-TLS client certificate-bound access tokens, OPTIONAL.

Methods inherited from class java.lang.Object

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

Method Details

resource

public OAuth2ProtectedResourceMetadata.Builder resource(String resource)

Sets the resource identifier for the protected resource, REQUIRED.

Parameters:

resource - the resource identifier URL for the protected resource

Returns:

the OAuth2ProtectedResourceMetadata.Builder for further configuration

authorizationServer

public OAuth2ProtectedResourceMetadata.Builder authorizationServer(String authorizationServer)

Add the issuer identifier for an authorization server, OPTIONAL.

Parameters:

authorizationServer - the issuer identifier URL for an authorization server

Returns:

the OAuth2ProtectedResourceMetadata.Builder for further configuration

authorizationServers

public OAuth2ProtectedResourceMetadata.Builder authorizationServers(Consumer<List<String>> authorizationServersConsumer)

A Consumer of the issuer identifier values for the authorization servers, allowing the ability to add, replace, or remove, OPTIONAL.

Parameters:

authorizationServersConsumer - a Consumer of the issuer identifier values for the authorization servers

Returns:

the OAuth2ProtectedResourceMetadata.Builder for further configuration

scope

public OAuth2ProtectedResourceMetadata.Builder scope(String scope)

Add a scope supported in authorization requests to the protected resource, RECOMMENDED.

Parameters:

scope - a scope supported in authorization requests to the protected resource

Returns:

the OAuth2ProtectedResourceMetadata.Builder for further configuration

scopes

public OAuth2ProtectedResourceMetadata.Builder scopes(Consumer<List<String>> scopesConsumer)

A Consumer of the scope values supported in authorization requests to the protected resource, allowing the ability to add, replace, or remove, RECOMMENDED.

Parameters:

scopesConsumer - a Consumer of the scope values supported in authorization requests to the protected resource

Returns:

the OAuth2ProtectedResourceMetadata.Builder for further configuration

bearerMethod

public OAuth2ProtectedResourceMetadata.Builder bearerMethod(String bearerMethod)

Add a supported method for sending an OAuth 2.0 bearer token to the protected resource, OPTIONAL. Defined values are "header", "body" and "query".

Parameters:

bearerMethod - a supported method for sending an OAuth 2.0 bearer token to the protected resource

Returns:

the OAuth2ProtectedResourceMetadata.Builder for further configuration

bearerMethods

public OAuth2ProtectedResourceMetadata.Builder bearerMethods(Consumer<List<String>> bearerMethodsConsumer)

A Consumer of the supported methods for sending an OAuth 2.0 bearer token to the protected resource, allowing the ability to add, replace, or remove, OPTIONAL.

Parameters:

bearerMethodsConsumer - a Consumer of the supported methods for sending an OAuth 2.0 bearer token to the protected resource

Returns:

the OAuth2ProtectedResourceMetadata.Builder for further configuration

resourceName

public OAuth2ProtectedResourceMetadata.Builder resourceName(String resourceName)

Sets the name of the protected resource intended for display to the end user, RECOMMENDED.

Parameters:

resourceName - the name of the protected resource intended for display to the end user

Returns:

the OAuth2ProtectedResourceMetadata.Builder for further configuration

tlsClientCertificateBoundAccessTokens

public OAuth2ProtectedResourceMetadata.Builder tlsClientCertificateBoundAccessTokens(boolean tlsClientCertificateBoundAccessTokens)

Set to true to indicate protected resource support for mutual-TLS client certificate-bound access tokens, OPTIONAL.

Parameters:

tlsClientCertificateBoundAccessTokens - true to indicate protected resource support for mutual-TLS client certificate-bound access tokens

Returns:

the OAuth2ProtectedResourceMetadata.Builder for further configuration

claim

public OAuth2ProtectedResourceMetadata.Builder claim(String name,
 Object value)

Sets the claim.

Parameters:

name - the claim name

value - the claim value

Returns:

the OAuth2ProtectedResourceMetadata.Builder for further configuration

claims

public OAuth2ProtectedResourceMetadata.Builder claims(Consumer<Map<String,Object>> claimsConsumer)

Provides access to every claim(String, Object) declared so far allowing the ability to add, replace, or remove.

Parameters:

claimsConsumer - a Consumer of the claims

Returns:

the OAuth2ProtectedResourceMetadata.Builder for further configurations

build

public OAuth2ProtectedResourceMetadata build()

Validate the claims and build the OAuth2ProtectedResourceMetadata.

Returns:

the OAuth2ProtectedResourceMetadata