|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.camel.builder.BuilderSupport
org.apache.camel.builder.RouteBuilder
public abstract class RouteBuilder
A Java DSL which is
used to build Route
instances in a CamelContext
for smart routing.
Constructor Summary | |
---|---|
RouteBuilder()
|
|
RouteBuilder(CamelContext context)
|
Method Summary | |
---|---|
protected void |
addRoutes(Routes routes)
Adds a collection of routes to this context |
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 |
configureRoute(RouteDefinition route)
|
protected CamelContext |
createContainer()
Factory method |
RouteBuilder |
errorHandler(ErrorHandlerBuilder errorHandlerBuilder)
Installs the given error handler builder |
RouteDefinition |
from(Endpoint... endpoints)
Creates a new route from the given endpoint |
RouteDefinition |
from(Endpoint endpoint)
Creates a new route from the given endpoint |
RouteDefinition |
from(String... uris)
Creates a new route from the given URIs input |
RouteDefinition |
from(String uri)
Creates a new route from the given URI input |
CamelContext |
getContext()
Gets the Camel context used. |
RoutesDefinition |
getRouteCollection()
|
List<Route> |
getRouteList()
Uses CamelContext.getRoutes() to return the routes in the context. |
RouteBuilder |
inheritErrorHandler(boolean inherit)
Configures whether or not the error handler is inherited by every processing node (or just the top most one) |
InterceptDefinition |
intercept()
Adds a route for an interceptor; use the ProcessorDefinition.proceed() method
to continue processing the underlying route being intercepted. |
RouteBuilder |
intercept(DelegateProcessor interceptor)
Adds the given interceptor to this route |
ChoiceDefinition |
intercept(Predicate predicate)
Applies a route for an interceptor if the given predicate is true otherwise the interceptor route is not applied |
void |
noStreamCaching()
Completely disable stream caching for all routes being defined in the same RouteBuilder after this. |
OnExceptionDefinition |
onException(Class... exceptions)
Exception clause for catching certain exceptions and handling them. |
OnExceptionDefinition |
onException(Class exception)
Exception clause for catching certain exceptions and handling them. |
protected void |
populateRoutes(List<Route> routes)
|
void |
setErrorHandlerBuilder(ErrorHandlerBuilder errorHandlerBuilder)
Sets the error handler to use with processors created by this builder |
void |
setInheritErrorHandler(boolean inheritErrorHandler)
|
void |
setRouteCollection(RoutesDefinition routeCollection)
|
void |
streamCaching()
Enable stream caching for all routes being defined in the same RouteBuilder after this call. |
String |
toString()
|
Methods inherited from class org.apache.camel.builder.BuilderSupport |
---|
bean, bean, body, body, constant, createErrorHandlerBuilder, deadLetterChannel, deadLetterChannel, deadLetterChannel, endpoint, endpoint, endpoints, endpoints, exceptionMessage, faultBody, faultBodyAs, getErrorHandlerBuilder, header, isInheritErrorHandler, loggingErrorHandler, loggingErrorHandler, loggingErrorHandler, loggingErrorHandler, noErrorHandler, outBody, outBody, property, regexReplaceAll, regexReplaceAll, setContext, systemProperty, systemProperty |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.camel.Routes |
---|
setContext |
Constructor Detail |
---|
public RouteBuilder()
public RouteBuilder(CamelContext context)
Method Detail |
---|
public String toString()
toString
in class Object
public abstract void configure() throws Exception
Exception
- can be thrown during configurationpublic RouteDefinition from(String uri)
uri
- the from uri
public RouteDefinition from(Endpoint endpoint)
endpoint
- the from endpoint
public RouteDefinition from(String... uris)
uris
- the from uris
public RouteDefinition from(Endpoint... endpoints)
endpoints
- the from endpoints
public RouteBuilder errorHandler(ErrorHandlerBuilder errorHandlerBuilder)
errorHandlerBuilder
- the error handler to be used by default for all child routes
public RouteBuilder inheritErrorHandler(boolean inherit)
inherit
- whether error handlers should be inherited or not
public RouteBuilder intercept(DelegateProcessor interceptor)
interceptor
- the interceptor
public InterceptDefinition intercept()
ProcessorDefinition.proceed()
method
to continue processing the underlying route being intercepted.
public ChoiceDefinition intercept(Predicate predicate)
predicate
- the predicate
public OnExceptionDefinition onException(Class exception)
exception
- exception to catch
public OnExceptionDefinition onException(Class... exceptions)
exceptions
- list of exceptions to catch
public CamelContext getContext()
Routes
getContext
in interface Routes
getContext
in class BuilderSupport
public List<Route> getRouteList() throws Exception
CamelContext.getRoutes()
to return the routes in the context.
getRouteList
in interface Routes
Exception
public void setInheritErrorHandler(boolean inheritErrorHandler)
setInheritErrorHandler
in class BuilderSupport
public void setErrorHandlerBuilder(ErrorHandlerBuilder errorHandlerBuilder)
BuilderSupport
setErrorHandlerBuilder
in class BuilderSupport
protected void checkInitialized() throws Exception
Exception
protected void populateRoutes(List<Route> routes) throws Exception
Exception
public void setRouteCollection(RoutesDefinition routeCollection)
public RoutesDefinition getRouteCollection()
public void noStreamCaching()
public void streamCaching()
protected CamelContext createContainer()
protected void configureRoute(RouteDefinition route)
protected void addRoutes(Routes routes) throws Exception
Exception
- if the routes could not be created for whatever reason
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |