RouteDefinition (Camel :: Core 2.22.2 API)

java.lang.Object
- org.apache.camel.model.OptionalIdentifiedDefinition<Type>
- - org.apache.camel.model.ProcessorDefinition<RouteDefinition>
  - - org.apache.camel.model.RouteDefinition

All Implemented Interfaces:: Block, OtherAttributesAware, NamedNode

@Metadata(label="configuration")
public class RouteDefinition
extends ProcessorDefinition<RouteDefinition>

A Camel route

Version:

Field Summary
- Fields inherited from class org.apache.camel.model.ProcessorDefinition
  inheritErrorHandler, log

Constructor Summary

Constructors
Constructor and Description

RouteDefinition()

RouteDefinition(Endpoint endpoint)

RouteDefinition(String uri)

Constructors
Constructor and Description
`RouteDefinition()`
`RouteDefinition(Endpoint endpoint)`
`RouteDefinition(String uri)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`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
`static RouteDefinition`	`fromEndpoint(Endpoint endpoint)`
`void`	`fromRest(String uri)` This route is created from the REST DSL.
`static RouteDefinition`	`fromUri(String uri)`
`String`	`getAutoStartup()` Whether to auto start this route
`String`	`getDelayer()` Whether to slow down processing messages by a given delay in msec.
`ErrorHandlerFactory`	`getErrorHandlerBuilder()`
`String`	`getErrorHandlerRef()` Sets the bean ref name of the error handler builder to use on this route
`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()` Whether handle fault is enabled on this route.
`List<FromDefinition>`	`getInputs()`
`InputTypeDefinition`	`getInputType()`
`String`	`getLogMask()` Whether security mask for Logging is enabled on this route.
`String`	`getMessageHistory()` Whether message history is enabled on this route.
`List<ProcessorDefinition<?>>`	`getOutputs()`
`OutputTypeDefinition`	`getOutputType()`
`RestBindingDefinition`	`getRestBindingDefinition()`
`RestDefinition`	`getRestDefinition()`
`List<RoutePolicy>`	`getRoutePolicies()`
`String`	`getRoutePolicyRef()` Reference to custom `RoutePolicy` to use by the route.
`List<PropertyDefinition>`	`getRouteProperties()`
`ShutdownRoute`	`getShutdownRoute()`
`ShutdownRunningTask`	`getShutdownRunningTask()` To control how to shutdown the route.
`Integer`	`getStartupOrder()` To configure the ordering of the routes being started
`ServiceStatus`	`getStatus(CamelContext camelContext)` Returns the status of the route if it has been registered with a `CamelContext`
`String`	`getStreamCache()` Whether stream caching is enabled on this route.
`String`	`getTrace()` Whether tracing is enabled on this route.
`RouteDefinition`	`group(String name)` Set the group name for this route
`RouteDefinition`	`handleFault()` Enable handle fault for this route.
`RouteDefinition`	`inputType(Class clazz)` Declare the expected data type of the input message by Java class.
`RouteDefinition`	`inputType(String urn)` Declare the expected data type of the input message.
`RouteDefinition`	`inputTypeWithValidate(Class clazz)` Declare the expected data type of the input message by Java class with content validation enabled.
`RouteDefinition`	`inputTypeWithValidate(String urn)` Declare the expected data type of the input message with content validation enabled.
`boolean`	`isAutoStartup(CamelContext camelContext)`
`boolean`	`isContextScopedErrorHandler(CamelContext context)`
`boolean`	`isOutputSupported()`
`Boolean`	`isRest()`
`boolean`	`isStartable(CamelContext camelContext)`
`boolean`	`isStoppable(CamelContext camelContext)`
`RouteDefinition`	`logMask()` Enable security mask for Logging on this route.
`RouteDefinition`	`logMask(String logMask)` Sets whether security mask for logging is enabled on this route.
`void`	`markPrepared()` Marks the route definition as prepared.
`void`	`markUnprepared()` Marks the route definition as un-prepared.
`RouteDefinition`	`messageHistory()` Enable message history for this route.
`RouteDefinition`	`messageHistory(String 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.
`RouteDefinition`	`outputType(Class clazz)` Declare the expected data type of the output message by Java class.
`RouteDefinition`	`outputType(String urn)` Declare the expected data type of the output message.
`RouteDefinition`	`outputTypeWithValidate(Class clazz)` Declare the expected data type of the ouput message by Java class with content validation enabled.
`RouteDefinition`	`outputTypeWithValidate(String urn)` Declare the expected data type of the output message with content validation enabled.
`void`	`prepare(ModelCamelContext context)` Prepares the route definition to be ready to be added to `CamelContext`
`Endpoint`	`resolveEndpoint(CamelContext camelContext, String uri)`
`RouteDefinition`	`routeDescription(String description)` Set the route description for this route
`RouteDefinition`	`routeGroup(String group)` Set the route group for this route
`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
`RouteDefinition`	`routeProperty(String key, String value)` Adds a custom property on the route.
`void`	`setAutoStartup(String autoStartup)` Whether to auto start this route
`void`	`setDelayer(String delayer)` Whether to slow down processing messages by a given delay in msec.
`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)` The group that this route belongs to; could be the name of the RouteBuilder class or be explicitly configured in the XML.
`void`	`setHandleFault(String handleFault)` Whether handle fault is enabled on this route.
`void`	`setInputs(List<FromDefinition> inputs)` Input to the route.
`void`	`setInputType(InputTypeDefinition inputType)`
`void`	`setLogMask(String logMask)` Whether security mask for Logging is enabled on this route.
`void`	`setMessageHistory(String messageHistory)` Whether message history is enabled on this route.
`void`	`setOutputs(List<ProcessorDefinition<?>> outputs)` Outputs are processors that determines how messages are processed by this route.
`void`	`setOutputType(OutputTypeDefinition outputType)`
`void`	`setRestBindingDefinition(RestBindingDefinition restBindingDefinition)`
`void`	`setRestDefinition(RestDefinition restDefinition)`
`void`	`setRoutePolicies(List<RoutePolicy> routePolicies)`
`void`	`setRoutePolicyRef(String routePolicyRef)` Reference to custom `RoutePolicy` to use by the route.
`void`	`setRouteProperties(List<PropertyDefinition> routeProperties)` To set metadata as properties on the route.
`void`	`setShutdownRoute(ShutdownRoute shutdownRoute)` To control how to shutdown the route.
`void`	`setShutdownRunningTask(ShutdownRunningTask shutdownRunningTask)` To control how to shutdown the route.
`void`	`setStartupOrder(Integer startupOrder)` To configure the ordering of the routes being started
`void`	`setStreamCache(String streamCache)` Whether stream caching is enabled on this route.
`void`	`setTrace(String trace)` Whether tracing is enabled on this route.
`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.
`RouteDefinition`	`streamCaching(String streamCache)` Enable stream caching for this route.
`String`	`toString()`
`RouteDefinition`	`tracing()` Enable tracing for this route.
`RouteDefinition`	`tracing(String tracing)` Enable tracing for this route.

Methods inherited from class org.apache.camel.model.ProcessorDefinition
addInterceptStrategies, addInterceptStrategy, addOutput, addRoutes, aggregate, aggregate, aggregate, aggregate, aop, attribute, bean, bean, bean, bean, bean, bean, bean, bean, beanRef, beanRef, beanRef, beanRef, beanRef, choice, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, configureChild, convertBodyTo, convertBodyTo, createChannel, createChildProcessor, createCompositeProcessor, createOutputsProcessor, createOutputsProcessor, createOutputsProcessorImpl, createProcessor, createProcessor, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, endChoice, endDoTry, endHystrix, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrichRef, enrichRef, enrichRef, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getLabel, getOtherAttributes, getParent, hystrix, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, makeProcessor, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, onException, pipeline, pipeline, pipeline, pipeline, placeholder, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichRef, pollEnrichRef, pollEnrichWith, pollEnrichWith, pollEnrichWith, preCreateProcessor, process, process, process, processRef, recipientList, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, rollback, rollback, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setBody, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setHeader, setInheritErrorHandler, setOtherAttributes, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sort, split, split, split, stop, threads, threads, threads, threads, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, toD, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wrapChannel, wrapChannel, wrapInErrorHandler, wrapProcessor

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition
description, description, getCustomId, getDescription, getDescriptionText, getId, getShortName, hasCustomIdAssigned, idOrCreate, setCustomId, setDescription, setId

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RouteDefinition
```
public RouteDefinition()
```
  - RouteDefinition
```
public RouteDefinition(@AsEndpointUri
                       String uri)
