org.apache.pulsar.client.api

Class ReaderConfiguration

java.lang.Object

org.apache.pulsar.client.api.ReaderConfiguration

All Implemented Interfaces:

Serializable

Deprecated.

Use PulsarClient.newReader() to construct and configure a Reader instance

@Deprecated
public class ReaderConfiguration
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReaderConfiguration() Deprecated.

Method Summary

Modifier and Type	Method and Description
ConsumerCryptoFailureAction	getCryptoFailureAction() Deprecated.
CryptoKeyReader	getCryptoKeyReader() Deprecated.
ReaderConfigurationData<byte[]>	getReaderConfigurationData() Deprecated.
ReaderListener<byte[]>	getReaderListener() Deprecated.
String	getReaderName() Deprecated.
int	getReceiverQueueSize() Deprecated.
String	getSubscriptionRolePrefix() Deprecated.
void	setCryptoFailureAction(ConsumerCryptoFailureAction action) Deprecated. Sets the ConsumerCryptoFailureAction to the value specified
ReaderConfiguration	setCryptoKeyReader(CryptoKeyReader cryptoKeyReader) Deprecated. Sets a CryptoKeyReader
ReaderConfiguration	setReaderListener(ReaderListener<byte[]> readerListener) Deprecated. Sets a ReaderListener for the reader
ReaderConfiguration	setReaderName(String readerName) Deprecated. Set the consumer name.
ReaderConfiguration	setReceiverQueueSize(int receiverQueueSize) Deprecated. Sets the size of the consumer receive queue.
ReaderConfiguration	setSubscriptionRolePrefix(String subscriptionRolePrefix) Deprecated. Set the subscription role prefix for subscription auth.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReaderConfiguration

public ReaderConfiguration()

Deprecated.

Method Detail

getReaderListener

public ReaderListener<byte[]> getReaderListener()

Deprecated.

Returns:

the configured ReaderListener for the reader

setReaderListener

public ReaderConfiguration setReaderListener(ReaderListener<byte[]> readerListener)

Deprecated.

Sets a ReaderListener for the reader

When a ReaderListener is set, application will receive messages through it. Calls to Reader.readNext() will not be allowed.

Parameters:

readerListener - the listener object

getReceiverQueueSize

public int getReceiverQueueSize()

Deprecated.

Returns:

the configure receiver queue size value

getCryptoKeyReader

public CryptoKeyReader getCryptoKeyReader()

Deprecated.

Returns:

the CryptoKeyReader

setCryptoKeyReader

public ReaderConfiguration setCryptoKeyReader(CryptoKeyReader cryptoKeyReader)

Deprecated.

Sets a CryptoKeyReader

Parameters:

cryptoKeyReader - CryptoKeyReader object

setCryptoFailureAction

public void setCryptoFailureAction(ConsumerCryptoFailureAction action)

Deprecated.

Sets the ConsumerCryptoFailureAction to the value specified

Parameters:

action - The action to take when the decoding fails

getCryptoFailureAction

public ConsumerCryptoFailureAction getCryptoFailureAction()

Deprecated.

Returns:

The ConsumerCryptoFailureAction

setReceiverQueueSize

public ReaderConfiguration setReceiverQueueSize(int receiverQueueSize)

Deprecated.

Sets the size of the consumer receive queue.

The consumer receive queue controls how many messages can be accumulated by the Consumer before the application calls Consumer.receive(). Using a higher value could potentially increase the consumer throughput at the expense of bigger memory utilization.

Default value is 1000 messages and should be good for most use cases.

Parameters:

receiverQueueSize - the new receiver queue size value

getReaderName

public String getReaderName()

Deprecated.

Returns:

the consumer name

setReaderName

public ReaderConfiguration setReaderName(String readerName)

Deprecated.

Set the consumer name.

Parameters:

readerName -

getSubscriptionRolePrefix

public String getSubscriptionRolePrefix()

Deprecated.

Returns:

the subscription role prefix for subscription auth

setSubscriptionRolePrefix

public ReaderConfiguration setSubscriptionRolePrefix(String subscriptionRolePrefix)

Deprecated.

Set the subscription role prefix for subscription auth. The default prefix is "reader".

Parameters:

subscriptionRolePrefix -

getReaderConfigurationData

public ReaderConfigurationData<byte[]> getReaderConfigurationData()

Deprecated.