Spring Pulsar

https://docs.spring.io/spring-pulsar/
Admin
Spring Pulsar is a Spring Framework integration for Apache Pulsar that enables easy development of...
Tokens:50,897
Snippets:572
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Using DefaultPulsarMessageListenerContainer

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-consumption.html

Example of manually configuring and instantiating a DefaultPulsarMessageListenerContainer.

```java
Map<String, Object> config = new HashMap<>();
config.put("topics", "my-topic");
PulsarConsumerFactory<String> pulsarConsumerFactorY = DefaultPulsarConsumerFactory<>(pulsarClient, config);

PulsarContainerProperties pulsarContainerProperties = new PulsarContainerProperties();

pulsarContainerProperties.setMessageListener((PulsarRecordMessageListener<?>) (consumer, msg) -> {
		});

DefaultPulsarMessageListenerContainer<String> pulsarListenerContainer = new DefaultPulsarMessageListenerContainer(pulsarConsumerFacotyr,
        pulsarContainerProperties);

return pulsarListenerContainer;
```

--------------------------------

### Configure Auth Parameter via Environment Variable

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/pulsar-client.html

Example of an environment variable definition for an authentication parameter.

```text
SPRING_PULSAR_CLIENT_AUTHENTICATION_PARAM_ISSUERURL=https://some.server.com
```

--------------------------------

### PulsarContainerProperties StartupFailurePolicy Methods

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/config/class-use/StartupFailurePolicy.html

Methods to get and set the startup failure policy for Pulsar message listeners.

```APIDOC
## PulsarContainerProperties.getStartupFailurePolicy()

### Description
Retrieves the currently configured StartupFailurePolicy for the Pulsar container.

### Returns
- **StartupFailurePolicy** - The policy to be applied on startup failure.

## PulsarContainerProperties.setStartupFailurePolicy(StartupFailurePolicy startupFailurePolicy)

### Description
Sets the action to take on the container when a failure occurs during startup.

### Parameters
- **startupFailurePolicy** (StartupFailurePolicy) - The policy to apply.
```

--------------------------------

### Manual Batch Acknowledgment Example

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-consumption.html

Example of injecting an Acknowledgment object into a PulsarListener to manually handle message outcomes in a batch context.

```java
@PulsarListener(subscriptionName = "hello-pulsar-subscription", topics = "hello-pulsar")
public void listen(List<Message<String>> messgaes, Acknowlegement acknowledgment) {
    for (Message<String> message : messages) {
		try {
			...
	        acknowledgment.acknowledge(message.getMessageId());
		}
		catch (Exception e) {
			acknowledgment.nack(message.getMessageId());
		}
    }
}
```

--------------------------------

### PulsarReaderContainerProperties StartupFailurePolicy Methods

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/config/class-use/StartupFailurePolicy.html

Methods to get and set the startup failure policy for Pulsar reader containers.

```APIDOC
## PulsarReaderContainerProperties.getStartupFailurePolicy()

### Description
Retrieves the currently configured StartupFailurePolicy for the Pulsar reader container.

### Returns
- **StartupFailurePolicy** - The policy to be applied on startup failure.

## PulsarReaderContainerProperties.setStartupFailurePolicy(StartupFailurePolicy startupFailurePolicy)

### Description
Sets the action to take on the reader container when a failure occurs during startup.

### Parameters
- **startupFailurePolicy** (StartupFailurePolicy) - The policy to apply.
```

--------------------------------

### Producer Customizer with Inline Lambda (Cacheable)

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-production.html

This example demonstrates a Lambda customizer that does not capture external variables, allowing it to function correctly as a cache key.

```java
void sendUser() {
    var user = randomUser();
    template.newMessage(user)
        .withTopic("user-topic")
        .withProducerCustomizer((b) -> b.producerName("user"))
        .send();
}
```

--------------------------------

### get(PulsarAdmin admin)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/function/PulsarFunction.html

Retrieves the configuration details for an existing function.

```APIDOC
## FunctionConfig get(PulsarAdmin admin)

### Description
Gets the configuration details for an existing function.

### Parameters
- **admin** (PulsarAdmin) - Required - The admin client.

### Returns
- **FunctionConfig** - the current config of the existing function

### Throws
- **PulsarAdminException** - if anything else goes wrong
```

--------------------------------

### get(PulsarAdmin admin)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/function/PulsarSink.html

Retrieves the configuration details for an existing sink function.

```APIDOC
### Method: get

#### Description
Gets the configuration details for an existing function.

#### Parameters
- **admin** (org.apache.pulsar.client.admin.PulsarAdmin) - Required - The admin client used to interact with Pulsar.

#### Returns
- **SinkConfig** - The current configuration of the existing function.

#### Throws
- **PulsarAdminException** - If an error occurs during the operation.
```

--------------------------------

### PulsarListener with Primitive Types

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-consumption.html

Example of consuming primitive types like Integer, where the framework automatically infers the schema.

```java
@PulsarListener(subscriptionName = "my-subscription-1", topics = "my-topic-1")
public void listen(Integer message) {
   System.out.println(message);
}
```

--------------------------------

### Transactional Consume-Process-Produce Listener

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/transactions.html

Example of a listener method using a transactional PulsarTemplate to process and produce messages within a synchronized transaction.

```java
@PulsarListener(topics = "my-input-topic") __**(1)**
void listen(String msg) { __**(2)**
    var transformedMsg = msg.toUpperCase(Locale.ROOT); __**(3)**
    this.transactionalTemplate.send("my-output-topic", transformedMsg); __**(4)**
} __**(5)** __**(6)**
```

--------------------------------

### PulsarConsumerErrorHandler Configuration

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-consumption.html

Example bean configuration for a PulsarConsumerErrorHandler using a PulsarDeadLetterPublishingRecoverer with a custom destination resolver.

