Add support for Apache Pulsar

Add support for Apache Pulsar using the Spring for Apache Pulsar
project.

See gh-34763

Co-authored-by: Phillip Webb <pwebb@vmware.com>

spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/messaging/pulsar/reading/MyBean.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2023-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.docs.messaging.pulsar.reading;
+
+import org.springframework.pulsar.annotation.PulsarReader;
+import org.springframework.stereotype.Component;
+
+@Component
+public class MyBean {
+
+	@PulsarReader(topics = "someTopic", startMessageId = "earliest")
+	public void processMessage(String content) {
+		// ...
+	}
+
+}

spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/messaging/pulsar/readingreactive/MyBean.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2023-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.docs.messaging.pulsar.readingreactive;
+
+import java.time.Instant;
+import java.util.List;
+
+import org.apache.pulsar.client.api.Message;
+import org.apache.pulsar.client.api.Schema;
+import org.apache.pulsar.reactive.client.api.StartAtSpec;
+import reactor.core.publisher.Mono;
+
+import org.springframework.pulsar.reactive.core.ReactiveMessageReaderBuilderCustomizer;
+import org.springframework.pulsar.reactive.core.ReactivePulsarReaderFactory;
+import org.springframework.stereotype.Component;
+
+@Component
+public class MyBean {
+
+	private final ReactivePulsarReaderFactory<String> pulsarReaderFactory;
+
+	public MyBean(ReactivePulsarReaderFactory<String> pulsarReaderFactory) {
+		this.pulsarReaderFactory = pulsarReaderFactory;
+	}
+
+	public void someMethod() {
+		ReactiveMessageReaderBuilderCustomizer<String> readerBuilderCustomizer = (readerBuilder) -> readerBuilder
+			.topic("someTopic")
+			.startAtSpec(StartAtSpec.ofInstant(Instant.now().minusSeconds(5)));
+		Mono<Message<String>> message = this.pulsarReaderFactory
+			.createReader(Schema.STRING, List.of(readerBuilderCustomizer))
+			.readOne();
+		// ...
+	}
+
+}

spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/messaging/pulsar/receiving/MyBean.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2023-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.docs.messaging.pulsar.receiving;
+
+import org.springframework.pulsar.annotation.PulsarListener;
+import org.springframework.stereotype.Component;
+
+@Component
+public class MyBean {
+
+	@PulsarListener(topics = "someTopic")
+	public void processMessage(String content) {
+		// ...
+	}
+
+}

spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/messaging/pulsar/receivingreactive/MyBean.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2023-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.docs.messaging.pulsar.receivingreactive;
+
+import reactor.core.publisher.Mono;
+
+import org.springframework.pulsar.reactive.config.annotation.ReactivePulsarListener;
+import org.springframework.stereotype.Component;
+
+@Component
+public class MyBean {
+
+	@ReactivePulsarListener(topics = "someTopic")
+	public Mono<Void> processMessage(String content) {
+		// ...
+		return Mono.empty();
+	}
+
+}

spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/messaging/pulsar/sending/MyBean.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2023-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.docs.messaging.pulsar.sending;
+
+import org.apache.pulsar.client.api.PulsarClientException;
+
+import org.springframework.pulsar.core.PulsarTemplate;
+import org.springframework.stereotype.Component;
+
+@Component
+public class MyBean {
+
+	private final PulsarTemplate<String> pulsarTemplate;
+
+	public MyBean(PulsarTemplate<String> pulsarTemplate) {
+		this.pulsarTemplate = pulsarTemplate;
+	}
+
+	public void someMethod() throws PulsarClientException {
+		this.pulsarTemplate.send("someTopic", "Hello");
+	}
+
+}

spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/messaging/pulsar/sendingreactive/MyBean.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2023-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.docs.messaging.pulsar.sendingreactive;
+
+import org.springframework.pulsar.reactive.core.ReactivePulsarTemplate;
+import org.springframework.stereotype.Component;
+
+@Component
+public class MyBean {
+
+	private final ReactivePulsarTemplate<String> pulsarTemplate;
+
+	public MyBean(ReactivePulsarTemplate<String> pulsarTemplate) {
+		this.pulsarTemplate = pulsarTemplate;
+	}
+
+	public void someMethod() {
+		this.pulsarTemplate.send("someTopic", "Hello").subscribe();
+	}
+
+}

spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/messaging/pulsar/reading/MyBean.kt

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2012-2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.docs.messaging.pulsar.reading
+
+import org.springframework.pulsar.annotation.PulsarReader
+import org.springframework.stereotype.Component
+
+@Suppress("UNUSED_PARAMETER")
+@Component
+class MyBean {
+
+	@PulsarReader(topics = ["someTopic"], startMessageId = "earliest")
+	fun processMessage(content: String?) {
+		// ...
+	}
+
+}
+

spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/messaging/pulsar/readingreactive/MyBean.kt

@@ -0,0 +1,44 @@
+/*
+* Copyright 2023-2023 the original author or authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*      https://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+package org.springframework.boot.docs.messaging.pulsar.readingreactive
+
+import org.apache.pulsar.client.api.Schema
+import org.apache.pulsar.reactive.client.api.ReactiveMessageReaderBuilder
+import org.apache.pulsar.reactive.client.api.StartAtSpec
+import org.springframework.pulsar.reactive.core.ReactiveMessageReaderBuilderCustomizer
+import org.springframework.pulsar.reactive.core.ReactivePulsarReaderFactory
+import org.springframework.stereotype.Component
+import java.time.Instant
+
+@Suppress("UNUSED_PARAMETER", "UNUSED_VARIABLE")
+@Component
+class MyBean(private val pulsarReaderFactory: ReactivePulsarReaderFactory<String>) {
+
+	fun someMethod() {
+		val readerBuilderCustomizer = ReactiveMessageReaderBuilderCustomizer {
+			readerBuilder: ReactiveMessageReaderBuilder<String> ->
+				readerBuilder
+					.topic("someTopic")
+					.startAtSpec(StartAtSpec.ofInstant(Instant.now().minusSeconds(5)))
+		}
+		val message = pulsarReaderFactory
+				.createReader(Schema.STRING, listOf(readerBuilderCustomizer))
+				.readOne()
+		// ...
+	}
+
+}

spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/messaging/pulsar/receiving/MyBean.kt

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2012-2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.docs.messaging.pulsar.receiving
+
+import org.springframework.pulsar.annotation.PulsarListener
+import org.springframework.stereotype.Component
+
+@Suppress("UNUSED_PARAMETER")
+@Component
+class MyBean {
+
+	@PulsarListener(topics = ["someTopic"])
+	fun processMessage(content: String?) {
+		// ...
+	}
+
+}
+

spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/messaging/pulsar/receivingreactive/MyBean.kt

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2023-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.boot.docs.messaging.pulsar.receivingreactive
+
+import org.springframework.pulsar.reactive.config.annotation.ReactivePulsarListener
+import org.springframework.stereotype.Component
+import reactor.core.publisher.Mono
+
+@Component
+@Suppress("UNUSED_PARAMETER")
+class MyBean {
+
+	@ReactivePulsarListener(topics = ["someTopic"])
+	fun processMessage(content: String?): Mono<Void> {
+		// ...
+		return Mono.empty()
+	}
+
+}

spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/messaging/pulsar/sending/MyBean.kt

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2012-2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.boot.docs.messaging.pulsar.sending
+
+import org.apache.pulsar.client.api.PulsarClientException
+import org.springframework.kafka.core.KafkaTemplate
+import org.springframework.pulsar.core.PulsarTemplate
+import org.springframework.stereotype.Component
+
+@Component
+class MyBean(private val pulsarTemplate: PulsarTemplate<String>) {
+
+	@Throws(PulsarClientException::class)
+	fun someMethod() {
+		pulsarTemplate.send("someTopic", "Hello")
+	}
+
+}
+

spring-boot-project/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/messaging/pulsar/sendingreactive/MyBean.kt

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2023-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.boot.docs.messaging.pulsar.sendingreactive
+
+import org.springframework.pulsar.reactive.core.ReactivePulsarTemplate
+import org.springframework.stereotype.Component
+
+@Component
+class MyBean(private val pulsarTemplate: ReactivePulsarTemplate<String>) {
+
+	fun someMethod() {
+		pulsarTemplate.send("someTopic", "Hello").subscribe()
+	}
+
+}