org.apache.camel.builder

Class RouteBuilder

java.lang.Object

org.apache.camel.builder.BuilderSupport

org.apache.camel.builder.RouteBuilder

All Implemented Interfaces:

org.apache.camel.Ordered, org.apache.camel.RoutesBuilder

Direct Known Subclasses:

AdviceWithRouteBuilder

public abstract class RouteBuilder
extends BuilderSupport
implements org.apache.camel.RoutesBuilder, org.apache.camel.Ordered

A Java DSL which is used to build Route instances in a CamelContext for smart routing.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Fields inherited from interface org.apache.camel.Ordered

HIGHEST, LOWEST

Constructor Summary

Constructors

Constructor and Description
RouteBuilder()
RouteBuilder(org.apache.camel.CamelContext context)

Method Summary

Modifier and Type	Method and Description
void	addLifecycleInterceptor(RouteBuilderLifecycleStrategy interceptor) Adds the given RouteBuilderLifecycleStrategy to be used.
static void	addRoutes(org.apache.camel.CamelContext context, org.apache.camel.util.function.ThrowingConsumer<RouteBuilder,Exception> rbc) Add routes to a context using a lambda expression.
void	addRoutesToCamelContext(org.apache.camel.CamelContext context)
void	bindToRegistry(String id, Class<?> type, Object bean) Binds the bean to the repository (if possible).
void	bindToRegistry(String id, Object bean) Binds the bean to the repository (if possible).
protected void	checkInitialized()
abstract void	configure() Called on initialization to build the routes using the fluent builder syntax. This is a central method for RouteBuilder implementations to implement the routes using the Java fluent builder syntax.
protected void	configureRest(RestDefinition rest)
RestsDefinition	configureRests(org.apache.camel.CamelContext context) Configures the rests
protected void	configureRoute(RouteDefinition route)
RoutesDefinition	configureRoutes(org.apache.camel.CamelContext context) Configures the routes
void	errorHandler(ErrorHandlerBuilder errorHandlerBuilder) Installs the given error handler builder
RouteDefinition	from(org.apache.camel.Endpoint endpoint) Creates a new route from the given endpoint
RouteDefinition	from(EndpointConsumerBuilder endpointDefinition)
RouteDefinition	from(String uri) Creates a new route from the given URI input
RouteDefinition	fromF(String uri, Object... args) Creates a new route from the given URI input
int	getOrder() Override this method to define ordering of RouteBuilder classes that are added to Camel from various runtimes such as camel-main, camel-spring-boot.
RestsDefinition	getRestCollection()
Map<String,RestConfigurationDefinition>	getRestConfigurations()
RoutesDefinition	getRouteCollection()
InterceptDefinition	intercept() Adds a route for an interceptor that intercepts every processing step.
InterceptFromDefinition	interceptFrom() Adds a route for an interceptor that intercepts incoming messages on any inputs in this route
InterceptFromDefinition	interceptFrom(String uri) Adds a route for an interceptor that intercepts incoming messages on the given endpoint.
InterceptSendToEndpointDefinition	interceptSendToEndpoint(String uri) Applies a route for an interceptor if an exchange is send to the given endpoint
OnCompletionDefinition	onCompletion() On completion callback for doing custom routing when the Exchange is complete.
OnExceptionDefinition	onException(Class<? extends Throwable>... exceptions) Exception clause for catching certain exceptions and handling them.
OnExceptionDefinition	onException(Class<? extends Throwable> exception) Exception clause for catching certain exceptions and handling them.
protected void	populateRests()
protected void	populateRoutes()
protected void	populateTransformers()
protected void	populateValidators()
<T> T	propertyInject(String key, Class<T> type) Injects a property placeholder value with the given key converted to the given type.
void	removeLifecycleInterceptor(RouteBuilderLifecycleStrategy interceptor) Adds the given RouteBuilderLifecycleStrategy.
RestDefinition	rest() Creates a new REST service
RestDefinition	rest(String path) Creates a new REST service
RestConfigurationDefinition	restConfiguration() Configures the REST services
RestConfigurationDefinition	restConfiguration(String component) Configures the REST service for the given component
void	setErrorHandlerBuilder(ErrorHandlerBuilder errorHandlerBuilder) Sets the error handler to use with processors created by this builder
void	setRestCollection(RestsDefinition restCollection)
void	setRouteCollection(RoutesDefinition routeCollection)
String	toString()
TransformerBuilder	transformer() Create a new TransformerBuilder.
ValidatorBuilder	validator() Create a new ValidatorBuilder.

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

