Package org.springframework.security.oauth2.core.endpoint

Class OAuth2AuthorizationRequest.Builder

java.lang.Object

org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder

Enclosing class:

OAuth2AuthorizationRequest

public static final class OAuth2AuthorizationRequest.Builder
extends Object

A builder for OAuth2AuthorizationRequest.

Method Summary

Modifier and Type	Method	Description
OAuth2AuthorizationRequest.Builder	additionalParameters(Consumer<Map<String,Object>> additionalParametersConsumer)	A Consumer to be provided access to the additional parameter(s) allowing the ability to add, replace, or remove.
OAuth2AuthorizationRequest.Builder	additionalParameters(Map<String,Object> additionalParameters)	Sets the additional parameter(s) used in the request.
OAuth2AuthorizationRequest.Builder	attributes(Consumer<Map<String,Object>> attributesConsumer)	A Consumer to be provided access to the attribute(s) allowing the ability to add, replace, or remove.
OAuth2AuthorizationRequest.Builder	attributes(Map<String,Object> attributes)	Sets the attributes associated to the request.
OAuth2AuthorizationRequest.Builder	authorizationRequestUri(String authorizationRequestUri)	Sets the URI string representation of the OAuth 2.0 Authorization Request.
OAuth2AuthorizationRequest.Builder	authorizationRequestUri(Function<org.springframework.web.util.UriBuilder,URI> authorizationRequestUriFunction)	A Function to be provided a UriBuilder representation of the OAuth 2.0 Authorization Request allowing for further customizations.
OAuth2AuthorizationRequest.Builder	authorizationUri(String authorizationUri)	Sets the uri for the authorization endpoint.
OAuth2AuthorizationRequest	build()	Builds a new OAuth2AuthorizationRequest.
OAuth2AuthorizationRequest.Builder	clientId(String clientId)	Sets the client identifier.
OAuth2AuthorizationRequest.Builder	parameters(Consumer<Map<String,Object>> parametersConsumer)	A Consumer to be provided access to all the parameters allowing the ability to add, replace, or remove.
OAuth2AuthorizationRequest.Builder	redirectUri(String redirectUri)	Sets the uri for the redirection endpoint.
OAuth2AuthorizationRequest.Builder	scope(String... scope)	Sets the scope(s).
OAuth2AuthorizationRequest.Builder	scopes(Set<String> scopes)	Sets the scope(s).
OAuth2AuthorizationRequest.Builder	state(String state)	Sets the state.

Methods inherited from class java.lang.Object

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

Method Details

authorizationUri

public OAuth2AuthorizationRequest.Builder authorizationUri(String authorizationUri)

Sets the uri for the authorization endpoint.

Parameters:

authorizationUri - the uri for the authorization endpoint

Returns:

the OAuth2AuthorizationRequest.Builder

clientId

public OAuth2AuthorizationRequest.Builder clientId(String clientId)

Sets the client identifier.

Parameters:

clientId - the client identifier

Returns:

the OAuth2AuthorizationRequest.Builder

redirectUri

public OAuth2AuthorizationRequest.Builder redirectUri(String redirectUri)

Sets the uri for the redirection endpoint.

Parameters:

redirectUri - the uri for the redirection endpoint

Returns:

the OAuth2AuthorizationRequest.Builder

scope

public OAuth2AuthorizationRequest.Builder scope(String... scope)

Sets the scope(s).

Parameters:

scope - the scope(s)

Returns:

the OAuth2AuthorizationRequest.Builder

scopes

public OAuth2AuthorizationRequest.Builder scopes(Set<String> scopes)

Sets the scope(s).

Parameters:

scopes - the scope(s)

Returns:

the OAuth2AuthorizationRequest.Builder

state

public OAuth2AuthorizationRequest.Builder state(String state)

Sets the state.

Parameters:

state - the state

Returns:

the OAuth2AuthorizationRequest.Builder

additionalParameters

public OAuth2AuthorizationRequest.Builder additionalParameters(Map<String,Object> additionalParameters)

Sets the additional parameter(s) used in the request.

Parameters:

additionalParameters - the additional parameter(s) used in the request

Returns:

the OAuth2AuthorizationRequest.Builder

additionalParameters

public OAuth2AuthorizationRequest.Builder additionalParameters(Consumer<Map<String,Object>> additionalParametersConsumer)

A Consumer to be provided access to the additional parameter(s) allowing the ability to add, replace, or remove.

Parameters:

additionalParametersConsumer - a Consumer of the additional parameters

Since:

5.3

parameters

public OAuth2AuthorizationRequest.Builder parameters(Consumer<Map<String,Object>> parametersConsumer)

A Consumer to be provided access to all the parameters allowing the ability to add, replace, or remove.

Parameters:

parametersConsumer - a Consumer of all the parameters

Since:

5.3

attributes

public OAuth2AuthorizationRequest.Builder attributes(Map<String,Object> attributes)

Sets the attributes associated to the request.

Parameters:

attributes - the attributes associated to the request

Returns:

the OAuth2AuthorizationRequest.Builder

Since:

5.2

attributes

public OAuth2AuthorizationRequest.Builder attributes(Consumer<Map<String,Object>> attributesConsumer)

A Consumer to be provided access to the attribute(s) allowing the ability to add, replace, or remove.

Parameters:

attributesConsumer - a Consumer of the attribute(s)

Since:

5.3

authorizationRequestUri

public OAuth2AuthorizationRequest.Builder authorizationRequestUri(String authorizationRequestUri)

Sets the URI string representation of the OAuth 2.0 Authorization Request.

NOTE: The URI string is required to be encoded in the application/x-www-form-urlencoded MIME format.

Parameters:

authorizationRequestUri - the URI string representation of the OAuth 2.0 Authorization Request

Returns:

the OAuth2AuthorizationRequest.Builder

Since:

5.1

authorizationRequestUri

public OAuth2AuthorizationRequest.Builder authorizationRequestUri(Function<org.springframework.web.util.UriBuilder,URI> authorizationRequestUriFunction)

A Function to be provided a UriBuilder representation of the OAuth 2.0 Authorization Request allowing for further customizations.

Parameters:

authorizationRequestUriFunction - a Function to be provided a UriBuilder representation of the OAuth 2.0 Authorization Request

Since:

5.3

build

public OAuth2AuthorizationRequest build()

Builds a new OAuth2AuthorizationRequest.

Returns:

a OAuth2AuthorizationRequest