Package org.forgerock.android.auth

Class AccessToken

java.lang.Object

org.forgerock.android.auth.Token

org.forgerock.android.auth.AccessToken

All Implemented Interfaces:

java.io.Serializable

public class AccessToken
extends org.forgerock.android.auth.Token
implements java.io.Serializable

Models an OAuth2 access token.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccessToken.AccessTokenBuilder
static class	AccessToken.Scope	Authorization Scope

Constructor Summary

Constructors

Constructor	Description
AccessToken(java.lang.String value, long expiresIn, java.util.Date expiration, java.lang.String refreshToken, java.lang.String idToken, java.lang.String tokenType, AccessToken.Scope scope, SSOToken sessionToken)

Method Summary

Modifier and Type	Method	Description
static AccessToken.AccessTokenBuilder	builder()
static AccessToken	fromJson(java.lang.String str)
java.util.Date	getExpiration()
long	getExpiresIn()
java.lang.String	getIdToken()
java.lang.String	getRefreshToken()
AccessToken.Scope	getScope()
SSOToken	getSessionToken()
java.lang.String	getTokenType()
boolean	isExpired()	Convenience method for checking expiration
boolean	isExpired(long threshold)	Convenience method for checking expiration
boolean	isPersisted()
void	setPersisted(boolean persisted)
java.lang.String	toJson()

Methods inherited from class org.forgerock.android.auth.Token

equals, getValue, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessToken

public AccessToken(java.lang.String value,
                   long expiresIn,
                   java.util.Date expiration,
                   java.lang.String refreshToken,
                   java.lang.String idToken,
                   java.lang.String tokenType,
                   AccessToken.Scope scope,
                   SSOToken sessionToken)

Method Detail

isExpired

public boolean isExpired()

Convenience method for checking expiration

Returns:

true if the expiration is before the current time

isExpired

public boolean isExpired(long threshold)

Convenience method for checking expiration

Parameters:

threshold - Threshold in Seconds

Returns:

true if the expiration is before the current time

toJson

public java.lang.String toJson()

fromJson

public static AccessToken fromJson(java.lang.String str)

builder

public static AccessToken.AccessTokenBuilder builder()

getExpiresIn

public long getExpiresIn()

getRefreshToken

public java.lang.String getRefreshToken()

getIdToken

public java.lang.String getIdToken()

getTokenType

public java.lang.String getTokenType()

getScope

public AccessToken.Scope getScope()

getExpiration

public java.util.Date getExpiration()

getSessionToken

public SSOToken getSessionToken()

isPersisted

public boolean isPersisted()

setPersisted

public void setPersisted(boolean persisted)