org.springframework.integration.dsl.kafka

Class KafkaProducerMessageHandlerSpec<K,V>

java.lang.Object

org.springframework.integration.dsl.core.IntegrationComponentSpec<S,H>

org.springframework.integration.dsl.core.MessageHandlerSpec<KafkaProducerMessageHandlerSpec<K,V>,org.springframework.integration.kafka.outbound.KafkaProducerMessageHandler<K,V>>

org.springframework.integration.dsl.kafka.KafkaProducerMessageHandlerSpec<K,V>

Type Parameters:

K - the key type.

V - the value type.

All Implemented Interfaces:

org.springframework.beans.factory.FactoryBean<org.springframework.integration.kafka.outbound.KafkaProducerMessageHandler<K,V>>

Direct Known Subclasses:

KafkaProducerMessageHandlerSpec.KafkaProducerMessageHandlerTemplateSpec

public class KafkaProducerMessageHandlerSpec<K,V>
extends MessageHandlerSpec<KafkaProducerMessageHandlerSpec<K,V>,org.springframework.integration.kafka.outbound.KafkaProducerMessageHandler<K,V>>

A MessageHandlerSpec implementation for the KafkaProducerMessageHandler.

Since:

1.2

Author:

Artem Bilan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KafkaProducerMessageHandlerSpec.KafkaProducerMessageHandlerTemplateSpec<K,V> A KafkaTemplate-based KafkaProducerMessageHandlerSpec extension.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.kafka.core.KafkaTemplate<K,V>	kafkaTemplate

Fields inherited from class org.springframework.integration.dsl.core.IntegrationComponentSpec

logger, PARSER, target

Method Summary

Modifier and Type	Method and Description
<P> KafkaProducerMessageHandlerSpec<K,V>	messageKey(Function<org.springframework.messaging.Message<P>,?> messageKeyFunction) Configure a Function that will be invoked at run time to determine the message key under which a message will be stored in the topic.
KafkaProducerMessageHandlerSpec<K,V>	messageKey(java.lang.String messageKey) Configure the message key to store message in Kafka topic.
KafkaProducerMessageHandlerSpec<K,V>	messageKeyExpression(org.springframework.expression.Expression messageKeyExpression) Configure an Expression to determine the Kafka message key to store at runtime against request Message as a root object of evaluation context.
KafkaProducerMessageHandlerSpec<K,V>	messageKeyExpression(java.lang.String messageKeyExpression) Configure a SpEL expression to determine the Kafka message key to store at runtime against request Message as a root object of evaluation context.
<P> KafkaProducerMessageHandlerSpec<K,V>	partitionId(Function<org.springframework.messaging.Message<P>,java.lang.Integer> partitionIdFunction) Configure a Function that will be invoked at run time to determine the partition id under which a message will be stored in the topic.
KafkaProducerMessageHandlerSpec<K,V>	partitionId(java.lang.Integer partitionId) Configure a partitionId of Kafka topic.
KafkaProducerMessageHandlerSpec<K,V>	partitionIdExpression(org.springframework.expression.Expression partitionIdExpression) Configure an Expression to determine the topic partitionId at runtime against request Message as a root object of evaluation context.
KafkaProducerMessageHandlerSpec<K,V>	partitionIdExpression(java.lang.String partitionIdExpression) Configure a SpEL expression to determine the topic partitionId at runtime against request Message as a root object of evaluation context.
KafkaProducerMessageHandlerSpec<K,V>	sendTimeout(long sendTimeout) Specify a timeout in milliseconds how long KafkaProducerMessageHandler should wait wait for send operation results.
KafkaProducerMessageHandlerSpec<K,V>	sync(boolean sync) A boolean indicating if the KafkaProducerMessageHandler should wait for the send operation results or not.
<P> KafkaProducerMessageHandlerSpec<K,V>	topic(Function<org.springframework.messaging.Message<P>,java.lang.String> topicFunction) Configure a Function that will be invoked at run time to determine the topic to which a message will be sent.
KafkaProducerMessageHandlerSpec<K,V>	topic(java.lang.String topic) Configure the Kafka topic to send messages.
KafkaProducerMessageHandlerSpec<K,V>	topicExpression(org.springframework.expression.Expression topicExpression) Configure an Expression to determine the Kafka topic at runtime against request Message as a root object of evaluation context.
KafkaProducerMessageHandlerSpec<K,V>	topicExpression(java.lang.String topicExpression) Configure a SpEL expression to determine the Kafka topic at runtime against request Message as a root object of evaluation context.

Methods inherited from class org.springframework.integration.dsl.core.IntegrationComponentSpec

_this, doGet, get, getId, getObject, getObjectType, id, isSingleton

Methods inherited from class java.lang.Object

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

Field Detail

kafkaTemplate

protected final org.springframework.kafka.core.KafkaTemplate<K,V> kafkaTemplate

Method Detail

topic

