org.apache.camel

Interface Route

All Known Implementing Classes:

DefaultRoute, EventDrivenConsumerRoute

public interface Route

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 CamelContext.startRoute(String) and CamelContext.stopRoute(String) methods.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GROUP_PROPERTY
static java.lang.String	ID_PROPERTY
static java.lang.String	PARENT_PROPERTY

Method Summary

Methods

Modifier and Type	Method and Description
void	addService(Service service) Adds a service to this route
Consumer	getConsumer() Gets the inbound Consumer
Endpoint	getEndpoint() Gets the inbound endpoint
java.lang.String	getId() Gets the route id
java.util.Map<java.lang.String,java.lang.Object>	getProperties() This property map is used to associate information about the route.
RouteContext	getRouteContext() Gets the route context
java.util.List<Service>	getServices() Returns the services for this particular route
Navigate<Processor>	navigate() Returns a navigator to navigate this route by navigating all the Processors.
void	onStartingServices(java.util.List<Service> services) A strategy callback allowing special initialization when services are starting.
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 java.lang.String ID_PROPERTY

See Also:

Constant Field Values

PARENT_PROPERTY

static final java.lang.String PARENT_PROPERTY

See Also:

Constant Field Values

GROUP_PROPERTY

static final java.lang.String GROUP_PROPERTY

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Gets the route id

Returns:

the route id

getEndpoint

Endpoint getEndpoint()

Gets the inbound endpoint

Returns:

the inbound endpoint

getConsumer

Consumer getConsumer()

Gets the inbound Consumer

Returns:

the inbound consumer

supportsSuspension

boolean supportsSuspension()

Whether or not the route supports suspension (suspend and resume)

Returns:

true if this route supports suspension

getProperties

java.util.Map<java.lang.String,java.lang.Object> getProperties()

This property map is used to associate information about the route.

Returns:

properties

getRouteContext

RouteContext getRouteContext()

Gets the route context

Returns:

the route context

onStartingServices

void onStartingServices(java.util.List<Service> services)
                        throws java.lang.Exception

A strategy callback allowing special initialization when services are starting.

Parameters:

services - the service

Throws:

java.lang.Exception - is thrown in case of error

getServices

java.util.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.

warmUp

void warmUp()

Callback preparing the route to be started, by warming up the route.