com.adaptris.core.services.cache

Class CacheServiceImpl

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.cache.CacheServiceImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

CacheServiceBase, ClearCacheService, SingleKeyCacheService

public abstract class CacheServiceImpl
extends ServiceImp
implements ConnectedService

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor and Description
CacheServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	closeService()
AdaptrisConnection	getConnection() Returns the AdaptrisConnection to use.
void	initService()
void	prepare() Prepare for initialisation.
protected Cache	retrieveCache()
void	setConnection(AdaptrisConnection cacheConnection) Set the connection associated with this cache service.
void	start() Starts the component.
void	stop() Stop the component
<T extends CacheServiceImpl> T	withConnection(AdaptrisConnection c)

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, doService, 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

CacheServiceImpl

public CacheServiceImpl()

Method Detail

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Specified by:

prepare in interface ComponentLifecycleExtension

Throws:

CoreException

closeService

public void closeService()

Specified by:

closeService in class ServiceImp

initService

public 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

retrieveCache

protected Cache retrieveCache()

getConnection

public AdaptrisConnection getConnection()

Description copied from interface: ConnectedService

Returns the AdaptrisConnection to use.

Specified by:

getConnection in interface ConnectedService

Returns:

the AdaptrisConnection

setConnection

public void setConnection(AdaptrisConnection cacheConnection)

Set the connection associated with this cache service.

Specified by:

setConnection in interface ConnectedService

Parameters:

cacheConnection - the AdaptrisConnection to use

See Also:

CacheConnection, SharedConnection

withConnection

public <T extends CacheServiceImpl> T withConnection(AdaptrisConnection c)