Package com.adaptris.core.services

Class StopProcessingService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.StopProcessingService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, ConfigComment, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Marks a message so that the processing chain is terminated",
                  tag="service")
public class StopProcessingService
extends ServiceImp

This service will cause the message to not be processed any further and will also request that the Workflows producer not be called.

What happens will be dependent on the parent workflow and parent service collection implementation. See CoreConstants.STOP_PROCESSING_KEY and CoreConstants.KEY_WORKFLOW_SKIP_PRODUCER for more information.

In the adapter configuration file this class is aliased as stop-processing-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
StopProcessingService()

Method Summary

Modifier and Type	Method	Description
protected void	closeService()
void	doService(AdaptrisMessage msg)	Apply the service to the message.
protected void	initService()
void	prepare()	Prepare for initialisation.

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getComments, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setComments, setContinueOnFail, setIsTrackingEndpoint, setUniqueId, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StopProcessingService

public StopProcessingService()

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

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp