org.apache.camel.model
Class CatchDefinition

java.lang.Object
  org.apache.camel.model.OptionalIdentifiedType<Type>
      org.apache.camel.model.ProcessorDefinition<CatchDefinition>
          org.apache.camel.model.CatchDefinition

All Implemented Interfaces:

Block

public class CatchDefinition
extends ProcessorDefinition<CatchDefinition>

Represents an XML <catch/> element

Version:

$Revision: 766610 $

Field Summary

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

nodeCounters

Constructor Summary

CatchDefinition()

CatchDefinition(Class exceptionType)

CatchDefinition(List<Class> exceptionClasses)

Method Summary

protected List<Class>	createExceptionClasses()
CatchProcessor	createProcessor(RouteContext routeContext)
CatchDefinition	exceptionClasses(Class exception) Sets the exception class that the CatchType want to catch
CatchDefinition	exceptionClasses(List<Class> exceptionClasses) Sets the exceptionClasses of the CatchType
List<Class>	getExceptionClasses()
List<String>	getExceptions()
Predicate	getHandledPolicy()
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() Returns a short name for this node which can be useful for ID generation or referring to related resources like images
CatchDefinition	handled(boolean handled) Sets whether the exchange should be marked as handled or not.
CatchDefinition	handled(Expression handled) Sets whether the exchange should be marked as handled or not.
CatchDefinition	handled(Predicate handled) Sets whether the exchange should be marked as handled or not.
ExpressionClause<CatchDefinition>	onWhen() Creates an expression to configure an additional predicate that should be true before the onCatch is triggered.
CatchDefinition	onWhen(Predicate predicate) Sets an additional predicate that should be true before the onCatch is triggered.
void	setExceptionClasses(List<Class> exceptionClasses)
void	setExceptions(List<String> exceptions)
void	setHandledPolicy(Predicate handledPolicy)
void	setOnWhen(WhenDefinition onWhen)
void	setOutputs(List<ProcessorDefinition> outputs)
String	toString()

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

addInterceptStrategy, addOutput, addRoutes, aggregate, aggregate, aggregate, aggregate, aggregate, aop, bean, bean, bean, bean, beanRef, beanRef, choice, clearOutput, configureChild, convertBodyTo, convertBodyTo, createChannel, createCompositeProcessor, createErrorHandlerBuilder, createOutputsProcessor, createOutputsProcessor, delay, delay, delay, doTry, end, enrich, enrich, errorHandler, filter, filter, filter, filter, getErrorHandlerBuilder, getErrorHandlerRef, getInterceptStrategies, getNodeFactory, getParent, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, loadBalance, loadBalance, loop, loop, loop, makeProcessor, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, pipeline, pipeline, pipeline, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, process, processRef, recipientList, recipientList, removeFaultHeader, removeHeader, removeProperty, resequence, resequence, resequence, resequencer, rollback, rollback, routingSlip, routingSlip, setBody, setBody, setErrorHandlerBuilder, setErrorHandlerBuilderIfNull, setErrorHandlerRef, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setNodeFactory, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sortBody, sortBody, split, split, split, stop, threads, threads, throttle, throwException, to, to, to, to, to, to, to, to, to, to, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, wireTap, wireTap, wireTap, wrapChannel, wrapProcessor

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

createId, description, getDescription, getId, getNodeCounter, hasCustomIdAssigned, idOrCreate, setDescription, setId

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

CatchDefinition

public CatchDefinition(Class exceptionType)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getShortName

public String getShortName()

Description copied from class: OptionalIdentifiedType

Returns a short name for this node which can be useful for ID generation or referring to related resources like images

Overrides:

getShortName in class OptionalIdentifiedType<CatchDefinition>

Returns:

defaults to "node" but derived nodes should overload this to provide a unique name

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

Overrides:

getLabel in class ProcessorDefinition<CatchDefinition>

createProcessor

public CatchProcessor createProcessor(RouteContext routeContext)
                               throws Exception

Overrides:

createProcessor in class ProcessorDefinition<CatchDefinition>

Throws:

Exception

getOutputs

public List<ProcessorDefinition> getOutputs()

Specified by:

getOutputs in class ProcessorDefinition<CatchDefinition>

setOutputs

public void setOutputs(List<ProcessorDefinition> outputs)

getExceptionClasses

public List<Class> getExceptionClasses()

setExceptionClasses

public void setExceptionClasses(List<Class> exceptionClasses)

exceptionClasses

public CatchDefinition exceptionClasses(List<Class> exceptionClasses)

Sets the exceptionClasses of the CatchType

Parameters:

exceptionClasses - a list of the exception classes

Returns:

the builder

onWhen

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

onWhen

public ExpressionClause<CatchDefinition> onWhen()

Creates an expression to configure 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.

Returns:

the expression clause to configure

handled

public CatchDefinition handled(boolean handled)

Sets whether the exchange should be marked as handled or not.

Parameters:

handled - handled or not

Returns:

the builder

handled

public CatchDefinition handled(Predicate handled)

Sets whether the exchange should be marked as handled or not.

Parameters:

handled - predicate that determines true or false

Returns:

the builder

handled

public CatchDefinition handled(Expression handled)

Sets whether the exchange should be marked as handled or not.

Parameters:

handled - expression that determines true or false

Returns:

the builder

exceptionClasses

public CatchDefinition exceptionClasses(Class exception)

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)

getHandledPolicy

public Predicate getHandledPolicy()

setHandledPolicy

public void setHandledPolicy(Predicate handledPolicy)

createExceptionClasses

protected List<Class> createExceptionClasses()