Package org.apache.camel.model

Class CatchDefinition

java.lang.Object

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

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

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

org.apache.camel.model.CatchDefinition

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

@Metadata(label="error")
public class CatchDefinition
extends OutputDefinition<CatchDefinition>

Catches exceptions as part of a try, catch, finally block

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
	CatchDefinition()
	CatchDefinition(Class<? extends Throwable> exceptionType)
	CatchDefinition(List<Class<? extends Throwable>> exceptionClasses)
protected	CatchDefinition(CatchDefinition source)

Method Summary

Modifier and Type	Method	Description
boolean	acceptDebugger(org.apache.camel.Exchange exchange)
CatchDefinition	copyDefinition()	Makes a copy of this definition.
CatchDefinition	exception(Class<? extends Throwable> exception)	The exception(s) to catch.
final CatchDefinition	exception(Class<? extends Throwable>... exceptions)	The exception(s) to catch.
CatchDefinition	exception(Class<? extends Throwable> exception1, Class<? extends Throwable> exception2)	The exception(s) to catch.
CatchDefinition	exception(Class<? extends Throwable> exception1, Class<? extends Throwable> exception2, Class<? extends Throwable> exception3)	The exception(s) to catch.
CatchDefinition	exception(List<Class<? extends Throwable>> exceptions)	The exception(s) to catch.
List<Class<? extends Throwable>>	getExceptionClasses()
List<String>	getExceptions()
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()
CatchDefinition	onWhen(org.apache.camel.Predicate predicate)	Sets an additional predicate that should be true before the onCatch is triggered.
void	setExceptionClasses(List<Class<? extends Throwable>> exceptionClasses)
void	setExceptions(List<String> exceptions)
void	setOnWhen(OnWhenDefinition onWhen)
void	setOutputs(List<ProcessorDefinition<?>> outputs)
String	toString()

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, isAbstract, isTopLevelOnly, 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

Constructor Details

CatchDefinition

public CatchDefinition()

CatchDefinition

protected CatchDefinition(CatchDefinition source)

CatchDefinition

public CatchDefinition(List<Class<? extends Throwable>> exceptionClasses)

CatchDefinition

public CatchDefinition(Class<? extends Throwable> exceptionType)

Method Details

copyDefinition

public CatchDefinition copyDefinition()

Description copied from interface: CopyableDefinition

Makes a copy of this definition.

Specified by:

copyDefinition in interface CopyableDefinition<ProcessorDefinition>

Overrides:

copyDefinition in class OutputDefinition<CatchDefinition>

toString

public String toString()

Overrides:

toString in class OutputDefinition<CatchDefinition>

getShortName

public String getShortName()

Specified by:

getShortName in interface org.apache.camel.NamedNode

Overrides:

getShortName in class OutputDefinition<CatchDefinition>

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<CatchDefinition>

getOutputs

public List<ProcessorDefinition<?>> getOutputs()

Description copied from interface: OutputNode

Gets the outputs

Specified by:

getOutputs in interface OutputNode

Overrides:

getOutputs in class OutputDefinition<CatchDefinition>

setOutputs

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

Overrides:

setOutputs in class OutputDefinition<CatchDefinition>

getExceptionClasses

public List<Class<? extends Throwable>> getExceptionClasses()

setExceptionClasses

public void setExceptionClasses(List<Class<? extends Throwable>> exceptionClasses)

acceptDebugger

public boolean acceptDebugger(org.apache.camel.Exchange exchange)

exception

public CatchDefinition exception(Class<? extends Throwable> exception)

The exception(s) to catch.

Parameters:

exception - one or more exceptions

Returns:

the builder

exception

public CatchDefinition exception(Class<? extends Throwable> exception1,
 Class<? extends Throwable> exception2)

The exception(s) to catch.

Parameters:

exception1 - fist exception

exception2 - second exception

Returns:

the builder

exception

public CatchDefinition exception(Class<? extends Throwable> exception1,
 Class<? extends Throwable> exception2,
 Class<? extends Throwable> exception3)

The exception(s) to catch.

Parameters:

exception1 - fist exception

exception2 - second exception

exception3 - third exception

Returns:

the builder

exception

@SafeVarargs
public final CatchDefinition exception(Class<? extends Throwable>... exceptions)

The exception(s) to catch.

Parameters:

exceptions - one or more exceptions

Returns:

the builder

exception

public CatchDefinition exception(List<Class<? extends Throwable>> exceptions)

The exception(s) to catch.

Parameters:

exceptions - one or more exceptions

Returns:

the builder

onWhen

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

Sets an additional predicate that should be true before the onCatch is triggered.

To be used for fine grained controlling whether a thrown exception should be intercepted by this exception type or not.

Parameters:

predicate - predicate that determines true or false

Returns:

the builder

getExceptions

public List<String> getExceptions()

setExceptions

public void setExceptions(List<String> exceptions)

getOnWhen

public OnWhenDefinition getOnWhen()

setOnWhen

public void setOnWhen(OnWhenDefinition onWhen)