org.apache.camel.impl.engine

Class SupervisingRouteController

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.impl.engine.DefaultRouteController

org.apache.camel.impl.engine.SupervisingRouteController

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.RouteController, org.apache.camel.StatefulService, org.apache.camel.StaticService, org.apache.camel.SuspendableService

public class SupervisingRouteController
extends DefaultRouteController

A supervising capable RouteController that delays the startup of the routes after the camel context startup and takes control of starting the routes in a safe manner. This controller is able to retry starting failing routes, and have various options to configure settings for backoff between restarting routes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SupervisingRouteController.Filter
static class	SupervisingRouteController.FilterResult

Field Summary

Fields inherited from class org.apache.camel.support.service.BaseService

BUILDED, FAILED, INITIALIZED, INITIALIZING, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
SupervisingRouteController()

Method Summary

Modifier and Type	Method and Description
void	addFilter(SupervisingRouteController.Filter filter) Add a filter used to determine the routes to supervise.
protected void	doInit()
protected void	doShutdown()
protected void	doStart()
protected void	doStop()
org.apache.camel.util.backoff.BackOff	getBackOff(String id)
Map<String,org.apache.camel.util.backoff.BackOff>	getBackOffConfigurations()
Optional<org.apache.camel.util.backoff.BackOffTimer.Task>	getBackOffContext(String id)
Collection<org.apache.camel.Route>	getControlledRoutes()
org.apache.camel.util.backoff.BackOff	getDefaultBackOff()
Collection<SupervisingRouteController.Filter>	getFilters()
Duration	getInitialDelay()
void	resumeRoute(String routeId)
void	setBackOff(String id, org.apache.camel.util.backoff.BackOff backOff) Sets the back-off to be applied to the given id.
void	setBackOffConfigurations(Map<String,org.apache.camel.util.backoff.BackOff> backOffConfigurations) Set the back-off for the given IDs.
void	setDefaultBackOff(org.apache.camel.util.backoff.BackOff defaultBackOff) Sets the default back-off.
void	setFilters(Collection<SupervisingRouteController.Filter> filters) Sets the filters user to determine the routes to supervise.
void	setInitialDelay(Duration initialDelay) Set the amount of time the route controller should wait before to start the routes after the camel context is started or after the route is initialized if the route is created after the camel context is started.
void	setInitialDelay(long initialDelay) #see this#setInitialDelay(Duration)
void	setInitialDelay(long initialDelay, TimeUnit initialDelayUnit) #see this#setInitialDelay(Duration)
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)

Methods inherited from class org.apache.camel.impl.engine.DefaultRouteController

getCamelContext, getInternalRouteController, getRouteStatus, isStartingRoutes, setCamelContext, startAllRoutes

Methods inherited from class org.apache.camel.support.service.BaseService

build, doBuild, doFail, doLifecycleChange, doResume, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.camel.spi.RouteController

unwrap

Methods inherited from interface org.apache.camel.CamelContextAware

trySetCamelContext

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Constructor Detail

SupervisingRouteController

public SupervisingRouteController()

Method Detail

getDefaultBackOff

public org.apache.camel.util.backoff.BackOff getDefaultBackOff()

setDefaultBackOff

public void setDefaultBackOff(org.apache.camel.util.backoff.BackOff defaultBackOff)

Sets the default back-off.

getBackOffConfigurations

public Map<String,org.apache.camel.util.backoff.BackOff> getBackOffConfigurations()

setBackOffConfigurations

public void setBackOffConfigurations(Map<String,org.apache.camel.util.backoff.BackOff> backOffConfigurations)

Set the back-off for the given IDs.

getBackOff

public org.apache.camel.util.backoff.BackOff getBackOff(String id)

setBackOff

public void setBackOff(String id,
                       org.apache.camel.util.backoff.BackOff backOff)

Sets the back-off to be applied to the given id.

getInitialDelay

public Duration getInitialDelay()

setInitialDelay

public void setInitialDelay(Duration initialDelay)

Set the amount of time the route controller should wait before to start the routes after the camel context is started or after the route is initialized if the route is created after the camel context is started.

Parameters:

initialDelay - the initial delay.

setInitialDelay

public void setInitialDelay(long initialDelay,
                            TimeUnit initialDelayUnit)

#see this#setInitialDelay(Duration)

Parameters:

initialDelay - the initial delay amount.

setInitialDelay

public void setInitialDelay(long initialDelay)

#see this#setInitialDelay(Duration)

Parameters:

initialDelay - the initial delay in milliseconds.

addFilter

public void addFilter(SupervisingRouteController.Filter filter)

Add a filter used to determine the routes to supervise.

setFilters

public void setFilters(Collection<SupervisingRouteController.Filter> filters)

Sets the filters user to determine the routes to supervise.

getFilters

public Collection<SupervisingRouteController.Filter> getFilters()

getBackOffContext

public Optional<org.apache.camel.util.backoff.BackOffTimer.Task> getBackOffContext(String id)

doInit

protected void doInit()
               throws Exception

Overrides:

doInit in class org.apache.camel.support.service.BaseService

Throws:

Exception

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.apache.camel.support.service.BaseService

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class org.apache.camel.support.service.BaseService

Throws:

Exception

doShutdown

protected void doShutdown()
                   throws Exception

Overrides:

doShutdown in class org.apache.camel.support.service.BaseService

Throws:

Exception

startRoute

public void startRoute(String routeId)
                throws Exception

Specified by:

startRoute in interface org.apache.camel.spi.RouteController

Overrides:

startRoute in class DefaultRouteController

Throws:

Exception

stopRoute

public void stopRoute(String routeId)
               throws Exception

Specified by:

stopRoute in interface org.apache.camel.spi.RouteController

Overrides:

stopRoute in class DefaultRouteController

Throws:

Exception

stopRoute

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

Specified by:

stopRoute in interface org.apache.camel.spi.RouteController

Overrides:

stopRoute in class DefaultRouteController

Throws:

Exception

stopRoute

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

Specified by:

stopRoute in interface org.apache.camel.spi.RouteController

Overrides:

stopRoute in class DefaultRouteController

Throws:

Exception

suspendRoute

public void suspendRoute(String routeId)
                  throws Exception

Specified by:

suspendRoute in interface org.apache.camel.spi.RouteController

Overrides:

suspendRoute in class DefaultRouteController

Throws:

Exception

suspendRoute

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

Specified by:

suspendRoute in interface org.apache.camel.spi.RouteController

Overrides:

suspendRoute in class DefaultRouteController

Throws:

Exception

resumeRoute

public void resumeRoute(String routeId)
                 throws Exception

Specified by:

resumeRoute in interface org.apache.camel.spi.RouteController

Overrides:

resumeRoute in class DefaultRouteController

Throws:

Exception

getControlledRoutes

public Collection<org.apache.camel.Route> getControlledRoutes()

Specified by:

getControlledRoutes in interface org.apache.camel.spi.RouteController

Overrides:

getControlledRoutes in class DefaultRouteController