com.buabook.exacttarget.fuelsdk

Class AutoRefreshETClient

java.lang.Object

com.exacttarget.fuelsdk.ETClient

com.buabook.exacttarget.fuelsdk.AutoRefreshETClient

public class AutoRefreshETClient
extends com.exacttarget.fuelsdk.ETClient

ETClient with Auto Refresh of Refresh Token

The default ETClient does not refresh the refresh token and, as per OAuth standards, expires after 14 days. This class extends ETClient and force refreshes the token after the configured amount of time.

NOTE: Due to the methods available to sub-classes, when the refresh token requires refreshing, 2 API calls will be made to ExactTarget. Normal access token refreshes will behave as before.

(c) 2016 Sport Trades Ltd

License GPLv3

Since:

8 Dec 2016

Version:

1.0.0

Author:

Jas Rajasansir

Field Summary

Fields

Modifier and Type	Field and Description
private static Duration	DEFAULT_REFRESH_TOKEN_LIFE
private DateTime	lastRefreshTime
private static Logger	log
private Duration	refreshTokenLife

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AutoRefreshETClient(com.exacttarget.fuelsdk.ETConfiguration configuration) Private constructor as calling this directly, without initialiseRefreshTracking(Duration), just gives you an ETClient
private	AutoRefreshETClient(String file) Private constructor as calling this directly, without initialiseRefreshTracking(Duration), just gives you an ETClient

Method Summary

Modifier and Type	Method and Description
DateTime	getLastRefreshTime()
private void	initialiseRefreshTracking(Duration refreshTokenLife)
static AutoRefreshETClient	newRefreshClient(com.exacttarget.fuelsdk.ETConfiguration configuration, Duration refreshTokenLife) Provides a functionally equivalent version of ETClient with automatic refresh of the refresh token based on the supplied duration
static AutoRefreshETClient	newRefreshClient(String file, Duration refreshTokenLife) Provides a functionally equivalent version of ETClient with automatic refresh of the refresh token based on the supplied duration
String	refreshToken() Performs the standard ETClient.refreshToken() with the added refresh of the refresh token if it has been greater than the specified duration (refreshTokenLife) since the last refresh.

Methods inherited from class com.exacttarget.fuelsdk.ETClient

autoHydrateObjects, create, create, delete, delete, delete, delete, getAccessToken, getClientId, getConfiguration, getGson, getLegacyToken, getRestConnection, getRESTConnection, getSoapConnection, getSOAPConnection, instantiate, requestToken, requestToken, retrieve, retrieve, retrieve, retrieve, retrieve, retrieve, retrieve, retrieveObject, retrieveObject, retrieveObject, retrieveObjects, retrieveObjects, retrieveObjects, retrieveObjects, retrieveObjects, retrieveObjects, retrieveObjects, update, update, update

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final Logger log

DEFAULT_REFRESH_TOKEN_LIFE

private static final Duration DEFAULT_REFRESH_TOKEN_LIFE

refreshTokenLife

private Duration refreshTokenLife

lastRefreshTime

private DateTime lastRefreshTime

Constructor Detail

AutoRefreshETClient

private AutoRefreshETClient(String file)
                     throws com.exacttarget.fuelsdk.ETSdkException

Private constructor as calling this directly, without initialiseRefreshTracking(Duration), just gives you an ETClient

Throws:

com.exacttarget.fuelsdk.ETSdkException

AutoRefreshETClient

private AutoRefreshETClient(com.exacttarget.fuelsdk.ETConfiguration configuration)
                     throws com.exacttarget.fuelsdk.ETSdkException

Private constructor as calling this directly, without initialiseRefreshTracking(Duration), just gives you an ETClient

Throws:

com.exacttarget.fuelsdk.ETSdkException

Method Detail

newRefreshClient

public static AutoRefreshETClient newRefreshClient(String file,
                                                   Duration refreshTokenLife)
                                            throws com.exacttarget.fuelsdk.ETSdkException

Provides a functionally equivalent version of ETClient with automatic refresh of the refresh token based on the supplied duration

Parameters:

refreshTokenLife - The duration between refresh token refreshes. Pass null to use the default (DEFAULT_REFRESH_TOKEN_LIFE)

Returns:

A new client with auto refresh of the refresh token enabled

Throws:

com.exacttarget.fuelsdk.ETSdkException

See Also:

ETClient.ETClient(String)

newRefreshClient

public static AutoRefreshETClient newRefreshClient(com.exacttarget.fuelsdk.ETConfiguration configuration,
                                                   Duration refreshTokenLife)
                                            throws com.exacttarget.fuelsdk.ETSdkException

Provides a functionally equivalent version of ETClient with automatic refresh of the refresh token based on the supplied duration

Parameters:

refreshTokenLife - The duration between refresh token refreshes. Pass null to use the default (DEFAULT_REFRESH_TOKEN_LIFE)

Returns:

A new client with auto refresh of the refresh token enabled

Throws:

com.exacttarget.fuelsdk.ETSdkException

See Also:

ETClient.ETClient(ETConfiguration)

refreshToken

public String refreshToken()
                    throws com.exacttarget.fuelsdk.ETSdkException

Performs the standard ETClient.refreshToken() with the added refresh of the refresh token if it has been greater than the specified duration (refreshTokenLife) since the last refresh.

Overrides:

refreshToken in class com.exacttarget.fuelsdk.ETClient

Throws:

com.exacttarget.fuelsdk.ETSdkException

getLastRefreshTime

public DateTime getLastRefreshTime()

initialiseRefreshTracking

private void initialiseRefreshTracking(Duration refreshTokenLife)
                                throws IllegalArgumentException

Throws:

IllegalArgumentException