README.adoc

Spring for Apache Pulsar

Spring Pulsar provides a basic Spring-friendly API for developing Apache Pulsar applications.

TIP: Most of the ideas in this project are borrowed from the Spring for Apache Kafka project, thus a familiarity with it would help.

spring-pulsar-docs/src/main/asciidoc/project-state.adoc

Getting Started

The reference documentation includes a quick tour section.

Getting Help

Are you having trouble with Spring Pulsar? We want to help!

• Check the reference documentation

• Learn the Spring basics — Spring Pulsar builds on many other Spring projects; check the spring.io website for a wealth of reference documentation. If you are new to Spring, try one of the guides.

• Ask a question — we monitor stackoverflow.com for questions tagged with spring-pulsar.

• Report bugs with Spring Pulsar at github.com/spring-projects/spring-pulsar/issues.

Reporting Issues

Spring Pulsar uses GitHub’s integrated issue tracking system to record bugs and feature requests. If you want to raise an issue, please follow the recommendations below:

• Before you log a bug, please search the issue tracker to see if someone has already reported the problem.

• If the issue doesn’t already exist, create a new issue.

• Please provide as much information as possible with the issue report. We like to know the Spring Pulsar version, operating system, and JVM version you’re using.

• If you need to paste code or include a stack trace, use Markdown ``` escapes before and after your text.

• If possible, try to create a test case or project that replicates the problem and attach it to the issue.

Building from Source

You don’t need to build from source to use Spring Pulsar (binaries in repo.spring.io), but if you want to try out the latest and greatest, Spring Pulsar can be built and published to your local Maven cache using the Gradle wrapper. You also need JDK 17.

./gradlew publishToMavenLocal

This will build all jars and documentation and publish them to your local Maven cache. It won’t run any of the tests. If you want to build everything and run tests, use the build task:

./gradlew build

Note	Some tests rely on a Docker daemon to test against live services using Testcontainers. These tests will be skipped if a local Docker daemon is not available.

The above command will build everything and run all unit tests and integration tests except the PulsarFunctionAdministrationIntegrationTests which requires the Pulsar RabbitMQ Connector to be downloaded prior to running. To download the connector (one time only) and run the integration test, add a system property to the task as follows:

./gradlew build -DdownloadRabbitConnector=true

By default, the build command will run unit tests followed by integration tests. If you want skip tests, use the -x test and/or -x integrationTest options:

./gradlew build -x test -x integrationTest

Modules

There are several modules in Spring Pulsar. Here is a quick overview:

spring-pulsar

The main library that provides the API to access Apache Pulsar.

spring-pulsar-cache-provider

Provides the interfaces for the cache provider used by the main library to cache producers.

spring-pulsar-cache-provider-caffeine

Provides the implementation of the cache provider using a shaded version of Caffeine.

spring-pulsar-dependencies

Provides a Gradle java-platform that recommends dependency versions.

spring-pulsar-docs

Provides reference docs and handles aggregating javadocs.

spring-pulsar-reactive

Provides the API to access Apache Pulsar using a Reactive client.

spring-pulsar-sample-apps

Provides sample applications to illustrate Spring Pulsar functionality as well as provide ability for quick manual verification during development.

License

Spring Pulsar is Open Source software released under the Apache 2.0 license.