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

Class OAuth2Authorization.Builder

java.lang.Object

org.springframework.security.oauth2.server.authorization.OAuth2Authorization.Builder

All Implemented Interfaces:

Serializable

Enclosing class:

OAuth2Authorization

public static class OAuth2Authorization.Builder
extends Object
implements Serializable

A builder for OAuth2Authorization.

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(String registeredClientId)

Method Summary

Modifier and Type	Method	Description
OAuth2Authorization.Builder	accessToken(org.springframework.security.oauth2.core.OAuth2AccessToken accessToken)	Sets the access token.
OAuth2Authorization.Builder	attribute(String name, Object value)	Adds an attribute associated to the authorization.
OAuth2Authorization.Builder	attributes(Consumer<Map<String,Object>> attributesConsumer)	A Consumer of the attributes Map allowing the ability to add, replace, or remove.
OAuth2Authorization.Builder	authorizationGrantType(org.springframework.security.oauth2.core.AuthorizationGrantType authorizationGrantType)	Sets the authorization grant type used for the authorization.
OAuth2Authorization.Builder	authorizedScopes(Set<String> authorizedScopes)	Sets the authorized scope(s).
OAuth2Authorization	build()	Builds a new OAuth2Authorization.
OAuth2Authorization.Builder	id(String id)	Sets the identifier for the authorization.
OAuth2Authorization.Builder	principalName(String principalName)	Sets the Principal name of the resource owner (or client).
OAuth2Authorization.Builder	refreshToken(org.springframework.security.oauth2.core.OAuth2RefreshToken refreshToken)	Sets the refresh token.
<T extends org.springframework.security.oauth2.core.OAuth2Token> OAuth2Authorization.Builder	token(T token)	Sets the token.
<T extends org.springframework.security.oauth2.core.OAuth2Token> OAuth2Authorization.Builder	token(T token, Consumer<Map<String,Object>> metadataConsumer)	Sets the token and associated metadata.
protected final OAuth2Authorization.Builder	tokens(Map<Class<? extends org.springframework.security.oauth2.core.OAuth2Token>,OAuth2Authorization.Token<?>> tokens)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder(String registeredClientId)

Method Details

id

public OAuth2Authorization.Builder id(String id)

Sets the identifier for the authorization.

Parameters:

id - the identifier for the authorization

Returns:

the OAuth2Authorization.Builder

principalName

public OAuth2Authorization.Builder principalName(String principalName)

Sets the Principal name of the resource owner (or client).

Parameters:

principalName - the Principal name of the resource owner (or client)

Returns:

the OAuth2Authorization.Builder

authorizationGrantType

public OAuth2Authorization.Builder authorizationGrantType(org.springframework.security.oauth2.core.AuthorizationGrantType authorizationGrantType)

Sets the authorization grant type used for the authorization.

Parameters:

authorizationGrantType - the AuthorizationGrantType

Returns:

the OAuth2Authorization.Builder

authorizedScopes

public OAuth2Authorization.Builder authorizedScopes(Set<String> authorizedScopes)

Sets the authorized scope(s).

Parameters:

authorizedScopes - the Set of authorized scope(s)

Returns:

the OAuth2Authorization.Builder

Since:

0.4.0

accessToken

public OAuth2Authorization.Builder accessToken(org.springframework.security.oauth2.core.OAuth2AccessToken accessToken)

Sets the access token.

Parameters:

accessToken - the OAuth2AccessToken

Returns:

the OAuth2Authorization.Builder

refreshToken

public OAuth2Authorization.Builder refreshToken(org.springframework.security.oauth2.core.OAuth2RefreshToken refreshToken)

Sets the refresh token.

Parameters:

refreshToken - the OAuth2RefreshToken

Returns:

the OAuth2Authorization.Builder

token

public <T extends org.springframework.security.oauth2.core.OAuth2Token>
OAuth2Authorization.Builder token(T token)

Sets the token.

Type Parameters:

T - the type of the token

Parameters:

token - the token

Returns:

the OAuth2Authorization.Builder

token

public <T extends org.springframework.security.oauth2.core.OAuth2Token>
OAuth2Authorization.Builder token(T token,
 Consumer<Map<String,Object>> metadataConsumer)

Sets the token and associated metadata.

Type Parameters:

T - the type of the token

Parameters:

token - the token

metadataConsumer - a Consumer of the metadata Map

Returns:

the OAuth2Authorization.Builder

tokens

protected final OAuth2Authorization.Builder tokens(Map<Class<? extends org.springframework.security.oauth2.core.OAuth2Token>,OAuth2Authorization.Token<?>> tokens)

attribute

public OAuth2Authorization.Builder attribute(String name,
 Object value)

Adds an attribute associated to the authorization.

Parameters:

name - the name of the attribute

value - the value of the attribute

Returns:

the OAuth2Authorization.Builder

attributes

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

A Consumer of the attributes Map allowing the ability to add, replace, or remove.

Parameters:

attributesConsumer - a Consumer of the attributes Map

Returns:

the OAuth2Authorization.Builder

build

public OAuth2Authorization build()

Builds a new OAuth2Authorization.

Returns:

the OAuth2Authorization