Route (Camel :: API 3.11.2 API)

All Superinterfaces:

RuntimeConfiguration
```
public interface Route
extends RuntimeConfiguration
```
A Route defines the processing used on an inbound message exchange from a specific Endpoint within a CamelContext.
Use the API from CamelContext to control the lifecycle of a route, such as starting and stopping using the RouteController.startRoute(String) and RouteController.stopRoute(String) methods.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CUSTOM_ID_PROPERTY`
`static String`	`DESCRIPTION_PROPERTY`
`static String`	`GROUP_PROPERTY`
`static String`	`ID_PROPERTY`
`static String`	`PARENT_PROPERTY`
`static String`	`REST_PROPERTY`
`static String`	`TEMPLATE_PROPERTY`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addErrorHandler(ErrorHandlerFactory factory, NamedNode exception)` Adds error handler for the given exception type
`void`	`addErrorHandlerFactoryReference(ErrorHandlerFactory source, ErrorHandlerFactory target)` Link the error handlers from a factory to another
`void`	`addService(Service service)` Adds a service to this route
`void`	`clearRouteModel()` Clears the route model when its no longer needed.
`List<Processor>`	`filter(String pattern)` Returns a list of all the `Processor`s from this route that has id's matching the pattern
`CamelContext`	`getCamelContext()` Gets the camel context
`Consumer`	`getConsumer()` Gets the inbound `Consumer`
`String`	`getDescription()` Gets the route description (if any has been configured).
`Endpoint`	`getEndpoint()` Gets the input endpoint for this route.
`ErrorHandlerFactory`	`getErrorHandlerFactory()`
`Set<NamedNode>`	`getErrorHandlers(ErrorHandlerFactory factory)` Gets the error handlers
`List<Processor>`	`getEventDrivenProcessors()` This method retrieves the event driven Processors on this route context.
`String`	`getGroup()` Gets the route group
`String`	`getId()` Gets the route id
`List<InterceptStrategy>`	`getInterceptStrategies()` This method retrieves the InterceptStrategy instances this route context.
`RouteError`	`getLastError()` Gets the last error.
`ManagementInterceptStrategy`	`getManagementInterceptStrategy()` Gets the special managed intercept strategy if any
`Collection<Processor>`	`getOnCompletions()`
`Processor`	`getOnException(String onExceptionId)`
`Collection<Processor>`	`getOnExceptions()`
`Processor`	`getProcessor()` Gets the `Processor`
`Map<String,Object>`	`getProperties()` This property map is used to associate information about the route.
`NamedNode`	`getRoute()` Get the route type.
`RouteController`	`getRouteController()` Gets the `RouteController` for this route.
`String`	`getRouteDescription()` Gets the route description
`String`	`getRouteId()` Gets the route id
`List<RoutePolicy>`	`getRoutePolicyList()` Gets the route policy List
`List<Service>`	`getServices()` Returns the services for this particular route
`Integer`	`getStartupOrder()` Gets the route startup order
`String`	`getUptime()` Gets the uptime in a human readable format
`long`	`getUptimeMillis()` Gets the uptime in milliseconds
`void`	`initializeServices()` A strategy callback allowing special initialization when services are initializing.
`Boolean`	`isAutoStartup()` Gets whether the route should automatically start when Camel starts.
`Navigate<Processor>`	`navigate()` Returns a navigator to navigate this route by navigating all the `Processor`s.
`void`	`setAutoStartup(Boolean autoStartup)` Sets whether the route should automatically start when Camel starts.
`void`	`setErrorHandlerFactory(ErrorHandlerFactory errorHandlerFactory)`
`void`	`setLastError(RouteError error)` Sets the last error.
`void`	`setManagementInterceptStrategy(ManagementInterceptStrategy interceptStrategy)` Sets a special intercept strategy for management.
`void`	`setOnCompletion(String onCompletionId, Processor processor)`
`void`	`setOnException(String onExceptionId, Processor processor)`
`void`	`setProcessor(Processor processor)` Sets the `Processor`
`void`	`setRouteController(RouteController controller)` Sets the `RouteController` for this route.
`void`	`setStartupOrder(Integer startupOrder)` Sets the route startup order
`boolean`	`supportsSuspension()` Whether or not the route supports suspension (suspend and resume)
`void`	`warmUp()` Callback preparing the route to be started, by warming up the route.

- Field Detail
  - ID_PROPERTY
