org.apache.camel.builder

Class ErrorHandlerBuilderRef

java.lang.Object

org.apache.camel.builder.ErrorHandlerBuilderSupport

org.apache.camel.builder.ErrorHandlerBuilderRef

All Implemented Interfaces:

ErrorHandlerBuilder, ErrorHandlerFactory

public class ErrorHandlerBuilderRef
extends ErrorHandlerBuilderSupport

Represents a proxy to an error handler builder which is resolved by named reference

Version:

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ERROR_HANDLER_BUILDER

Constructor Summary

Constructors

Constructor and Description
ErrorHandlerBuilderRef(String ref)

Method Summary

Methods

Modifier and Type	Method and Description
void	addErrorHandlers(RouteContext routeContext, OnExceptionDefinition exception) Adds error handler for the given exception type
ErrorHandlerBuilder	cloneBuilder() Clones this builder so each RouteBuilder has its private builder to use, to avoid changes from one RouteBuilder to influence the others.
protected void	cloneBuilder(ErrorHandlerBuilderRef other)
Processor	createErrorHandler(RouteContext routeContext, Processor processor) Creates the error handler
String	getRef()
static boolean	isErrorHandlerBuilderConfigured(String ref) Returns whether a specific error handler builder has been configured or not.
protected static ErrorHandlerFactory	lookupErrorHandlerBuilder(ModelCamelContext camelContext)
static ErrorHandlerFactory	lookupErrorHandlerBuilder(RouteContext routeContext, String ref) Lookup the error handler by the given ref
boolean	removeOnExceptionList(String id) Remove the OnExceptionList by look up the route id from the ErrorHandlerBuilder internal map
boolean	supportTransacted() Whether this error handler supports transacted exchanges.
String	toString()

Methods inherited from class org.apache.camel.builder.ErrorHandlerBuilderSupport

cloneBuilder, configure, exceptionPolicyStrategy, getErrorHandlers, getExceptionPolicyStrategy, getRouteId, setErrorHandlers, setExceptionPolicyStrategy

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ERROR_HANDLER_BUILDER

public static final String DEFAULT_ERROR_HANDLER_BUILDER

See Also:

Constant Field Values

Constructor Detail

ErrorHandlerBuilderRef

public ErrorHandlerBuilderRef(String ref)

Method Detail

addErrorHandlers

public void addErrorHandlers(RouteContext routeContext,
                    OnExceptionDefinition exception)

Description copied from interface: ErrorHandlerBuilder

Adds error handler for the given exception type

Specified by:

addErrorHandlers in interface ErrorHandlerBuilder

Overrides:

addErrorHandlers in class ErrorHandlerBuilderSupport

Parameters:

routeContext - the route context

exception - the exception to handle

removeOnExceptionList

public boolean removeOnExceptionList(String id)

Description copied from class: ErrorHandlerBuilderSupport

Remove the OnExceptionList by look up the route id from the ErrorHandlerBuilder internal map

Overrides:

removeOnExceptionList in class ErrorHandlerBuilderSupport

Parameters:

id - the route id

Returns:

true if the route context is found and removed

createErrorHandler

public Processor createErrorHandler(RouteContext routeContext,
                           Processor processor)
                             throws Exception

Description copied from interface: ErrorHandlerFactory

Creates the error handler

Parameters:

routeContext - the route context

processor - the outer processor

Returns:

the error handler

Throws:

Exception - is thrown if the error handler could not be created

supportTransacted

public boolean supportTransacted()

Description copied from interface: ErrorHandlerBuilder

Whether this error handler supports transacted exchanges.

cloneBuilder

public ErrorHandlerBuilder cloneBuilder()

Description copied from interface: ErrorHandlerBuilder

Clones this builder so each RouteBuilder has its private builder to use, to avoid changes from one RouteBuilder to influence the others.

This is needed by the current Camel 2.x architecture.

Returns:

a clone of this ErrorHandlerBuilder

cloneBuilder

protected void cloneBuilder(ErrorHandlerBuilderRef other)

lookupErrorHandlerBuilder

public static ErrorHandlerFactory lookupErrorHandlerBuilder(RouteContext routeContext,
                                            String ref)

Lookup the error handler by the given ref

Parameters:

routeContext - the route context

ref - reference id for the error handler

Returns:

the error handler

lookupErrorHandlerBuilder

protected static ErrorHandlerFactory lookupErrorHandlerBuilder(ModelCamelContext camelContext)

isErrorHandlerBuilderConfigured

public static boolean isErrorHandlerBuilderConfigured(String ref)

Returns whether a specific error handler builder has been configured or not.

Can be used to test if none has been configured and then install a custom error handler builder replacing the default error handler (that would have been used as fallback otherwise).
This is for instance used by the transacted policy to setup a TransactedErrorHandlerBuilder in camel-spring.

getRef

public String getRef()

toString

public String toString()

Overrides:

toString in class Object