org.springframework.security.oauth2.client

Class OAuth2AuthorizeRequest.Builder

java.lang.Object

org.springframework.security.oauth2.client.OAuth2AuthorizeRequest.Builder

Enclosing class:

OAuth2AuthorizeRequest

public static class OAuth2AuthorizeRequest.Builder
extends java.lang.Object

A builder for OAuth2AuthorizeRequest.

Method Summary

Modifier and Type	Method and Description
OAuth2AuthorizeRequest.Builder	attribute(java.lang.String name, java.lang.Object value) Sets an attribute associated to the request.
OAuth2AuthorizeRequest.Builder	attributes(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> attributesConsumer) Provides a Consumer access to the attributes associated to the request.
OAuth2AuthorizeRequest	build() Builds a new OAuth2AuthorizeRequest.
OAuth2AuthorizeRequest.Builder	principal(Authentication principal) Sets the Principal (to be) associated to the authorized client.
OAuth2AuthorizeRequest.Builder	principal(java.lang.String principalName) Sets the name of the Principal (to be) associated to the authorized client.

Methods inherited from class java.lang.Object

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

Method Detail

principal

public OAuth2AuthorizeRequest.Builder principal(java.lang.String principalName)

Sets the name of the Principal (to be) associated to the authorized client.

Parameters:

principalName - the name of the Principal (to be) associated to the authorized client

Returns:

the OAuth2AuthorizeRequest.Builder

Since:

5.3

principal

public OAuth2AuthorizeRequest.Builder principal(Authentication principal)

Sets the Principal (to be) associated to the authorized client.

Parameters:

principal - the Principal (to be) associated to the authorized client

Returns:

the OAuth2AuthorizeRequest.Builder

attributes

public OAuth2AuthorizeRequest.Builder attributes(java.util.function.Consumer<java.util.Map<java.lang.String,java.lang.Object>> attributesConsumer)

Provides a Consumer access to the attributes associated to the request.

Parameters:

attributesConsumer - a Consumer of the attributes associated to the request

Returns:

the OAuth2AuthorizeRequest.Builder

attribute

public OAuth2AuthorizeRequest.Builder attribute(java.lang.String name,
                                                java.lang.Object value)

Sets an attribute associated to the request.

Parameters:

name - the name of the attribute

value - the value of the attribute

Returns:

the OAuth2AuthorizeRequest.Builder

build

public OAuth2AuthorizeRequest build()

Builds a new OAuth2AuthorizeRequest.

Returns:

a OAuth2AuthorizeRequest