RetryStoreDeleteService (Interlok Core/Base)

java.lang.Object
- com.adaptris.core.ServiceImp
- - com.adaptris.core.http.jetty.retry.RetryStoreServiceImpl
  - - com.adaptris.core.http.jetty.retry.RetryStoreDeleteService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, StateManagedComponent
```
@ComponentProfile(summary="Delete a message from the retry store",
                  since="3.11.1",
                  tag="retry")
public class RetryStoreDeleteService
extends RetryStoreServiceImpl
```
Delete a message from the configured retry store.
While not tightly coupled it is designed as a supporting service for use with RetryFromJetty.

Since:

3.11.1

In the adapter configuration file this class is aliased as retry-store-delete-service 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

RetryStoreDeleteService()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`doService(AdaptrisMessage msg)`	Apply the service to the message.
`java.lang.String`	`getMessageId()`	The messageID to delete.
`void`	`prepare()`	Prepare for initialisation.
`void`	`setMessageId(java.lang.String messageId)`	The messageID to delete.
`RetryStoreDeleteService`	`withMessageId(java.lang.String s)`

Methods inherited from class com.adaptris.core.http.jetty.retry.RetryStoreServiceImpl
closeService, getRetryStore, initService, setRetryStore, start, stop, withRetryStore

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

- Constructor Detail
  - RetryStoreDeleteService
```
public RetryStoreDeleteService()
```
- Method Detail
  - 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
  - prepare
```
public void prepare()
             throws CoreException
```
    Description copied from interface: ComponentLifecycleExtension
    
    Prepare for initialisation.
    
    Specified by:
    
    prepare in interface ComponentLifecycleExtension
    
    Overrides:
    
    prepare in class RetryStoreServiceImpl
    
    Throws:
    
    CoreException
  - withMessageId
```
public RetryStoreDeleteService withMessageId(java.lang.String s)
```
  - getMessageId
```
public java.lang.String getMessageId()
```
    The messageID to delete.
    This supports metadata resolution via InterlokMessage.resolve(String) since it is not expected that it should be deleting the current messages unique-id.
  - setMessageId
```
public void setMessageId(java.lang.String messageId)
```
    The messageID to delete.
    This supports metadata resolution via InterlokMessage.resolve(String) since it is not expected that it should be deleting the current messages unique-id.