com.neovisionaries.android.oauth20

Class AccessToken

java.lang.Object

com.neovisionaries.android.oauth20.AccessToken

All Implemented Interfaces:

android.os.Parcelable

public class AccessToken
extends Object
implements android.os.Parcelable

Access token.

Since:

1.9

Author:

Takahiko Kawasaki

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<AccessToken>	CREATOR CREATER required by Parcelable interface.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
AccessToken() The default constructor.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
String	getAccessToken() Get the access token (= the value of access_token (REQUIRED parameter)).
int	getExpiresIn() Get the lifetime of the access token in seconds (= the value of expires_in parameter (RECOMMENDED parameter)).
String	getRefreshToken() Get the refresh token (= the value of refresh_token parameter (OPTIONAL parameter)).
String	getScope() Get the space-delimited scope list (= the value of scope parameter (OPTIONAL parameter)).
String	getTokenType() Get the token type (= the value of token_type (REQUIRED parameter)).
AccessToken	setAccessToken(String accessToken) Set the access token (= the value of access_token (REQUIRED parameter)).
AccessToken	setExpiresIn(int expiresIn) Set the lifetime of the access token in seconds (= the value of expires_in parameter (RECOMMENDED parameter)).
AccessToken	setRefreshToken(String refreshToken) Set the refresh token (= the value of refresh_token parameter (OPTIONAL parameter)).
AccessToken	setScope(String scope) Set the space-delimited scope list (= the value of scope parameter (OPTIONAL parameter)).
AccessToken	setTokenType(String tokenType) Set the token type (= the value of token_type (REQUIRED parameter)).
void	writeToParcel(android.os.Parcel out, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<AccessToken> CREATOR

CREATER required by Parcelable interface.

Constructor Detail

AccessToken

public AccessToken()

The default constructor.

Method Detail

getAccessToken

public String getAccessToken()

Get the access token (= the value of access_token (REQUIRED parameter)).

Returns:

The access token.

setAccessToken

public AccessToken setAccessToken(String accessToken)

Set the access token (= the value of access_token (REQUIRED parameter)).

Parameters:

accessToken - The access token.

Returns:

this object.

getTokenType

public String getTokenType()

Get the token type (= the value of token_type (REQUIRED parameter)).

Returns:

The token type.

See Also:

RFC 6749 (OAuth 2.0), 7.1. Access Token Types

setTokenType

public AccessToken setTokenType(String tokenType)

Set the token type (= the value of token_type (REQUIRED parameter)).

Parameters:

tokenType - The token type.

Returns:

this object.

getExpiresIn

public int getExpiresIn()

Get the lifetime of the access token in seconds (= the value of expires_in parameter (RECOMMENDED parameter)).

Returns:

The lifetime of the access token in seconds. 0 may be returned when the value is not available.

setExpiresIn

public AccessToken setExpiresIn(int expiresIn)

Set the lifetime of the access token in seconds (= the value of expires_in parameter (RECOMMENDED parameter)).

Parameters:

expiresIn - The lifetime of the access token in seconds.

Returns:

this object.

getRefreshToken

public String getRefreshToken()

Get the refresh token (= the value of refresh_token parameter (OPTIONAL parameter)).

Returns:

The refresh token. null may be returned when the value is not available.

setRefreshToken

public AccessToken setRefreshToken(String refreshToken)

Set the refresh token (= the value of refresh_token parameter (OPTIONAL parameter)).

Parameters:

refreshToken - The refresh token.

Returns:

this object.

getScope

public String getScope()

Get the space-delimited scope list (= the value of scope parameter (OPTIONAL parameter)).

RFC 6749 (OAuth 2.0), 3.3. Access Token Scope says "The value of the scope parameter is expressed as a list of space-delimited, case-sensitive strings." However, Facebook does not comply with this specification and uses a comma (0x2C) as the delimiter. Therefore, this method returns a comma-delimited scope list if this AccessToken instance was built from a response from Facebook.

Returns:

The space-delimited scope list.

setScope

public AccessToken setScope(String scope)

Set the space-delimited scope list (= the value of scope parameter (OPTIONAL parameter)).

Parameters:

scope - The space-delimited scope list.

Returns:

this object.

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel out,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable