Enum Class ShutdownRunningTask

java.lang.Object

java.lang.Enum<ShutdownRunningTask>

org.apache.camel.ShutdownRunningTask

All Implemented Interfaces:

Serializable, Comparable<ShutdownRunningTask>, Constable

public enum ShutdownRunningTask
extends Enum<ShutdownRunningTask>

Per-consumer policy controlling how many pending tasks are processed before the consumer stops during graceful shutdown.

Set on a route via the DSL .shutdownRunningTask(ShutdownRunningTask.CompleteAllTasks) call. Most consumers handle a single task at a time, so the distinction only matters for BatchConsumer implementations (such as file or JPA consumers) that can have multiple pending messages in a batch when shutdown is triggered.

• CompleteCurrentTaskOnly - the default: finish the current in-flight task and then stop; any remaining pending tasks are left unprocessed.
• CompleteAllTasks - drain the entire current batch before stopping; only applicable to BatchConsumer consumers.

See Also:

• ShutdownRoute
• BatchConsumer
• ShutdownStrategy

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CompleteAllTasks
CompleteCurrentTaskOnly

Method Summary

Modifier and Type	Method	Description
static ShutdownRunningTask	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ShutdownRunningTask[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CompleteCurrentTaskOnly

public static final ShutdownRunningTask CompleteCurrentTaskOnly

CompleteAllTasks

public static final ShutdownRunningTask CompleteAllTasks

Method Details

values

public static ShutdownRunningTask[] 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 ShutdownRunningTask 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