```java
@Bean
PulsarConsumerErrorHandler<Integer> pulsarConsumerErrorHandler(PulsarClient pulsarClient) {
    PulsarProducerFactory<Integer> pulsarProducerFactory = new DefaultPulsarProducerFactory<>(pulsarClient, Map.of());
        PulsarTemplate<Integer> pulsarTemplate = new PulsarTemplate<>(pulsarProducerFactory);

        BiFunction<Consumer<?>, Message<?>, String> destinationResolver =
                (c, m) -> "my-foo-dlt";

        PulsarDeadLetterPublishingRecoverer<Integer> pulsarDeadLetterPublishingRecoverer =
                new PulsarDeadLetterPublishingRecoverer<>(pulsarTemplate, destinationResolver);

        return new DefaultPulsarConsumerErrorHandler<>(pulsarDeadLetterPublishingRecoverer,
                new FixedBackOff(100, 5));
}
```

--------------------------------

### Producer Customizer with Internal Variable Usage (Cacheable)

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-production.html

This example demonstrates that variables defined within the Lambda closure or static method calls do not interfere with cache key matching.

```java
void sendUser() {
    var user = randomUser();
    template.newMessage(user)
        .withTopic("user-topic")
        .withProducerCustomizer((b) -> {
           var name = SomeHelper.someStaticMethod();
           b.producerName(name);
        })
        .send();
}
```

--------------------------------

### Perform a full project build

Source: https://docs.spring.io/spring-pulsar/reference/intro/building.html

Executes a clean build of the entire project using the Gradle wrapper.

```bash
./gradlew clean build
```

--------------------------------

### transactions()

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/PulsarTemplate.html

Gets the transaction properties.

```APIDOC
## transactions()

### Description
Gets the transaction properties.

### Returns
- **TransactionProperties** - The transaction properties.
```

--------------------------------

### Generate reference documentation

Source: https://docs.spring.io/spring-pulsar/reference/intro/building.html

Builds the project's Antora-based reference documentation.

```bash
./gradlew :spring-pulsar-docs:antora
```

--------------------------------

### getStartupFailurePolicy

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/listener/PulsarContainerProperties.html

Retrieves the configured startup failure policy for the container.

```APIDOC
## getStartupFailurePolicy

### Description
Returns the action to take on the container when a failure occurs during startup.

### Signature
`public @Nullable StartupFailurePolicy getStartupFailurePolicy()`
```

--------------------------------

### create(Duration, Long, Integer, EvictionListener)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/cache/provider/CacheProviderFactory.html

Creates a new cache provider instance with the specified configuration options, including expiration, size, and an eviction listener.

```APIDOC
## CacheProvider<K,V> create(Duration cacheExpireAfterAccess, Long cacheMaximumSize, Integer cacheInitialCapacity, CacheProviderFactory.EvictionListener<K,V> evictionListener)

### Description
Creates a cache provider instance with the specified options for cache expiration, maximum size, initial capacity, and an eviction listener.

### Parameters
- **cacheExpireAfterAccess** (Duration) - Time period to expire unused entries in the cache.
- **cacheMaximumSize** (Long) - Maximum number of entries allowed in the cache.
- **cacheInitialCapacity** (Integer) - The initial size of the cache.
- **evictionListener** (CacheProviderFactory.EvictionListener<K,V>) - Listener invoked when an entry is evicted from the cache.

### Returns
- **CacheProvider<K,V>** - A configured cache provider instance.
```

--------------------------------

### Configure Zipkin dependencies for Gradle

Source: https://docs.spring.io/spring-pulsar/reference/reference/observability.html

Add these dependencies to your build.gradle to enable Brave tracing with Zipkin reporting.

```groovy
dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-actuator'
    implementation 'io.micrometer:micrometer-tracing-bridge-brave'
    implementation 'io.zipkin.reporter2:zipkin-reporter-brave'
    implementation 'io.zipkin.reporter2:zipkin-sender-urlconnection'
}
```

--------------------------------

### build()

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/PulsarTopicBuilder.html

Constructs the PulsarTopic instance.

```APIDOC
## build()

### Description
Constructs the PulsarTopic with the properties configured in this builder.

### Returns
- **PulsarTopic** - The constructed PulsarTopic instance.
```

--------------------------------

### Publishing to Partitioned Topics with Custom Routing

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/publishing-consuming-partitioned-topics.html

Demonstrates using a custom MessageRouter to direct messages to specific partitions and configuring the producer routing mode.

```java
@SpringBootApplication
public class PulsarBootPartitioned {

	public static void main(String[] args) {
		SpringApplication.run(PulsarBootPartitioned.class, "--spring.pulsar.producer.message-routing-mode=CustomPartition");
	}

	@Bean
	public ApplicationRunner runner(PulsarTemplate<String> pulsarTemplate) {
		pulsarTemplate.setDefaultTopicName("hello-pulsar-partitioned");
		return args -> {
			for (int i = 0; i < 10; i++) {
				pulsarTemplate.sendAsync("hello john doe 0 ", new FooRouter());
				pulsarTemplate.sendAsync("hello alice doe 1", new BarRouter());
				pulsarTemplate.sendAsync("hello buzz doe 2", new BuzzRouter());
			}
		};
	}

	@PulsarListener(subscriptionName = "hello-pulsar-partitioned-subscription", topics = "hello-pulsar-partitioned")
	public void listen(String message) {
		System.out.println("Message Received: " + message);
	}

    static class FooRouter implements MessageRouter {

		@Override
		public int choosePartition(Message<?> msg, TopicMetadata metadata) {
			return 0;
		}
	}

	static class BarRouter implements MessageRouter {

		@Override
		public int choosePartition(Message<?> msg, TopicMetadata metadata) {
			return 1;
		}
	}

	static class BuzzRouter implements MessageRouter {

		@Override
		public int choosePartition(Message<?> msg, TopicMetadata metadata) {
			return 2;
		}
	}

}
```

--------------------------------

### Configure Basic Authentication

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/pulsar-client.html

YAML configuration for the Basic authentication plugin.

```yaml
spring:
  pulsar:
    client:
      authentication:
        plugin-class-name: org.apache.pulsar.client.impl.auth.AuthenticationBasic
        param:
          userId: ...
          password: ...
```

--------------------------------

### Configure Athenz Authentication

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/pulsar-client.html

YAML configuration for the Athenz authentication plugin.

