public class RouteDefinition extends ProcessorDefinition<RouteDefinition>
inheritErrorHandler, log
Constructor and Description |
---|
RouteDefinition() |
RouteDefinition(Endpoint endpoint) |
RouteDefinition(String uri) |
Modifier and Type | Method and Description |
---|---|
protected RouteContext |
addRoutes(CamelContext camelContext,
Collection<Route> routes,
FromDefinition fromType) |
List<RouteContext> |
addRoutes(ModelCamelContext camelContext,
Collection<Route> routes) |
RouteDefinition |
adviceWith(CamelContext camelContext,
RouteBuilder builder)
Deprecated.
|
RouteDefinition |
adviceWith(ModelCamelContext camelContext,
RouteBuilder builder)
Advices this route with the route builder.
|
RouteDefinition |
autoStartup(boolean autoStartup)
Sets the auto startup property on this route.
|
RouteDefinition |
autoStartup(String autoStartup)
Sets the auto startup property on this route.
|
RouteDefinition |
delayer(long delay)
Enable delayer for this route.
|
RouteDefinition |
errorHandler(ErrorHandlerFactory errorHandlerBuilder)
Installs the given error handler builder.
|
RouteDefinition |
from(Endpoint... endpoints)
Creates inputs to the route
|
RouteDefinition |
from(Endpoint endpoint)
Creates an input to the route
|
RouteDefinition |
from(String... uris)
Creates inputs to the route
|
RouteDefinition |
from(String uri)
Creates an input to the route
|
String |
getAutoStartup() |
String |
getDelayer() |
ErrorHandlerFactory |
getErrorHandlerBuilder() |
String |
getErrorHandlerRef() |
String |
getGroup()
The group that this route belongs to; could be the name of the RouteBuilder class
or be explicitly configured in the XML.
|
String |
getHandleFault() |
List<FromDefinition> |
getInputs() |
String |
getMessageHistory() |
List<ProcessorDefinition<?>> |
getOutputs() |
List<RoutePolicy> |
getRoutePolicies() |
String |
getRoutePolicyRef() |
String |
getShortName()
Returns a short name for this node which can be useful for ID generation or referring to related resources like images
|
ShutdownRoute |
getShutdownRoute() |
ShutdownRunningTask |
getShutdownRunningTask() |
Integer |
getStartupOrder() |
ServiceStatus |
getStatus(CamelContext camelContext)
Returns the status of the route if it has been registered with a
CamelContext |
String |
getStreamCache() |
String |
getTrace() |
RouteDefinition |
group(String name)
Set the group name for this route
|
RouteDefinition |
handleFault()
Enable handle fault for this route.
|
boolean |
isAutoStartup(CamelContext camelContext) |
boolean |
isContextScopedErrorHandler(CamelContext context) |
boolean |
isOutputSupported() |
boolean |
isStartable(CamelContext camelContext) |
boolean |
isStoppable(CamelContext camelContext) |
void |
markPrepared()
Marks the route definition as prepared.
|
RouteDefinition |
messageHistory()
Enable message history for this route.
|
RouteDefinition |
noAutoStartup()
Disables this route from being auto started when Camel starts.
|
RouteDefinition |
noDelayer()
Disable delayer for this route.
|
RouteDefinition |
noHandleFault()
Disable handle fault for this route.
|
RouteDefinition |
noMessageHistory()
Disable message history for this route.
|
RouteDefinition |
noStreamCaching()
Disable stream caching for this route.
|
RouteDefinition |
noTracing()
Disable tracing for this route.
|
void |
prepare(ModelCamelContext context)
Prepares the route definition to be ready to be added to
CamelContext |
Endpoint |
resolveEndpoint(CamelContext camelContext,
String uri) |
RouteDefinition |
routeId(String id)
Set the route id for this route
|
RouteDefinition |
routePolicy(RoutePolicy... policies)
Configures route policies for this route
|
RouteDefinition |
routePolicyRef(String routePolicyRef)
Configures a route policy for this route
|
void |
setAutoStartup(String autoStartup) |
void |
setDelayer(String delayer) |
void |
setErrorHandlerBuilder(ErrorHandlerFactory errorHandlerBuilder)
Sets the error handler to use with processors created by this builder
|
void |
setErrorHandlerBuilderIfNull(ErrorHandlerFactory errorHandlerBuilder)
Sets the error handler if one is not already set
|
void |
setErrorHandlerRef(String errorHandlerRef)
Sets the bean ref name of the error handler builder to use on this route
|
void |
setGroup(String group) |
void |
setHandleFault(String handleFault) |
void |
setInputs(List<FromDefinition> inputs) |
void |
setMessageHistory(String messageHistory) |
void |
setOutputs(List<ProcessorDefinition<?>> outputs) |
void |
setRoutePolicies(List<RoutePolicy> routePolicies) |
void |
setRoutePolicyRef(String routePolicyRef) |
void |
setShutdownRoute(ShutdownRoute shutdownRoute) |
void |
setShutdownRunningTask(ShutdownRunningTask shutdownRunningTask) |
void |
setStartupOrder(Integer startupOrder) |
void |
setStreamCache(String streamCache) |
void |
setTrace(String trace) |
RouteDefinition |
shutdownRoute(ShutdownRoute shutdownRoute)
Configures a shutdown route option.
|
RouteDefinition |
shutdownRunningTask(ShutdownRunningTask shutdownRunningTask)
Configures a shutdown running task option.
|
RouteDefinition |
startupOrder(int order)
Configures the startup order for this route
Camel will reorder routes and star them ordered by 0..N where 0 is the lowest number and N the highest number.
|
RouteDefinition |
streamCaching()
Enable stream caching for this route.
|
String |
toString() |
RouteDefinition |
tracing()
Enable tracing for this route.
|
addInterceptStrategies, addInterceptStrategy, addOutput, addRoutes, aggregate, aggregate, aggregate, aggregate, aop, attribute, bean, bean, bean, bean, beanRef, beanRef, beanRef, beanRef, choice, clearOutput, configureChild, convertBodyTo, convertBodyTo, createChannel, createChildProcessor, createCompositeProcessor, createOutputsProcessor, createOutputsProcessor, createProcessor, createProcessor, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, endChoice, endDoTry, endParent, enrich, enrich, enrichRef, filter, filter, filter, filter, getIndex, getInterceptStrategies, getLabel, getOtherAttributes, getParent, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, makeProcessor, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, onException, pipeline, pipeline, pipeline, pipeline, placeholder, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichRef, preCreateProcessor, process, processRef, recipientList, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeHeaders, removeHeaders, removeProperty, resequence, resequence, resolveKnownConstantFields, resolvePropertyPlaceholders, rollback, rollback, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, sample, sample, sample, setBody, setBody, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setInheritErrorHandler, setOtherAttributes, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sort, split, split, split, stop, threads, threads, threads, threads, throttle, throttle, throwException, to, to, to, to, to, to, to, to, to, to, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wrapChannel, wrapInErrorHandler, wrapProcessor
description, getDescription, getDescriptionText, getId, hasCustomIdAssigned, idOrCreate, isCustomId, setCustomId, setDescription, setId
public RouteDefinition()
public RouteDefinition(String uri)
public RouteDefinition(Endpoint endpoint)
public void prepare(ModelCamelContext context)
CamelContext
context
- the camel contextpublic void markPrepared()
public String getShortName()
OptionalIdentifiedDefinition
getShortName
in interface NamedNode
getShortName
in class OptionalIdentifiedDefinition<RouteDefinition>
public ServiceStatus getStatus(CamelContext camelContext)
CamelContext
public boolean isStartable(CamelContext camelContext)
public boolean isStoppable(CamelContext camelContext)
public List<RouteContext> addRoutes(ModelCamelContext camelContext, Collection<Route> routes) throws Exception
Exception
public Endpoint resolveEndpoint(CamelContext camelContext, String uri) throws NoSuchEndpointException
NoSuchEndpointException
@Deprecated public RouteDefinition adviceWith(CamelContext camelContext, RouteBuilder builder) throws Exception
Exception
public RouteDefinition adviceWith(ModelCamelContext camelContext, RouteBuilder builder) throws Exception
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.camelContext
- the camel contextbuilder
- the route builderException
- can be thrown from the route builderAdviceWithRouteBuilder
public RouteDefinition from(String uri)
uri
- the from uripublic RouteDefinition from(Endpoint endpoint)
endpoint
- the from endpointpublic RouteDefinition from(String... uris)
uris
- the from urispublic RouteDefinition from(Endpoint... endpoints)
endpoints
- the from endpointspublic RouteDefinition group(String name)
name
- the group namepublic RouteDefinition routeId(String id)
routeId
in class ProcessorDefinition<RouteDefinition>
id
- the route idpublic RouteDefinition noStreamCaching()
public RouteDefinition streamCaching()
public RouteDefinition noTracing()
public RouteDefinition tracing()
public RouteDefinition messageHistory()
public RouteDefinition noMessageHistory()
public RouteDefinition noHandleFault()
public RouteDefinition handleFault()
public RouteDefinition noDelayer()
public RouteDefinition delayer(long delay)
delay
- delay in millispublic RouteDefinition errorHandler(ErrorHandlerFactory errorHandlerBuilder)
errorHandlerBuilder
- the error handler to be used by default for all child routespublic RouteDefinition noAutoStartup()
public RouteDefinition autoStartup(String autoStartup)
autoStartup
- - String indicator ("true" or "false")public RouteDefinition autoStartup(boolean autoStartup)
autoStartup
- - boolean indicatorpublic RouteDefinition startupOrder(int order)
startupOrder
in class ProcessorDefinition<RouteDefinition>
order
- the order represented as a numberpublic RouteDefinition routePolicy(RoutePolicy... policies)
policies
- the route policiespublic RouteDefinition routePolicyRef(String routePolicyRef)
routePolicyRef
- reference to a RoutePolicy
to lookup and use.
You can specify multiple references by separating using comma.public RouteDefinition shutdownRoute(ShutdownRoute shutdownRoute)
shutdownRoute
- the option to use when shutting down this routepublic RouteDefinition shutdownRunningTask(ShutdownRunningTask shutdownRunningTask)
shutdownRunningTask
- the option to use when shutting down and how to act upon running tasks.public List<FromDefinition> getInputs()
public void setInputs(List<FromDefinition> inputs)
public List<ProcessorDefinition<?>> getOutputs()
getOutputs
in class ProcessorDefinition<RouteDefinition>
public void setOutputs(List<ProcessorDefinition<?>> outputs)
public boolean isOutputSupported()
isOutputSupported
in class ProcessorDefinition<RouteDefinition>
public String getGroup()
public String getStreamCache()
public void setStreamCache(String streamCache)
public String getMessageHistory()
public void setMessageHistory(String messageHistory)
public String getHandleFault()
public void setHandleFault(String handleFault)
public String getDelayer()
public void setDelayer(String delayer)
public String getAutoStartup()
public boolean isAutoStartup(CamelContext camelContext) throws Exception
Exception
public void setAutoStartup(String autoStartup)
public Integer getStartupOrder()
public void setStartupOrder(Integer startupOrder)
public void setErrorHandlerRef(String errorHandlerRef)
public String getErrorHandlerRef()
public void setErrorHandlerBuilderIfNull(ErrorHandlerFactory errorHandlerBuilder)
public void setRoutePolicyRef(String routePolicyRef)
public String getRoutePolicyRef()
public List<RoutePolicy> getRoutePolicies()
public void setRoutePolicies(List<RoutePolicy> routePolicies)
public ShutdownRoute getShutdownRoute()
public void setShutdownRoute(ShutdownRoute shutdownRoute)
public ShutdownRunningTask getShutdownRunningTask()
public void setShutdownRunningTask(ShutdownRunningTask shutdownRunningTask)
public ErrorHandlerFactory getErrorHandlerBuilder()
public void setErrorHandlerBuilder(ErrorHandlerFactory errorHandlerBuilder)
public boolean isContextScopedErrorHandler(CamelContext context)
protected RouteContext addRoutes(CamelContext camelContext, Collection<Route> routes, FromDefinition fromType) throws Exception
Exception
Apache Camel