Enum Class ContainerProperties.ShareAckMode

java.lang.Object

java.lang.Enum<ContainerProperties.ShareAckMode>

org.springframework.kafka.listener.ContainerProperties.ShareAckMode

All Implemented Interfaces:

Serializable, Comparable<ContainerProperties.ShareAckMode>, Constable

Enclosing class:

ContainerProperties

public static enum ContainerProperties.ShareAckMode
extends Enum<ContainerProperties.ShareAckMode>

The acknowledgment mode for share consumer containers.

Since:

4.1

See Also:

• ContainerProperties.setShareAckMode(ShareAckMode)

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXPLICIT	Kafka client explicit mode, container-managed.
IMPLICIT	Kafka client implicit mode.
MANUAL	Kafka client explicit mode, listener-managed.

Method Summary

Modifier and Type	Method	Description
static ContainerProperties.ShareAckMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ContainerProperties.ShareAckMode[]	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

IMPLICIT

public static final ContainerProperties.ShareAckMode IMPLICIT

Kafka client implicit mode. All records are automatically acknowledged as ACCEPT by the broker regardless of processing outcome. No per-record acknowledgment control is available in this mode. Equivalent to setting share.acknowledgement.mode=implicit on the Kafka client.

EXPLICIT

public static final ContainerProperties.ShareAckMode EXPLICIT

Kafka client explicit mode, container-managed. The container sends ACCEPT after successful processing and delegates to the ShareConsumerRecordRecoverer (default: REJECT) on error. This is the default.

MANUAL

public static final ContainerProperties.ShareAckMode MANUAL

Kafka client explicit mode, listener-managed. The listener must acknowledge each record manually via the provided ShareAcknowledgment. Subsequent polls are blocked until all records from the previous poll are acknowledged.

Method Details

values

public static ContainerProperties.ShareAckMode[] 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 ContainerProperties.ShareAckMode 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