com.sdl.web.oauth.common

Interface OAuthToken

All Known Implementing Classes:

DefaultOAuthToken

public interface OAuthToken

This represents the OAuth Token that is obtained from a token endpoint.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_ID Client Id parameter name.
static String	EXPIRES_ON Expires On parameter name.
static String	GRANT_TYPE_CREDENTIALS Credentials grant type.
static String	GRANT_TYPE_REFRESH Refresh token grant type.

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.

Field Detail

GRANT_TYPE_CREDENTIALS

static final String GRANT_TYPE_CREDENTIALS

Credentials grant type.

See Also:

Constant Field Values

GRANT_TYPE_REFRESH

static final String GRANT_TYPE_REFRESH

Refresh token grant type.

See Also:

Constant Field Values

CLIENT_ID

static final String CLIENT_ID

Client Id parameter name.

See Also:

Constant Field Values

EXPIRES_ON

static final String EXPIRES_ON

Expires On parameter name.

See Also:

Constant Field Values

Method Detail

getClientId

String getClientId()

The client_id.

Returns:

The OAuth client_id parameter

getAttributes

Map<String,String> getAttributes()

The OAuth attributes passed in the OAuth Token.

Returns:

The OAuth attribute

getExpiresOn

long getExpiresOn()

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

Returns:

The OAuth expiration time

getToken

String getToken()

The token itself.

Returns:

The OAuth token

getRefreshToken

String getRefreshToken()

Token, to be used to refresh OAuth token.

Returns:

the refresh token.