Package com.linecorp.armeria.common.auth.oauth2

Class OAuth2TokenDescriptorBuilder

java.lang.Object

com.linecorp.armeria.common.auth.oauth2.OAuth2TokenDescriptorBuilder

@UnstableApi
public final class OAuth2TokenDescriptorBuilder
extends Object

Builds an instance of OAuth2TokenDescriptor.

Method Summary

Modifier and Type	Method	Description
OAuth2TokenDescriptorBuilder	audience(String audience)	aud Token Introspection Response field, OPTIONAL.
OAuth2TokenDescriptor	build()	Builds a new instance of OAuth2TokenDescriptor based on the configured parameters.
OAuth2TokenDescriptorBuilder	clientId(String clientId)	client_id Token Introspection Response field, OPTIONAL.
OAuth2TokenDescriptorBuilder	expiresAt(Instant expiresAt)	exp Token Introspection Response field, OPTIONAL.
OAuth2TokenDescriptorBuilder	extras(Iterable<? extends Map.Entry<String,String>> extras)	An Iterable of extra system-specific token parameters included with Token Introspection Response, OPTIONAL.
OAuth2TokenDescriptorBuilder	extras(String key, String value)	A pair of extra system-specific token parameters included with Token Introspection Response, OPTIONAL.
OAuth2TokenDescriptorBuilder	extras(Map<String,String> extras)	A Map of extra system-specific token parameters included with Token Introspection Response, OPTIONAL.
OAuth2TokenDescriptorBuilder	issuedAt(Instant issuedAt)	iat Token Introspection Response field, OPTIONAL.
OAuth2TokenDescriptorBuilder	issuer(String issuer)	iss Token Introspection Response field, OPTIONAL.
OAuth2TokenDescriptorBuilder	jwtId(String jwtId)	jti Token Introspection Response field, OPTIONAL.
OAuth2TokenDescriptorBuilder	notBefore(Instant notBefore)	nbf Token Introspection Response field, OPTIONAL.
OAuth2TokenDescriptorBuilder	scope(Iterable<String> scope)	scope Token Introspection Response field, OPTIONAL.
OAuth2TokenDescriptorBuilder	scope(String... scope)	scope Token Introspection Response field, OPTIONAL.
OAuth2TokenDescriptorBuilder	subject(String subject)	sub Token Introspection Response field, OPTIONAL.
OAuth2TokenDescriptorBuilder	tokenType(String tokenType)	token_type Token Introspection Response field, OPTIONAL.
OAuth2TokenDescriptorBuilder	userName(String userName)	username Token Introspection Response field, OPTIONAL.

Methods inherited from class java.lang.Object

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

Method Details

scope

public OAuth2TokenDescriptorBuilder scope(Iterable<String> scope)

scope Token Introspection Response field, OPTIONAL. An Iterable of individual scope values.

scope

public OAuth2TokenDescriptorBuilder scope(String... scope)

scope Token Introspection Response field, OPTIONAL. An array of individual scope values.

clientId

public OAuth2TokenDescriptorBuilder clientId(String clientId)

client_id Token Introspection Response field, OPTIONAL. Client identifier for the OAuth 2.0 client that requested this token.

userName

public OAuth2TokenDescriptorBuilder userName(String userName)

username Token Introspection Response field, OPTIONAL. Human-readable identifier for the resource owner who authorized this token.

tokenType

public OAuth2TokenDescriptorBuilder tokenType(String tokenType)

token_type Token Introspection Response field, OPTIONAL. Type of the token as defined at [RFC6749], Section 7.1.

expiresAt

public OAuth2TokenDescriptorBuilder expiresAt(Instant expiresAt)

exp Token Introspection Response field, OPTIONAL. Instant timestamp, indicating when this token will expire, as defined at [RFC7519].

issuedAt

public OAuth2TokenDescriptorBuilder issuedAt(Instant issuedAt)

iat Token Introspection Response field, OPTIONAL. Instant timestamp, indicating when this token was originally issued, as defined at [RFC7519].

notBefore

public OAuth2TokenDescriptorBuilder notBefore(Instant notBefore)

nbf Token Introspection Response field, OPTIONAL. Instant timestamp, indicating when this token is not to be used before, as defined at [RFC7519].

subject

public OAuth2TokenDescriptorBuilder subject(String subject)

sub Token Introspection Response field, OPTIONAL. Subject of the token. Usually a machine-readable identifier of the resource owner who authorized this token. As defined at [RFC7519].

audience

public OAuth2TokenDescriptorBuilder audience(String audience)

aud Token Introspection Response field, OPTIONAL. Service-specific string identifier or list of string identifiers representing the intended audience for this token, as defined at [RFC7519].

issuer

public OAuth2TokenDescriptorBuilder issuer(String issuer)

iss Token Introspection Response field, OPTIONAL. String representing the issuer of this token, as defined at [RFC7519].

jwtId

public OAuth2TokenDescriptorBuilder jwtId(String jwtId)

jti Token Introspection Response field, OPTIONAL. String identifier for the token - JWT ID, as defined at [RFC7519].

extras

public OAuth2TokenDescriptorBuilder extras(String key,
 String value)

A pair of extra system-specific token parameters included with Token Introspection Response, OPTIONAL.

extras

public OAuth2TokenDescriptorBuilder extras(Map<String,String> extras)

A Map of extra system-specific token parameters included with Token Introspection Response, OPTIONAL.

extras

public OAuth2TokenDescriptorBuilder extras(Iterable<? extends Map.Entry<String,String>> extras)

An Iterable of extra system-specific token parameters included with Token Introspection Response, OPTIONAL.

build

public OAuth2TokenDescriptor build()

Builds a new instance of OAuth2TokenDescriptor based on the configured parameters.