Package com.adaptris.core.services.cache

Class RemoveKeyFromCache

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.cache.CacheServiceImpl

com.adaptris.core.services.cache.SingleKeyCacheService

com.adaptris.core.services.cache.RemoveKeyFromCache

All Implemented Interfaces:

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

@ComponentProfile(summary="Remove a key from the configured cache",
                  since="3.9.2",
                  tag="service,cache",
                  recommended=CacheConnection.class)
public class RemoveKeyFromCache
extends SingleKeyCacheService

Simplified version of RemoveFromCacheService that doesn't retrieve the value for insertion into the message.

In the adapter configuration file this class is aliased as remove-key-from-cache 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	Description
RemoveKeyFromCache()

Method Summary

Modifier and Type	Method	Description
void	doService(AdaptrisMessage msg)	Apply the service to the message.

Methods inherited from class com.adaptris.core.services.cache.SingleKeyCacheService

getKey, prepare, setKey, withKey

Methods inherited from class com.adaptris.core.services.cache.CacheServiceImpl

closeService, getConnection, initService, retrieveCache, setConnection, start, stop, withConnection

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.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.ComponentLifecycle

close, init

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Methods inherited from interface com.adaptris.core.Service

continueOnFailure, isBranching, setUniqueId

Methods inherited from interface com.adaptris.core.StateManagedComponent

changeState, requestClose, requestInit, requestStart, requestStop, retrieveComponentState

Constructor Details

RemoveKeyFromCache

public RemoveKeyFromCache()

Method Details

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Description copied from interface: Service

Apply the service to the message.

Parameters:

msg - the AdaptrisMessage to process

Throws:

ServiceException - wrapping any underlying Exceptions