com.adaptris.conditional

Class While

java.lang.Object

com.adaptris.core.ServiceImp

com.adaptris.conditional.While

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, JndiBindable, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Runs the configured service/list repeatedly \'WHILE\' the configured condition is met.",
                  tag="service, conditional")
public class While
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 continuously until the configured conditions do not evaluate to true.

You can also set a value for the maximum amount of times your services will run regardless of whether your conditions continue to evaluate to true.

  5
 

The default value for the max-loops is 10. Setting this value to 0, will loop forever until your configured conditions evaluate to false.

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

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
While()

Method Summary

Modifier and Type	Method and Description
protected void	closeService()
void	doService(AdaptrisMessage msg)
Condition	getCondition()
java.lang.Integer	getMaxLoops()
ThenService	getThen()
protected void	initService()
void	prepare()
void	setCondition(Condition condition)
void	setMaxLoops(java.lang.Integer maxLoops)
void	setThen(ThenService ifTrueService)
void	start()
void	stop()

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsConfirmation, getIsTrackingEndpoint, getLookupName, getUniqueId, init, isBranching, isConfirmation, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, rethrowServiceException, retrieveComponentState, setContinueOnFail, setIsConfirmation, setIsTrackingEndpoint, setLookupName, setUniqueId

Methods inherited from class java.lang.Object

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

Field Detail

log

protected transient org.slf4j.Logger log

Constructor Detail

While

public While()

Method Detail

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Throws:

ServiceException

prepare

public void prepare()
             throws CoreException

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

Specified by:

start in interface ComponentLifecycle

Overrides:

start in class ServiceImp

Throws:

CoreException

stop

public void stop()

Specified by:

stop in interface ComponentLifecycle

Overrides:

stop in class ServiceImp

getCondition

public Condition getCondition()

setCondition

public void setCondition(Condition condition)

getThen

public ThenService getThen()

setThen

public void setThen(ThenService ifTrueService)

getMaxLoops

public java.lang.Integer getMaxLoops()

setMaxLoops

public void setMaxLoops(java.lang.Integer maxLoops)