com.adaptris.core.http.oauth

Class GetAndCacheOauthToken

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.http.oauth.OauthTokenGetter

com.adaptris.core.http.oauth.GetAndCacheOauthToken

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, ConnectedService, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Get a cached OAUTH token or get a token and cache it",
                  since="3.10.1",
                  tag="service,http,https,oauth",
                  recommended=CacheConnection.class)
public class GetAndCacheOauthToken
extends OauthTokenGetter
implements ConnectedService

Variation of GetOauthToken that automatically caches the AccessToken in the cache of your choosing.

If the 'key' exists in the cache, then that is retrieved, and used. If it does not, then the configured AccessTokenBuilder is used to generate the access token; which is cached against the specified key. If an expiry is available, then that's used to as the expiry for the token within the cache. Bear in mind that not all caches support a per-item-expiry; ExpiringMapCache does and by default a CacheConnection with this configured will be used.

Note that previously you would have composed a chain of services to achieve the same thing (probably involving CheckCacheService or similar); this just simplifies that chain into a single step since you almost certainly want to cache the access token.

In the adapter configuration file this class is aliased as get-and-cache-oauth-token which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor and Description
GetAndCacheOauthToken()

Method Summary

Modifier and Type	Method and Description
protected void	closeService()
void	doService(AdaptrisMessage msg) Apply the service to the message.
java.lang.String	getCacheKey()
AdaptrisConnection	getConnection() Returns the AdaptrisConnection to use.
protected void	initService()
void	prepare() Prepare for initialisation.
void	setCacheKey(java.lang.String cacheKey) Set the key to the cache.
void	setConnection(AdaptrisConnection c) The connection to the cache where tokens will be stored.
void	start() Starts the component.
void	stop() Stop the component
GetAndCacheOauthToken	withCacheKey(java.lang.String s)
GetAndCacheOauthToken	withConnection(AdaptrisConnection c)

Methods inherited from class com.adaptris.core.http.oauth.OauthTokenGetter

getAccessTokenBuilder, getAccessTokenWriter, setAccessTokenBuilder, setAccessTokenWriter, tokenWriterIfNull, tokenWriterToUse, withAccessTokenBuilder, withAccessTokenWriter

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, setUniqueId

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.Service

continueOnFailure, isBranching, setUniqueId

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Methods inherited from interface com.adaptris.core.StateManagedComponent

changeState, requestClose, requestInit, requestStart, requestStop, retrieveComponentState

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.ComponentLifecycle

close, init

Constructor Detail

GetAndCacheOauthToken

public GetAndCacheOauthToken()

Method Detail

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Specified by:

prepare in interface ComponentLifecycleExtension

Overrides:

prepare in class OauthTokenGetter

Throws:

CoreException

initService

protected void initService()
                    throws CoreException

Overrides:

initService in class OauthTokenGetter

Throws:

CoreException

start

public void start()
           throws CoreException

Description copied from interface: ComponentLifecycle

Starts the component.

Once a component is started it should be ready to process messages. In the case of AdaptrisMessageConsumer, calling start will begin message delivery.

Specified by:

start in interface ComponentLifecycle

Overrides:

start in class OauthTokenGetter

Throws:

CoreException - wrapping any underlying Exceptions

stop

public void stop()

Description copied from interface: ComponentLifecycle

Stop the component

A stopped component is not expected to be ready to process messages. In the case of AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing a RuntimeException may cause unintended consequences

Specified by:

stop in interface ComponentLifecycle

Overrides:

stop in class OauthTokenGetter

closeService

protected void closeService()

Overrides:

closeService in class OauthTokenGetter

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Description copied from interface: Service

Apply the service to the message.

Specified by:

doService in interface Service

Parameters:

msg - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions

setConnection

public void setConnection(AdaptrisConnection c)

The connection to the cache where tokens will be stored.

If not expilicitly configured, will be defaulted to ExpiringMapCache; 1 Hour + ExpirationPolicy.ACCESSED.

Specified by:

setConnection in interface ConnectedService

Parameters:

c - the AdaptrisConnection to use

getConnection

public AdaptrisConnection getConnection()

Description copied from interface: ConnectedService

Returns the AdaptrisConnection to use.

Specified by:

getConnection in interface ConnectedService

Returns:

the AdaptrisConnection

withConnection

public GetAndCacheOauthToken withConnection(AdaptrisConnection c)

getCacheKey

public java.lang.String getCacheKey()

setCacheKey

public void setCacheKey(java.lang.String cacheKey)

Set the key to the cache.

Parameters:

cacheKey - the key to the cache.

withCacheKey

public GetAndCacheOauthToken withCacheKey(java.lang.String s)