org.apache.camel.impl

Class DurationRoutePolicy

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.support.RoutePolicySupport

org.apache.camel.impl.DurationRoutePolicy

All Implemented Interfaces:

CamelContextAware, Service, ShutdownableService, RoutePolicy, StatefulService, SuspendableService

public class DurationRoutePolicy
extends RoutePolicySupport
implements CamelContextAware

RoutePolicy which executes for a duration and then triggers an action.

This can be used to stop the route after it has processed a number of messages, or has been running for N seconds.

Field Summary

Fields inherited from class org.apache.camel.support.RoutePolicySupport

log

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
DurationRoutePolicy()
DurationRoutePolicy(CamelContext camelContext, String routeId)

Method Summary

Modifier and Type	Method and Description
protected void	doStop() Implementations override this method to support customized start/stop.
org.apache.camel.impl.DurationRoutePolicy.Action	getAction()
CamelContext	getCamelContext() Get the CamelContext
int	getMaxMessages()
int	getMaxSeconds()
void	onExchangeDone(Route route, Exchange exchange) Callback invoked when an Exchange is done being routed, where it started from the given Route Notice this callback is invoked when the Exchange is done and the Route is the route where the Exchange was started.
void	onInit(Route route) Callback invoked when the Route is being initialized
protected ScheduledFuture	performMaxDurationAction()
protected void	performMaxMessagesAction()
void	setAction(org.apache.camel.impl.DurationRoutePolicy.Action action) What action to perform when maximum is triggered.
void	setCamelContext(CamelContext camelContext) Injects the CamelContext
void	setMaxMessages(int maxMessages) Maximum number of messages to process before the action is triggered
void	setMaxSeconds(int maxSeconds) Maximum seconds Camel is running before the action is triggered

Methods inherited from class org.apache.camel.support.RoutePolicySupport

doStart, getExceptionHandler, handleException, onExchangeBegin, onRemove, onResume, onStart, onStop, onSuspend, resumeOrStartConsumer, resumeRoute, setExceptionHandler, startConsumer, startRoute, stopConsumer, stopRoute, stopRoute, stopRouteAsync, suspendOrStopConsumer, suspendRoute, suspendRoute

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, 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

Constructor Detail

DurationRoutePolicy

public DurationRoutePolicy()

DurationRoutePolicy

public DurationRoutePolicy(CamelContext camelContext,
                           String routeId)

Method Detail

getCamelContext

public CamelContext getCamelContext()

Description copied from interface: CamelContextAware

Get the CamelContext

Specified by:

getCamelContext in interface CamelContextAware

Returns:

camelContext the Camel context

setCamelContext

public void setCamelContext(CamelContext camelContext)

Description copied from interface: CamelContextAware

Injects the CamelContext

Specified by:

setCamelContext in interface CamelContextAware

Parameters:

camelContext - the Camel context

getMaxMessages

public int getMaxMessages()

setMaxMessages

public void setMaxMessages(int maxMessages)

Maximum number of messages to process before the action is triggered

getMaxSeconds

public int getMaxSeconds()

setMaxSeconds

public void setMaxSeconds(int maxSeconds)

Maximum seconds Camel is running before the action is triggered

getAction

public org.apache.camel.impl.DurationRoutePolicy.Action getAction()

setAction

public void setAction(org.apache.camel.impl.DurationRoutePolicy.Action action)

What action to perform when maximum is triggered.

onInit

public void onInit(Route route)

Description copied from interface: RoutePolicy

Callback invoked when the Route is being initialized

Specified by:

onInit in interface RoutePolicy

Overrides:

onInit in class RoutePolicySupport

Parameters:

route - the route being initialized

onExchangeDone

public void onExchangeDone(Route route,
                           Exchange exchange)

Description copied from interface: RoutePolicy

Callback invoked when an Exchange is done being routed, where it started from the given Route

Notice this callback is invoked when the Exchange is done and the Route is the route where the Exchange was started. Most often its also the route where the exchange is done. However its possible to route an Exchange to other routes using endpoints such as direct or seda. Bottom line is that the Route parameter may not be the endpoint route and thus why we state its the starting route.

Specified by:

onExchangeDone in interface RoutePolicy

Overrides:

onExchangeDone in class RoutePolicySupport

Parameters:

route - the route where the exchange started from

exchange - the created exchange

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class RoutePolicySupport

Throws:

Exception

See Also:

ServiceSupport.doStart()

performMaxMessagesAction

protected void performMaxMessagesAction()

performMaxDurationAction

protected ScheduledFuture performMaxDurationAction()