```yaml
spring:
  pulsar:
    client:
      authentication:
        plugin-class-name: org.apache.pulsar.client.impl.auth.AuthenticationAthenz
        param:
          tenantDomain: ...
          tenantService: ...
          providerDomain: ...
          privateKey: ...
          keyId: ...
```

--------------------------------

### Producer Customizer with External Variable Capture (Non-Cacheable)

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-production.html

This example shows a Lambda customizer capturing an external variable, which prevents it from matching as a cache key.

```java
void sendUser() {
    var user = randomUser();
    var name = randomName();
    template.newMessage(user)
        .withTopic("user-topic")
        .withProducerCustomizer((b) -> b.producerName(name))
        .send();
}
```

--------------------------------

### setStartupFailurePolicy

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/listener/PulsarContainerProperties.html

Sets the startup failure policy for the container.

```APIDOC
## setStartupFailurePolicy

### Description
Sets the action to take on the container when a failure occurs during startup.

### Signature
`public void setStartupFailurePolicy(@Nullable StartupFailurePolicy startupFailurePolicy)`

### Parameters
- **startupFailurePolicy** (StartupFailurePolicy) - Optional - The action to take when a failure occurs during startup.
```

--------------------------------

### Basic PulsarListener Usage

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-consumption.html

Demonstrates the standard way to define a Pulsar listener with explicit subscription and topic names.

```java
@PulsarListener(subscriptionName = "hello-pulsar-subscription", topics = "hello-pulsar")
public void listen(String message) {
    System.out.println("Message Received: " + message);
}
```

--------------------------------

### Configure Gradle Repositories

Source: https://docs.spring.io/spring-pulsar/reference/appendix/non-ga-versions.html

Add these repository blocks to your build.gradle file to include the required Spring and Apache repositories.

```groovy
repositories {
    maven {
        name = 'spring-milestones'
        url = 'https://repo.spring.io/milestone'
    }
    maven {
        name = 'spring-snapshots'
        url = 'https://repo.spring.io/snapshot'
    }
    maven {
        name = 'apache-snapshot'
        url = 'https://repository.apache.org/content/repositories/snapshots'
    }
}
```

--------------------------------

### Configure Transaction Timeout via Customizer

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/transactions.html

Example of using a PulsarContainerFactoryCustomizer bean to set the transaction timeout on the container factory when using Spring Boot.

```java
@Bean
PulsarContainerFactoryCustomizer<ConcurrentPulsarListenerContainerFactory<?>> containerCustomizer() {
    return (containerFactory) -> containerFactory.getContainerProperties().transactions().setTimeout(Duration.ofSeconds(45));
}
```

--------------------------------

### void customize(ClientBuilder clientBuilder)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/PulsarClientBuilderCustomizer.html

Customizes the provided Pulsar ClientBuilder instance.

```APIDOC
## void customize(org.apache.pulsar.client.api.ClientBuilder clientBuilder)

### Description
Customizes a Pulsar `ClientBuilder` instance. This method is intended to be implemented by users to apply custom configurations to the client builder.

### Parameters
- **clientBuilder** (org.apache.pulsar.client.api.ClientBuilder) - The builder instance to be customized.
```

--------------------------------

### Configure Token Authentication

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/pulsar-client.html

YAML configuration for the Token authentication plugin.

```yaml
spring:
  pulsar:
    client:
      authentication:
        plugin-class-name: org.apache.pulsar.client.impl.auth.AuthenticationToken
        param:
          token: some-token-goes-here
```

--------------------------------

### Import Spring Framework BOM

Source: https://docs.spring.io/spring-pulsar/reference/appendix/getting-dependencies-without-boot.html

Use the Spring Framework BOM to align transitive dependencies and avoid classpath conflicts.

```xml
<dependencyManagement>
	<dependencies>
		<!-- ... other dependency elements ... -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-framework-bom</artifactId>
			<version>7.0.8</version>
			<type>pom</type>
			<scope>import</scope>
		</dependency>
	</dependencies>
</dependencyManagement>
```

```gradle
plugins {
	id "io.spring.dependency-management" version "1.1.4"
}

dependencyManagement {
	imports {
		mavenBom 'org.springframework:spring-framework-bom:7.0.8'
	}
}
```

--------------------------------

### Configure Maven Repositories

Source: https://docs.spring.io/spring-pulsar/reference/appendix/non-ga-versions.html

Add these repository definitions to your pom.xml to enable access to Spring and Apache snapshot and milestone artifacts.

```xml
<repositories>
    <repository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>https://repo.spring.io/milestone</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
    <repository>
        <id>spring-snapshots</id>
        <name>Spring Snapshots</name>
        <url>https://repo.spring.io/snapshot</url>
        <releases>
            <enabled>false</enabled>
        </releases>
    </repository>
    <repository>
        <id>apache-snapshots</id>
        <name>Apache Snapshots</name>
        <url>https://repository.apache.org/content/repositories/snapshots</url>
        <releases>
            <enabled>false</enabled>
        </releases>
    </repository>
</repositories>
```

--------------------------------

### createAdminClient()

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/PulsarAdministration.html

Creates and returns a new PulsarAdmin client instance.

```APIDOC
## createAdminClient

### Description
Creates a new instance of the PulsarAdmin client.

### Returns
- **PulsarAdmin** - The configured PulsarAdmin client instance.

### Throws
- **PulsarClientException** - If the client cannot be created.
```

--------------------------------

### DefaultSchemaResolver()

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/DefaultSchemaResolver.html

Constructs a new DefaultSchemaResolver instance.

```APIDOC
## DefaultSchemaResolver()

### Description
Constructs a new DefaultSchemaResolver instance.
```

--------------------------------

### Configure Tracing Properties

Source: https://docs.spring.io/spring-pulsar/reference/reference/observability.html

Enable tracing and set the Zipkin endpoint in your application configuration.

```yaml
management:
  tracing.enabled: true
  zipkin:
    tracing.endpoint: "http://localhost:9411/api/v2/spans"
```

--------------------------------

### Build project without tests

Source: https://docs.spring.io/spring-pulsar/reference/intro/building.html

