org.springframework.kafka.core

Class KafkaTemplate<K,V>

java.lang.Object

org.springframework.kafka.core.KafkaTemplate<K,V>

Type Parameters:

K - the key type.

V - the value type.

All Implemented Interfaces:

KafkaOperations<K,V>

public class KafkaTemplate<K,V>
extends java.lang.Object
implements KafkaOperations<K,V>

A template for executing high-level operations.

Author:

Marius Bogoevici, Gary Russell

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Constructor and Description
KafkaTemplate(ProducerFactory<K,V> producerFactory) Create an instance using the supplied producer factory.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.Future<org.apache.kafka.clients.producer.RecordMetadata>	convertAndSend(int partition, K key, V data) Send the data to the default topic with the provided key and partition.
java.util.concurrent.Future<org.apache.kafka.clients.producer.RecordMetadata>	convertAndSend(K key, V data) Send the data to the default topic with the provided key and no partition.
java.util.concurrent.Future<org.apache.kafka.clients.producer.RecordMetadata>	convertAndSend(java.lang.String topic, int partition, K key, V data) Send the data to the provided topic with the provided key and partition.
java.util.concurrent.Future<org.apache.kafka.clients.producer.RecordMetadata>	convertAndSend(java.lang.String topic, K key, V data) Send the data to the provided topic with the provided key and no partition.
java.util.concurrent.Future<org.apache.kafka.clients.producer.RecordMetadata>	convertAndSend(java.lang.String topic, V data) Send the data to the provided topic with no key or partition.
java.util.concurrent.Future<org.apache.kafka.clients.producer.RecordMetadata>	convertAndSend(V data) Send the data to the default topic with no key or partition.
protected java.util.concurrent.Future<org.apache.kafka.clients.producer.RecordMetadata>	doSend(org.apache.kafka.clients.producer.ProducerRecord<K,V> producerRecord) Send the producer record.
void	flush() Flush the producer.
java.lang.String	getDefaultTopic() The default topic for send methods where a topic is not providing.
void	setDefaultTopic(java.lang.String defaultTopic) Set the default topic for send methods where a topic is not providing.
void	setProducerListener(ProducerListener<K,V> producerListener) Set a ProducerListener which will be invoked when Kafka acknowledges a send operation.
org.apache.kafka.clients.producer.RecordMetadata	syncConvertAndSend(int partition, K key, V data) Send the data to the default topic with the provided key and partition.
org.apache.kafka.clients.producer.RecordMetadata	syncConvertAndSend(K key, V data) Send the data to the default topic with the provided key and no partition; wait for result.
org.apache.kafka.clients.producer.RecordMetadata	syncConvertAndSend(java.lang.String topic, int partition, K key, V data) Send the data to the provided topic with the provided key and partition; wait for result.
org.apache.kafka.clients.producer.RecordMetadata	syncConvertAndSend(java.lang.String topic, K key, V data) Send the data to the provided topic with the provided key and no partition; wait for result.
org.apache.kafka.clients.producer.RecordMetadata	syncConvertAndSend(java.lang.String topic, V data) Send the data to the provided topic with no key or partition.; wait for result.
org.apache.kafka.clients.producer.RecordMetadata	syncConvertAndSend(V data) Send the data to the default topic with no key or partition; wait for result.

Methods inherited from class java.lang.Object

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

Field Detail

logger

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

Constructor Detail

KafkaTemplate

public KafkaTemplate(ProducerFactory<K,V> producerFactory)

Create an instance using the supplied producer factory.

Parameters:

producerFactory - the producer factory.

Method Detail

getDefaultTopic

public java.lang.String getDefaultTopic()

The default topic for send methods where a topic is not providing.

Returns:

the topic.

setDefaultTopic

public void setDefaultTopic(java.lang.String defaultTopic)

Set the default topic for send methods where a topic is not providing.

Parameters:

defaultTopic - the topic.

setProducerListener

public void setProducerListener(ProducerListener<K,V> producerListener)

Set a ProducerListener which will be invoked when Kafka acknowledges a send operation.

Parameters:

producerListener - the listener.

convertAndSend

public java.util.concurrent.Future<org.apache.kafka.clients.producer.RecordMetadata> convertAndSend(V data)

Description copied from interface: KafkaOperations

Send the data to the default topic with no key or partition.

Specified by:

convertAndSend in interface KafkaOperations<K,V>

Parameters:

data - The data.

Returns:

a Future for the RecordMetadata.

convertAndSend

public java.util.concurrent.Future<org.apache.kafka.clients.producer.RecordMetadata> convertAndSend(K key,
                                                                                                    V data)

Description copied from interface: KafkaOperations

Send the data to the default topic with the provided key and no partition.

Specified by:

convertAndSend in interface KafkaOperations<K,V>

Parameters:

key - the key.

data - The data.

Returns:

a Future for the RecordMetadata.

convertAndSend

public java.util.concurrent.Future<org.apache.kafka.clients.producer.RecordMetadata> convertAndSend(int partition,
                                                                                                    K key,
                                                                                                    V data)

Description copied from interface: KafkaOperations

Send the data to the default topic with the provided key and partition.

Specified by:

convertAndSend in interface KafkaOperations<K,V>

Parameters:

partition - the partition.

key - the key.

data - the data.

Returns:

a Future for the RecordMetadata.

convertAndSend

public java.util.concurrent.Future<org.apache.kafka.clients.producer.RecordMetadata> convertAndSend(java.lang.String topic,
                                                                                                    V data)

Description copied from interface: KafkaOperations

Send the data to the provided topic with no key or partition.

Specified by:

convertAndSend in interface KafkaOperations<K,V>

Parameters:

