org.apache.shindig.gadgets.oauth2

Interface OAuth2Token

All Superinterfaces:

Serializable

All Known Implementing Classes:

OAuth2TokenPersistence

public interface OAuth2Token
extends Serializable

Contains all relevant data for a token. OAuth2Token implementations should be Serializable to facilitate cluster storage and caching across the various phases of OAuth 2.0 flows. OAuth2Tokens are stored in the OAuth2Store, they may be held in memory or in another persistence layer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OAuth2Token.Type

Method Summary

Methods

Modifier and Type	Method and Description
long	getExpiresAt() issuedAt + expires_in or 0 if no expires_in was sent by server
String	getGadgetUri()
long	getIssuedAt() Used for creating MAC token nonces
String	getMacAlgorithm() For use with the MAC token specification.
String	getMacExt() For use with the MAC token specification.
byte[]	getMacSecret() For use with the MAC token specification.
Map<String,String>	getProperties() Contains any additional properties sent on the token.
String	getScope() See http://tools.ietf.org/html/draft-ietf-oauth-v2-21#section-3.3
byte[]	getSecret()
String	getServiceName()
String	getTokenType()
OAuth2Token.Type	getType()
String	getUser()
void	setExpiresAt(long expiresAt) Setter for expiresAt field
void	setGadgetUri(String gadgetUri) Setter for gadgetUri field
void	setIssuedAt(long issuedAt) Setter for issuedAt field
void	setMacAlgorithm(String algorithm) For use with the MAC token specification.
void	setMacSecret(byte[] secret) For use with the MAC token specification.
void	setProperties(Map<String,String> properties) Set the properties on the token
void	setScope(String scope) Setter for scope field
void	setSecret(byte[] secret) Setter for secret property
void	setServiceName(String serviceName) Setter for serviceName field
void	setTokenType(String tokenType) Setter for tokenType property
void	setType(OAuth2Token.Type type) Setter for type property
void	setUser(String user) Setter for user property

Method Detail

getIssuedAt

long getIssuedAt()

Used for creating MAC token nonces

Returns:

the time (in milliseconds) when the token was issued

getExpiresAt

long getExpiresAt()

issuedAt + expires_in or 0 if no expires_in was sent by server

Returns:

the time (in milliseconds) when the token expires

getGadgetUri

String getGadgetUri()

Returns:

uri of the gadget the token applies to

getMacAlgorithm

String getMacAlgorithm()

For use with the MAC token specification. See See http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05

Returns:

the Mac algorithm

getMacExt

String getMacExt()

For use with the MAC token specification. See See http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05

Returns:

the mac ext

getMacSecret

byte[] getMacSecret()

For use with the MAC token specification. See See http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05

Returns:

the mac secret

getProperties

Map<String,String> getProperties()

Contains any additional properties sent on the token.

Returns:

properties sent on the token

getScope

String getScope()

See http://tools.ietf.org/html/draft-ietf-oauth-v2-21#section-3.3

Returns:

scope the token applies to, or "" for no scope

getSecret

byte[] getSecret()

Returns:

the token secret (unencrypted or signed)

getServiceName

String getServiceName()

Returns:

serviceName (in gadget spec) the token applies to

getTokenType

String getTokenType()

Returns:

type of this token e.g. "Bearer"

getType

OAuth2Token.Type getType()

Returns:

if this is an Type.ACCESS or Type.REFRESH token

getUser

String getUser()

Returns:

shindig user the token was issued for

setExpiresAt

void setExpiresAt(long expiresAt)

Setter for expiresAt field

Parameters:

expiresIn -

setGadgetUri

void setGadgetUri(String gadgetUri)

Setter for gadgetUri field

Parameters:

gadgetUri -

setIssuedAt

void setIssuedAt(long issuedAt)

Setter for issuedAt field

Parameters:

expiresIn -

setMacAlgorithm

void setMacAlgorithm(String algorithm)

For use with the MAC token specification. See See http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05

setMacSecret

void setMacSecret(byte[] secret)
                  throws OAuth2RequestException

For use with the MAC token specification. See See http://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-05

Throws:

OAuth2RequestException

setProperties

void setProperties(Map<String,String> properties)

Set the properties on the token

setScope

void setScope(String scope)

Setter for scope field

setSecret

void setSecret(byte[] secret)
               throws OAuth2RequestException

Setter for secret property

Parameters:

secret -

Throws:

OAuth2RequestException

setServiceName

void setServiceName(String serviceName)

Setter for serviceName field

Parameters:

serviceName -

setTokenType

void setTokenType(String tokenType)

Setter for tokenType property

Parameters:

tokenType -

setType

void setType(OAuth2Token.Type type)

Setter for type property

Parameters:

type -

setUser

void setUser(String user)

Setter for user property

Parameters:

user -