org.exoplatform.moxtra.oauth2

Class AccessToken

java.lang.Object

org.exoplatform.moxtra.oauth2.AccessToken

public class AccessToken
extends Object

OAuth2 token data (access and refresh tokens).
Created by The eXo Platform SAS

Version:

$Id: UserToken.java 00000 Mar 25, 2015 pnedonosko $

Author:

Peter Nedonosko

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AccessToken() Create empty store.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(AccessTokenRefreshListener listener, boolean fireNow) Add listener to this access token.
static AccessToken	copyToken(AccessToken otherToken) Create a copy of existing token object but without registered in it listeners.
static AccessToken	createToken(String accessToken, String refreshToken, Long expiresInSeconds, String scope) Init token from existing data.
protected void	fireListeners()
String	getAccessToken()
Calendar	getExpirationTime()
String	getRefreshToken()
String	getScope()
void	init(String accessToken, String refreshToken, Long expiresInSeconds, String scope) Set new OAuth2 token data and fire registered listeners.
boolean	isExpired() Return true if access token expired and should be renewed.
boolean	isExpired(Calendar toDate) Return true if access token expired to given date.
boolean	isInitialized() Return true if this instance of AccessToken initialized with access token.
void	load(String accessToken, String refreshToken, Calendar expirationTime, String scope) Load OAuth2 token from given data.
void	merge(AccessToken newToken) Import OAuth2 tokens from a new AccessToken and unregister listeners of that instance.
static AccessToken	newToken() Create empty not initialized token object.
void	removeListener(AccessTokenRefreshListener listener)
protected void	removeListeners()

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessToken

protected AccessToken()

Create empty store.

Parameters:

id -

Method Detail

newToken

public static AccessToken newToken()

Create empty not initialized token object. Use #init(String, String, long, String) to set access data to the object.

Returns:

AccessToken

createToken

public static AccessToken createToken(String accessToken,
                      String refreshToken,
                      Long expiresInSeconds,
                      String scope)

Init token from existing data.

Parameters:

accessToken -

refreshToken -

expiresInSeconds -

scope -

Returns:

AccessToken

copyToken

public static AccessToken copyToken(AccessToken otherToken)

Create a copy of existing token object but without registered in it listeners.

Parameters:

otherToken - AccessToken

Returns:

AccessToken

addListener

public void addListener(AccessTokenRefreshListener listener,
               boolean fireNow)

Add listener to this access token. Optionally fire this listener immediately.

Parameters:

listener - AccessTokenRefreshListener

fireNow - boolean if true fire given listener on this access token

removeListener

public void removeListener(AccessTokenRefreshListener listener)

getAccessToken

public String getAccessToken()

Returns:

the accessToken

getRefreshToken

public String getRefreshToken()

Returns:

the refreshToken, can be null

getExpirationTime

public Calendar getExpirationTime()

Returns:

the expirationTime

getScope

public String getScope()

Returns:

the scope, can be null

merge

public void merge(AccessToken newToken)

Import OAuth2 tokens from a new AccessToken and unregister listeners of that instance.

Parameters:

newToken - AccessToken

Throws:

CloudDriveException

init

public void init(String accessToken,
        String refreshToken,
        Long expiresInSeconds,
        String scope)

Set new OAuth2 token data and fire registered listeners.

Parameters:

accessToken -

refreshToken -

expiresInSeconds - Long when token expires in seconds

scope -

load

public void load(String accessToken,
        String refreshToken,
        Calendar expirationTime,
        String scope)

Load OAuth2 token from given data.

Parameters:

accessToken -

refreshToken -

expirationTime - Calendar

scope -

isExpired

public boolean isExpired()

Return true if access token expired and should be renewed.

Returns:

true if expired, false otherwise

isExpired

public boolean isExpired(Calendar toDate)

Return true if access token expired to given date.

Parameters:

toDate - Calendar some date to check if this token will be expired after it

Returns:

true if expired, false otherwise

isInitialized

public boolean isInitialized()

Return true if this instance of AccessToken initialized with access token.

Returns:

true if initialized, false otherwise

removeListeners

protected void removeListeners()

fireListeners

protected void fireListeners()