org.apache.camel.spi

Interface RouteController

All Superinterfaces:

CamelContextAware, Service

All Known Implementing Classes:

ClusteredRouteController, DefaultRouteController, SupervisingRouteController

public interface RouteController
extends CamelContextAware, Service

Method Summary

Modifier and Type	Method and Description
Collection<Route>	getControlledRoutes() Return the list of routes controlled by this controller.
void	resumeRoute(String routeId)
void	startRoute(String routeId)
void	stopRoute(String routeId)
void	stopRoute(String routeId, long timeout, TimeUnit timeUnit)
boolean	stopRoute(String routeId, long timeout, TimeUnit timeUnit, boolean abortAfterTimeout)
void	suspendRoute(String routeId)
void	suspendRoute(String routeId, long timeout, TimeUnit timeUnit)
default <T extends RouteController> T	unwrap(Class<T> clazz) Access the underlying concrete RouteController implementation.

Methods inherited from interface org.apache.camel.CamelContextAware

getCamelContext, setCamelContext

Methods inherited from interface org.apache.camel.Service

start, stop

Method Detail

getControlledRoutes

Collection<Route> getControlledRoutes()

Return the list of routes controlled by this controller.

Returns:

the list of controlled routes

startRoute

void startRoute(String routeId)
         throws Exception

Throws:

Exception

stopRoute

void stopRoute(String routeId)
        throws Exception

Throws:

Exception

stopRoute

void stopRoute(String routeId,
               long timeout,
               TimeUnit timeUnit)
        throws Exception

Throws:

Exception

stopRoute

boolean stopRoute(String routeId,
                  long timeout,
                  TimeUnit timeUnit,
                  boolean abortAfterTimeout)
           throws Exception

Throws:

Exception

suspendRoute

void suspendRoute(String routeId)
           throws Exception

Throws:

Exception

suspendRoute

void suspendRoute(String routeId,
                  long timeout,
                  TimeUnit timeUnit)
           throws Exception

Throws:

Exception

resumeRoute

void resumeRoute(String routeId)
          throws Exception

Throws:

Exception

unwrap

default <T extends RouteController> T unwrap(Class<T> clazz)

Access the underlying concrete RouteController implementation.

Parameters:

clazz - the proprietary class or interface of the underlying concrete RouteController.

Returns:

an instance of the underlying concrete RouteController as the required type.