com.google.cloud.spring.pubsub.core.publisher

Class PubSubPublisherTemplate

java.lang.Object

com.google.cloud.spring.pubsub.core.publisher.PubSubPublisherTemplate

All Implemented Interfaces:

PubSubPublisherOperations

public class PubSubPublisherTemplate
extends Object
implements PubSubPublisherOperations

Default implementation of PubSubPublisherOperations.

The main Google Cloud Pub/Sub integration component for publishing to topics.

Since:

1.1

Author:

Vinicius Carvalho, João André Martins, Mike Eltsufin, Chengyuan Zhao, Doug Hoard, SateeshKumar Kota

Constructor Summary

Constructors

Constructor and Description
PubSubPublisherTemplate(PublisherFactory publisherFactory) Default PubSubPublisherTemplate constructor that uses SimplePubSubMessageConverter to serialize and deserialize payloads.

Method Summary

Modifier and Type	Method and Description
PubSubMessageConverter	getMessageConverter()
PublisherFactory	getPublisherFactory()
org.springframework.util.concurrent.ListenableFuture<String>	publish(String topic, com.google.pubsub.v1.PubsubMessage pubsubMessage) Send a message to Pub/Sub.
<T> org.springframework.util.concurrent.ListenableFuture<String>	publish(String topic, T payload) Send a message to Pub/Sub.
<T> org.springframework.util.concurrent.ListenableFuture<String>	publish(String topic, T payload, Map<String,String> headers) Uses the configured message converter to first convert the payload and headers to a PubsubMessage and then publish it.
void	setMessageConverter(PubSubMessageConverter pubSubMessageConverter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PubSubPublisherTemplate

public PubSubPublisherTemplate(PublisherFactory publisherFactory)

Default PubSubPublisherTemplate constructor that uses SimplePubSubMessageConverter to serialize and deserialize payloads.

Parameters:

publisherFactory - the Publisher factory to publish to topics.

Method Detail

getMessageConverter

public PubSubMessageConverter getMessageConverter()

setMessageConverter

public void setMessageConverter(PubSubMessageConverter pubSubMessageConverter)

publish

public <T> org.springframework.util.concurrent.ListenableFuture<String> publish(String topic,
                                                                                T payload,
                                                                                Map<String,String> headers)

Uses the configured message converter to first convert the payload and headers to a PubsubMessage and then publish it.

Specified by:

publish in interface PubSubPublisherOperations

Type Parameters:

T - the type of the payload to publish

Parameters:

topic - canonical topic name, e.g., "topicName", or the fully-qualified topic name in the projects/<project_name>/topics/<topic_name> format

payload - an object that will be serialized and sent

headers - the headers to publish

Returns:

the listenable future of the call

publish

public <T> org.springframework.util.concurrent.ListenableFuture<String> publish(String topic,
                                                                                T payload)

Description copied from interface: PubSubPublisherOperations

Send a message to Pub/Sub.

Specified by:

publish in interface PubSubPublisherOperations

Type Parameters:

T - the type of the payload to publish

Parameters:

topic - canonical topic name, e.g., "topicName", or the fully-qualified topic name in the projects/<project_name>/topics/<topic_name> format

payload - an object that will be serialized and sent

Returns:

the listenable future of the call

publish

public org.springframework.util.concurrent.ListenableFuture<String> publish(String topic,
                                                                            com.google.pubsub.v1.PubsubMessage pubsubMessage)

Description copied from interface: PubSubPublisherOperations

Send a message to Pub/Sub.

Specified by:

publish in interface PubSubPublisherOperations

Parameters:

topic - canonical topic name, e.g., "topicName", or the fully-qualified topic name in the projects/<project_name>/topics/<topic_name> format

pubsubMessage - a Google Cloud Pub/Sub API message

Returns:

the listenable future of the call

getPublisherFactory

public PublisherFactory getPublisherFactory()