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

Class OAuth2TokenContext.AbstractBuilder<T extends OAuth2TokenContext,B extends OAuth2TokenContext.AbstractBuilder<T,B>>

java.lang.Object

org.springframework.security.oauth2.server.authorization.token.OAuth2TokenContext.AbstractBuilder<T,B>

Type Parameters:

T - the type of the context

B - the type of the builder

Direct Known Subclasses:

DefaultOAuth2TokenContext.Builder, JwtEncodingContext.Builder, OAuth2TokenClaimsContext.Builder

Enclosing interface:

OAuth2TokenContext

public abstract static class OAuth2TokenContext.AbstractBuilder<T extends OAuth2TokenContext,B extends OAuth2TokenContext.AbstractBuilder<T,B>>
extends Object

Base builder for implementations of OAuth2TokenContext.

Constructor Summary

Constructors

Constructor	Description
AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
B	authorization(OAuth2Authorization authorization)	Sets the authorization.
B	authorizationGrant(org.springframework.security.core.Authentication authorizationGrant)	Sets the Authentication representing the authorization grant.
B	authorizationGrantType(org.springframework.security.oauth2.core.AuthorizationGrantType authorizationGrantType)	Sets the authorization grant type.
B	authorizationServerContext(AuthorizationServerContext authorizationServerContext)	Sets the authorization server context.
B	authorizedScopes(Set<String> authorizedScopes)	Sets the authorized scope(s).
abstract T	build()	Builds a new OAuth2TokenContext.
B	context(Consumer<Map<Object,Object>> contextConsumer)	A Consumer of the attributes Map allowing the ability to add, replace, or remove.
protected <V> V	get(Object key)
protected Map<Object,Object>	getContext()
protected final B	getThis()
B	principal(org.springframework.security.core.Authentication principal)	Sets the Authentication representing the Principal resource owner (or client).
B	put(Object key, Object value)	Associates an attribute.
B	registeredClient(RegisteredClient registeredClient)	Sets the registered client.
B	tokenType(OAuth2TokenType tokenType)	Sets the token type.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractBuilder

public AbstractBuilder()

Method Details

registeredClient

public B registeredClient(RegisteredClient registeredClient)

Sets the registered client.

Parameters:

registeredClient - the RegisteredClient

Returns:

the OAuth2TokenContext.AbstractBuilder for further configuration

principal

public B principal(org.springframework.security.core.Authentication principal)

Sets the Authentication representing the Principal resource owner (or client).

Parameters:

principal - the Authentication representing the Principal resource owner (or client)

Returns:

the OAuth2TokenContext.AbstractBuilder for further configuration

authorizationServerContext

public B authorizationServerContext(AuthorizationServerContext authorizationServerContext)

Sets the authorization server context.

Parameters:

authorizationServerContext - the AuthorizationServerContext

Returns:

the OAuth2TokenContext.AbstractBuilder for further configuration

Since:

0.2.3

authorization

public B authorization(OAuth2Authorization authorization)

Sets the authorization.

Parameters:

authorization - the OAuth2Authorization

Returns:

the OAuth2TokenContext.AbstractBuilder for further configuration

authorizedScopes

public B authorizedScopes(Set<String> authorizedScopes)

Sets the authorized scope(s).

Parameters:

authorizedScopes - the authorized scope(s)

Returns:

the OAuth2TokenContext.AbstractBuilder for further configuration

tokenType

public B tokenType(OAuth2TokenType tokenType)

Sets the token type.

Parameters:

tokenType - the OAuth2TokenType

Returns:

the OAuth2TokenContext.AbstractBuilder for further configuration

authorizationGrantType

public B authorizationGrantType(org.springframework.security.oauth2.core.AuthorizationGrantType authorizationGrantType)

Sets the authorization grant type.

Parameters:

authorizationGrantType - the AuthorizationGrantType

Returns:

the OAuth2TokenContext.AbstractBuilder for further configuration

authorizationGrant

public B authorizationGrant(org.springframework.security.core.Authentication authorizationGrant)

Sets the Authentication representing the authorization grant.

Parameters:

authorizationGrant - the Authentication representing the authorization grant

Returns:

the OAuth2TokenContext.AbstractBuilder for further configuration

put

public B put(Object key,
 Object value)

Associates an attribute.

Parameters:

key - the key for the attribute

value - the value of the attribute

Returns:

the OAuth2TokenContext.AbstractBuilder for further configuration

context

public B context(Consumer<Map<Object,Object>> contextConsumer)

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

Parameters:

contextConsumer - a Consumer of the attributes Map

Returns:

the OAuth2TokenContext.AbstractBuilder for further configuration

get

protected <V> V get(Object key)

getContext

protected Map<Object,Object> getContext()

getThis

protected final B getThis()

build

public abstract T build()

Builds a new OAuth2TokenContext.

Returns:

the OAuth2TokenContext