Performs a clean build while skipping the test suite execution.

```bash
./gradlew clean build -x test
```

--------------------------------

### Configure Zipkin dependencies for Maven

Source: https://docs.spring.io/spring-pulsar/reference/reference/observability.html

Add these dependencies to your pom.xml to enable Brave tracing with Zipkin reporting.

```xml
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <dependency>
        <groupId>io.micrometer</groupId>
        <artifactId>micrometer-tracing-bridge-brave</artifactId>
    </dependency>
    <dependency>
        <groupId>io.zipkin.reporter2</groupId>
        <artifactId>zipkin-reporter-brave</artifactId>
    </dependency>
    <dependency>
        <groupId>io.zipkin.reporter2</groupId>
        <artifactId>zipkin-sender-urlconnection</artifactId>
    </dependency>
</dependencies>
```

--------------------------------

### load()

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/cache/provider/CacheProviderFactory.html

Uses the Java ServiceLoader API to discover and return the first available CacheProviderFactory implementation.

```APIDOC
## static <K,V> CacheProviderFactory<K,V> load()

### Description
Uses the Java ServiceLoader API to find the first available cache provider factory implementation.

### Returns
- **CacheProviderFactory<K,V>** - The discovered cache provider factory service.

### Throws
- **IllegalStateException** - If no factory implementation is found.
```

--------------------------------

### withProducerCustomizer(ProducerBuilderCustomizer)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/index-files/index-22.html

Specifies a customizer to configure the producer builder.

```APIDOC
## withProducerCustomizer(ProducerBuilderCustomizer)

### Description
Specifies the customizer to use to further configure the producer builder.

### Signature
`SendMessageBuilder<T> withProducerCustomizer(ProducerBuilderCustomizer<T> producerCustomizer)`
```

--------------------------------

### createClient()

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/DefaultPulsarClientFactory.html

Creates a new PulsarClient instance.

```APIDOC
## Method: createClient()

### Description
Create a client instance.

### Returns
- **PulsarClient** - The created client instance.
```

--------------------------------

### Implement Pulsar Producer and Consumer

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/quick-tour.html

A complete Spring Boot application demonstrating message production via PulsarTemplate and consumption via the PulsarListener annotation.

```java
@SpringBootApplication
public class PulsarBootHelloWorld {

    public static void main(String[] args) {
        SpringApplication.run(PulsarBootHelloWorld.class, args);
    }

    @Bean
    ApplicationRunner runner(PulsarTemplate<String> pulsarTemplate) {
        return (args) -> pulsarTemplate.send("hello-pulsar-topic", "Hello Pulsar World!");
    }

    @PulsarListener(subscriptionName = "hello-pulsar-sub", topics = "hello-pulsar-topic")
    void listen(String message) {
        System.out.println("Message Received: " + message);
    }
}
```

--------------------------------

### void customize(PulsarAdminBuilder adminBuilder)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/PulsarAdminBuilderCustomizer.html

Customizes the provided PulsarAdminBuilder instance.

```APIDOC
## void customize(org.apache.pulsar.client.admin.PulsarAdminBuilder adminBuilder)

### Description
Customizes a `PulsarAdminBuilder` instance. This method is intended to be implemented to apply specific configurations to the builder.

### Parameters
- **adminBuilder** (org.apache.pulsar.client.admin.PulsarAdminBuilder) - The builder instance to be customized.
```

--------------------------------

### create(PulsarAdmin admin) and createWithUrl(PulsarAdmin admin)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/function/PulsarSink.html

Creates a new sink function using either a file-based or URL-based approach.

```APIDOC
### Method: create / createWithUrl

#### Description
Creates the function using either the file-based (create) or url-based (createWithUrl) create API.

#### Parameters
- **admin** (org.apache.pulsar.client.admin.PulsarAdmin) - Required - The admin client used to interact with Pulsar.

#### Throws
- **PulsarAdminException** - If an error occurs during the operation.
```

--------------------------------

### DefaultPulsarConsumerFactory(PulsarClient, List<ConsumerBuilderCustomizer<T>>)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/DefaultPulsarConsumerFactory.html

Constructs a new DefaultPulsarConsumerFactory instance.

```APIDOC
## Constructor: DefaultPulsarConsumerFactory(PulsarClient, List<ConsumerBuilderCustomizer<T>>)

### Description
Construct a consumer factory instance using the provided PulsarClient and a list of default configuration customizers.

### Parameters
- **pulsarClient** (org.apache.pulsar.client.api.PulsarClient) - Required - The Pulsar client instance.
- **defaultConfigCustomizers** (List<ConsumerBuilderCustomizer<T>>) - Required - A list of customizers to apply to the consumer builder.
```

--------------------------------

### Simplified PulsarListener Usage

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-consumption.html

Shows a minimal listener configuration where subscription names are auto-generated and topics are resolved automatically.

```java
@PulsarListener
public void listen(String message) {
    System.out.println("Message Received: " + message);
}
```

--------------------------------

### resume()

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/listener/AbstractPulsarMessageListenerContainer.html

Resumes the container if it is currently paused.

```APIDOC
## resume()

### Description
Resume this container, if paused.
```

--------------------------------

### config()

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/function/PulsarSource.html

Retrieves the configuration associated with the Pulsar source.

```APIDOC
## config()

### Description
Returns the value of the `config` record component.

### Returns
- **org.apache.pulsar.common.io.SourceConfig** - The configuration object for the Pulsar source.
```

--------------------------------

### createContainer(String... topics)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/config/PulsarContainerFactory.html

Creates and configures a container for the specified topics without an associated listener.

```APIDOC
## createContainer(String... topics)

### Description
Create and configure a container without a listener. Containers created using this method are not added to the listener endpoint registry.

### Parameters
- **topics** (String...) - Required - The topics to consume.

### Returns
- **C** - The created container.
```

--------------------------------

### createConsumer(Schema<T>, Collection<String>, String, Map<String, String>, List<ConsumerBuilderCustomizer<T>>)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/DefaultPulsarConsumerFactory.html

Creates a Pulsar consumer with specified schema, topics, subscription, metadata, and customizers.

```APIDOC
## Method: createConsumer

### Description
Creates a consumer instance using the provided schema, topics, subscription name, metadata properties, and optional customizers.

### Parameters
- **schema** (org.apache.pulsar.client.api.Schema<T>) - Required - The schema for the consumer.
- **topics** (Collection<String>) - Optional - The collection of topics to subscribe to.
- **subscriptionName** (String) - Optional - The name of the subscription.
- **metadataProperties** (Map<String, String>) - Optional - Metadata properties for the consumer.
- **customizers** (List<ConsumerBuilderCustomizer<T>>) - Optional - List of customizers to apply to the consumer builder.

### Returns
- **Consumer<T>** - The created Pulsar consumer.
```

--------------------------------

### config()

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/function/PulsarFunction.html

Retrieves the configuration for the Pulsar function.

```APIDOC
## config()

### Description
Returns the value of the `config` record component.

### Returns
- **org.apache.pulsar.common.functions.FunctionConfig** - The function configuration object.
```

--------------------------------

### name(String)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/PulsarTopicBuilder.html

Sets the name of the topic under construction.

```APIDOC
## name(String name)

### Description
Set the name of the topic under construction. Accepts formats like 'name', 'tenant/namespace/name', or 'domain://tenant/namespace/name'.

### Parameters
- **name** (String) - Required - The topic name.
```

--------------------------------

### PulsarTopicBuilder()

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/PulsarTopicBuilder.html

Creates a new builder instance with default domain 'persistent', tenant 'public', and namespace 'default'.

```APIDOC
## PulsarTopicBuilder()

### Description
Create a builder instance that uses default values for domain, tenant, and namespace.
```

--------------------------------

### Configure ObjectMapper for Pulsar

Source: https://docs.spring.io/spring-pulsar/reference/reference/custom-object-mapper.html

Recommended configuration settings for a custom ObjectMapper to align with Pulsar's default behavior.

```java
myObjectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
myObjectMapper.configure(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL, false);
myObjectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
```

--------------------------------

### DefaultPulsarClientFactory(String serviceUrl)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/DefaultPulsarClientFactory.html

Constructs a factory that creates clients using a default Pulsar client builder with the specified service URL.

```APIDOC
## Constructor: DefaultPulsarClientFactory(String serviceUrl)

### Description
Construct a factory that creates clients using a default Pulsar client builder with no modifications other than the specified service url.

### Parameters
- **serviceUrl** (String) - Required - The service URL to connect to.
```

--------------------------------

### createReader(List<String> topics, MessageId messageId, Schema<T> schema, List<ReaderBuilderCustomizer<T>> customizers)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/DefaultPulsarReaderFactory.html

Creates a Pulsar Reader based on the provided topics, schema, and optional customizers.

```APIDOC
## createReader(List<String> topics, MessageId messageId, Schema<T> schema, List<ReaderBuilderCustomizer<T>> customizers)

### Description
Creates a Pulsar Reader based on the provided topics, schema, and properties.

### Parameters
- **topics** (List<String>) - Optional - Set of topics to read from.
- **messageId** (org.apache.pulsar.client.api.MessageId) - Optional - Starting message id to read from.
- **schema** (org.apache.pulsar.client.api.Schema<T>) - Required - Schema of the message to consume.
- **customizers** (List<ReaderBuilderCustomizer<T>>) - Optional - The optional list of customizers to apply to the reader builder.

### Returns
- **Reader<T>** - The created reader.
```

--------------------------------

### createConsumer(Schema, Collection, String, Map, List)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/PulsarConsumerFactory.html

Creates a Pulsar consumer using the provided schema, topics, subscription name, metadata properties, and a list of customizers.

```APIDOC
## createConsumer(Schema<T> schema, Collection<String> topics, String subscriptionName, Map<String, String> metadataProperties, List<ConsumerBuilderCustomizer<T>> customizers)

### Description
Creates a Pulsar consumer instance with advanced configuration options including metadata properties and a list of customizers.

### Parameters
- **schema** (org.apache.pulsar.client.api.Schema<T>) - Required - The schema of the messages to be consumed.
- **topics** (Collection<String>) - Optional - The topics the consumer will subscribe to, or null to use default topics.
- **subscriptionName** (String) - Optional - The name for the subscription, or null to use the default configured subscription name.
- **metadataProperties** (Map<String, String>) - Optional - Metadata properties to attach to the consumer.
- **customizers** (List<ConsumerBuilderCustomizer<T>>) - Optional - A list of customizers to apply to the consumer builder.

### Returns
- **Consumer<T>** - The created Pulsar consumer instance.

### Throws
- **PulsarException** - If a communication error occurs with Pulsar.
```

--------------------------------

### createContainer(String... topics)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/config/ConcurrentPulsarListenerContainerFactory.html

Creates and configures a container without a listener. Containers created using this method are not added to the listener endpoint registry.

```APIDOC
## Method: createContainer

### Description
Creates and configures a container without a listener. Containers created using this method are not added to the listener endpoint registry.

### Parameters
- **topics** (String...) - Required - The topics to subscribe to.

### Returns
- **ConcurrentPulsarMessageListenerContainer<T>** - The configured container instance.
```

--------------------------------

### create(PulsarAdmin admin)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/function/PulsarFunctionOperations.html

Creates a Pulsar function using the file-based create API.

```APIDOC
## void create(org.apache.pulsar.client.admin.PulsarAdmin admin)

### Description
Creates the function using the file-based create api.

### Parameters
- **admin** (org.apache.pulsar.client.admin.PulsarAdmin) - Required - The admin client.

### Throws
- **org.apache.pulsar.client.admin.PulsarAdminException** - If anything goes wrong.
```

--------------------------------

### createConsumer(Schema, Collection, String, ConsumerBuilderCustomizer)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/PulsarConsumerFactory.html

Creates a Pulsar consumer using the provided schema, topics, subscription name, and a single customizer.

