Package org.apache.camel.model

Class WhenDefinition

java.lang.Object

org.apache.camel.model.OptionalIdentifiedDefinition<Type>

org.apache.camel.model.ProcessorDefinition<ExpressionNode>

org.apache.camel.model.ExpressionNode

org.apache.camel.model.OutputExpressionNode

org.apache.camel.model.WhenDefinition

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, Block, HasExpressionType, OutputNode, org.apache.camel.NamedNode, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware

Direct Known Subclasses:

WhenSkipSendToEndpointDefinition

@Metadata(label="eip,routing")
@AsPredicate
public class WhenDefinition
extends OutputExpressionNode

Triggers a route when the expression evaluates to true

Field Summary

Fields inherited from class org.apache.camel.model.ProcessorDefinition

disabled, inheritErrorHandler

Constructor Summary

Constructors

Constructor	Description
WhenDefinition()
WhenDefinition(ExpressionDefinition expression)
WhenDefinition(org.apache.camel.Predicate predicate)

Method Summary

Modifier and Type	Method	Description
protected String	description()
ProcessorDefinition<?>	endParent()	Strategy to allow ProcessorDefinitions to have special logic when using end() in the DSL to return back to the intended parent.
String	getLabel()	Returns a label to describe this node such as the expression if some kind of expression node
String	getShortName()
void	setExpression(ExpressionDefinition expression)	Expression used as the predicate to evaluate whether this when should trigger and route the message or not.
String	toString()

Methods inherited from class org.apache.camel.model.OutputExpressionNode

getOutputs, setOutputs

Methods inherited from class org.apache.camel.model.ExpressionNode

configureChild, getExpression, getExpressionType, id, preCreateProcessor, setExpression, setExpressionType

Methods inherited from class org.apache.camel.model.ProcessorDefinition

addInterceptStrategy, addOutput, aggregate, aggregate, aggregate, aggregate, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, choice, circuitBreaker, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, convertBodyTo, convertBodyTo, convertBodyTo, delay, delay, delay, disabled, disabled, disabled, doTry, dynamicRouter, dynamicRouter, end, endChoice, endCircuitBreaker, endDoCatch, endDoTry, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getDisabled, getIndex, getInterceptStrategies, getParent, getRouteConfiguration, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, kamelet, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, nodePrefixId, onCompletion, onException, onException, pausable, pausable, pausable, pausable, pipeline, pipeline, pipeline, pipeline, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, process, process, process, recipientList, recipientList, recipientList, recipientList, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, resumable, resumable, resumable, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setDisabled, setExchangePattern, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, setRouteConfiguration, sort, sort, sort, split, split, split, split, startupOrder, step, step, stop, threads, threads, threads, threads, throttle, throttle, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, to, to, to, to, toD, toD, toD, toD, toD, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition

description, description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, hasCustomIdAssigned, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

WhenDefinition

public WhenDefinition()

WhenDefinition

public WhenDefinition(org.apache.camel.Predicate predicate)

WhenDefinition

public WhenDefinition(ExpressionDefinition expression)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

description

protected String description()

getShortName

public String getShortName()

getLabel

public String getLabel()

Description copied from class: ProcessorDefinition

Returns a label to describe this node such as the expression if some kind of expression node

Specified by:

getLabel in interface org.apache.camel.NamedNode

Overrides:

getLabel in class ExpressionNode

setExpression

public void setExpression(ExpressionDefinition expression)

Expression used as the predicate to evaluate whether this when should trigger and route the message or not.

Overrides:

setExpression in class ExpressionNode

endParent

public ProcessorDefinition<?> endParent()

Description copied from class: ProcessorDefinition

Strategy to allow ProcessorDefinitions to have special logic when using end() in the DSL to return back to the intended parent.

For example a content based router we return back to the ChoiceDefinition when we end() from a WhenDefinition.

Overrides:

endParent in class ProcessorDefinition<ExpressionNode>

Returns:

the end