org.apache.camel.processor

Class CatchProcessor

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.processor.DelegateAsyncProcessor

org.apache.camel.processor.CatchProcessor

All Implemented Interfaces:

AsyncProcessor, DelegateProcessor, Navigate<Processor>, Processor, Service, ShutdownableService, HasId, IdAware, StatefulService, SuspendableService, Traceable

public class CatchProcessor
extends DelegateAsyncProcessor
implements Traceable, IdAware

A processor which catches exceptions.

Version:

Field Summary

Fields inherited from class org.apache.camel.processor.DelegateAsyncProcessor

processor

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
CatchProcessor(List<Class<? extends Throwable>> exceptions, Processor processor, Predicate onWhen, Predicate handled)

Method Summary

Modifier and Type	Method and Description
protected Throwable	catches(Exchange exchange, Throwable exception) Returns with the exception that is caught by this processor.
List<Class<? extends Throwable>>	getExceptions()
String	getId() Returns the id
String	getTraceLabel() Gets the trace label used for logging when tracing is enabled.
protected boolean	handles(Exchange exchange) Whether this catch processor handles the exception it have caught
protected boolean	matchesWhen(Exchange exchange) Strategy method for matching the exception type with the current exchange.
boolean	process(Exchange exchange, AsyncCallback callback) Processes the message exchange.
void	setId(String id) Sets the id
String	toString()

Methods inherited from class org.apache.camel.processor.DelegateAsyncProcessor

doShutdown, doStart, doStop, getProcessor, hasNext, next, process, processNext, setProcessor, setProcessor

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Constructor Detail

CatchProcessor

public CatchProcessor(List<Class<? extends Throwable>> exceptions,
                      Processor processor,
                      Predicate onWhen,
                      Predicate handled)

Method Detail

toString

public String toString()

Overrides:

toString in class DelegateAsyncProcessor

getId

public String getId()

Description copied from interface: HasId

Returns the id

Specified by:

getId in interface HasId

Returns:

the id

setId

public void setId(String id)

Description copied from interface: IdAware

Sets the id

Specified by:

setId in interface IdAware

Parameters:

id - the id

getTraceLabel

public String getTraceLabel()

Description copied from interface: Traceable

Gets the trace label used for logging when tracing is enabled.

The label should be short and precise.

Specified by:

getTraceLabel in interface Traceable

Returns:

the label

process

public boolean process(Exchange exchange,
                       AsyncCallback callback)

Description copied from interface: AsyncProcessor

Processes the message exchange. Similar to Processor.process(org.apache.camel.Exchange), but the caller supports having the exchange asynchronously processed.

If there was a failure processing then the caused Exception would be set on the Exchange.

Specified by:

process in interface AsyncProcessor

Overrides:

process in class DelegateAsyncProcessor

Parameters:

exchange - the message exchange

callback - the AsyncCallback will be invoked when the processing of the exchange is completed. If the exchange is completed synchronously, then the callback is also invoked synchronously. The callback should therefore be careful of starting recursive loop.

Returns:

(doneSync) true to continue execute synchronously, false to continue being executed asynchronously

catches

protected Throwable catches(Exchange exchange,
                            Throwable exception)

Returns with the exception that is caught by this processor. This method traverses exception causes, so sometimes the exception returned from this method might be one of causes of the parameter passed.

Parameters:

exchange - the current exchange

exception - the thrown exception

Returns:

Throwable that this processor catches. null if nothing matches.

handles

protected boolean handles(Exchange exchange)

Whether this catch processor handles the exception it have caught

Parameters:

exchange - the current exchange

Returns:

true if this processor handles it, false otherwise.

getExceptions

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

matchesWhen

protected boolean matchesWhen(Exchange exchange)

Strategy method for matching the exception type with the current exchange.

This default implementation will match as:

• Always true if no when predicate on the exception type
• Otherwise the when predicate is matches against the current exchange

Parameters:

exchange - the current Exchange

Returns:

true if matched, false otherwise.