com.paypal.sdk.models

Class OAuthToken

java.lang.Object

com.paypal.sdk.models.OAuthToken

public class OAuthToken
extends Object

This is a model class for OAuthToken type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuthToken.Builder Class to build instances of OAuthToken.

Constructor Summary

Constructors

Constructor and Description
OAuthToken() Default constructor.
OAuthToken(String accessToken, String tokenType, Long expiresIn, String scope, Long expiry, String refreshToken, String idToken) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
String	getAccessToken() Getter for AccessToken.
Long	getExpiresIn() Getter for ExpiresIn.
Long	getExpiry() Getter for Expiry.
String	getIdToken() Getter for IdToken.
String	getRefreshToken() Getter for RefreshToken.
String	getScope() Getter for Scope.
String	getTokenType() Getter for TokenType.
void	setAccessToken(String accessToken) Setter for AccessToken.
void	setExpiresIn(Long expiresIn) Setter for ExpiresIn.
void	setExpiry(Long expiry) Setter for Expiry.
void	setIdToken(String idToken) Setter for IdToken.
void	setRefreshToken(String refreshToken) Setter for RefreshToken.
void	setScope(String scope) Setter for Scope.
void	setTokenType(String tokenType) Setter for TokenType.
OAuthToken.Builder	toBuilder() Builds a new OAuthToken.Builder object.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthToken

public OAuthToken()

Default constructor.

OAuthToken

public OAuthToken(String accessToken,
                  String tokenType,
                  Long expiresIn,
                  String scope,
                  Long expiry,
                  String refreshToken,
                  String idToken)

Initialization constructor.

Parameters:

accessToken - String value for accessToken.

tokenType - String value for tokenType.

expiresIn - Long value for expiresIn.

scope - String value for scope.

expiry - Long value for expiry.

refreshToken - String value for refreshToken.

idToken - String value for idToken.

Method Detail

getAccessToken

public String getAccessToken()

Getter for AccessToken. Access token

Returns:

Returns the String

setAccessToken

public void setAccessToken(String accessToken)

Setter for AccessToken. Access token

Parameters:

accessToken - Value for String

getTokenType

public String getTokenType()

Getter for TokenType. Type of access token

Returns:

Returns the String

setTokenType

public void setTokenType(String tokenType)

Setter for TokenType. Type of access token

Parameters:

tokenType - Value for String

getExpiresIn

public Long getExpiresIn()

Getter for ExpiresIn. Time in seconds before the access token expires

Returns:

Returns the Long

setExpiresIn

public void setExpiresIn(Long expiresIn)

Setter for ExpiresIn. Time in seconds before the access token expires

Parameters:

expiresIn - Value for Long

getScope

public String getScope()

Getter for Scope. List of scopes granted This is a space-delimited list of strings.

Returns:

Returns the String

setScope

public void setScope(String scope)

Setter for Scope. List of scopes granted This is a space-delimited list of strings.

Parameters:

scope - Value for String

getExpiry

public Long getExpiry()

Getter for Expiry. Time of token expiry as unix timestamp (UTC)

Returns:

Returns the Long

setExpiry

public void setExpiry(Long expiry)

Setter for Expiry. Time of token expiry as unix timestamp (UTC)

Parameters:

expiry - Value for Long

getRefreshToken

public String getRefreshToken()

Getter for RefreshToken. Refresh token Used to get a new access token when it expires.

Returns:

Returns the String

setRefreshToken

public void setRefreshToken(String refreshToken)

Setter for RefreshToken. Refresh token Used to get a new access token when it expires.

Parameters:

refreshToken - Value for String

getIdToken

public String getIdToken()

Getter for IdToken. An ID token response type is of JSON Web Token (JWT) that contains claims about the identity of the authenticated user.

Returns:

Returns the String

setIdToken

public void setIdToken(String idToken)

Setter for IdToken. An ID token response type is of JSON Web Token (JWT) that contains claims about the identity of the authenticated user.

Parameters:

idToken - Value for String

toBuilder

public OAuthToken.Builder toBuilder()

Builds a new OAuthToken.Builder object. Creates the instance with the state of the current model.

Returns:

a new OAuthToken.Builder object