```APIDOC
## createConsumer(Schema<T> schema, Collection<String> topics, String subscriptionName, ConsumerBuilderCustomizer<T> customizer)

### Description
Creates a Pulsar consumer instance. This method allows specifying the message schema, target topics, subscription name, and an optional customizer for the consumer builder.

### Parameters
- **schema** (org.apache.pulsar.client.api.Schema<T>) - Required - The schema of the messages to be consumed.
- **topics** (Collection<String>) - Optional - The topics the consumer will subscribe to, or null to use default topics.
- **subscriptionName** (String) - Optional - The name for the subscription, or null to use the default configured subscription name.
- **customizer** (ConsumerBuilderCustomizer<T>) - Optional - A customizer to apply to the consumer builder.

### Returns
- **Consumer<T>** - The created Pulsar consumer instance.

### Throws
- **PulsarException** - If a communication error occurs with Pulsar.
```

--------------------------------

### PulsarTopicBuilder(TopicDomain, String, String)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/PulsarTopicBuilder.html

Creates a new builder instance with custom default domain, tenant, and namespace.

```APIDOC
## PulsarTopicBuilder(TopicDomain defaultDomain, String defaultTenant, String defaultNamespace)

### Description
Create a builder instance that uses the specified defaults for topic naming.

### Parameters
- **defaultDomain** (TopicDomain) - Required - Domain to use when topic name is not fully-qualified.
- **defaultTenant** (String) - Optional - Tenant to use when topic name is not fully-qualified.
- **defaultNamespace** (String) - Optional - Namespace to use when topic name is not fully-qualified.
```

--------------------------------

### Using the @PulsarReader Annotation

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-consumption.html

Demonstrates the basic usage of the @PulsarReader annotation to read messages from a specified topic.

```java
@PulsarReader(id = "reader-demo-id", topics = "reader-demo-topic", startMessageId = "earliest")
void read(String message) {
    //...
}
```

--------------------------------

### onEviction(K key, V value, String reason)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/cache/provider/CacheProviderFactory.EvictionListener.html

This method is invoked when an entry is evicted from the cache. It provides the key and value of the evicted entry along with the reason for the eviction.

```APIDOC
## void onEviction(K key, V value, String reason)

### Description
Called when an entry is evicted from the cache. Implementations can use this to perform cleanup or logging tasks.

### Parameters
- **key** (K) - The cache key, or null depending on cache implementation and eviction cause.
- **value** (V) - The cached value, or null depending on cache implementation and eviction cause.
- **reason** (String) - The reason for the eviction.
```

--------------------------------

### Import Spring Pulsar BOM

Source: https://docs.spring.io/spring-pulsar/reference/appendix/getting-dependencies-without-boot.html

Use the BOM to ensure consistent versioning of Spring Pulsar modules across your project.

```xml
<dependencyManagement>
	<dependencies>
		<!-- ... other dependency elements ... -->
		<dependency>
			<groupId>org.springframework.pulsar</groupId>
			<artifactId>spring-pulsar-bom</artifactId>
			<version>2.0.7-SNAPSHOT</version>
			<type>pom</type>
			<scope>import</scope>
		</dependency>
	</dependencies>
</dependencyManagement>
```

```gradle
plugins {
	id "io.spring.dependency-management" version "1.1.4"
}

dependencyManagement {
	imports {
		mavenBom 'org.springframework.pulsar:spring-pulsar-bom:2.0.7-SNAPSHOT'
	}
}
```

--------------------------------

### createWithUrl(PulsarAdmin admin)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/function/PulsarFunctionOperations.html

Creates a Pulsar function using the URL-based create API.

```APIDOC
## void createWithUrl(org.apache.pulsar.client.admin.PulsarAdmin admin)

### Description
Creates the function using the url-based create api.

### Parameters
- **admin** (org.apache.pulsar.client.admin.PulsarAdmin) - Required - The admin client.

### Throws
- **org.apache.pulsar.client.admin.PulsarAdminException** - If anything goes wrong.
```

--------------------------------

### Configure Sasl Authentication

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/pulsar-client.html

YAML configuration for the Sasl authentication plugin.

```yaml
spring:
  pulsar:
    client:
      authentication:
        plugin-class-name: org.apache.pulsar.client.impl.auth.AuthenticationSasl
        param:
          saslJaasClientSectionName: ...
          serverType: ...
```

--------------------------------

### Customizing the ReaderBuilder

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-consumption.html

Shows how to use a PulsarReaderReaderBuilderCustomizer bean to apply custom configurations to the ReaderBuilder.

```java
@PulsarReader(id = "reader-customizer-demo-id", topics = "reader-customizer-demo-topic",
    readerCustomizer = "myCustomizer")
void read(String message) {
    //...
}

@Bean
public PulsarReaderReaderBuilderCustomizer<String> myCustomizer() {
    return readerBuilder -> {
        readerBuilder.startMessageId(messageId); // the first message read is after this message id.
        // Any other customizations on the readerBuilder
    };
}
```

--------------------------------

### Trusting All Packages for Header Mapping

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-consumption.html

Configure the mapper to trust all packages by using the wildcard character. Use caution as this allows any class on the classpath to be loaded.

```java
// via bean
@Bean(name = "pulsarHeaderTrustedPackages")
String[] pulsarHeaderTrustedPackages() {
    return new String[] { "*" };
}

// via builder
JsonPulsarHeaderMapper.builder().trustedPackages("*").build();
```

--------------------------------

### matchHeader(String headerName)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/support/header/PulsarHeaderMatcher.PatternMatch.html

Determines if the provided header name matches the configured pattern.

```APIDOC
## Method: matchHeader(String headerName)

### Description
Checks if the specified header name matches the pattern defined in this matcher.

### Parameters
- **headerName** (String) - The name of the header to check.

### Returns
- **boolean** - True if the header matches, false otherwise.
```

--------------------------------

### matchHeader(String headerName)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/support/header/PulsarHeaderMatcher.html

Determines if the provided header name matches the criteria defined by the implementation.

```APIDOC
## boolean matchHeader(String headerName)

### Description
Determine if the header matches the defined criteria.

### Parameters
- **headerName** (String) - The name of the header to check.

### Returns
- **boolean** - True if the header matches, false otherwise.
```

