DefaultShutdownStrategy (Camel

java.lang.Object
- org.apache.camel.support.ServiceSupport
- - org.apache.camel.impl.DefaultShutdownStrategy

All Implemented Interfaces:

CamelContextAware, Service, ShutdownableService, ShutdownStrategy, StatefulService, StaticService, SuspendableService
```
public class DefaultShutdownStrategy
extends ServiceSupport
implements ShutdownStrategy, CamelContextAware
```
Default ShutdownStrategy which uses graceful shutdown.
Graceful shutdown ensures that any inflight and pending messages will be taken into account and it will wait until these exchanges has been completed.
This strategy will perform graceful shutdown in two steps:
- Graceful - By suspending/stopping consumers, and let any in-flight exchanges complete
- Forced - After a given period of time, a timeout occurred and if there are still pending exchanges to complete, then a more aggressive forced strategy is performed.
The idea by the graceful shutdown strategy, is to stop taking in more new messages, and allow any existing inflight messages to complete. Then when there is no more inflight messages then the routes can be fully shutdown. This mean that if there is inflight messages then we will have to wait for these messages to complete. If they do not complete after a period of time, then a timeout triggers. And then a more aggressive strategy takes over.
The idea by the forced shutdown strategy, is to stop continue processing messages. And force routes and its services to shutdown now. There is a risk when shutting down now, that some resources is not properly shutdown, which can cause side effects. The timeout value is by default 300 seconds, but can be customized.
As this strategy will politely wait until all exchanges has been completed it can potential wait for a long time, and hence why a timeout value can be set. When the timeout triggers you can also specify whether the remainder consumers should be shutdown now or ignore.
Will by default use a timeout of 300 seconds (5 minutes) by which it will shutdown now the remaining consumers. This ensures that when shutting down Camel it at some point eventually will shutdown. This behavior can of course be configured using the setTimeout(long) and setShutdownNowOnTimeout(boolean) methods.
Routes will by default be shutdown in the reverse order of which they where started. You can customize this using the setShutdownRoutesInReverseOrder(boolean) method.
After route consumers have been shutdown, then any ShutdownPrepared services on the routes is being prepared for shutdown, by invoking ShutdownPrepared#prepareShutdown(boolean) which force=false.
Then if a timeout occurred and the strategy has been configured with shutdown-now on timeout, then the strategy performs a more aggressive forced shutdown, by forcing all consumers to shutdown and then invokes ShutdownPrepared#prepareShutdown(boolean) with force=true on the services. This allows the services to know they should force shutdown now.
When timeout occurred and a forced shutdown is happening, then there may be threads/tasks which are still inflight which may be rejected continued being routed. By default this can cause WARN and ERRORs to be logged. The option setSuppressLoggingOnTimeout(boolean) can be used to suppress these logs, so they are logged at TRACE level instead.
Also when a timeout occurred then information about the inflight exchanges is logged, if isLogInflightExchangesOnTimeout() is enabled (is by default). This allows end users to known where these inflight exchanges currently are in the route(s), and how long time they have been inflight.
This information can also be obtained from the InflightRepository at all time during runtime.
Version:

Field Summary
- Fields inherited from class org.apache.camel.support.ServiceSupport
  shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors
Constructor and Description

DefaultShutdownStrategy()

DefaultShutdownStrategy(CamelContext camelContext)

Constructors
Constructor and Description
`DefaultShutdownStrategy()`
`DefaultShutdownStrategy(CamelContext camelContext)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`doShutdown()` Implementations override this method to perform customized shutdown.
`protected boolean`	`doShutdown(CamelContext context, List<RouteStartupOrder> routes, long timeout, TimeUnit timeUnit, boolean suspendOnly, boolean abortAfterTimeout, boolean forceShutdown)`
`protected void`	`doStart()` Implementations override this method to support customized start/stop.
`protected void`	`doStop()` Implementations override this method to support customized start/stop.
`boolean`	`forceShutdown(Service service)` Whether a service is forced to shutdown.
`CamelContext`	`getCamelContext()` Get the `CamelContext`
`Future<?>`	`getCurrentShutdownTaskFuture()`
`protected static int`	`getPendingInflightExchanges(RouteStartupOrder order)` Calculates the total number of inflight exchanges for the given route
`long`	`getTimeout()` Gets the timeout.
`TimeUnit`	`getTimeUnit()` Gets the time unit used
`boolean`	`hasTimeoutOccurred()` Whether a timeout has occurred during a shutdown.
`boolean`	`isLogInflightExchangesOnTimeout()` Whether to log information about the inflight `Exchange`s which are still running during a shutdown which didn't complete without the given timeout.
`boolean`	`isShutdownNowOnTimeout()` Whether to force shutdown of all consumers when a timeout occurred.
`boolean`	`isShutdownRoutesInReverseOrder()` Whether to shutdown routes in reverse order than they where started.
`boolean`	`isSuppressLoggingOnTimeout()` Whether Camel should try to suppress logging during shutdown and timeout was triggered, meaning forced shutdown is happening.
`protected static void`	`logInflightExchanges(CamelContext camelContext, List<RouteStartupOrder> routes, boolean infoLevel)` Logs information about the inflight exchanges
`void`	`setCamelContext(CamelContext camelContext)` Injects the `CamelContext`
`void`	`setLogInflightExchangesOnTimeout(boolean logInflightExchangesOnTimeout)` Sets whether to log information about the inflight `Exchange`s which are still running during a shutdown which didn't complete without the given timeout.
`void`	`setShutdownNowOnTimeout(boolean shutdownNowOnTimeout)` Sets whether to force shutdown of all consumers when a timeout occurred and thus not all consumers was shutdown within that period.
`void`	`setShutdownRoutesInReverseOrder(boolean shutdownRoutesInReverseOrder)` Sets whether routes should be shutdown in reverse or the same order as they where started.
`void`	`setSuppressLoggingOnTimeout(boolean suppressLoggingOnTimeout)` Whether Camel should try to suppress logging during shutdown and timeout was triggered, meaning forced shutdown is happening.
`void`	`setTimeout(long timeout)` Set an timeout to wait for the shutdown to complete.
`void`	`setTimeUnit(TimeUnit timeUnit)` Set the time unit to use
`void`	`shutdown(CamelContext context, List<RouteStartupOrder> routes)` Shutdown the routes
`void`	`shutdown(CamelContext context, List<RouteStartupOrder> routes, long timeout, TimeUnit timeUnit)` Shutdown the routes using a specified timeout instead of the default timeout values
`boolean`	`shutdown(CamelContext context, RouteStartupOrder route, long timeout, TimeUnit timeUnit, boolean abortAfterTimeout)` Shutdown the route using a specified timeout instead of the default timeout values and supports abortAfterTimeout mode
`void`	`shutdownForced(CamelContext context, List<RouteStartupOrder> routes)` Shutdown the routes, forcing shutdown being more aggressive, if timeout occurred.
`protected static void`	`shutdownNow(Consumer consumer)` Shutdown the consumer immediately.
`protected void`	`shutdownNow(List<Consumer> consumers)` Shutdown all the consumers immediately.
`protected void`	`shutdownRoutesNow(List<RouteStartupOrder> routes)` Shutdown all the consumers immediately.
`void`	`suspend(CamelContext context, List<RouteStartupOrder> routes)` Suspends the routes
`void`	`suspend(CamelContext context, List<RouteStartupOrder> routes, long timeout, TimeUnit timeUnit)` Suspends the routes using a specified timeout instead of the default timeout values
`protected static void`	`suspendNow(Consumer consumer)` Suspends/stops the consumer immediately.

Methods inherited from class org.apache.camel.support.ServiceSupport
doResume, 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

Methods inherited from interface org.apache.camel.Service
start, stop

- Constructor Detail
  - DefaultShutdownStrategy
```
public DefaultShutdownStrategy()
```
  - DefaultShutdownStrategy
```
public DefaultShutdownStrategy(CamelContext camelContext)
```
- Method Detail
  - shutdown
```
public void shutdown(CamelContext context,
            List<RouteStartupOrder> routes)
              throws Exception
```
    Description copied from interface: ShutdownStrategy
    
    Shutdown the routes
    
    Specified by:
    
    shutdown in interface ShutdownStrategy
    
    Parameters:
    context - the camel context
    routes - the routes, ordered by the order they was started
    
    Throws:
    
    Exception - is thrown if error shutting down the consumers, however its preferred to avoid this
  - shutdownForced
```
public void shutdownForced(CamelContext context,
                  List<RouteStartupOrder> routes)
                    throws Exception
```
    Description copied from interface: ShutdownStrategy
    
    Shutdown the routes, forcing shutdown being more aggressive, if timeout occurred.
    This operation is used when CamelContext is shutting down, to ensure Camel will shutdown if messages seems to be stuck.
    
    Specified by:
    
    shutdownForced in interface ShutdownStrategy
    
    Parameters:
    context - the camel context
    routes - the routes, ordered by the order they was started
    
    Throws:
    
    Exception - is thrown if error shutting down the consumers, however its preferred to avoid this
  - suspend
```
public void suspend(CamelContext context,
           List<RouteStartupOrder> routes)
             throws Exception
```
    Description copied from interface: ShutdownStrategy
    
    Suspends the routes
    
    Specified by:
    
    suspend in interface ShutdownStrategy
    
    Parameters:
    context - the camel context
    routes - the routes, ordered by the order they was started
    
    Throws:
    
    Exception - is thrown if error suspending the consumers, however its preferred to avoid this
  - shutdown
```
public void shutdown(CamelContext context,
            List<RouteStartupOrder> routes,
            long timeout,
            TimeUnit timeUnit)
              throws Exception
```
    Description copied from interface: ShutdownStrategy
    
    Shutdown the routes using a specified timeout instead of the default timeout values
    
    Specified by:
    
    shutdown in interface ShutdownStrategy
    
    Parameters:
    context - the camel context
    routes - the routes, ordered by the order they was started
    timeout - timeout
    timeUnit - the unit to use
    
    Throws:
    
    Exception - is thrown if error shutting down the consumers, however its preferred to avoid this
  - shutdown
```
public boolean shutdown(CamelContext context,
               RouteStartupOrder route,
               long timeout,
               TimeUnit timeUnit,
               boolean abortAfterTimeout)
                 throws Exception
```
    Description copied from interface: ShutdownStrategy
    
    Shutdown the route using a specified timeout instead of the default timeout values and supports abortAfterTimeout mode
    
    Specified by:
    
    shutdown in interface ShutdownStrategy
    
    Parameters:
    context - the camel context
    route - the route
    timeout - timeout
    timeUnit - the unit to use
    abortAfterTimeout - should abort shutdown after timeout
    
    Returns:
    true if the route is stopped before the timeout
    
    Throws:
    
    Exception - is thrown if error shutting down the consumer, however its preferred to avoid this
  - suspend
```
public void suspend(CamelContext context,
           List<RouteStartupOrder> routes,
           long timeout,
           TimeUnit timeUnit)
             throws Exception
```
    Description copied from interface: ShutdownStrategy
    
    Suspends the routes using a specified timeout instead of the default timeout values
    
    Specified by:
    
    suspend in interface ShutdownStrategy
    
    Parameters:
    context - the camel context
    routes - the routes, ordered by the order they was started
    timeout - timeout
    timeUnit - the unit to use
    
    Throws:
    
    Exception - is thrown if error suspending the consumers, however its preferred to avoid this
  - doShutdown
```
protected boolean doShutdown(CamelContext context,
                 List<RouteStartupOrder> routes,
                 long timeout,
                 TimeUnit timeUnit,
                 boolean suspendOnly,
                 boolean abortAfterTimeout,
                 boolean forceShutdown)
                      throws Exception
```
    Throws:
    
    Exception
  - forceShutdown
```
public boolean forceShutdown(Service service)
```
    Description copied from interface: ShutdownStrategy
    
    Whether a service is forced to shutdown.
    Can be used to signal to services that they are no longer allowed to run, such as if a forced shutdown is currently in progress.
    For example the Camel RedeliveryErrorHandler uses this information to know if a forced shutdown is in progress, and then break out of redelivery attempts.
    
    Specified by:
    
    forceShutdown in interface ShutdownStrategy
    
    Parameters:
    service - the service
    
    Returns:
    true indicates the service is to be forced to shutdown, false the service can keep running.
  - hasTimeoutOccurred
```
public boolean hasTimeoutOccurred()
```
    Description copied from interface: ShutdownStrategy
    
    Whether a timeout has occurred during a shutdown.
    
    Specified by:
    
    hasTimeoutOccurred in interface ShutdownStrategy
  - setTimeout
```
public void setTimeout(long timeout)
```
    Description copied from interface: ShutdownStrategy
    
    Set an timeout to wait for the shutdown to complete.
    You must set a positive value. If you want to wait (forever) then use a very high value such as Long.MAX_VALUE
    The default timeout unit is SECONDS
    
    Specified by:
    
    setTimeout in interface ShutdownStrategy
    
    Parameters:
    timeout - timeout
  - getTimeout
```
public long getTimeout()
```
    Description copied from interface: ShutdownStrategy
    
    Gets the timeout.
    The default timeout unit is SECONDS
    
    Specified by:
    
    getTimeout in interface ShutdownStrategy
    
    Returns:
    the timeout
  - setTimeUnit
```
public void setTimeUnit(TimeUnit timeUnit)
```
    Description copied from interface: ShutdownStrategy
    
    Set the time unit to use
    
    Specified by:
    
    setTimeUnit in interface ShutdownStrategy
    
    Parameters:
    timeUnit - the unit to use
  - getTimeUnit
```
public TimeUnit getTimeUnit()
```
    Description copied from interface: ShutdownStrategy
    
    Gets the time unit used
    
    Specified by:
    
    getTimeUnit in interface ShutdownStrategy
    
    Returns:
    the time unit
  - setShutdownNowOnTimeout
```
public void setShutdownNowOnTimeout(boolean shutdownNowOnTimeout)
```
    Description copied from interface: ShutdownStrategy
    
    Sets whether to force shutdown of all consumers when a timeout occurred and thus not all consumers was shutdown within that period.
    You should have good reasons to set this option to false as it means that the routes keep running and is halted abruptly when CamelContext has been shutdown.
    
    Specified by:
    
    setShutdownNowOnTimeout in interface ShutdownStrategy
    
    Parameters:
    shutdownNowOnTimeout - true to force shutdown, false to leave them running
  - isShutdownNowOnTimeout
```
public boolean isShutdownNowOnTimeout()
```
    Description copied from interface: ShutdownStrategy
    
    Whether to force shutdown of all consumers when a timeout occurred.
    
    Specified by:
    
    isShutdownNowOnTimeout in interface ShutdownStrategy
    
    Returns:
    force shutdown or not
  - isShutdownRoutesInReverseOrder
```
public boolean isShutdownRoutesInReverseOrder()
```
    Description copied from interface: ShutdownStrategy
    
    Whether to shutdown routes in reverse order than they where started.
    This option is by default set to true.
    
    Specified by:
    
    isShutdownRoutesInReverseOrder in interface ShutdownStrategy
    
    Returns:
    true if routes should be shutdown in reverse order.
  - setShutdownRoutesInReverseOrder
```
public void setShutdownRoutesInReverseOrder(boolean shutdownRoutesInReverseOrder)
```
    Description copied from interface: ShutdownStrategy
    
    Sets whether routes should be shutdown in reverse or the same order as they where started.
    
    Specified by:
    
    setShutdownRoutesInReverseOrder in interface ShutdownStrategy
    
    Parameters:
    shutdownRoutesInReverseOrder - true to shutdown in reverse order
  - isSuppressLoggingOnTimeout
```
public boolean isSuppressLoggingOnTimeout()
```
    Description copied from interface: ShutdownStrategy
    
    Whether Camel should try to suppress logging during shutdown and timeout was triggered, meaning forced shutdown is happening. And during forced shutdown we want to avoid logging errors/warnings et all in the logs as a side-effect of the forced timeout.
    By default this is false
    Notice the suppress is a best effort as there may still be some logs coming from 3rd party libraries and whatnot, which Camel cannot control.
    
    Specified by:
    
    isSuppressLoggingOnTimeout in interface ShutdownStrategy
  - setSuppressLoggingOnTimeout
```
public void setSuppressLoggingOnTimeout(boolean suppressLoggingOnTimeout)
```
    Description copied from interface: ShutdownStrategy
    
    Whether Camel should try to suppress logging during shutdown and timeout was triggered, meaning forced shutdown is happening. And during forced shutdown we want to avoid logging errors/warnings et all in the logs as a side-effect of the forced timeout.
    By default this is false
    Notice the suppress is a best effort as there may still be some logs coming from 3rd party libraries and whatnot, which Camel cannot control.
    
    Specified by:
    
    setSuppressLoggingOnTimeout in interface ShutdownStrategy
    
    Parameters:
    suppressLoggingOnTimeout - true to suppress logging, false to log as usual.
  - isLogInflightExchangesOnTimeout
```
public boolean isLogInflightExchangesOnTimeout()
```
    Description copied from interface: ShutdownStrategy
    
    Whether to log information about the inflight Exchanges which are still running during a shutdown which didn't complete without the given timeout.
    
    Specified by:
    
    isLogInflightExchangesOnTimeout in interface ShutdownStrategy
  - setLogInflightExchangesOnTimeout
```
public void setLogInflightExchangesOnTimeout(boolean logInflightExchangesOnTimeout)
```
    Description copied from interface: ShutdownStrategy
    
    Sets whether to log information about the inflight Exchanges which are still running during a shutdown which didn't complete without the given timeout.
    
    Specified by:
    
    setLogInflightExchangesOnTimeout in interface ShutdownStrategy
    
    Parameters:
    logInflightExchangesOnTimeout - true to log information about the inflight exchanges, false to not log
  - 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
  - getCurrentShutdownTaskFuture
```
public Future<?> getCurrentShutdownTaskFuture()
```
  - shutdownRoutesNow
```
protected void shutdownRoutesNow(List<RouteStartupOrder> routes)
```
    Shutdown all the consumers immediately.
    
    Parameters:
    routes - the routes to shutdown
  - shutdownNow
```
protected void shutdownNow(List<Consumer> consumers)
```
    Shutdown all the consumers immediately.
    
    Parameters:
    consumers - the consumers to shutdown
  - shutdownNow
```
protected static void shutdownNow(Consumer consumer)
```
    Shutdown the consumer immediately.
    
    Parameters:
    consumer - the consumer to shutdown
  - suspendNow
```
protected static void suspendNow(Consumer consumer)
```
    Suspends/stops the consumer immediately.
    
    Parameters:
    consumer - the consumer to suspend
  - doStart
```
protected void doStart()
                throws Exception
```
    Description copied from class: ServiceSupport
    
    Implementations override this method to support customized start/stop.
    Important: See ServiceSupport.doStop() for more details.
    
    Specified by:
    
    doStart in class ServiceSupport
    
    Throws:
    
    Exception
    See Also:
    ServiceSupport.doStop()
  - 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.
    
    Specified by:
    
    doStop in class ServiceSupport
    
    Throws:
    
    Exception
    See Also:
    ServiceSupport.doStart()
  - doShutdown
```
protected void doShutdown()
                   throws Exception
```
    Description copied from class: ServiceSupport
    
    Implementations override this method to perform customized shutdown.
    
    Overrides:
    
    doShutdown in class ServiceSupport
    
    Throws:
    
    Exception
  - getPendingInflightExchanges
```
protected static int getPendingInflightExchanges(RouteStartupOrder order)
```
    Calculates the total number of inflight exchanges for the given route
    
    Parameters:
    order - the route
    
    Returns:
    number of inflight exchanges
  - logInflightExchanges
```
protected static void logInflightExchanges(CamelContext camelContext,
                        List<RouteStartupOrder> routes,
                        boolean infoLevel)
```
    Logs information about the inflight exchanges
    
    Parameters:
    infoLevel - true to log at INFO level, false to log at DEBUG level

Class DefaultShutdownStrategy

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.camel.Service

Constructor Detail

DefaultShutdownStrategy

DefaultShutdownStrategy

Method Detail

shutdown

shutdownForced

suspend

shutdown

shutdown

suspend

doShutdown

forceShutdown

hasTimeoutOccurred

setTimeout

getTimeout

setTimeUnit

getTimeUnit

setShutdownNowOnTimeout

isShutdownNowOnTimeout

isShutdownRoutesInReverseOrder

setShutdownRoutesInReverseOrder

isSuppressLoggingOnTimeout

setSuppressLoggingOnTimeout

isLogInflightExchangesOnTimeout

setLogInflightExchangesOnTimeout

getCamelContext

setCamelContext

getCurrentShutdownTaskFuture

shutdownRoutesNow

shutdownNow

shutdownNow

suspendNow

doStart

doStop

doShutdown

getPendingInflightExchanges

logInflightExchanges