com.sdl.web.oauth.common

Class DefaultOAuthToken

java.lang.Object

com.sdl.web.oauth.common.DefaultOAuthToken

All Implemented Interfaces:

OAuthToken

public class DefaultOAuthToken
extends Object
implements OAuthToken

This is the default OAuth Token implementation.

Field Summary

Fields inherited from interface com.sdl.web.oauth.common.OAuthToken

CLIENT_ID, EXPIRES_ON, GRANT_TYPE_CREDENTIALS, GRANT_TYPE_REFRESH

Constructor Summary

Constructors

Constructor and Description
DefaultOAuthToken(SecretKey key, Map<String,String> authAttributes, String tokenToRefresh) Construct a new OAuth2 access token.
DefaultOAuthToken(SecretKey key, String token, String refreshToken) Construct a new OAuth2 access token.
DefaultOAuthToken(String token, String refreshToken) Construct a new OAuth2 access token.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAttributes() The OAuth attributes passed in the OAuth Token.
String	getClientId() The client_id.
long	getExpiresOn() The time the token will expire in ms.
String	getRefreshToken() Token, to be used to refresh OAuth token.
String	getToken() The token itself.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOAuthToken

public DefaultOAuthToken(SecretKey key,
                         Map<String,String> authAttributes,
                         String tokenToRefresh)
                  throws OAuthException

Construct a new OAuth2 access token.

Parameters:

key - the key to use for calculating the digest.

authAttributes - the authorization attributes.

tokenToRefresh - token, used to refresh access token.

Throws:

OAuthException - throws exception if digest can not be created.

DefaultOAuthToken

public DefaultOAuthToken(String token,
                         String refreshToken)
                  throws OAuthException

Construct a new OAuth2 access token.

Parameters:

token - access token.

refreshToken - token, used to refresh access token.

Throws:

OAuthException - throws exception if digest can not be created.

DefaultOAuthToken

public DefaultOAuthToken(SecretKey key,
                         String token,
                         String refreshToken)
                  throws OAuthException

Construct a new OAuth2 access token.

Parameters:

key - the key to use for calculating the digest.

token - access token.

refreshToken - token, used to refresh access token.

Throws:

OAuthException - throws exception if digest can not be created.

Method Detail

getClientId

public String getClientId()

Description copied from interface: OAuthToken

The client_id.

Specified by:

getClientId in interface OAuthToken

Returns:

The OAuth client_id parameter

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: OAuthToken

The OAuth attributes passed in the OAuth Token.

Specified by:

getAttributes in interface OAuthToken

Returns:

The OAuth attribute

getExpiresOn

public long getExpiresOn()

Description copied from interface: OAuthToken

The time the token will expire in ms. since epoch.

Specified by:

getExpiresOn in interface OAuthToken

Returns:

The OAuth expiration time

getToken

public String getToken()

Description copied from interface: OAuthToken

The token itself.

Specified by:

getToken in interface OAuthToken

Returns:

The OAuth token

getRefreshToken

public String getRefreshToken()

Description copied from interface: OAuthToken

Token, to be used to refresh OAuth token.

Specified by:

getRefreshToken in interface OAuthToken

Returns:

the refresh token.

toString

public String toString()

Overrides:

toString in class Object