Package org.apache.pulsar.client.api

Enum Class ProducerAccessMode

java.lang.Object

java.lang.Enum<ProducerAccessMode>

org.apache.pulsar.client.api.ProducerAccessMode

All Implemented Interfaces:

Serializable, Comparable<ProducerAccessMode>, Constable

public enum ProducerAccessMode
extends Enum<ProducerAccessMode>

The type of access to the topic that the producer requires.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Exclusive	Require exclusive access for producer.
ExclusiveWithFencing	Acquire exclusive access for the producer.
Shared	By default multiple producers can publish on a topic.
WaitForExclusive	Producer creation is pending until it can acquire exclusive access.

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 java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Shared

public static final ProducerAccessMode Shared

By default multiple producers can publish on a topic.

Exclusive

public static final ProducerAccessMode Exclusive

Require exclusive access for producer. Fail immediately if there's already a producer connected.

ExclusiveWithFencing

public static final ProducerAccessMode ExclusiveWithFencing

Acquire exclusive access for the producer. Any existing producer will be removed and invalidated immediately.

WaitForExclusive

public static final ProducerAccessMode WaitForExclusive

Producer creation is pending 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