--------------------------------

### matchHeader(String headerName)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/support/header/PulsarHeaderMatcher.NeverMatch.html

Determines if the provided header name matches. For the NeverMatch implementation, this always returns false.

```APIDOC
### Method
`boolean matchHeader(String headerName)`

#### Parameters
- **headerName** (String) - The header name to check.

#### Returns
- **boolean** - Always returns false.
```

--------------------------------

### getAllListenerContainers()

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/config/GenericListenerEndpointRegistry.html

Returns all listener container instances, including those managed by this registry and those declared as beans in the application context.

```APIDOC
## getAllListenerContainers()

### Description
Return all listener container instances including those managed by this registry and those declared as beans in the application context.
```

--------------------------------

### Configure OAuth2 Authentication

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/pulsar-client.html

YAML configuration for the OAuth2 authentication plugin.

```yaml
spring:
  pulsar:
    client:
      authentication:
        plugin-class-name: org.apache.pulsar.client.impl.auth.oauth2.AuthenticationOAuth2
        param:
          issuerUrl: ...
          privateKey: ...
          audience: ...
          scope: ...
```

--------------------------------

### fromPatternString(String pattern)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/support/header/PulsarHeaderMatcher.PatternMatch.html

Creates a PatternMatch instance from a pattern string.

```APIDOC
## Method: fromPatternString(String pattern)

### Description
Static factory method to create a PatternMatch instance from a given pattern string.

### Parameters
- **pattern** (String) - The pattern string to use.

### Returns
- **PulsarHeaderMatcher.PatternMatch** - A new instance configured with the provided pattern.
```

--------------------------------

### Configure Schema Mappings via SchemaResolverCustomizer

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-production.html

Provide a customizer bean to programmatically add schema mappings for complex types.

```java
@Bean
public SchemaResolverCustomizer<DefaultSchemaResolver> schemaResolverCustomizer() {
	return (schemaResolver) -> {
		schemaResolver.addCustomSchemaMapping(User.class, Schema.AVRO(User.class));
		schemaResolver.addCustomSchemaMapping(Address.class, Schema.JSON(Address.class));
	}
}
```

--------------------------------

### Supported Topic Name Formats

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/PulsarTopicBuilder.html

Accepted formats for the topic name when using the name() method.

```text
- 'name'
- 'tenant/namespace/name'
- 'domain://tenant/namespace/name'
```

--------------------------------

### DefaultPulsarClientFactory(PulsarClientBuilderCustomizer customizer)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/DefaultPulsarClientFactory.html

Constructs a factory that creates clients using a customized Pulsar client builder.

```APIDOC
## Constructor: DefaultPulsarClientFactory(PulsarClientBuilderCustomizer customizer)

### Description
Construct a factory that creates clients using a customized Pulsar client builder.

### Parameters
- **customizer** (PulsarClientBuilderCustomizer) - Required - The customizer to apply to the builder.
```

--------------------------------

### Configuring Trusted Packages via Builder

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-consumption.html

Configure trusted packages directly when constructing a JsonPulsarHeaderMapper instance.

```java
@Bean
JsonPulsarHeaderMapper headerMapper() {
    return JsonPulsarHeaderMapper.builder()
        .trustedPackages("com.example.events", "com.example.dto")
        .build();
}
```

--------------------------------

### createContainer(String... topics)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/config/DefaultPulsarReaderContainerFactory.html

Creates and configures a Pulsar message reader container for the specified topics.

```APIDOC
## Method: createContainer

### Description
Creates and configures a container without a listener. Containers created using this method are not added to the listener endpoint registry.

### Parameters
- **topics** (String...) - Required - The topics to be read by the container.

### Returns
- **DefaultPulsarMessageReaderContainer<T>** - The configured container instance.
```

--------------------------------

### NeverMatch(String... headers)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/support/header/PulsarHeaderMatcher.NeverMatch.html

Constructs a new NeverMatch instance with the specified headers.

```APIDOC
### Constructor
`NeverMatch(String... headers)`

#### Parameters
- **headers** (String...) - The headers to be associated with this matcher.
```

--------------------------------

### asMap()

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/index-files/index-1.html

Returns a thread-safe map view of the cache entries.

```APIDOC
## Map<K, V> asMap()

### Description
Provides a view of the entries stored in the cache as a thread-safe map.

### Returns
- **Map** - A thread-safe map containing the cache entries.
```

--------------------------------

### Default PulsarTopicBuilder Configuration

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/PulsarTopicBuilder.html

Default settings applied when initializing a new PulsarTopicBuilder instance.

```text
- domain -> 'persistent'
- tenant -> 'public'
- namespace -> 'default'
```

--------------------------------

### loadConf(ConsumerBuilder<T> builder, Map<String, Object> properties)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/ConsumerBuilderConfigurationUtil.html

Configures the specified properties onto the provided Pulsar ConsumerBuilder, ensuring non-serializable properties are handled correctly.

```APIDOC
## static <T> void loadConf(ConsumerBuilder<T> builder, Map<String, Object> properties)

### Description
Configures the specified properties onto the provided Pulsar ConsumerBuilder. This method is intended to work around an underlying Pulsar issue where standard configuration loading might set non-serializable fields to null.

### Parameters
- **builder** (org.apache.pulsar.client.api.ConsumerBuilder<T>) - The Pulsar consumer builder instance to configure.
- **properties** (Map<String, Object>) - A map of configuration properties to apply to the builder.
```

--------------------------------

### Configure Message Type to Topic Mappings

Source: https://docs.spring.io/spring-pulsar/reference/reference/topic-resolution.html

Use application.yml to map specific message classes to their corresponding Pulsar topics.

```yaml
spring:
  pulsar:
    defaults:
      type-mappings:
        - message-type: com.acme.Foo
          topic-name: foo-topic
        - message-type: com.acme.Bar
          topic-name: bar-topic
```

--------------------------------

### Consume Messages without Explicit Schema

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-consumption.html

Demonstrates consuming a message where the schema is inferred from the type configuration.

