com.adaptris.core.services.exception

Class ThrowExceptionService

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.exception.ThrowExceptionService

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Throw an exception based on some configured criteria",
                  tag="service,error-handling")
public class ThrowExceptionService
extends ServiceImp

Throws an exception based on a configurable set of criteria.

Use this service as part of a workflow to throw an exception at a time and place of your choosing (rather than when the exception actually occurs perhaps). The ServiceException is generated by concrete implementations of ExceptionGenerator; if the generated exception is null, then no exception is thrown.

See Also:

ExceptionGenerator

In the adapter configuration file this class is aliased as throw-exception-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 and Description
ThrowExceptionService()
ThrowExceptionService(ExceptionGenerator eg)
ThrowExceptionService(java.lang.String uniqueId, ExceptionGenerator eg)

Method Summary

Modifier and Type	Method and Description
protected void	closeService()
void	doService(AdaptrisMessage msg) Apply the service to the message.
ExceptionGenerator	getExceptionGenerator()
protected void	initService()
void	prepare() Prepare for initialisation.
void	setExceptionGenerator(ExceptionGenerator eg) How to generate the exception for throwing.

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, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

ThrowExceptionService

public ThrowExceptionService()

ThrowExceptionService

public ThrowExceptionService(ExceptionGenerator eg)

ThrowExceptionService

public ThrowExceptionService(java.lang.String uniqueId,
                             ExceptionGenerator eg)

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

initService

protected void initService()
                    throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

closeService

protected void closeService()

Specified by:

closeService in class ServiceImp

getExceptionGenerator

public ExceptionGenerator getExceptionGenerator()

setExceptionGenerator

public void setExceptionGenerator(ExceptionGenerator eg)

How to generate the exception for throwing.

Parameters:

eg - the generator.

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException