service.tut.pori.users.google

Class OAuth2Token

java.lang.Object

service.tut.pori.users.google.OAuth2Token

public class OAuth2Token
extends java.lang.Object

OAuth2 Token

Constructor Summary

Constructors

Constructor and Description
OAuth2Token()

Method Summary

Modifier and Type	Method and Description
boolean	expiresIn(long time) This returns true if the token has already expired, expires in the the given timeframe or does not have a valid expiration time
static java.util.Date	fromExpiresIn(java.lang.Long expiresIn)
java.lang.String	getAccessToken()
java.util.Date	getExpires()
java.lang.String	getRefreshToken()
static com.google.gson.Gson	getTokenGSONSerializer()
java.lang.String	getType()
boolean	isExpired() Same as calling expiresIn(0)
boolean	isValid() Note: if you want to know if this token has expired, use isExpired() instead Note: this does not validate the token stricly as defined by the OAuth2 spec (e.g.
void	setAccessToken(java.lang.String accessToken)
void	setExpires(java.util.Date expires)
void	setExpiresIn(java.lang.Long expiresIn)
void	setRefreshToken(java.lang.String refreshToken)
void	setType(java.lang.String type)
static java.lang.Long	toExpiresIn(java.util.Date expirationDate)

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2Token

public OAuth2Token()

Method Detail

getTokenGSONSerializer

public static com.google.gson.Gson getTokenGSONSerializer()

Returns:

serializer capable of properly serializing an OAuth2Token

fromExpiresIn

public static java.util.Date fromExpiresIn(java.lang.Long expiresIn)

Parameters:

expiresIn - in seconds

Returns:

the expiration date based on the given expiresIn or null if null value was passed

toExpiresIn

public static java.lang.Long toExpiresIn(java.util.Date expirationDate)

Parameters:

expirationDate -

Returns:

seconds to the expiration date (always at least 0) as designated b the expirationDate or null if null passed

isValid

public boolean isValid()

Note: if you want to know if this token has expired, use isExpired() instead Note: this does not validate the token stricly as defined by the OAuth2 spec (e.g. http://tools.ietf.org/html/draft-ietf-oauth-v2-31#section-4.2.2), This is generally because the draft seems to change ~7 times a year, and because there is an ambiguity on what to do on missing expires_in field. This class should be subclassed to provide a more accurate (provider specific) implementation if one is needed.

Returns:

true if: - the token contains an accessToken, which is NOT expired OR - ...the token contains an refreshToken

isExpired

public boolean isExpired()

Same as calling expiresIn(0)

Returns:

true if this token has expired

See Also:

expiresIn(long)

expiresIn

public boolean expiresIn(long time)

This returns true if the token has already expired, expires in the the given timeframe or does not have a valid expiration time

Parameters:

time - the timeframe in ms

Returns:

true if the token expires in the given timeframe

getAccessToken

public java.lang.String getAccessToken()

Returns:

the accessToken

setAccessToken

public void setAccessToken(java.lang.String accessToken)

Parameters:

accessToken - the accessToken to set

getRefreshToken

public java.lang.String getRefreshToken()

Returns:

the refreshToken

setRefreshToken

public void setRefreshToken(java.lang.String refreshToken)

Parameters:

refreshToken - the refreshToken to set

getExpires

public java.util.Date getExpires()

Returns:

the expires

setExpires

public void setExpires(java.util.Date expires)

Parameters:

expires - the expires to set

setExpiresIn

public void setExpiresIn(java.lang.Long expiresIn)

Parameters:

expiresIn - (in seconds)

getType

public java.lang.String getType()

Returns:

the type

setType

public void setType(java.lang.String type)

Parameters:

type - the type to set