org.springframework.cloud.gcp.pubsub.core

Class PubSubTemplate

java.lang.Object

org.springframework.cloud.gcp.pubsub.core.PubSubTemplate

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, PubSubOperations

public class PubSubTemplate
extends Object
implements PubSubOperations, org.springframework.beans.factory.InitializingBean

Default implementation of PubSubOperations.

The main Google Cloud Pub/Sub integration component for publishing to topics and consuming messages from subscriptions asynchronously or by pulling.

Author:

Vinicius Carvalho, João André Martins, Mike Eltsufin, Chengyuan Zhao

Constructor Summary

Constructors

Constructor and Description
PubSubTemplate(PublisherFactory publisherFactory, SubscriberFactory subscriberFactory) Default PubSubTemplate constructor that uses SimplePubSubMessageConverter to serialize and deserialize payloads.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
PubSubAcknowledger	getAcknowledger()
PubSubMessageConverter	getMessageConverter()
PublisherFactory	getPublisherFactory()
SubscriberFactory	getSubscriberFactory()
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.
List<AcknowledgeablePubsubMessage>	pull(String subscription, Integer maxMessages, Boolean returnImmediately) Pull a number of messages from a Google Cloud Pub/Sub subscription.
List<com.google.pubsub.v1.PubsubMessage>	pullAndAck(String subscription, Integer maxMessages, Boolean returnImmediately) Pull and auto-acknowledge a number of messages from a Google Cloud Pub/Sub subscription.
com.google.pubsub.v1.PubsubMessage	pullNext(String subscription) Pull and auto-acknowledge a message from a Google Cloud Pub/Sub subscription.
PubSubTemplate	setMessageConverter(PubSubMessageConverter messageConverter)
com.google.cloud.pubsub.v1.Subscriber	subscribe(String subscription, com.google.cloud.pubsub.v1.MessageReceiver messageHandler) Add a callback method to an existing subscription.

Methods inherited from class java.lang.Object

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

Constructor Detail

PubSubTemplate

public PubSubTemplate(PublisherFactory publisherFactory,
                      SubscriberFactory subscriberFactory)

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

Parameters:

publisherFactory - the Publisher factory to publish to topics

subscriberFactory - the Subscriber factory to subscribe to subscriptions

Method Detail

getMessageConverter

public PubSubMessageConverter getMessageConverter()

setMessageConverter

public PubSubTemplate setMessageConverter(PubSubMessageConverter messageConverter)

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 PubSubOperations

Parameters:

topic - the name of an existing topic

payload - an object that will be serialized and sent

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: PubSubOperations

Send a message to Pub/Sub.

Specified by:

publish in interface PubSubOperations

Parameters:

topic - the name of an existing topic

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: PubSubOperations

Send a message to Pub/Sub.

Specified by:

publish in interface PubSubOperations

Parameters:

topic - the name of an existing topic

pubsubMessage - a Google Cloud Pub/Sub API message

Returns:

the listenable future of the call

subscribe

public com.google.cloud.pubsub.v1.Subscriber subscribe(String subscription,
                                                       com.google.cloud.pubsub.v1.MessageReceiver messageHandler)

Description copied from interface: PubSubOperations

Add a callback method to an existing subscription.

The created Subscriber is returned so it can be stopped.

Specified by:

subscribe in interface PubSubOperations

Parameters:

subscription - the name of an existing subscription

messageHandler - the callback method triggered when new messages arrive

Returns:

subscriber listening to new messages

pull

public List<AcknowledgeablePubsubMessage> pull(String subscription,
                                               Integer maxMessages,
                                               Boolean returnImmediately)

Description copied from interface: PubSubOperations

Pull a number of messages from a Google Cloud Pub/Sub subscription.

Specified by:

pull in interface PubSubOperations

Parameters:

subscription - the subscription name

maxMessages - the maximum number of pulled messages

returnImmediately - returns immediately even if subscription doesn't contain enough messages to satisfy maxMessages

Returns:

the list of received acknowledgeable messages

pullAndAck

public List<com.google.pubsub.v1.PubsubMessage> pullAndAck(String subscription,
                                                           Integer maxMessages,
                                                           Boolean returnImmediately)

Description copied from interface: PubSubOperations

Pull and auto-acknowledge a number of messages from a Google Cloud Pub/Sub subscription.

Specified by:

pullAndAck in interface PubSubOperations

Parameters:

subscription - the subscription name

maxMessages - the maximum number of pulled messages

returnImmediately - returns immediately even if subscription doesn't contain enough messages to satisfy maxMessages

Returns:

the list of received messages

pullNext

public com.google.pubsub.v1.PubsubMessage pullNext(String subscription)

Description copied from interface: PubSubOperations

Pull and auto-acknowledge a message from a Google Cloud Pub/Sub subscription.

Specified by:

pullNext in interface PubSubOperations

Parameters:

subscription - the subscription name

Returns:

a received message, or null if none exists in the subscription

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getPublisherFactory

public PublisherFactory getPublisherFactory()

getSubscriberFactory

public SubscriberFactory getSubscriberFactory()

getAcknowledger

public PubSubAcknowledger getAcknowledger()