Enum Class ShutdownRoute

java.lang.Object
java.lang.Enum<ShutdownRoute>
org.apache.camel.ShutdownRoute
All Implemented Interfaces:
Serializable, Comparable<ShutdownRoute>, Constable

public enum ShutdownRoute extends Enum<ShutdownRoute>
Represents the options available when shutting down routes.

Is used for example to defer shutting down a route until all inflight exchanges have been completed, after which the route can be shutdown safely.

This allows fine grained configuration in accomplishing graceful shutdown where you have for example some internal route which other routes are dependent upon.

  • Default - The default behavior where a route will attempt to shutdown now
  • Defer - Will defer shutting down the route and let it be active during graceful shutdown. The route will be shutdown at a later stage during the graceful shutdown process.
  • Enum Constant Details

  • Method Details

    • values

      public static ShutdownRoute[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ShutdownRoute valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null