```
static final String ID_PROPERTY
```
    See Also:
    
    Constant Field Values
  - CUSTOM_ID_PROPERTY
```
static final String CUSTOM_ID_PROPERTY
```
    See Also:
    
    Constant Field Values
  - PARENT_PROPERTY
```
static final String PARENT_PROPERTY
```
    See Also:
    
    Constant Field Values
  - GROUP_PROPERTY
```
static final String GROUP_PROPERTY
```
    See Also:
    
    Constant Field Values
  - REST_PROPERTY
```
static final String REST_PROPERTY
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_PROPERTY
```
static final String TEMPLATE_PROPERTY
```
    See Also:
    
    Constant Field Values
  - DESCRIPTION_PROPERTY
```
static final String DESCRIPTION_PROPERTY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getId
```
String getId()
```
    Gets the route id
    
    Returns:
    
    the route id
  - getGroup
```
String getGroup()
```
    Gets the route group
    
    Returns:
    
    the route group
  - getUptime
```
String getUptime()
```
    Gets the uptime in a human readable format
    
    Returns:
    
    the uptime in days/hours/minutes
  - getUptimeMillis
```
long getUptimeMillis()
```
    Gets the uptime in milliseconds
    
    Returns:
    
    the uptime in milliseconds
  - getConsumer
```
Consumer getConsumer()
```
    Gets the inbound Consumer
    
    Returns:
    
    the inbound consumer
  - getProcessor
```
Processor getProcessor()
```
    Gets the Processor
    
    Returns:
    
    the processor
  - setProcessor
```
void setProcessor(Processor processor)
```
    Sets the Processor
  - supportsSuspension
```
boolean supportsSuspension()
```
    Whether or not the route supports suspension (suspend and resume)
    
    Returns:
    
    true if this route supports suspension
  - getProperties
```
Map<String,Object> getProperties()
```
    This property map is used to associate information about the route.
    
    Returns:
    
    properties
  - getDescription
```
String getDescription()
```
    Gets the route description (if any has been configured).
    The description is configured using the DESCRIPTION_PROPERTY as key in the getProperties().
    
    Returns:
    
    the description, or null if no description has been configured.
  - getCamelContext
```
CamelContext getCamelContext()
```
    Gets the camel context
    
    Returns:
    
    the camel context
  - getEndpoint
```
Endpoint getEndpoint()
```
    Gets the input endpoint for this route.
    
    Returns:
    
    the endpoint
  - initializeServices
```
void initializeServices()
                 throws Exception
```
    A strategy callback allowing special initialization when services are initializing.
    
    Throws:
    
    Exception - is thrown in case of error
  - getServices
```
List<Service> getServices()
```
    Returns the services for this particular route
    
    Returns:
    
    the services
  - addService
```
void addService(Service service)
```
    Adds a service to this route
    
    Parameters:
    
    service - the service
  - navigate
```
Navigate<Processor> navigate()
```
    Returns a navigator to navigate this route by navigating all the Processors.
    
    Returns:
    
    a navigator for Processor.
  - filter
```
List<Processor> filter(String pattern)
```
    Returns a list of all the Processors from this route that has id's matching the pattern
    
    Parameters:
    
    pattern - the pattern to match by ids
    
    Returns:
    
    a list of Processor, is never null.
  - warmUp
```
void warmUp()
```
    Callback preparing the route to be started, by warming up the route.
  - getLastError
```
RouteError getLastError()
```
    Gets the last error.
    
    Returns:
    
    the error
  - setLastError
```
void setLastError(RouteError error)
```
    Sets the last error.
    
    Parameters:
    
    error - the error
  - getStartupOrder
```
Integer getStartupOrder()
```
    Gets the route startup order
  - setStartupOrder
```
void setStartupOrder(Integer startupOrder)
```
    Sets the route startup order
  - getRouteController
```
RouteController getRouteController()
```
    Gets the RouteController for this route.
    
    Returns:
    
    the route controller,
  - setRouteController
```
void setRouteController(RouteController controller)
```
    Sets the RouteController for this route.
    
    Parameters:
    
    controller - the RouteController
  - setAutoStartup
```
void setAutoStartup(Boolean autoStartup)
```
    Sets whether the route should automatically start when Camel starts.
    Default is true to always start up.
    
    Specified by:
    
    setAutoStartup in interface RuntimeConfiguration
    
    Parameters:
    
    autoStartup - whether to start up automatically.
  - isAutoStartup
