Enum Class ProducerAccessMode

java.lang.Object

java.lang.Enum<ProducerAccessMode>

org.apache.pulsar.client.api.v5.config.ProducerAccessMode

All Implemented Interfaces:

Serializable, Comparable<ProducerAccessMode>, Constable

public enum ProducerAccessMode
extends Enum<ProducerAccessMode>

Access mode for a producer on a topic.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXCLUSIVE	Only one producer is allowed on the topic.
EXCLUSIVE_WITH_FENCING	Only one producer is allowed on the topic.
SHARED	Multiple producers can publish on the topic.
WAIT_FOR_EXCLUSIVE	Only one producer is allowed on the topic.

Method Summary

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

SHARED

public static final ProducerAccessMode SHARED

Multiple producers can publish on the topic.

EXCLUSIVE

public static final ProducerAccessMode EXCLUSIVE

Only one producer is allowed on the topic. If another producer tries to connect, it will fail.

EXCLUSIVE_WITH_FENCING

public static final ProducerAccessMode EXCLUSIVE_WITH_FENCING

Only one producer is allowed on the topic. If another producer tries to connect, the existing producer is fenced and disconnected.

WAIT_FOR_EXCLUSIVE

public static final ProducerAccessMode WAIT_FOR_EXCLUSIVE

Only one producer is allowed on the topic. If another producer is already connected, the new producer will wait until it can acquire exclusive access.

Method Details

values

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