com.adaptris.core.services.conditional

Class IfElse

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.core.services.conditional.IfElse

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Runs the configured service/list \'IF\' the configured condition is met, otherwise will run the \'else\' service/list.",
                  tag="service, conditional",
                  since="3.7.3")
public class IfElse
extends ServiceImp

This Service allows you to test boolean (true or false) Condition's, which if evaluate to "true" will run a configured set of services, otherwise run a different set of services.

Note, that although you must specify a service or list of services should the configured conditions pass, you do not have to configure services to run should the conditions fail.

Typically your Condition will test for equality, in-line expressions or whether values exist or not. The values to test will generally come from the payload or message metadata.
Also note that some conditions can be nested, such that you can test that a value is equal to another AND / OR a value is equal/not to another value.

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor and Description
IfElse()

Method Summary

Modifier and Type	Method and Description
protected void	closeService()
protected Condition	condition()
void	doService(AdaptrisMessage msg) Apply the service to the message.
Condition	getCondition()
ElseService	getOtherwise()
ThenService	getThen()
protected void	initService()
void	prepare() Prepare for initialisation.
void	setCondition(Condition condition) Set the conditions to apply.
void	setOtherwise(ElseService elseService)
void	setThen(ThenService thenService)
void	start() Starts the component.
void	stop() Stop the component

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

IfElse

public IfElse()

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.

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

start

public void start()
           throws CoreException

Description copied from interface: ComponentLifecycle

Starts the component.

Once a component is started it should be ready to process messages. In the case of AdaptrisMessageConsumer, calling start will begin message delivery.

Specified by:

start in interface ComponentLifecycle

Overrides:

start in class ServiceImp

Throws:

CoreException - wrapping any underlying Exceptions

stop

public void stop()

Description copied from interface: ComponentLifecycle

Stop the component

A stopped component is not expected to be ready to process messages. In the case of AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing a RuntimeException may cause unintended consequences

Specified by:

stop in interface ComponentLifecycle

Overrides:

stop in class ServiceImp

getCondition

public Condition getCondition()

setCondition

public void setCondition(Condition condition)

Set the conditions to apply.

Parameters:

condition -

condition

protected Condition condition()

getThen

public ThenService getThen()

setThen

public void setThen(ThenService thenService)

getOtherwise

public ElseService getOtherwise()

setOtherwise

public void setOtherwise(ElseService elseService)