public KafkaProducerMessageHandlerSpec<K,V> topic(java.lang.String topic)

Configure the Kafka topic to send messages.

Parameters:

topic - the Kafka topic name.

Returns:

the spec.

topicExpression

public KafkaProducerMessageHandlerSpec<K,V> topicExpression(java.lang.String topicExpression)

Configure a SpEL expression to determine the Kafka topic at runtime against request Message as a root object of evaluation context.

Parameters:

topicExpression - the topic SpEL expression.

Returns:

the spec.

topicExpression

public KafkaProducerMessageHandlerSpec<K,V> topicExpression(org.springframework.expression.Expression topicExpression)

Configure an Expression to determine the Kafka topic at runtime against request Message as a root object of evaluation context.

Parameters:

topicExpression - the topic expression.

Returns:

the spec.

topic

public <P> KafkaProducerMessageHandlerSpec<K,V> topic(Function<org.springframework.messaging.Message<P>,java.lang.String> topicFunction)

Configure a Function that will be invoked at run time to determine the topic to which a message will be sent. Typically used with a Java 8 Lambda expression:

 .<Foo>topic(m -> m.getPayload().getTopic())
 
 

Type Parameters:

P - the expected payload type.

Parameters:

topicFunction - the topic function.

Returns:

the current KafkaProducerMessageHandlerSpec.

See Also:

FunctionExpression

messageKeyExpression

public KafkaProducerMessageHandlerSpec<K,V> messageKeyExpression(java.lang.String messageKeyExpression)

Configure a SpEL expression to determine the Kafka message key to store at runtime against request Message as a root object of evaluation context.

Parameters:

messageKeyExpression - the message key SpEL expression.

Returns:

the spec.

messageKey

public KafkaProducerMessageHandlerSpec<K,V> messageKey(java.lang.String messageKey)

Configure the message key to store message in Kafka topic.

Parameters:

messageKey - the message key to use.

Returns:

the spec.

messageKeyExpression

public KafkaProducerMessageHandlerSpec<K,V> messageKeyExpression(org.springframework.expression.Expression messageKeyExpression)

Configure an Expression to determine the Kafka message key to store at runtime against request Message as a root object of evaluation context.

Parameters:

messageKeyExpression - the message key expression.

Returns:

the spec.

messageKey

public <P> KafkaProducerMessageHandlerSpec<K,V> messageKey(Function<org.springframework.messaging.Message<P>,?> messageKeyFunction)

Configure a Function that will be invoked at run time to determine the message key under which a message will be stored in the topic. Typically used with a Java 8 Lambda expression:

 .<Foo>messageKey(m -> m.getPayload().getKey())
 
 

Type Parameters:

P - the expected payload type.

Parameters:

messageKeyFunction - the message key function.

Returns:

the current KafkaProducerMessageHandlerSpec.

See Also:

FunctionExpression

partitionId

public KafkaProducerMessageHandlerSpec<K,V> partitionId(java.lang.Integer partitionId)

Configure a partitionId of Kafka topic.

Parameters:

partitionId - the partitionId to use.

Returns:

the spec.

partitionIdExpression

public KafkaProducerMessageHandlerSpec<K,V> partitionIdExpression(java.lang.String partitionIdExpression)

Configure a SpEL expression to determine the topic partitionId at runtime against request Message as a root object of evaluation context.

Parameters:

partitionIdExpression - the partitionId expression to use.

Returns:

the spec.

partitionId

public <P> KafkaProducerMessageHandlerSpec<K,V> partitionId(Function<org.springframework.messaging.Message<P>,java.lang.Integer> partitionIdFunction)

Configure a Function that will be invoked at run time to determine the partition id under which a message will be stored in the topic. Typically used with a Java 8 Lambda expression:

 .partitionId(m -> m.getHeaders().get("partitionId", Integer.class))
 
 

Type Parameters:

P - the expected payload type.

Parameters:

partitionIdFunction - the partitionId function.

Returns:

the spec.

partitionIdExpression

public KafkaProducerMessageHandlerSpec<K,V> partitionIdExpression(org.springframework.expression.Expression partitionIdExpression)

Configure an Expression to determine the topic partitionId at runtime against request Message as a root object of evaluation context.

Parameters:

partitionIdExpression - the partitionId expression to use.

Returns:

the spec.

sync

public KafkaProducerMessageHandlerSpec<K,V> sync(boolean sync)

A boolean indicating if the KafkaProducerMessageHandler should wait for the send operation results or not. Defaults to false. In sync mode a downstream send operation exception will be re-thrown.

Parameters:

sync - the send mode; async by default.

Returns:

the spec.

sendTimeout

public KafkaProducerMessageHandlerSpec<K,V> sendTimeout(long sendTimeout)

Specify a timeout in milliseconds how long KafkaProducerMessageHandler should wait wait for send operation results. Defaults to 10 seconds.

Parameters:

sendTimeout - the timeout to wait for result fo send operation.

Returns:

the spec.