Package com.adaptris.core.http.oauth

Class OauthTokenGetter

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.http.oauth.OauthTokenGetter

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, StateManagedComponent

Direct Known Subclasses:

GetAndCacheOauthToken, GetOauthToken

public abstract class OauthTokenGetter
extends ServiceImp

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor	Description
OauthTokenGetter()

Method Summary

Modifier and Type	Method	Description
protected void	closeService()
AccessTokenBuilder	getAccessTokenBuilder()
AccessTokenWriter	getAccessTokenWriter()
protected void	initService()
void	prepare()	Prepare for initialisation.
void	setAccessTokenBuilder(AccessTokenBuilder b)	Set the access token builder.
void	setAccessTokenWriter(AccessTokenWriter b)	Specify how to write the access token once it is retrieved.
void	start()	Starts the component.
void	stop()	Stop the component
protected AccessTokenWriter	tokenWriterIfNull()
protected AccessTokenWriter	tokenWriterToUse()
<T extends OauthTokenGetter> T	withAccessTokenBuilder(AccessTokenBuilder b)
<T extends OauthTokenGetter> T	withAccessTokenWriter(AccessTokenWriter b)

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

doService

Constructor Details

OauthTokenGetter

public OauthTokenGetter()

Method Details

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException

tokenWriterIfNull

protected AccessTokenWriter tokenWriterIfNull()

tokenWriterToUse

protected AccessTokenWriter tokenWriterToUse()

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

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 ServiceImp

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 ServiceImp

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

withAccessTokenBuilder

public <T extends OauthTokenGetter> T withAccessTokenBuilder(AccessTokenBuilder b)

getAccessTokenBuilder

public AccessTokenBuilder getAccessTokenBuilder()

setAccessTokenBuilder

public void setAccessTokenBuilder(AccessTokenBuilder b)

Set the access token builder.

Parameters:

b - the builder.

withAccessTokenWriter

public <T extends OauthTokenGetter> T withAccessTokenWriter(AccessTokenWriter b)

getAccessTokenWriter

public AccessTokenWriter getAccessTokenWriter()

setAccessTokenWriter

public void setAccessTokenWriter(AccessTokenWriter b)

Specify how to write the access token once it is retrieved.

Parameters:

b - the writer.