body, bodyAs, constant, createErrorHandlerBuilder, deadLetterChannel, deadLetterChannel, defaultErrorHandler, endpoint, endpoint, endpoints, endpoints, exceptionMessage, exchangeProperty, getContext, getErrorHandlerBuilder, header, jsonpath, jsonpath, language, method, method, method, method, noErrorHandler, regexReplaceAll, regexReplaceAll, setContext, simple, simple, simpleF, simpleF, systemProperty, systemProperty, xpath, xpath, xpath, xpath

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.slf4j.Logger log

Constructor Detail

RouteBuilder

public RouteBuilder()

RouteBuilder

public RouteBuilder(org.apache.camel.CamelContext context)

Method Detail

getOrder

public int getOrder()

Override this method to define ordering of RouteBuilder classes that are added to Camel from various runtimes such as camel-main, camel-spring-boot. This allows end users to control the ordering if some routes must be added and started before others.

Use low numbers for higher priority. Normally the sorting will start from 0 and move upwards. So if you want to be last then use Integer.MAX_VALUE or eg Ordered.LOWEST.

Specified by:

getOrder in interface org.apache.camel.Ordered

addRoutes

public static void addRoutes(org.apache.camel.CamelContext context,
                             org.apache.camel.util.function.ThrowingConsumer<RouteBuilder,Exception> rbc)
                      throws Exception

Add routes to a context using a lambda expression. It can be used as following:

 RouteBuilder.addRoutes(context, rb ->
     rb.from("direct:inbound").bean(ProduceTemplateBean.class)));
 

Parameters:

context - the camel context to add routes

rbc - a lambda expression receiving the RouteBuilder to use to create routes

Throws:

Exception - if an error occurs

toString

public String toString()

Overrides:

toString in class Object

configure

public abstract void configure()
                        throws Exception

Called on initialization to build the routes using the fluent builder syntax.

This is a central method for RouteBuilder implementations to implement the routes using the Java fluent builder syntax.

Throws:

Exception - can be thrown during configuration

bindToRegistry

public void bindToRegistry(String id,
                           Object bean)

Binds the bean to the repository (if possible).

Parameters:

id - the id of the bean

bean - the bean

bindToRegistry

public void bindToRegistry(String id,
                           Class<?> type,
                           Object bean)

Binds the bean to the repository (if possible).

Parameters:

id - the id of the bean

type - the type of the bean to associate the binding

bean - the bean

restConfiguration

public RestConfigurationDefinition restConfiguration()

Configures the REST services

Returns:

the builder

restConfiguration

public RestConfigurationDefinition restConfiguration(String component)

Configures the REST service for the given component

Returns:

the builder

rest

public RestDefinition rest()

Creates a new REST service

Returns:

the builder

rest

public RestDefinition rest(String path)

Creates a new REST service

Parameters:

path - the base path

Returns:

the builder

transformer

public TransformerBuilder transformer()

Create a new TransformerBuilder.

Returns:

the builder

validator

public ValidatorBuilder validator()

Create a new ValidatorBuilder.

Returns:

the builder

from

public RouteDefinition from(String uri)

Creates a new route from the given URI input

Parameters:

uri - the from uri

Returns:

the builder

fromF

public RouteDefinition fromF(String uri,
                             Object... args)

Creates a new route from the given URI input

Parameters:

uri - the String formatted from uri

args - arguments for the string formatting of the uri

Returns:

the builder

from

public RouteDefinition from(org.apache.camel.Endpoint endpoint)

Creates a new route from the given endpoint

Parameters:

endpoint - the from endpoint

Returns:

the builder

from

