org.springframework.cloud.gcp.pubsub.support

Class DefaultSubscriberFactory

java.lang.Object

org.springframework.cloud.gcp.pubsub.support.DefaultSubscriberFactory

All Implemented Interfaces:

SubscriberFactory

public class DefaultSubscriberFactory
extends Object
implements SubscriberFactory

The default SubscriberFactory implementation.

Author:

João André Martins, Mike Eltsufin, Doug Hoard, Chengyuan Zhao, Maurice Zeijen

Constructor Summary

Constructors

Constructor and Description
DefaultSubscriberFactory(GcpProjectIdProvider projectIdProvider) Default DefaultSubscriberFactory constructor.

Method Summary

Modifier and Type	Method and Description
com.google.pubsub.v1.PullRequest	createPullRequest(String subscriptionName, Integer maxMessages, Boolean returnImmediately) Create a PullRequest for synchronously pulling a number of messages from a Google Cloud Pub/Sub subscription.
Subscriber	createSubscriber(String subscriptionName, MessageReceiver receiver) Create a Subscriber for the specified subscription name and wired it up to asynchronously deliver messages to the provided MessageReceiver.
SubscriberStub	createSubscriberStub() Create a SubscriberStub that is needed to execute PullRequests.
String	getProjectId() Method to get the project id.
void	setApiClock(com.google.api.core.ApiClock apiClock) Set the clock to use for the retry logic in synchronous pulling.
void	setChannelProvider(com.google.api.gax.rpc.TransportChannelProvider channelProvider) Set the provider for the subscribers' transport channel.
void	setCredentialsProvider(com.google.api.gax.core.CredentialsProvider credentialsProvider) Set the provider for the GCP credentials to be used by the subscribers' API calls.
void	setExecutorProvider(com.google.api.gax.core.ExecutorProvider executorProvider) Set the provider for the subscribers' executor.
void	setFlowControlSettings(com.google.api.gax.batching.FlowControlSettings flowControlSettings) Set the flow control for the subscribers, including the behaviour for when the flow limits are hit.
void	setHeaderProvider(com.google.api.gax.rpc.HeaderProvider headerProvider) Set the provider for the HTTP headers to be added to the subscribers' REST API calls.
void	setMaxAckExtensionPeriod(org.threeten.bp.Duration maxAckExtensionPeriod) Set the maximum period the ack timeout is extended by.
void	setParallelPullCount(Integer parallelPullCount) Set the number of pull workers.
void	setPullEndpoint(String pullEndpoint) Set the endpoint for synchronous pulling messages.
void	setSubscriberStubRetrySettings(com.google.api.gax.retrying.RetrySettings subscriberStubRetrySettings) Set the retry settings for the generated subscriber stubs.
void	setSystemExecutorProvider(com.google.api.gax.core.ExecutorProvider systemExecutorProvider) Set the provider for the system executor, to poll and manage lease extensions.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSubscriberFactory

public DefaultSubscriberFactory(GcpProjectIdProvider projectIdProvider)

Default DefaultSubscriberFactory constructor.

Parameters:

projectIdProvider - provides the default GCP project ID for selecting the subscriptions

Method Detail

getProjectId

public String getProjectId()

Description copied from interface: SubscriberFactory

Method to get the project id.

Specified by:

getProjectId in interface SubscriberFactory

Returns:

the project id

setExecutorProvider

public void setExecutorProvider(com.google.api.gax.core.ExecutorProvider executorProvider)

Set the provider for the subscribers' executor. Useful to specify the number of threads to be used by each executor.

Parameters:

executorProvider - the executor provider to set

setChannelProvider

public void setChannelProvider(com.google.api.gax.rpc.TransportChannelProvider channelProvider)

Set the provider for the subscribers' transport channel.

Parameters:

channelProvider - the channel provider to set

setCredentialsProvider

public void setCredentialsProvider(com.google.api.gax.core.CredentialsProvider credentialsProvider)

Set the provider for the GCP credentials to be used by the subscribers' API calls.

Parameters:

credentialsProvider - the credentials provider to set

setHeaderProvider

public void setHeaderProvider(com.google.api.gax.rpc.HeaderProvider headerProvider)

Set the provider for the HTTP headers to be added to the subscribers' REST API calls.

Parameters:

headerProvider - the header provider to set

setSystemExecutorProvider

public void setSystemExecutorProvider(com.google.api.gax.core.ExecutorProvider systemExecutorProvider)

Set the provider for the system executor, to poll and manage lease extensions.

Parameters:

systemExecutorProvider - the system executor provider to set

setFlowControlSettings

public void setFlowControlSettings(com.google.api.gax.batching.FlowControlSettings flowControlSettings)

Set the flow control for the subscribers, including the behaviour for when the flow limits are hit.

Parameters:

flowControlSettings - the flow control settings to set

setMaxAckExtensionPeriod

public void setMaxAckExtensionPeriod(org.threeten.bp.Duration maxAckExtensionPeriod)

Set the maximum period the ack timeout is extended by.

Parameters:

maxAckExtensionPeriod - the max ack extension period to set

setParallelPullCount

public void setParallelPullCount(Integer parallelPullCount)

Set the number of pull workers.

Parameters:

parallelPullCount - the parallel pull count to set

setPullEndpoint

public void setPullEndpoint(String pullEndpoint)

Set the endpoint for synchronous pulling messages.

Parameters:

pullEndpoint - the pull endpoint to set

setApiClock

public void setApiClock(com.google.api.core.ApiClock apiClock)

Set the clock to use for the retry logic in synchronous pulling.

Parameters:

apiClock - the api clock to set

setSubscriberStubRetrySettings

public void setSubscriberStubRetrySettings(com.google.api.gax.retrying.RetrySettings subscriberStubRetrySettings)

Set the retry settings for the generated subscriber stubs.

Parameters:

subscriberStubRetrySettings - parameters for retrying pull requests when they fail, including jitter logic, timeout, and exponential backoff

createSubscriber

public Subscriber createSubscriber(String subscriptionName,
                                   MessageReceiver receiver)

Description copied from interface: SubscriberFactory

Create a Subscriber for the specified subscription name and wired it up to asynchronously deliver messages to the provided MessageReceiver.

Specified by:

createSubscriber in interface SubscriberFactory

Parameters:

subscriptionName - the name of the subscription

receiver - the callback for receiving messages asynchronously

Returns:

the Subscriber that was created to bind the receiver to the subscription

createPullRequest

public com.google.pubsub.v1.PullRequest createPullRequest(String subscriptionName,
                                                          Integer maxMessages,
                                                          Boolean returnImmediately)

Description copied from interface: SubscriberFactory

Create a PullRequest for synchronously pulling a number of messages from a Google Cloud Pub/Sub subscription.

Specified by:

createPullRequest in interface SubscriberFactory

Parameters:

subscriptionName - the name of the subscription

maxMessages - the maximum number of pulled messages; must be greater than zero. If null is passed in, then up to Integer.MAX_VALUE messages will be requested.

returnImmediately - causes the pull request to return immediately even if subscription doesn't contain enough messages to satisfy maxMessages

Returns:

the pull request that can be executed using a SubscriberStub

createSubscriberStub

public SubscriberStub createSubscriberStub()

Description copied from interface: SubscriberFactory

Create a SubscriberStub that is needed to execute PullRequests.

Specified by:

createSubscriberStub in interface SubscriberFactory

Returns:

the SubscriberStub used for executing PullRequests