org.springframework.cloud.stream.binder

Class AbstractBinder<T,C extends ConsumerProperties,P extends ProducerProperties>

java.lang.Object

org.springframework.cloud.stream.binder.AbstractBinder<T,C,P>

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, Binder<T,C,P>, org.springframework.context.ApplicationContextAware

public abstract class AbstractBinder<T,C extends ConsumerProperties,P extends ProducerProperties>
extends Object
implements org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean, Binder<T,C,P>

Author:

David Turanski, Gary Russell, Ilayaperumal Gopinathan, Mark Fisher, Marius Bogoevici

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractBinder.JavaClassMimeTypeConversion Handles representing any java class as a MimeType.

Field Summary

Fields

Modifier and Type	Field and Description
protected EmbeddedHeadersMessageConverter	embeddedHeadersMessageConverter
protected org.springframework.expression.EvaluationContext	evaluationContext
protected org.apache.commons.logging.Log	logger
protected static String	PARTITION_HEADER
protected PartitionSelectorStrategy	partitionSelector

Constructor Summary

Constructors

Constructor and Description
AbstractBinder()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
static String	applyPrefix(String prefix, String name) For binder implementations that support a prefix, apply the prefix to the name.
Binding<T>	bindConsumer(String name, String group, T target, C properties) Bind the target component as a message consumer to the logical entity identified by the name.
Binding<T>	bindProducer(String name, T outboundBindTarget, P properties) Bind the target component as a message producer to the logical entity identified by the name.
protected String	buildPartitionRoutingExpression(String expressionRoot)
protected org.springframework.retry.support.RetryTemplate	buildRetryTemplateIfRetryEnabled(ConsumerProperties properties) Create and configure a retry template if the consumer 'maxAttempts' property is set.
static String	constructDLQName(String name) For binder implementations that support dead lettering, construct the name of the dead letter entity for the underlying pipe name.
protected MessageValues	deserializePayloadIfNecessary(org.springframework.messaging.Message<?> message)
protected MessageValues	deserializePayloadIfNecessary(MessageValues messageValues)
protected abstract Binding<T>	doBindConsumer(String name, String group, T inputTarget, C properties)
protected abstract Binding<T>	doBindProducer(String name, T outboundBindTarget, P properties)
void	doManualAck(LinkedList<org.springframework.messaging.MessageHeaders> messageHeaders) Perform manual acknowledgement based on the metadata stored in the binder.
MessageValues	extractMessageValues(org.springframework.messaging.Message<?> receivedMessage) Extract the message values from the the received message when the received message is embedded with header values.
protected org.springframework.context.support.AbstractApplicationContext	getApplicationContext()
protected org.springframework.beans.factory.config.ConfigurableListableBeanFactory	getBeanFactory()
protected String	groupedName(String name, String group) Construct a name comprised of the name and group.
protected void	onInit() Subclasses may implement this method to perform any necessary initialization.
protected MessageValues	serializePayloadIfNecessary(org.springframework.messaging.Message<?> message)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setCodec(org.springframework.integration.codec.Codec codec)
void	setIntegrationEvaluationContext(org.springframework.expression.EvaluationContext evaluationContext)
void	setPartitionSelector(PartitionSelectorStrategy partitionSelector) Set the partition strategy to be used by this binder if no partitionExpression is provided for a module.

Methods inherited from class java.lang.Object

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

Field Detail

PARTITION_HEADER

protected static final String PARTITION_HEADER

See Also:

Constant Field Values

logger

protected final org.apache.commons.logging.Log logger

embeddedHeadersMessageConverter

protected final EmbeddedHeadersMessageConverter embeddedHeadersMessageConverter

evaluationContext

protected volatile org.springframework.expression.EvaluationContext evaluationContext

partitionSelector

protected volatile PartitionSelectorStrategy partitionSelector

Constructor Detail

AbstractBinder

public AbstractBinder()

Method Detail

applyPrefix

public static String applyPrefix(String prefix,
                                 String name)

For binder implementations that support a prefix, apply the prefix to the name.

