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

Field Summary

static String	GROUP_PROPERTY
static String	ID_PROPERTY
static String	PARENT_PROPERTY

Method Summary

void	addService(Service service) Adds a service to this route
Consumer	getConsumer() Gets the inbound Consumer
Endpoint	getEndpoint() Gets the inbound endpoint
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 is starting.
boolean	supportsSuspension() Whether or not the route supports suspension

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

Method Detail

getId

String getId()

Gets the route id

Returns:

the route id

getEndpoint

Endpoint getEndpoint()

Gets the inbound endpoint

getConsumer

Consumer getConsumer()

Gets the inbound Consumer

supportsSuspension

boolean supportsSuspension()

Whether or not the route supports suspension

getProperties

Map<String,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(List<Service> services)
                        throws Exception

A strategy callback allowing special initialization when services is starting.

Parameters:

services - the service

Throws:

Exception - is thrown in case of error

getServices

List<Service> getServices()

Returns the services for this particular route

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.