com.authlete.common.dto

Class TokenInfo

java.lang.Object

com.authlete.common.dto.TokenInfo

All Implemented Interfaces:

Serializable

public class TokenInfo
extends Object
implements Serializable

Information about a token of the type "urn:ietf:params:oauth:token-type:access_token" or the type "urn:ietf:params:oauth:token-type:refresh_token".

This class is used to hold detailed information about a subject token or an actor token. See the descriptions of TokenResponse.getSubjectTokenInfo() and TokenResponse.getActorTokenInfo() for details.

Since:

3.26, Authlete 2.3

See Also:

TokenResponse.getSubjectTokenInfo(), TokenResponse.getActorTokenInfo(), RFC 8693 OAuth 2.0 Token Exchange, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TokenInfo()

Method Summary

Modifier and Type	Method and Description
AuthzDetails	getAuthorizationDetails() Get the authorization details associated with the token.
long	getClientId() Get the client ID.
String	getClientIdAlias() Get the alias of the client ID.
long	getExpiresAt() Get the expiration date/time in seconds since the Unix epoch.
Property[]	getProperties() Get the extra properties associated with the token.
URI[]	getResources() Get the resources associated with the token.
Scope[]	getScopes() Get the scopes.
String	getSubject() Get the subject (= resource owner's unique identifier).
boolean	isClientIdAliasUsed() Get the flag indicating whether the alias of the client ID was used when the token was created.
TokenInfo	setAuthorizationDetails(AuthzDetails details) Set the authorization details associated with the token.
TokenInfo	setClientId(long clientId) Set the client ID.
TokenInfo	setClientIdAlias(String alias) Set the alias of the client ID.
TokenInfo	setClientIdAliasUsed(boolean used) Set the flag indicating whether the alias of the client ID was used when the token was created.
TokenInfo	setExpiresAt(long expiresAt) Set the expiration date/time in seconds since the Unix epoch.
TokenInfo	setProperties(Property[] properties) Set the extra properties associated with the token.
TokenInfo	setResources(URI[] resources) Set the resources associated with the token.
TokenInfo	setScopes(Scope[] scopes) Set the scopes.
TokenInfo	setSubject(String subject) Set the subject (= resource owner's unique identifier).

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenInfo

public TokenInfo()

Method Detail

getClientId

public long getClientId()

Get the client ID.

Returns:

The client ID.

setClientId

public TokenInfo setClientId(long clientId)

Set the client ID.

Parameters:

clientId - The client ID.

Returns:

this instance.

getSubject

public String getSubject()

Get the subject (= resource owner's unique identifier).

Returns:

The subject.

setSubject

public TokenInfo setSubject(String subject)

Set the subject (= resource owner's unique identifier).

Parameters:

subject - The subject.

Returns:

this instance.

getScopes

public Scope[] getScopes()

Get the scopes.

Returns:

The scopes.

setScopes

public TokenInfo setScopes(Scope[] scopes)

Set the scopes.

Parameters:

scopes - The scopes.

Returns:

this instance.

getExpiresAt

public long getExpiresAt()

Get the expiration date/time in seconds since the Unix epoch.

Returns:

The expiration date/time.

setExpiresAt

public TokenInfo setExpiresAt(long expiresAt)

Set the expiration date/time in seconds since the Unix epoch.

Parameters:

expiresAt - The expiration date/time.

Returns:

this instance.

getProperties

public Property[] getProperties()

Get the extra properties associated with the token.

Returns:

The extra properties.

See Also:

Extra Properties, How to add extra properties to an access token - Authlete Knowledge Base

setProperties

public TokenInfo setProperties(Property[] properties)

Set the extra properties associated with the token.

Parameters:

properties - The extra properties.

Returns:

this instance.

See Also:

Extra Properties, How to add extra properties to an access token - Authlete Knowledge Base

getClientIdAlias

public String getClientIdAlias()

Get the alias of the client ID.

Returns:

The alias of the client ID.

See Also:

Using "Client ID Alias" - Authlete Knowledge Base

setClientIdAlias

public TokenInfo setClientIdAlias(String alias)

Set the alias of the client ID.

Parameters:

alias - The alias of the client ID.

Returns:

this instance.

See Also:

Using "Client ID Alias" - Authlete Knowledge Base

isClientIdAliasUsed

public boolean isClientIdAliasUsed()

Get the flag indicating whether the alias of the client ID was used when the token was created.

Returns:

true if the alias of the client ID was used.

See Also:

Using "Client ID Alias" - Authlete Knowledge Base

setClientIdAliasUsed

public TokenInfo setClientIdAliasUsed(boolean used)

Set the flag indicating whether the alias of the client ID was used when the token was created.

Parameters:

used - true to indicate that the alias of the client ID was used.

Returns:

this instance.

See Also:

Using "Client ID Alias" - Authlete Knowledge Base

getResources

public URI[] getResources()

Get the resources associated with the token.

The values are ones specified by the resource request parameters.

Returns:

The resources.

See Also:

RFC 8707 Resource Indicators for OAuth 2.0

setResources

public TokenInfo setResources(URI[] resources)

Set the resources associated with the token.

The values are ones specified by the resource request parameters.

Parameters:

resources - The resources.

Returns:

this instance.

See Also:

RFC 8707 Resource Indicators for OAuth 2.0

getAuthorizationDetails

public AuthzDetails getAuthorizationDetails()

Get the authorization details associated with the token.

The value is one specified by the authorization_details request parameter.

Returns:

The authorization details.

See Also:

OAuth 2.0 Rich Authorization Requests

setAuthorizationDetails

public TokenInfo setAuthorizationDetails(AuthzDetails details)

Set the authorization details associated with the token.

The value is one specified by the authorization_details request parameter.

Parameters:

details - The authorization details.

Returns:

this instance.

See Also:

OAuth 2.0 Rich Authorization Requests