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

Class OAuth2TokenIntrospection.Builder

java.lang.Object

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

Enclosing class:

OAuth2TokenIntrospection

public static final class OAuth2TokenIntrospection.Builder
extends Object

A builder for OAuth2TokenIntrospection.

Method Summary

Modifier and Type	Method	Description
OAuth2TokenIntrospection.Builder	active(boolean active)	Sets the indicator of whether or not the presented token is currently active, REQUIRED.
OAuth2TokenIntrospection.Builder	audience(String audience)	Add the identifier representing the intended audience for this token, OPTIONAL.
OAuth2TokenIntrospection.Builder	audiences(Consumer<List<String>> audiencesConsumer)	A Consumer of the intended audience(s) for this token, allowing the ability to add, replace, or remove, OPTIONAL.
OAuth2TokenIntrospection	build()	Validate the claims and build the OAuth2TokenIntrospection.
OAuth2TokenIntrospection.Builder	claim(String name, Object value)	Sets the claim.
OAuth2TokenIntrospection.Builder	claims(Consumer<Map<String,Object>> claimsConsumer)	Provides access to every claim(String, Object) declared so far with the possibility to add, replace, or remove.
OAuth2TokenIntrospection.Builder	clientId(String clientId)	Sets the client identifier for the OAuth 2.0 client that requested this token, OPTIONAL.
OAuth2TokenIntrospection.Builder	expiresAt(Instant expiresAt)	Sets the time indicating when this token will expire, OPTIONAL.
OAuth2TokenIntrospection.Builder	id(String jti)	Sets the identifier for the token, OPTIONAL.
OAuth2TokenIntrospection.Builder	issuedAt(Instant issuedAt)	Sets the time indicating when this token was originally issued, OPTIONAL.
OAuth2TokenIntrospection.Builder	issuer(String issuer)	Sets the issuer of this token, OPTIONAL.
OAuth2TokenIntrospection.Builder	notBefore(Instant notBefore)	Sets the time indicating when this token is not to be used before, OPTIONAL.
OAuth2TokenIntrospection.Builder	scope(String scope)	Add the scope associated with this token, OPTIONAL.
OAuth2TokenIntrospection.Builder	scopes(Consumer<List<String>> scopesConsumer)	A Consumer of the scope(s) associated with this token, allowing the ability to add, replace, or remove, OPTIONAL.
OAuth2TokenIntrospection.Builder	subject(String subject)	Sets the subject of the token, usually a machine-readable identifier of the resource owner who authorized this token, OPTIONAL.
OAuth2TokenIntrospection.Builder	tokenType(String tokenType)	Sets the token type (e.g.
OAuth2TokenIntrospection.Builder	username(String username)	Sets the human-readable identifier for the resource owner who authorized this token, OPTIONAL.

Methods inherited from class java.lang.Object

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

Method Details

active

public OAuth2TokenIntrospection.Builder active(boolean active)

Sets the indicator of whether or not the presented token is currently active, REQUIRED.

Parameters:

active - true if the token is currently active, false otherwise

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

scope

public OAuth2TokenIntrospection.Builder scope(String scope)

Add the scope associated with this token, OPTIONAL.

Parameters:

scope - the scope associated with this token

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

scopes

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

A Consumer of the scope(s) associated with this token, allowing the ability to add, replace, or remove, OPTIONAL.

Parameters:

scopesConsumer - a Consumer of the scope(s) associated with this token

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

clientId

public OAuth2TokenIntrospection.Builder clientId(String clientId)

Sets the client identifier for the OAuth 2.0 client that requested this token, OPTIONAL.

Parameters:

clientId - the client identifier for the OAuth 2.0 client that requested this token

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

username

public OAuth2TokenIntrospection.Builder username(String username)

Sets the human-readable identifier for the resource owner who authorized this token, OPTIONAL.

Parameters:

username - the human-readable identifier for the resource owner who authorized this token

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

tokenType

public OAuth2TokenIntrospection.Builder tokenType(String tokenType)

Sets the token type (e.g. bearer), OPTIONAL.

Parameters:

tokenType - the token type

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

expiresAt

public OAuth2TokenIntrospection.Builder expiresAt(Instant expiresAt)

Sets the time indicating when this token will expire, OPTIONAL.

Parameters:

expiresAt - the time indicating when this token will expire

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

issuedAt

public OAuth2TokenIntrospection.Builder issuedAt(Instant issuedAt)

Sets the time indicating when this token was originally issued, OPTIONAL.

Parameters:

issuedAt - the time indicating when this token was originally issued

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

notBefore

public OAuth2TokenIntrospection.Builder notBefore(Instant notBefore)

Sets the time indicating when this token is not to be used before, OPTIONAL.

Parameters:

notBefore - the time indicating when this token is not to be used before

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

subject

public OAuth2TokenIntrospection.Builder subject(String subject)

Sets the subject of the token, usually a machine-readable identifier of the resource owner who authorized this token, OPTIONAL.

Parameters:

subject - the subject of the token

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

audience

public OAuth2TokenIntrospection.Builder audience(String audience)

Add the identifier representing the intended audience for this token, OPTIONAL.

Parameters:

audience - the identifier representing the intended audience for this token

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

audiences

public OAuth2TokenIntrospection.Builder audiences(Consumer<List<String>> audiencesConsumer)

A Consumer of the intended audience(s) for this token, allowing the ability to add, replace, or remove, OPTIONAL.

Parameters:

audiencesConsumer - a Consumer of the intended audience(s) for this token

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

issuer

public OAuth2TokenIntrospection.Builder issuer(String issuer)

Sets the issuer of this token, OPTIONAL.

Parameters:

issuer - the issuer of this token

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

id

public OAuth2TokenIntrospection.Builder id(String jti)

Sets the identifier for the token, OPTIONAL.

Parameters:

jti - the identifier for the token

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

claim

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

Sets the claim.

Parameters:

name - the claim name

value - the claim value

Returns:

the OAuth2TokenIntrospection.Builder for further configuration

claims

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

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

Parameters:

claimsConsumer - a Consumer of the claims

Returns:

the OAuth2TokenIntrospection.Builder for further configurations

build

public OAuth2TokenIntrospection build()

Validate the claims and build the OAuth2TokenIntrospection.

The following claims are REQUIRED: active

Returns:

the OAuth2TokenIntrospection