Package com.google.auth.oauth2

Class AccessToken

java.lang.Object

com.google.auth.oauth2.AccessToken

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

IdToken

public class AccessToken
extends java.lang.Object
implements java.io.Serializable

Represents a temporary OAuth2 access token and its expiration information.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccessToken.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.Long	expirationTimeMillis
private java.util.List<java.lang.String>	scopes
private static long	serialVersionUID
private java.lang.String	tokenValue

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AccessToken(AccessToken.Builder builder)
	AccessToken(java.lang.String tokenValue, java.util.Date expirationTime)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.util.Date	getExpirationTime()	Time when access token will expire.
(package private) java.lang.Long	getExpirationTimeMillis()
java.util.List<java.lang.String>	getScopes()	Scopes from the access token response.
java.lang.String	getTokenValue()	String representation of the access token.
int	hashCode()
static AccessToken.Builder	newBuilder()
AccessToken.Builder	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

tokenValue

private final java.lang.String tokenValue

expirationTimeMillis

private final java.lang.Long expirationTimeMillis

scopes

private final java.util.List<java.lang.String> scopes

Constructor Detail

AccessToken

public AccessToken(java.lang.String tokenValue,
                   java.util.Date expirationTime)

Parameters:

tokenValue - String representation of the access token.

expirationTime - Time when access token will expire.

AccessToken

private AccessToken(AccessToken.Builder builder)

Method Detail

newBuilder

public static AccessToken.Builder newBuilder()

toBuilder

public AccessToken.Builder toBuilder()

getScopes

public java.util.List<java.lang.String> getScopes()

Scopes from the access token response. Not all credentials provide scopes in response and as per https://datatracker.ietf.org/doc/html/rfc6749#section-5.1 it is optional in the response.

Returns:

List of scopes

getTokenValue

public java.lang.String getTokenValue()

String representation of the access token.

Returns:

The raw access token string value.

getExpirationTime

public java.util.Date getExpirationTime()

Time when access token will expire.

Returns:

The expiration time as a Date.

getExpirationTimeMillis

java.lang.Long getExpirationTimeMillis()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object