com.google.cloud.spring.pubsub.integration.inbound

Class PubSubInboundChannelAdapter

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.endpoint.MessageProducerSupport

com.google.cloud.spring.pubsub.integration.inbound.PubSubInboundChannelAdapter

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.SmartInitializingSingleton, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, org.springframework.integration.context.ExpressionCapable, org.springframework.integration.core.MessageProducer, org.springframework.integration.IntegrationPattern, org.springframework.integration.support.context.NamedComponent, org.springframework.integration.support.management.ManageableLifecycle, org.springframework.integration.support.management.ManageableSmartLifecycle, org.springframework.integration.support.management.TrackableComponent

public class PubSubInboundChannelAdapter
extends org.springframework.integration.endpoint.MessageProducerSupport

Converts from GCP Pub/Sub message to Spring message and sends the Spring message to the attached channels.

Author:

João André Martins, Mike Eltsufin, Doug Hoard, Taylor Burke

Field Summary

Fields inherited from class org.springframework.integration.endpoint.AbstractEndpoint

lifecycleCondition, lifecycleLock

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor and Description
PubSubInboundChannelAdapter(PubSubSubscriberOperations pubSubSubscriberOperations, String subscriptionName)

Method Summary

Modifier and Type	Method and Description
protected void	doStart()
protected void	doStop()
AckMode	getAckMode()
org.springframework.messaging.MessageChannel	getErrorChannel() Workaround for GH-2615; prevents successful completion when exception received with closed context.
Class<?>	getPayloadType()
void	setAckMode(AckMode ackMode)
void	setHeaderMapper(org.springframework.integration.mapping.HeaderMapper<Map<String,String>> headerMapper) Set the header mapper to map headers from incoming PubsubMessage into Message.
void	setPayloadType(Class<?> payloadType) Set the desired type of the payload of the Message constructed by converting the incoming Pub/Sub message.

Methods inherited from class org.springframework.integration.endpoint.MessageProducerSupport

afterSingletonsInstantiated, buildErrorMessage, getErrorMessageAttributes, getIntegrationPatternType, getMessagingTemplate, getOutputChannel, onInit, sendErrorMessageIfNecessary, sendMessage, setErrorChannel, setErrorChannelName, setErrorMessageStrategy, setOutputChannel, setOutputChannelName, setSendTimeout, setShouldTrack, subscribeToPublisher

Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint

destroy, doStop, getPhase, getRole, isActive, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getComponentType, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName, getComponentType

Constructor Detail

PubSubInboundChannelAdapter

public PubSubInboundChannelAdapter(PubSubSubscriberOperations pubSubSubscriberOperations,
                                   String subscriptionName)

Method Detail

getAckMode

public AckMode getAckMode()

setAckMode

public void setAckMode(AckMode ackMode)

getPayloadType

public Class<?> getPayloadType()

setPayloadType

public void setPayloadType(Class<?> payloadType)

Set the desired type of the payload of the Message constructed by converting the incoming Pub/Sub message. The channel adapter will use the PubSubMessageConverter configured for PubSubSubscriberOperations.subscribeAndConvert(String, java.util.function.Consumer, Class). The default payload type is byte[].class.

Parameters:

payloadType - the type of the payload of the Message produced by the adapter. Cannot be set to null.

setHeaderMapper

public void setHeaderMapper(org.springframework.integration.mapping.HeaderMapper<Map<String,String>> headerMapper)

Set the header mapper to map headers from incoming PubsubMessage into Message.

Parameters:

headerMapper - the header mapper

doStart

protected void doStart()

Overrides:

doStart in class org.springframework.integration.endpoint.MessageProducerSupport

doStop

protected void doStop()

Overrides:

doStop in class org.springframework.integration.endpoint.MessageProducerSupport

getErrorChannel

public org.springframework.messaging.MessageChannel getErrorChannel()

Workaround for GH-2615; prevents successful completion when exception received with closed context.

Overrides:

getErrorChannel in class org.springframework.integration.endpoint.MessageProducerSupport

Returns:

error channel configured in parent class