public RouteDefinition from(EndpointConsumerBuilder endpointDefinition)

errorHandler

public void errorHandler(ErrorHandlerBuilder errorHandlerBuilder)

Installs the given error handler builder

Parameters:

errorHandlerBuilder - the error handler to be used by default for all child routes

propertyInject

public <T> T propertyInject(String key,
                            Class<T> type)
                     throws Exception

Injects a property placeholder value with the given key converted to the given type.

Parameters:

key - the property key

type - the type to convert the value as

Returns:

the value, or null if value is empty

Throws:

Exception - is thrown if property with key not found or error converting to the given type.

intercept

public InterceptDefinition intercept()

Adds a route for an interceptor that intercepts every processing step.

Returns:

the builder

interceptFrom

public InterceptFromDefinition interceptFrom()

Adds a route for an interceptor that intercepts incoming messages on any inputs in this route

Returns:

the builder

interceptFrom

public InterceptFromDefinition interceptFrom(String uri)

Adds a route for an interceptor that intercepts incoming messages on the given endpoint.

Parameters:

uri - endpoint uri

Returns:

the builder

interceptSendToEndpoint

public InterceptSendToEndpointDefinition interceptSendToEndpoint(String uri)

Applies a route for an interceptor if an exchange is send to the given endpoint

Parameters:

uri - endpoint uri

Returns:

the builder

onException

public OnExceptionDefinition onException(Class<? extends Throwable> exception)

Exception clause for catching certain exceptions and handling them.

Parameters:

exception - exception to catch

Returns:

the builder

onException

public OnExceptionDefinition onException(Class<? extends Throwable>... exceptions)

Exception clause for catching certain exceptions and handling them.

Parameters:

exceptions - list of exceptions to catch

Returns:

the builder

onCompletion

public OnCompletionDefinition onCompletion()

On completion callback for doing custom routing when the Exchange is complete.

Returns:

the builder

addRoutesToCamelContext

public void addRoutesToCamelContext(org.apache.camel.CamelContext context)
                             throws Exception

Specified by:

addRoutesToCamelContext in interface org.apache.camel.RoutesBuilder

Throws:

Exception

configureRoutes

public RoutesDefinition configureRoutes(org.apache.camel.CamelContext context)
                                 throws Exception

Configures the routes

Parameters:

context - the Camel context

Returns:

the routes configured

Throws:

Exception - can be thrown during configuration

configureRests

public RestsDefinition configureRests(org.apache.camel.CamelContext context)
                               throws Exception

Configures the rests

Parameters:

context - the Camel context

Returns:

the rests configured

Throws:

Exception - can be thrown during configuration

setErrorHandlerBuilder

public void setErrorHandlerBuilder(ErrorHandlerBuilder errorHandlerBuilder)

Description copied from class: BuilderSupport

Sets the error handler to use with processors created by this builder

Overrides:

setErrorHandlerBuilder in class BuilderSupport

addLifecycleInterceptor

public void addLifecycleInterceptor(RouteBuilderLifecycleStrategy interceptor)

Adds the given RouteBuilderLifecycleStrategy to be used.

removeLifecycleInterceptor

public void removeLifecycleInterceptor(RouteBuilderLifecycleStrategy interceptor)

Adds the given RouteBuilderLifecycleStrategy.

checkInitialized

protected void checkInitialized()
                         throws Exception

Throws:

Exception

populateRoutes

protected void populateRoutes()
                       throws Exception

Throws:

Exception

populateRests

protected void populateRests()
                      throws Exception

Throws:

Exception

populateTransformers

protected void populateTransformers()

populateValidators

protected void populateValidators()

getRestCollection

public RestsDefinition getRestCollection()

getRestConfigurations

public Map<String,RestConfigurationDefinition> getRestConfigurations()

setRestCollection

public void setRestCollection(RestsDefinition restCollection)

setRouteCollection

public void setRouteCollection(RoutesDefinition routeCollection)

getRouteCollection

public RoutesDefinition getRouteCollection()

configureRest

protected void configureRest(RestDefinition rest)

configureRoute

protected void configureRoute(RouteDefinition route)