Package org.apache.camel.model

Class CatchDefinition

java.lang.Object

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

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

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

org.apache.camel.model.CatchDefinition

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, Block, OutputNode, org.apache.camel.NamedNode, 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

inheritErrorHandler

Constructor Summary

Constructors

Constructor	Description
CatchDefinition()
CatchDefinition(Class<? extends Throwable> exceptionType)
CatchDefinition(List<Class<? extends Throwable>> exceptionClasses)

Method Summary

Modifier and Type	Method	Description
CatchDefinition	exception(Class<? extends Throwable>... exceptions)	The exception(s) to catch.
CatchDefinition	exceptionClasses(Class<? extends Throwable> exception)	Deprecated. use exception(Class[])
CatchDefinition	exceptionClasses(List<Class<? extends Throwable>> exceptionClasses)	Deprecated. use exception(Class[])
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
WhenDefinition	getOnWhen()
List<ProcessorDefinition<?>>	getOutputs()
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(WhenDefinition 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, delay, delay, delay, 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, getIndex, getInterceptStrategies, getParent, getRouteConfiguration, id, 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, 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, preCreateProcessor, 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, 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

CatchDefinition

public CatchDefinition()

CatchDefinition

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

CatchDefinition

public CatchDefinition(Class<? extends Throwable> exceptionType)

Method Detail

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()

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)

exceptionClasses

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

Deprecated.

use exception(Class[])

The exceptions to catch.

Parameters:

exceptionClasses - a list of the exception classes

Returns:

the builder

exception

public CatchDefinition exception(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

exceptionClasses

@Deprecated
public CatchDefinition exceptionClasses(Class<? extends Throwable> exception)

Deprecated.

use exception(Class[])

Sets the exception class that the CatchType want to catch

Parameters:

exception - the exception of class

Returns:

the builder

getExceptions

public List<String> getExceptions()

setExceptions

public void setExceptions(List<String> exceptions)

getOnWhen

public WhenDefinition getOnWhen()

setOnWhen

public void setOnWhen(WhenDefinition onWhen)