```java
@PulsarListener(subscriptionName = "user-sub", topics = "user-topic")
public void listen(User user) {
    System.out.println(user);
}
```

--------------------------------

### DefaultPulsarReaderFactory(PulsarClient pulsarClient, List<ReaderBuilderCustomizer<T>> defaultConfigCustomizers)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/DefaultPulsarReaderFactory.html

Constructs a new DefaultPulsarReaderFactory instance with an optional list of default configuration customizers.

```APIDOC
## DefaultPulsarReaderFactory(PulsarClient pulsarClient, List<ReaderBuilderCustomizer<T>> defaultConfigCustomizers)

### Description
Constructs a reader factory instance with an optional list of customizers.

### Parameters
- **pulsarClient** (org.apache.pulsar.client.api.PulsarClient) - Required - The client used to consume.
- **defaultConfigCustomizers** (List<ReaderBuilderCustomizer<T>>) - Optional - The optional list of customizers to apply to the readers.
```

--------------------------------

### PulsarContainerProperties Constructors

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/message-consumption.html

Constructors for defining topic information for the container.

```java
public PulsarContainerProperties(String... topics)

public PulsarContainerProperties(Pattern topicPattern)
```

--------------------------------

### DefaultPulsarReaderFactory(PulsarClient pulsarClient)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/DefaultPulsarReaderFactory.html

Constructs a new DefaultPulsarReaderFactory instance with no default configuration.

```APIDOC
## DefaultPulsarReaderFactory(PulsarClient pulsarClient)

### Description
Constructs a reader factory instance with no default configuration.

### Parameters
- **pulsarClient** (org.apache.pulsar.client.api.PulsarClient) - Required - The client used to consume.
```

--------------------------------

### Configure Cluster-Level Failover via YAML

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/pulsar-client.html

Use these properties in your application.yml to define a primary Pulsar cluster and multiple backup clusters for automatic failover.

```yaml
spring:
  pulsar:
    client:
      service-url: "pulsar://my.primary.server:6650"
      failover:
        delay: 30s
        switch-back-delay: 15s
        check-interval: 1s
        backup-clusters:
          - service-url: "pulsar://my.second.server:6650"
            authentication:
              plugin-class-name: org.apache.pulsar.client.impl.auth.AuthenticationToken
              param:
                token: "my-token"
          - service-url: "pulsar://my.third.server:6650"
```

--------------------------------

### Consuming with Failover Subscription

Source: https://docs.spring.io/spring-pulsar/reference/reference/pulsar/publishing-consuming-partitioned-topics.html

Uses the Failover subscription type to ensure each partition is consumed by a dedicated consumer.

```java
@PulsarListener(subscriptionName = "hello-pulsar-partitioned-subscription", topics = "hello-pulsar-partitioned", subscriptionType = SubscriptionType.Failover)
public void listen1(String foo) {
    System.out.println("Message Received 1: " + foo);
}

@PulsarListener(subscriptionName = "hello-pulsar-partitioned-subscription", topics = "hello-pulsar-partitioned", subscriptionType = SubscriptionType.Failover)
public void listen2(String foo) {
    System.out.println("Message Received 2: " + foo);
}

@PulsarListener(subscriptionName = "hello-pulsar-partitioned-subscription",  topics = "hello-pulsar-partitioned", subscriptionType = SubscriptionType.Failover)
public void listen3(String foo) {
    System.out.println("Message Received 3: " + foo);
}
```

--------------------------------

### CaffeineCacheProvider(Cache<K,V> cache)

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/cache/provider/caffeine/CaffeineCacheProvider.html

Constructs a new CaffeineCacheProvider instance using the provided Caffeine cache.

```APIDOC
### Constructor
`CaffeineCacheProvider(com.github.benmanes.caffeine.cache.Cache<K,V> cache)`

### Description
Initializes the cache provider with a specific Caffeine cache instance.
```

--------------------------------

### CaffeineCacheProviderFactory.create

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/cache/provider/caffeine/CaffeineCacheProviderFactory.html

Creates a new cache provider instance with specified expiration, size, and eviction listener configurations.

```APIDOC
## Method: create

### Description
Creates a cache provider instance with the specified options for expiration, capacity, and eviction handling.

### Signature
`CacheProvider<K,V> create(Duration cacheExpireAfterAccess, Long cacheMaximumSize, Integer cacheInitialCapacity, CacheProviderFactory.EvictionListener<K,V> evictionListener)`

### Parameters
- **cacheExpireAfterAccess** (Duration) - Time period to expire unused entries in the cache.
- **cacheMaximumSize** (Long) - Maximum number of entries allowed in the cache.
- **cacheInitialCapacity** (Integer) - The initial size of the cache.
- **evictionListener** (CacheProviderFactory.EvictionListener<K,V>) - Listener invoked when an entry is evicted from the cache.

### Returns
- **CacheProvider<K,V>** - A configured cache provider instance.
```

--------------------------------

### createReader

Source: https://docs.spring.io/spring-pulsar/docs/2.0.7-SNAPSHOT/api/org/springframework/pulsar/core/PulsarReaderFactory.html

Creates a Pulsar Reader based on the provided topics, schema, and optional configuration properties.

```APIDOC
## createReader

### Description
Creates a Pulsar `Reader` instance based on the provided topics, schema, and optional customizers.

### Signature
`org.apache.pulsar.client.api.Reader<T> createReader(@Nullable List<String> topics, @Nullable org.apache.pulsar.client.api.MessageId messageId, org.apache.pulsar.client.api.Schema<T> schema, @Nullable List<ReaderBuilderCustomizer<T>> customizers)`

### Parameters
- **topics** (List<String>) - Optional - Set of topics to read from.
- **messageId** (MessageId) - Optional - Starting message ID to read from.
- **schema** (Schema<T>) - Required - Schema of the message to consume.
- **customizers** (List<ReaderBuilderCustomizer<T>>) - Optional - List of customizers to apply to the reader builder.

### Returns
- **Reader<T>** - The created Pulsar reader instance.

### Throws
- **PulsarException** - Thrown if any PulsarClientException occurs during communication.
```
Tokens:
Raw