RemoveFromCacheService (Interlok Core/Base)

java.lang.Object
- com.adaptris.core.ServiceImp
- - com.adaptris.core.services.cache.CacheServiceImpl
  - - com.adaptris.core.services.cache.CacheServiceBase
    - - com.adaptris.core.services.cache.RetrieveFromCacheService
      - com.adaptris.core.services.cache.RemoveFromCacheService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, ConnectedService, MessageEventGenerator, Service, StateManagedComponent
```
@ComponentProfile(summary="Retrieve values from a cache, and remove those values from the cache",
                  tag="service,cache",
                  recommended=CacheConnection.class)
public class RemoveFromCacheService
extends RetrieveFromCacheService
```
Service that retrieves an item from the cache and then removes it

In the adapter configuration file this class is aliased as remove-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

RemoveFromCacheService()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`doService(AdaptrisMessage msg)`	Retrieves the item from the cache, stores it against the message and then removes it from the cache

Methods inherited from class com.adaptris.core.services.cache.RetrieveFromCacheService
getExceptionIfNotFound, setExceptionIfNotFound

Methods inherited from class com.adaptris.core.services.cache.CacheServiceBase
addCacheEntryEvaluator, addCacheValueToMessage, getCacheEntryEvaluators, setCacheEntryEvaluators

Methods inherited from class com.adaptris.core.services.cache.CacheServiceImpl
closeService, getConnection, initService, prepare, 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 Detail
  - RemoveFromCacheService
```
public RemoveFromCacheService()
```
- Method Detail
  - doService
```
public void doService(AdaptrisMessage msg)
               throws ServiceException
```
    Retrieves the item from the cache, stores it against the message and then removes it from the cache
    
    Specified by:
    
    doService in interface Service
    
    Overrides:
    
    doService in class RetrieveFromCacheService
    
    Parameters:
    
    msg - the AdaptrisMessage to process
    
    Throws:
    
    ServiceException - wrapping any underlying Exceptions
    
    See Also:
    
    RetrieveFromCacheService.doService(com.adaptris.core.AdaptrisMessage)