Parameters:

prefix - the prefix.

name - the name.

constructDLQName

public static String constructDLQName(String name)

For binder implementations that support dead lettering, construct the name of the dead letter entity for the underlying pipe name.

Parameters:

name - the name.

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getApplicationContext

protected org.springframework.context.support.AbstractApplicationContext getApplicationContext()

getBeanFactory

protected org.springframework.beans.factory.config.ConfigurableListableBeanFactory getBeanFactory()

setCodec

public void setCodec(org.springframework.integration.codec.Codec codec)

setPartitionSelector

public void setPartitionSelector(PartitionSelectorStrategy partitionSelector)

Set the partition strategy to be used by this binder if no partitionExpression is provided for a module.

Parameters:

partitionSelector - The selector.

setIntegrationEvaluationContext

public void setIntegrationEvaluationContext(org.springframework.expression.EvaluationContext evaluationContext)

afterPropertiesSet

public final void afterPropertiesSet()
                              throws Exception

Specified by:

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

Throws:

Exception

extractMessageValues

public MessageValues extractMessageValues(org.springframework.messaging.Message<?> receivedMessage)

Extract the message values from the the received message when the received message is embedded with header values. Once extracted, deserialize the payload if necessary.

Parameters:

receivedMessage - the received message

Returns:

extracted message values

onInit

protected void onInit()
               throws Exception

Subclasses may implement this method to perform any necessary initialization. It will be invoked from afterPropertiesSet() which is itself final.

Throws:

Exception

bindConsumer

public final Binding<T> bindConsumer(String name,
                                     String group,
                                     T target,
                                     C properties)

Description copied from interface: Binder

Bind the target component as a message consumer to the logical entity identified by the name.

Specified by:

bindConsumer in interface Binder<T,C extends ConsumerProperties,P extends ProducerProperties>

Parameters:

name - the logical identity of the message source

group - the consumer group to which this consumer belongs - subscriptions are shared among consumers in the same group (a null or empty String, must be treated as an anonymous group that doesn't share the subscription with any other consumer)

target - the app interface to be bound as a consumer

properties - the consumer properties

doBindConsumer

protected abstract Binding<T> doBindConsumer(String name,
                                             String group,
                                             T inputTarget,
                                             C properties)

bindProducer

public final Binding<T> bindProducer(String name,
                                     T outboundBindTarget,
                                     P properties)

Description copied from interface: Binder

Bind the target component as a message producer to the logical entity identified by the name.

Specified by:

bindProducer in interface Binder<T,C extends ConsumerProperties,P extends ProducerProperties>

Parameters:

name - the logical identity of the message target

outboundBindTarget - the app interface to be bound as a producer

properties - the producer properties

doBindProducer

protected abstract Binding<T> doBindProducer(String name,
                                             T outboundBindTarget,
                                             P properties)

groupedName

protected final String groupedName(String name,
                                   String group)

Construct a name comprised of the name and group.

Parameters:

name - the name.

group - the group.

Returns:

the constructed name.

serializePayloadIfNecessary

protected final MessageValues serializePayloadIfNecessary(org.springframework.messaging.Message<?> message)

deserializePayloadIfNecessary

protected final MessageValues deserializePayloadIfNecessary(org.springframework.messaging.Message<?> message)

deserializePayloadIfNecessary

protected final MessageValues deserializePayloadIfNecessary(MessageValues messageValues)

buildPartitionRoutingExpression

protected String buildPartitionRoutingExpression(String expressionRoot)

buildRetryTemplateIfRetryEnabled

protected org.springframework.retry.support.RetryTemplate buildRetryTemplateIfRetryEnabled(ConsumerProperties properties)

Create and configure a retry template if the consumer 'maxAttempts' property is set.

Parameters:

properties - The properties.

Returns:

The retry template, or null if retry is not enabled.

doManualAck

public void doManualAck(LinkedList<org.springframework.messaging.MessageHeaders> messageHeaders)

Perform manual acknowledgement based on the metadata stored in the binder.