com.box.sdk

Class ScopedToken

Object

BoxJSONObject

ScopedToken

public class ScopedToken
extends BoxJSONObject

Constructor Summary

Constructors

Constructor and Description
ScopedToken(JsonObject jsonObject) Constructs a ScopedToken object from a parsed JsonObject.

Method Summary

Modifier and Type	Method and Description
String	getAccessToken() Gets the lower scoped token.
long	getExpiresIn() Gets the expires in time in milliseconds.
String	getIssuedTokenType() Gets the issued token type as per ietf namespace.
long	getObtainedAt() Gets the time in milliseconds when the token was obtained.
JsonArray	getRestrictedTo() Gets the restricted to information for the scoped token.
String	getTokenType() Gets the token type.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.
void	setExpiresIn(long milliseconds) Sets the time in milliseconds in which this token will expire.
void	setObtainedAt(long milliseconds)

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject

Methods inherited from class Object

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

Constructor Detail

ScopedToken

public ScopedToken(JsonObject jsonObject)

Constructs a ScopedToken object from a parsed JsonObject.

Parameters:

jsonObject - parsed json object from response of token exchange

Method Detail

parseJSONMember

protected void parseJSONMember(JsonObject.Member member)

Description copied from class: BoxJSONObject

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Parameters:

member - the JSON member to be parsed.

getAccessToken

public String getAccessToken()

Gets the lower scoped token.

Returns:

lower scoped access token

getExpiresIn

public long getExpiresIn()

Gets the expires in time in milliseconds.

Returns:

the time in milliseconds after which the token expires

setExpiresIn

public void setExpiresIn(long milliseconds)

Sets the time in milliseconds in which this token will expire.

Parameters:

milliseconds - the number of milliseconds for which the access token is valid.

getTokenType

public String getTokenType()

Gets the token type.

Returns:

the token type

getIssuedTokenType

public String getIssuedTokenType()

Gets the issued token type as per ietf namespace.

Returns:

the issued token type as per ietf namespace

getRestrictedTo

public JsonArray getRestrictedTo()

Gets the restricted to information for the scoped token.

Returns:

the restricted to information

getObtainedAt

public long getObtainedAt()

Gets the time in milliseconds when the token was obtained.

Returns:

the time in millinseconds when the token was obtained

setObtainedAt

public void setObtainedAt(long milliseconds)

Parameters:

milliseconds - the time in milliseconds at which it was obtained