org.apache.camel.reifier

Class RouteReifier

java.lang.Object

org.apache.camel.reifier.AbstractReifier

org.apache.camel.reifier.ProcessorReifier<RouteDefinition>

org.apache.camel.reifier.RouteReifier

public class RouteReifier
extends ProcessorReifier<RouteDefinition>

Field Summary

Fields inherited from class org.apache.camel.reifier.ProcessorReifier

definition, log

Fields inherited from class org.apache.camel.reifier.AbstractReifier

camelContext, routeContext

Constructor Summary

Constructors

Constructor and Description
RouteReifier(org.apache.camel.CamelContext camelContext, ProcessorDefinition<?> definition)
RouteReifier(org.apache.camel.spi.RouteContext routeContext, ProcessorDefinition<?> definition)

Method Summary

Modifier and Type	Method and Description
RouteDefinition	adviceWith(RouteBuilder builder) Advices this route with the route builder.
static RouteDefinition	adviceWith(RouteDefinition definition, org.apache.camel.CamelContext camelContext, RouteBuilder builder) Advices this route with the route builder.
org.apache.camel.Processor	createProcessor() Override this in definition class and implement logic to create the processor based on the definition model.
org.apache.camel.Route	createRoute()
protected org.apache.camel.Route	doCreateRoute(org.apache.camel.CamelContext camelContext, org.apache.camel.spi.RouteContext routeContext)
org.apache.camel.Endpoint	resolveEndpoint(String uri)

Methods inherited from class org.apache.camel.reifier.ProcessorReifier

addInterceptStrategies, addRoutes, clearReifiers, configureChild, createChildProcessor, createCompositeProcessor, createOutputsProcessor, createOutputsProcessor, createOutputsProcessorImpl, createProcessor, getConfiguredExecutorService, getConfiguredScheduledExecutorService, getId, hasOutputs, lookupExecutorServiceRef, lookupScheduledExecutorServiceRef, makeProcessor, preCreateProcessor, registerReifier, reifier, willCreateNewThreadPool, wrapChannel, wrapChannel, wrapInErrorHandler, wrapProcessor

Methods inherited from class org.apache.camel.reifier.AbstractReifier

asRef, createExpression, createExpression, createPredicate, createPredicate, or, parse, parse, parseBoolean, parseBoolean, parseFloat, parseFloat, parseInt, parseInt, parseLong, parseLong, parseString

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteReifier

public RouteReifier(org.apache.camel.spi.RouteContext routeContext,
                    ProcessorDefinition<?> definition)

RouteReifier

public RouteReifier(org.apache.camel.CamelContext camelContext,
                    ProcessorDefinition<?> definition)

Method Detail

adviceWith

public static RouteDefinition adviceWith(RouteDefinition definition,
                                         org.apache.camel.CamelContext camelContext,
                                         RouteBuilder builder)
                                  throws Exception

Advices this route with the route builder.

Important: It is recommended to only advice a given route once (you can of course advice multiple routes). If you do it multiple times, then it may not work as expected, especially when any kind of error handling is involved. The Camel team plan for Camel 3.0 to support this as internal refactorings in the routing engine is needed to support this properly.

You can use a regular RouteBuilder but the specialized AdviceWithRouteBuilder has additional features when using the advice with feature. We therefore suggest you to use the AdviceWithRouteBuilder.

The advice process will add the interceptors, on exceptions, on completions etc. configured from the route builder to this route.

This is mostly used for testing purpose to add interceptors and the likes to an existing route.

Will stop and remove the old route from camel context and add and start this new advised route.

Parameters:

definition - the model definition

camelContext - the camel context

builder - the route builder

Returns:

a new route which is this route merged with the route builder

Throws:

Exception - can be thrown from the route builder

See Also:

AdviceWithRouteBuilder

createProcessor

public org.apache.camel.Processor createProcessor()
                                           throws Exception

Description copied from class: ProcessorReifier

Override this in definition class and implement logic to create the processor based on the definition model.

Specified by:

createProcessor in class ProcessorReifier<RouteDefinition>

Throws:

Exception

createRoute

public org.apache.camel.Route createRoute()

resolveEndpoint

public org.apache.camel.Endpoint resolveEndpoint(String uri)
                                          throws org.apache.camel.NoSuchEndpointException

Throws:

org.apache.camel.NoSuchEndpointException

adviceWith

public RouteDefinition adviceWith(RouteBuilder builder)
                           throws Exception

Advices this route with the route builder.

Important: It is recommended to only advice a given route once (you can of course advice multiple routes). If you do it multiple times, then it may not work as expected, especially when any kind of error handling is involved. The Camel team plan for Camel 3.0 to support this as internal refactorings in the routing engine is needed to support this properly.

You can use a regular RouteBuilder but the specialized AdviceWithRouteBuilder has additional features when using the advice with feature. We therefore suggest you to use the AdviceWithRouteBuilder.

The advice process will add the interceptors, on exceptions, on completions etc. configured from the route builder to this route.

This is mostly used for testing purpose to add interceptors and the likes to an existing route.

Will stop and remove the old route from camel context and add and start this new advised route.

Parameters:

builder - the route builder

Returns:

a new route which is this route merged with the route builder

Throws:

Exception - can be thrown from the route builder

See Also:

AdviceWithRouteBuilder

doCreateRoute

protected org.apache.camel.Route doCreateRoute(org.apache.camel.CamelContext camelContext,
                                               org.apache.camel.spi.RouteContext routeContext)
                                        throws Exception

Throws:

Exception