org.apache.camel

Interface Route

All Superinterfaces:

EndpointAware

All Known Implementing Classes:

DefaultRoute, EventDrivenConsumerRoute

public interface Route
extends EndpointAware

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 String	DESCRIPTION_PROPERTY
static String	GROUP_PROPERTY
static String	ID_PROPERTY
static String	PARENT_PROPERTY
static String	REST_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
String	getDescription() Gets the route description (if any has been configured).
String	getId() Gets the route id
Map<String,Object>	getProperties() This property map is used to associate information about the route.
RouteContext	getRouteContext() Gets the route context
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(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.

Methods inherited from interface org.apache.camel.EndpointAware

getEndpoint

Field Detail

ID_PROPERTY

static final String 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

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

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

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.

getRouteContext

RouteContext getRouteContext()

Gets the route context

Returns:

the route context

onStartingServices

void onStartingServices(List<Service> services)
                        throws Exception

A strategy callback allowing special initialization when services are starting.

Parameters:

services - the service

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.

warmUp

void warmUp()

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