Package org.springframework.pulsar.config

Interface PulsarReaderEndpoint<C extends PulsarMessageReaderContainer>

Type Parameters:
C - reader listener container type.
All Known Implementing Classes:
AbstractPulsarReaderEndpoint, MethodPulsarReaderEndpoint
public interface PulsarReaderEndpoint<C extends PulsarMessageReaderContainer>
Model for a Pulsar Reader endpoint. Can be used against a PulsarReaderConfigurer to register endpoints programmatically.
Author:
Soby Chacko

  • Method Details

    • getId

      @Nullable String getId()
      Return the id of this endpoint.
      Returns:
      the id of this endpoint. The id can be further qualified when the endpoint is resolved against its actual listener container.
      See Also:

    • getSubscriptionName

      @Nullable String getSubscriptionName()
      Return the subscription name for this endpoint's container.
      Returns:
      the subscription name.

    • getTopics

      List<String> getTopics()
      Return the topics for this endpoint's container.
      Returns:
      the topics.

    • getSchemaType

      org.apache.pulsar.common.schema.SchemaType getSchemaType()
      Return the schema type for this endpoint's container.
      Returns:
      the schema type.

    • setupListenerContainer

      void setupListenerContainer(C listenerContainer, @Nullable MessageConverter messageConverter)
      Setup the specified message listener container with the model defined by this endpoint.

      This endpoint must provide the requested missing option(s) of the specified container to make it usable. Usually, this is about setting the queues and the messageListener to use but an implementation may override any default setting that was already set.

      Parameters:
      listenerContainer - the listener container to configure
      messageConverter - message converter used

    • getAutoStartup

      @Nullable Boolean getAutoStartup()

    • getStartMessageId

      org.apache.pulsar.client.api.MessageId getStartMessageId()