Package org.apache.pulsar.client.api

Class ReaderConfiguration

java.lang.Object
org.apache.pulsar.client.api.ReaderConfiguration
All Implemented Interfaces:
Serializable
@Deprecated public class ReaderConfiguration extends Object implements Serializable
Deprecated.
Use PulsarClient#newReader() to construct and configure a Reader instance
See Also:

  • Constructor Details

    • ReaderConfiguration

      public ReaderConfiguration()
      Deprecated.

  • Method Details

    • 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 org.apache.pulsar.client.api.CryptoKeyReader getCryptoKeyReader()
      Deprecated.
      Returns:
      the CryptoKeyReader

    • setCryptoKeyReader

      public ReaderConfiguration setCryptoKeyReader(org.apache.pulsar.client.api.CryptoKeyReader cryptoKeyReader)
      Deprecated.
      Sets a CryptoKeyReader.
      Parameters:
      cryptoKeyReader - CryptoKeyReader object

    • setCryptoFailureAction

      public void setCryptoFailureAction(org.apache.pulsar.client.api.ConsumerCryptoFailureAction action)
      Deprecated.
      Sets the ConsumerCryptoFailureAction to the value specified.
      Parameters:
      action - The action to take when the decoding fails

    • getCryptoFailureAction

      public org.apache.pulsar.client.api.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 org.apache.pulsar.client.impl.conf.ReaderConfigurationData<byte[]> getReaderConfigurationData()
      Deprecated.