Package org.apache.camel.model

Class InterceptDefinition

java.lang.Object

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

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

org.apache.camel.model.OutputDefinition<InterceptDefinition>

org.apache.camel.model.InterceptDefinition

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, Block, CopyableDefinition<ProcessorDefinition>, DisabledAwareDefinition, OutputNode, org.apache.camel.NamedNode, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware

Direct Known Subclasses:

InterceptFromDefinition

@Metadata(label="configuration")
public class InterceptDefinition
extends OutputDefinition<InterceptDefinition>

Intercepts a message at each step in the route

Field Summary

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

outputs

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

disabled

Constructor Summary

Constructors

Modifier	Constructor	Description
	InterceptDefinition()
protected	InterceptDefinition(InterceptDefinition source)

Method Summary

Modifier and Type	Method	Description
InterceptDefinition	copyDefinition()	Makes a copy of this definition.
String	getLabel()	Returns a label to describe this node such as the expression if some kind of expression node
OnWhenDefinition	getOnWhen()
List<ProcessorDefinition<?>>	getOutputs()	Gets the outputs
String	getShortName()
boolean	isAbstract()	Whether this model is abstract or not.
boolean	isTopLevelOnly()	Whether this definition can only be added as top-level directly on the route itself (such as onException,onCompletion,intercept, etc.)
InterceptDefinition	onWhen(org.apache.camel.Predicate predicate)	Applies this interceptor only if the given predicate is true
void	setOnWhen(OnWhenDefinition onWhen)
void	setOutputs(List<ProcessorDefinition<?>> outputs)
String	toString()
InterceptDefinition	when(org.apache.camel.Predicate predicate)	Deprecated. use onWhen(Predicate)

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, configureChild, convertBodyTo, convertBodyTo, convertBodyTo, convertHeaderTo, convertHeaderTo, convertHeaderTo, convertHeaderTo, convertVariableTo, convertVariableTo, convertVariableTo, convertVariableTo, delay, delay, delay, description, disabled, disabled, disabled, doTry, dynamicRouter, dynamicRouter, end, endChoice, endCircuitBreaker, endDoCatch, endDoTry, endParent, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getDisabled, getIndex, getInheritErrorHandler, getInterceptStrategies, getParent, getRouteConfiguration, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, isWrappingEntireOutput, kamelet, loadBalance, loadBalance, log, log, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, nodePrefixId, onCompletion, onException, onException, onException, onException, pausable, pausable, pausable, pausable, pipeline, pipeline, pipeline, policy, policy, poll, poll, poll, poll, poll, poll, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollV, preCreateProcessor, process, process, process, recipientList, recipientList, recipientList, recipientList, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, removeVariable, resequence, resequence, resumable, resumable, resumable, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setDisabled, setExchangePattern, setExchangePattern, setHeader, setHeader, setHeader, setHeaders, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, setRouteConfiguration, setVariable, setVariable, setVariable, setVariables, 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, toD, toD, toD, toD, toD, toD, toD, toD, toD, toF, tokenize, toV, transacted, transacted, transform, transform, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap

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

getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, getNodePrefixId, 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

Methods inherited from interface org.apache.camel.NamedNode

acceptDebugger

Constructor Details

InterceptDefinition

public InterceptDefinition()

InterceptDefinition

protected InterceptDefinition(InterceptDefinition source)

Method Details

copyDefinition

public InterceptDefinition copyDefinition()

Description copied from interface: CopyableDefinition

Makes a copy of this definition.

Specified by:

copyDefinition in interface CopyableDefinition<ProcessorDefinition>

Overrides:

copyDefinition in class OutputDefinition<InterceptDefinition>

toString

public String toString()

Overrides:

toString in class OutputDefinition<InterceptDefinition>

getShortName

public String getShortName()

Specified by:

getShortName in interface org.apache.camel.NamedNode

Overrides:

getShortName in class OutputDefinition<InterceptDefinition>

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 ProcessorDefinition<InterceptDefinition>

isAbstract

public boolean isAbstract()

Description copied from class: ProcessorDefinition

Whether this model is abstract or not.

An abstract model is something that is used for configuring cross cutting concerns such as error handling, transaction policies, interceptors etc.

Regular definitions is what is part of the route, such as ToDefinition, WireTapDefinition and the likes.

Will by default return false to indicate regular definition, so all the abstract definitions must override this method and return true instead.

This information is used in camel-spring to let Camel work a bit on the model provided by JAXB from the Spring XML file. This is needed to handle those cross cutting concerns properly. The Java DSL does not have this issue as it can work this out directly using the fluent builder methods.

Overrides:

isAbstract in class ProcessorDefinition<InterceptDefinition>

Returns:

true for abstract, otherwise false for regular.

isTopLevelOnly

public boolean isTopLevelOnly()

Description copied from class: ProcessorDefinition

Whether this definition can only be added as top-level directly on the route itself (such as onException,onCompletion,intercept, etc.)

If trying to add a top-level only definition to a nested output would fail in the ProcessorDefinition.addOutput(ProcessorDefinition) method.

Overrides:

isTopLevelOnly in class ProcessorDefinition<InterceptDefinition>

getOutputs

public List<ProcessorDefinition<?>> getOutputs()

Description copied from interface: OutputNode

Gets the outputs

Specified by:

getOutputs in interface OutputNode

Overrides:

getOutputs in class OutputDefinition<InterceptDefinition>

setOutputs

public void setOutputs(List<ProcessorDefinition<?>> outputs)

Overrides:

setOutputs in class OutputDefinition<InterceptDefinition>

getOnWhen

public OnWhenDefinition getOnWhen()

setOnWhen

public void setOnWhen(OnWhenDefinition onWhen)

when

@Deprecated
public InterceptDefinition when(@AsPredicate
 org.apache.camel.Predicate predicate)

Deprecated.

use onWhen(Predicate)

Applies this interceptor only if the given predicate is true

Parameters:

predicate - the predicate

Returns:

the builder

onWhen

public InterceptDefinition onWhen(@AsPredicate
 org.apache.camel.Predicate predicate)

Applies this interceptor only if the given predicate is true

Parameters:

predicate - the predicate

Returns:

the builder