```
  - RouteDefinition
```
public RouteDefinition(Endpoint endpoint)
```
- Method Detail
  - fromRest
```
public void fromRest(@AsEndpointUri
                     String uri)
```
    This route is created from the REST DSL.
  - prepare
```
public void prepare(ModelCamelContext context)
```
    Prepares the route definition to be ready to be added to CamelContext
    
    Parameters:
    
    context - the camel context
  - markPrepared
```
public void markPrepared()
```
    Marks the route definition as prepared.
    This is needed if routes have been created by components such as camel-spring or camel-blueprint. Usually they share logic in the camel-core-xml module which prepares the routes.
  - markUnprepared
```
public void markUnprepared()
```
    Marks the route definition as un-prepared.
    This is needed if routes have been created by components such as camel-scala. To unset the prepare so the routes can be prepared at a later stage when scala has build the routes completely.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getStatus
```
public ServiceStatus getStatus(CamelContext camelContext)
```
    Returns the status of the route if it has been registered with a CamelContext
  - isStartable
```
public boolean isStartable(CamelContext camelContext)
```
  - isStoppable
```
public boolean isStoppable(CamelContext camelContext)
```
  - addRoutes
```
public List<RouteContext> addRoutes(ModelCamelContext camelContext,
                                    Collection<Route> routes)
                             throws Exception