```
Boolean isAutoStartup()
```
    Gets whether the route should automatically start when Camel starts.
    Default is true to always start up.
    
    Specified by:
    
    isAutoStartup in interface RuntimeConfiguration
    
    Returns:
    
    true if route should automatically start
  - getRouteId
```
String getRouteId()
```
    Gets the route id
  - getRouteDescription
```
String getRouteDescription()
```
    Gets the route description
  - getRoute
```
NamedNode getRoute()
```
    Get the route type. Important: is null after the route has been created.
    
    Returns:
    
    the route type during creation of the route, is null after the route has been created.
  - clearRouteModel
```
void clearRouteModel()
```
    Clears the route model when its no longer needed.
  - getEventDrivenProcessors
```
List<Processor> getEventDrivenProcessors()
```
    This method retrieves the event driven Processors on this route context.
  - getInterceptStrategies
```
List<InterceptStrategy> getInterceptStrategies()
```
    This method retrieves the InterceptStrategy instances this route context.
    
    Returns:
    
    the strategy
  - setManagementInterceptStrategy
```
void setManagementInterceptStrategy(ManagementInterceptStrategy interceptStrategy)
```
    Sets a special intercept strategy for management.
    Is by default used to correlate managed performance counters with processors when the runtime route is being constructed
    
    Parameters:
    
    interceptStrategy - the managed intercept strategy
  - getManagementInterceptStrategy
```
ManagementInterceptStrategy getManagementInterceptStrategy()
```
    Gets the special managed intercept strategy if any
    
    Returns:
    
    the managed intercept strategy, or null if not managed
  - getRoutePolicyList
```
List<RoutePolicy> getRoutePolicyList()
```
    Gets the route policy List
    
    Returns:
    
    the route policy list if any
  - setErrorHandlerFactory
```
void setErrorHandlerFactory(ErrorHandlerFactory errorHandlerFactory)
```
  - getErrorHandlerFactory
```
ErrorHandlerFactory getErrorHandlerFactory()
```
  - getOnCompletions
```
Collection<Processor> getOnCompletions()
```
  - setOnCompletion
```
void setOnCompletion(String onCompletionId,
                     Processor processor)
```
  - getOnExceptions
```
Collection<Processor> getOnExceptions()
```
  - getOnException
```
Processor getOnException(String onExceptionId)
```
  - setOnException
```
void setOnException(String onExceptionId,
                    Processor processor)
```
  - addErrorHandler
```
void addErrorHandler(ErrorHandlerFactory factory,
                     NamedNode exception)
```
    Adds error handler for the given exception type
    
    Parameters:
    
    factory - the error handler factory
    
    exception - the exception to handle
  - getErrorHandlers
```
Set<NamedNode> getErrorHandlers(ErrorHandlerFactory factory)
```
    Gets the error handlers
    
    Parameters:
    
    factory - the error handler factory
  - addErrorHandlerFactoryReference
```
void addErrorHandlerFactoryReference(ErrorHandlerFactory source,
                                     ErrorHandlerFactory target)
```
    Link the error handlers from a factory to another
    
    Parameters:
    
    source - the source factory
    
    target - the target factory

Interface Route

Field Summary

Method Summary

Methods inherited from interface org.apache.camel.RuntimeConfiguration

Field Detail

ID_PROPERTY

CUSTOM_ID_PROPERTY

PARENT_PROPERTY

GROUP_PROPERTY

REST_PROPERTY

TEMPLATE_PROPERTY

DESCRIPTION_PROPERTY

Method Detail

getId

getGroup

getUptime

getUptimeMillis

getConsumer

getProcessor

setProcessor

supportsSuspension

getProperties

getDescription

getCamelContext

getEndpoint

initializeServices

getServices

addService

navigate

filter

warmUp

getLastError

setLastError

getStartupOrder

setStartupOrder

getRouteController

setRouteController

setAutoStartup

isAutoStartup

getRouteId

getRouteDescription

getRoute

clearRouteModel

getEventDrivenProcessors

getInterceptStrategies

setManagementInterceptStrategy

getManagementInterceptStrategy

getRoutePolicyList

setErrorHandlerFactory

getErrorHandlerFactory

getOnCompletions

setOnCompletion

getOnExceptions

getOnException

setOnException

addErrorHandler

getErrorHandlers

addErrorHandlerFactoryReference