topic - the topic.

data - The data.

Returns:

a Future for the RecordMetadata.

convertAndSend

public java.util.concurrent.Future<org.apache.kafka.clients.producer.RecordMetadata> convertAndSend(java.lang.String topic,
                                                                                                    K key,
                                                                                                    V data)

Description copied from interface: KafkaOperations

Send the data to the provided topic with the provided key and no partition.

Specified by:

convertAndSend in interface KafkaOperations<K,V>

Parameters:

topic - the topic.

key - the key.

data - The data.

Returns:

a Future for the RecordMetadata.

convertAndSend

public java.util.concurrent.Future<org.apache.kafka.clients.producer.RecordMetadata> convertAndSend(java.lang.String topic,
                                                                                                    int partition,
                                                                                                    K key,
                                                                                                    V data)

Description copied from interface: KafkaOperations

Send the data to the provided topic with the provided key and partition.

Specified by:

convertAndSend in interface KafkaOperations<K,V>

Parameters:

topic - the topic.

partition - the partition.

key - the key.

data - the data.

Returns:

a Future for the RecordMetadata.

syncConvertAndSend

public org.apache.kafka.clients.producer.RecordMetadata syncConvertAndSend(V data)
                                                                    throws java.lang.InterruptedException,
                                                                           java.util.concurrent.ExecutionException

Description copied from interface: KafkaOperations

Send the data to the default topic with no key or partition; wait for result.

Specified by:

syncConvertAndSend in interface KafkaOperations<K,V>

Parameters:

data - The data.

Returns:

a RecordMetadata.

Throws:

java.lang.InterruptedException - thread interrupted while awaiting result.

java.util.concurrent.ExecutionException - execution exception while awaiting result.

syncConvertAndSend

public org.apache.kafka.clients.producer.RecordMetadata syncConvertAndSend(K key,
                                                                           V data)
                                                                    throws java.lang.InterruptedException,
                                                                           java.util.concurrent.ExecutionException

Description copied from interface: KafkaOperations

Send the data to the default topic with the provided key and no partition; wait for result.

Specified by:

syncConvertAndSend in interface KafkaOperations<K,V>

Parameters:

key - the key.

data - The data.

Returns:

a RecordMetadata.

Throws:

java.lang.InterruptedException - thread interrupted while awaiting result.

java.util.concurrent.ExecutionException - execution exception while awaiting result.

syncConvertAndSend

public org.apache.kafka.clients.producer.RecordMetadata syncConvertAndSend(int partition,
                                                                           K key,
                                                                           V data)
                                                                    throws java.lang.InterruptedException,
                                                                           java.util.concurrent.ExecutionException

Description copied from interface: KafkaOperations

Send the data to the default topic with the provided key and partition. wait for result.

Specified by:

syncConvertAndSend in interface KafkaOperations<K,V>

Parameters:

partition - the partition.

key - the key.

data - the data.

Returns:

a RecordMetadata.

Throws:

java.lang.InterruptedException - thread interrupted while awaiting result.

java.util.concurrent.ExecutionException - execution exception while awaiting result.

syncConvertAndSend

public org.apache.kafka.clients.producer.RecordMetadata syncConvertAndSend(java.lang.String topic,
                                                                           V data)
                                                                    throws java.lang.InterruptedException,
                                                                           java.util.concurrent.ExecutionException

Description copied from interface: KafkaOperations

Send the data to the provided topic with no key or partition.; wait for result.

Specified by:

syncConvertAndSend in interface KafkaOperations<K,V>

Parameters:

topic - the topic.

data - The data.

Returns:

a RecordMetadata.

Throws:

java.lang.InterruptedException - thread interrupted while awaiting result.

java.util.concurrent.ExecutionException - execution exception while awaiting result.

syncConvertAndSend

public org.apache.kafka.clients.producer.RecordMetadata syncConvertAndSend(java.lang.String topic,
                                                                           K key,
                                                                           V data)
                                                                    throws java.lang.InterruptedException,
                                                                           java.util.concurrent.ExecutionException

Description copied from interface: KafkaOperations

Send the data to the provided topic with the provided key and no partition; wait for result.

Specified by:

syncConvertAndSend in interface KafkaOperations<K,V>

Parameters:

topic - the topic.

key - the key.

data - The data.

Returns:

a RecordMetadata.

Throws:

java.lang.InterruptedException - thread interrupted while awaiting result.

java.util.concurrent.ExecutionException - execution exception while awaiting result.

syncConvertAndSend

public org.apache.kafka.clients.producer.RecordMetadata syncConvertAndSend(java.lang.String topic,
                                                                           int partition,
                                                                           K key,
                                                                           V data)
                                                                    throws java.lang.InterruptedException,
                                                                           java.util.concurrent.ExecutionException

Description copied from interface: KafkaOperations

Send the data to the provided topic with the provided key and partition; wait for result.

Specified by:

syncConvertAndSend in interface KafkaOperations<K,V>

Parameters:

topic - the topic.

partition - the partition.

key - the key.

data - the data.

Returns:

a RecordMetadata.

Throws:

java.lang.InterruptedException - thread interrupted while awaiting result.

java.util.concurrent.ExecutionException - execution exception while awaiting result.

doSend

protected java.util.concurrent.Future<org.apache.kafka.clients.producer.RecordMetadata> doSend(org.apache.kafka.clients.producer.ProducerRecord<K,V> producerRecord)

Send the producer record.

Parameters:

producerRecord - the producer record.

Returns:

a Future for the RecordMetadata.

flush

public void flush()

Description copied from interface: KafkaOperations

Flush the producer.

Specified by:

flush in interface KafkaOperations<K,V>