```
    Throws:
    
    Exception
  - resolveEndpoint
```
public Endpoint resolveEndpoint(CamelContext camelContext,
                                String uri)
                         throws NoSuchEndpointException
```
    Throws:
    
    NoSuchEndpointException
  - adviceWith
```
public RouteDefinition adviceWith(CamelContext camelContext,
                                  RouteBuilder builder)
                           throws Exception
```
    Throws:
    
    Exception
  - adviceWith
```
public RouteDefinition adviceWith(ModelCamelContext 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:
    
    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
  - from
```
public RouteDefinition from(@AsEndpointUri
                            String uri)
```
    Creates an input to the route
    
    Parameters:
    
    uri - the from uri
    
    Returns:
    
    the builder
  - from
```
public RouteDefinition from(Endpoint endpoint)
```
    Creates an input to the route
    
    Parameters:
    
    endpoint - the from endpoint
    
    Returns:
    
    the builder
  - from
```
public RouteDefinition from(@AsEndpointUri
                            String... uris)
```
    Creates inputs to the route
    
    Parameters:
    
    uris - the from uris
    
    Returns:
    
    the builder
  - from
```
public RouteDefinition from(Endpoint... endpoints)
```
    Creates inputs to the route
    
    Parameters:
    
    endpoints - the from endpoints
    
    Returns:
    
    the builder
  - group
```
public RouteDefinition group(String name)
```
    Set the group name for this route
    
    Parameters:
    
    name - the group name
    
    Returns:
    
    the builder
  - routeGroup
```
public RouteDefinition routeGroup(String group)
```
    Set the route group for this route
    
    Overrides:
    
    routeGroup in class ProcessorDefinition<RouteDefinition>
    
    Parameters:
    
    group - the route group
    
    Returns:
    
    the builder
  - routeId
```
public RouteDefinition routeId(String id)
```
    Set the route id for this route
    
    Overrides:
    
    routeId in class ProcessorDefinition<RouteDefinition>
    
    Parameters:
    
    id - the route id
    
    Returns:
    
    the builder
  - routeDescription
```
public RouteDefinition routeDescription(String description)
```
    Set the route description for this route
    
    Overrides:
    
    routeDescription in class ProcessorDefinition<RouteDefinition>
    
    Parameters:
    
    description - the route description
    
    Returns:
    
    the builder
  - noStreamCaching
```
public RouteDefinition noStreamCaching()
```
    Disable stream caching for this route.
    
    Returns:
    
    the builder
  - streamCaching
```
public RouteDefinition streamCaching()
```
    Enable stream caching for this route.
    
    Returns:
    
    the builder
  - streamCaching
```
public RouteDefinition streamCaching(String streamCache)
```
    Enable stream caching for this route.
    
    Parameters:
    
    streamCache - whether to use stream caching (true or false), the value can be a property placeholder
    
    Returns:
    
    the builder
  - noTracing
```
public RouteDefinition noTracing()
```
    Disable tracing for this route.
    
    Returns:
    
    the builder
  - tracing
```
public RouteDefinition tracing()
```
    Enable tracing for this route.
    
    Returns:
    
    the builder
  - tracing
```
public RouteDefinition tracing(String tracing)
```
    Enable tracing for this route.
    
    Parameters:
    
    tracing - whether to use tracing (true or false), the value can be a property placeholder
    
    Returns:
    
    the builder
  - messageHistory
```
public RouteDefinition messageHistory()
```
    Enable message history for this route.
    
    Returns:
    
    the builder
  - messageHistory
```
public RouteDefinition messageHistory(String messageHistory)
```
    Enable message history for this route.
    
    Parameters:
    
    messageHistory - whether to use message history (true or false), the value can be a property placeholder
    
    Returns:
    
    the builder
  - logMask
```
public RouteDefinition logMask()
```
    Enable security mask for Logging on this route.
    
    Returns:
    
    the builder
  - logMask
```
public RouteDefinition logMask(String logMask)
```
    Sets whether security mask for logging is enabled on this route.
    
    Parameters:
    
    logMask - whether to enable security mask for Logging (true or false), the value can be a property placeholder
    
    Returns:
    
    the builder
  - noMessageHistory
```
public RouteDefinition noMessageHistory()
```
    Disable message history for this route.
    
    Returns:
    
    the builder
  - noHandleFault
```
public RouteDefinition noHandleFault()
```
    Disable handle fault for this route.
    
    Returns:
    
    the builder
  - handleFault
```
public RouteDefinition handleFault()
```
    Enable handle fault for this route.
    
    Returns:
    
    the builder
  - noDelayer
```
public RouteDefinition noDelayer()
```
    Disable delayer for this route.
    
    Returns:
    
    the builder
  - delayer
```
public RouteDefinition delayer(long delay)
```
    Enable delayer for this route.
    
    Parameters:
    
    delay - delay in millis
    
    Returns:
    
    the builder
  - errorHandler
```
public RouteDefinition errorHandler(ErrorHandlerFactory errorHandlerBuilder)
```
    Installs the given error handler builder.
    
    Parameters:
    
    errorHandlerBuilder - the error handler to be used by default for all child routes
    
    Returns:
    
    the current builder with the error handler configured
  - noAutoStartup
```
public RouteDefinition noAutoStartup()
```
    Disables this route from being auto started when Camel starts.
    
    Returns:
    
    the builder
  - autoStartup
```
public RouteDefinition autoStartup(String autoStartup)
```
    Sets the auto startup property on this route.
    
    Parameters:
    
    autoStartup - whether to auto startup (true or false), the value can be a property placeholder
    
    Returns:
    
    the builder
  - autoStartup
```
public RouteDefinition autoStartup(boolean autoStartup)
```
    Sets the auto startup property on this route.
    
    Parameters:
    
    autoStartup - - boolean indicator
    
    Returns:
    
    the builder
  - startupOrder
```
public 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. Camel will stop routes in reverse order when its stopping.
    
    Overrides:
    
    startupOrder in class ProcessorDefinition<RouteDefinition>
    
    Parameters:
    
    order - the order represented as a number
    
    Returns:
    
    the builder
  - routePolicy
```
public RouteDefinition routePolicy(RoutePolicy... policies)
```
    Configures route policies for this route
    
    Parameters:
    
    policies - the route policies
    
    Returns:
    
    the builder
  - routePolicyRef
```
public RouteDefinition routePolicyRef(String routePolicyRef)
```
    Configures a route policy for this route
    
    Parameters:
    
    routePolicyRef - reference to a RoutePolicy to lookup and use. You can specify multiple references by separating using comma.
    
    Returns:
    
    the builder
  - shutdownRoute
```
public RouteDefinition shutdownRoute(ShutdownRoute shutdownRoute)
```
    Configures a shutdown route option.
    
    Parameters:
    
    shutdownRoute - the option to use when shutting down this route
    
    Returns:
    
    the builder
  - shutdownRunningTask
```
public RouteDefinition shutdownRunningTask(ShutdownRunningTask shutdownRunningTask)
```
    Configures a shutdown running task option.
    
    Parameters:
    
    shutdownRunningTask - the option to use when shutting down and how to act upon running tasks.
    
    Returns:
    
    the builder
  - inputType
```
public RouteDefinition inputType(String urn)
```
    Declare the expected data type of the input message. If the actual message type is different at runtime, camel look for a required Transformer and apply if exists. The type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name' is a fully qualified class name. For example java:java.lang.String, json:ABCOrder.
    
    Parameters:
    
    urn - input type URN
    
    Returns:
    
    the builder
    
    See Also:
    
    Transformer
  - inputTypeWithValidate
```
public RouteDefinition inputTypeWithValidate(String urn)
```
    Declare the expected data type of the input message with content validation enabled. If the actual message type is different at runtime, camel look for a required Transformer and apply if exists, and then applies Validator as well. The type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name' is a fully qualified class name. For example java:java.lang.String, json:ABCOrder.
    
    Parameters:
    
    urn - input type URN
    
    Returns:
    
    the builder
    
    See Also:
    
    Transformer, Validator
  - inputType
```
public RouteDefinition inputType(Class clazz)
```
    Declare the expected data type of the input message by Java class. If the actual message type is different at runtime, camel look for a required Transformer and apply if exists.
    
    Parameters:
    
    clazz - Class object of the input type
    
    Returns:
    
    the builder
    
    See Also:
    
    Transformer
  - inputTypeWithValidate
```
public RouteDefinition inputTypeWithValidate(Class clazz)
```
    Declare the expected data type of the input message by Java class with content validation enabled. If the actual message type is different at runtime, camel look for a required Transformer and apply if exists, and then applies Validator as well.
    
    Parameters:
    
    clazz - Class object of the input type
    
    Returns:
    
    the builder
    
    See Also:
    
    Transformer, Validator
  - outputType
```
public RouteDefinition outputType(String urn)
```
    Declare the expected data type of the output message. If the actual message type is different at runtime, camel look for a required Transformer and apply if exists. The type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name' is a fully qualified class name. For example java:java.lang.String, json:ABCOrder.
    
    Parameters:
    
    urn - output type URN
    
    Returns:
    
    the builder
    
    See Also:
    
    Transformer
  - outputTypeWithValidate
```
public RouteDefinition outputTypeWithValidate(String urn)
```
    Declare the expected data type of the output message with content validation enabled. If the actual message type is different at runtime, Camel look for a required Transformer and apply if exists, and then applies Validator as well. The type name consists of two parts, 'scheme' and 'name' connected with ':'. For Java type 'name' is a fully qualified class name. For example java:java.lang.String, json:ABCOrder.
    
    Parameters:
    
    urn - output type URN
    
    Returns:
    
    the builder
    
    See Also:
    
    Transformer, Validator
  - outputType
```
public RouteDefinition outputType(Class clazz)
```
    Declare the expected data type of the output message by Java class. If the actual message type is different at runtime, camel look for a required Transformer and apply if exists.
    
    Parameters:
    
    clazz - Class object of the output type
    
    Returns:
    
    the builder
    
    See Also:
    
    Transformer
  - outputTypeWithValidate
```
public RouteDefinition outputTypeWithValidate(Class clazz)
```
    Declare the expected data type of the ouput message by Java class with content validation enabled. If the actual message type is different at runtime, camel look for a required Transformer and apply if exists, and then applies Validator as well.
    
    Parameters:
    
    clazz - Class object of the output type
    
    Returns:
    
    the builder
    
    See Also:
    
    Transformer, Validator
  - routeProperty
```
public RouteDefinition routeProperty(String key,
                                     String value)
```
    Adds a custom property on the route.
  - getInputs
```
public List<FromDefinition> getInputs()
```
  - setInputs
```
public void setInputs(List<FromDefinition> inputs)
```
    Input to the route.
  - getOutputs
```
public List<ProcessorDefinition<?>> getOutputs()
```
    Specified by:
    
    getOutputs in class ProcessorDefinition<RouteDefinition>
  - setOutputs
```
public void setOutputs(List<ProcessorDefinition<?>> outputs)
```
    Outputs are processors that determines how messages are processed by this route.
  - isOutputSupported
```
public boolean isOutputSupported()
```
    Specified by:
    
    isOutputSupported in class ProcessorDefinition<RouteDefinition>
  - getGroup
```
public String getGroup()
```
    The group that this route belongs to; could be the name of the RouteBuilder class or be explicitly configured in the XML.
    May be null.
  - setGroup
```
public void setGroup(String group)
```
    The group that this route belongs to; could be the name of the RouteBuilder class or be explicitly configured in the XML.
    May be null.
  - getStreamCache
```
public String getStreamCache()
```
    Whether stream caching is enabled on this route.
  - setStreamCache
```
public void setStreamCache(String streamCache)
```
    Whether stream caching is enabled on this route.
  - getTrace
```
public String getTrace()
```
    Whether tracing is enabled on this route.
  - setTrace
```
public void setTrace(String trace)
```
    Whether tracing is enabled on this route.
  - getMessageHistory
```
public String getMessageHistory()
```
    Whether message history is enabled on this route.
  - setMessageHistory
```
@Metadata(defaultValue="true")
public void setMessageHistory(String messageHistory)
```
    Whether message history is enabled on this route.
  - getLogMask
```
public String getLogMask()
```
    Whether security mask for Logging is enabled on this route.
  - setLogMask
```
public void setLogMask(String logMask)
```
    Whether security mask for Logging is enabled on this route.
  - getHandleFault
```
public String getHandleFault()
```
    Whether handle fault is enabled on this route.
  - setHandleFault
```
public void setHandleFault(String handleFault)
```
    Whether handle fault is enabled on this route.
  - getDelayer
```
public String getDelayer()
```
    Whether to slow down processing messages by a given delay in msec.
  - setDelayer
```
public void setDelayer(String delayer)
```
    Whether to slow down processing messages by a given delay in msec.
  - getAutoStartup
```
public String getAutoStartup()
```
    Whether to auto start this route
  - isAutoStartup
```
public boolean isAutoStartup(CamelContext camelContext)
                      throws Exception
```
    Throws:
    
    Exception
  - setAutoStartup
```
@Metadata(defaultValue="true")
public void setAutoStartup(String autoStartup)
```
    Whether to auto start this route
  - getStartupOrder
```
public Integer getStartupOrder()
```
    To configure the ordering of the routes being started
  - setStartupOrder
```
public void setStartupOrder(Integer startupOrder)
```
    To configure the ordering of the routes being started
  - setErrorHandlerRef
```
public void setErrorHandlerRef(String errorHandlerRef)
```
    Sets the bean ref name of the error handler builder to use on this route
  - getErrorHandlerRef
```
public String getErrorHandlerRef()
```
    Sets the bean ref name of the error handler builder to use on this route
  - setErrorHandlerBuilderIfNull
```
public void setErrorHandlerBuilderIfNull(ErrorHandlerFactory errorHandlerBuilder)
```
    Sets the error handler if one is not already set
  - setRoutePolicyRef
```
public void setRoutePolicyRef(String routePolicyRef)
```
    Reference to custom RoutePolicy to use by the route. Multiple policies can be configured by separating values using comma.
  - getRoutePolicyRef
```
public String getRoutePolicyRef()
```
    Reference to custom RoutePolicy to use by the route. Multiple policies can be configured by separating values using comma.
  - getRoutePolicies
```
public List<RoutePolicy> getRoutePolicies()
```
  - setRoutePolicies
```
public void setRoutePolicies(List<RoutePolicy> routePolicies)
```
  - getShutdownRoute
```
public ShutdownRoute getShutdownRoute()
```
  - setShutdownRoute
```
@Metadata(defaultValue="Default")
public void setShutdownRoute(ShutdownRoute shutdownRoute)
```
    To control how to shutdown the route.
  - getShutdownRunningTask
```
public ShutdownRunningTask getShutdownRunningTask()
```
    To control how to shutdown the route.
  - setShutdownRunningTask
```
@Metadata(defaultValue="CompleteCurrentTaskOnly")
public void setShutdownRunningTask(ShutdownRunningTask shutdownRunningTask)
```
    To control how to shutdown the route.
  - getErrorHandlerBuilder
```
public ErrorHandlerFactory getErrorHandlerBuilder()
```
  - setErrorHandlerBuilder
```
public void setErrorHandlerBuilder(ErrorHandlerFactory errorHandlerBuilder)
```
    Sets the error handler to use with processors created by this builder
  - isRest
```
public Boolean isRest()
```
  - getRestDefinition
```
public RestDefinition getRestDefinition()
```
  - setRestDefinition
```
public void setRestDefinition(RestDefinition restDefinition)
```
  - getRestBindingDefinition
```
public RestBindingDefinition getRestBindingDefinition()
```
  - setRestBindingDefinition
```
public void setRestBindingDefinition(RestBindingDefinition restBindingDefinition)
```
  - isContextScopedErrorHandler
```
public boolean isContextScopedErrorHandler(CamelContext context)
```
  - setInputType
```
public void setInputType(InputTypeDefinition inputType)
```
  - getInputType
```
public InputTypeDefinition getInputType()
```
  - setOutputType
```
public void setOutputType(OutputTypeDefinition outputType)
```
  - getOutputType
```
public OutputTypeDefinition getOutputType()
```
  - getRouteProperties
```
public List<PropertyDefinition> getRouteProperties()
```
  - setRouteProperties
```
@Metadata(label="advanced")
public void setRouteProperties(List<PropertyDefinition> routeProperties)
```
    To set metadata as properties on the route.
  - addRoutes
```
protected RouteContext addRoutes(CamelContext camelContext,
                                 Collection<Route> routes,
                                 FromDefinition fromType)
                          throws Exception
```
    Throws:
    
    Exception
  - fromUri
```
public static RouteDefinition fromUri(String uri)
```
  - fromEndpoint
```
public static RouteDefinition fromEndpoint(Endpoint endpoint)
```

Class RouteDefinition

Field Summary

Fields inherited from class org.apache.camel.model.ProcessorDefinition

Constructor Summary

Method Summary

Methods inherited from class org.apache.camel.model.ProcessorDefinition

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition

Methods inherited from class java.lang.Object

Constructor Detail

RouteDefinition

RouteDefinition

RouteDefinition

Method Detail

fromRest

prepare

markPrepared

markUnprepared

toString

getStatus

isStartable

isStoppable

addRoutes

resolveEndpoint

adviceWith

adviceWith

from

from

from

from

group

routeGroup

routeId

routeDescription

noStreamCaching

streamCaching

streamCaching

noTracing

tracing

tracing

messageHistory

messageHistory

logMask

logMask

noMessageHistory

noHandleFault

handleFault

noDelayer

delayer

errorHandler

noAutoStartup

autoStartup

autoStartup

startupOrder

routePolicy

routePolicyRef

shutdownRoute

shutdownRunningTask

inputType

inputTypeWithValidate

inputType

inputTypeWithValidate

outputType

outputTypeWithValidate

outputType

outputTypeWithValidate

routeProperty

getInputs

setInputs

getOutputs

setOutputs

isOutputSupported

getGroup

setGroup

getStreamCache

setStreamCache

getTrace

setTrace

getMessageHistory

setMessageHistory

getLogMask