io.siddhi.extension.io.kafka.sink

Class KafkaSink

java.lang.Object

io.siddhi.core.stream.output.sink.Sink<KafkaSink.KafkaSinkState>

io.siddhi.extension.io.kafka.sink.KafkaSink

All Implemented Interfaces:

io.siddhi.core.stream.output.sink.SinkListener

Direct Known Subclasses:

KafkaMultiDCSink

public class KafkaSink
extends io.siddhi.core.stream.output.sink.Sink<KafkaSink.KafkaSinkState>

This class implements a Kafka sink to publish Siddhi events to a kafka cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	KafkaSink.KafkaSinkState State class for Kafka sink.

Nested classes/interfaces inherited from class io.siddhi.core.stream.output.sink.Sink

io.siddhi.core.stream.output.sink.Sink.OnErrorAction

Field Summary

Fields

Modifier and Type	Field and Description
protected String	bootstrapServers
protected static String	ENTRY_SEPARATOR
protected static String	HEADER_SEPARATOR
protected static String	IS_BINARY_MESSAGE
protected Boolean	isBinaryMessage
protected Boolean	isSequenced
protected static String	KAFKA_BROKER_LIST
protected static String	KAFKA_MESSAGE_KEY
protected static String	KAFKA_OPTIONAL_CONFIGURATION_PROPERTIES
protected static String	KAFKA_PARTITION_NO
protected static String	KAFKA_PUBLISH_TOPIC
protected io.siddhi.core.util.transport.Option	keyOption
static String	LAST_SENT_SEQ_NO_PERSIST_KEY
protected String	optionalConfigs
protected io.siddhi.core.util.transport.Option	partitionOption
protected static String	SEQ_ID
static String	SEQ_NO_HEADER_DELIMITER
static String	SEQ_NO_HEADER_FIELD_SEPERATOR
protected String	sequenceId
protected io.siddhi.core.util.transport.Option	topicOption

Fields inherited from class io.siddhi.core.stream.output.sink.Sink

isTryingToConnect

Constructor Summary

Constructors

Constructor and Description
KafkaSink()

Method Summary

Modifier and Type	Method and Description
void	connect()
void	destroy()
void	disconnect()
protected io.siddhi.core.stream.ServiceDeploymentInfo	exposeServiceDeploymentInfo()
byte[]	getSequencedBinaryPayloadToSend(byte[] payload, KafkaSink.KafkaSinkState kafkaSinkState)
String[]	getSupportedDynamicOptions()
Class[]	getSupportedInputEventClasses()
protected io.siddhi.core.util.snapshot.state.StateFactory<KafkaSink.KafkaSinkState>	init(io.siddhi.query.api.definition.StreamDefinition outputStreamDefinition, io.siddhi.core.util.transport.OptionHolder optionHolder, io.siddhi.core.util.config.ConfigReader sinkConfigReader, io.siddhi.core.config.SiddhiAppContext siddhiAppContext)
void	publish(Object payload, io.siddhi.core.util.transport.DynamicOptions dynamicOptions, KafkaSink.KafkaSinkState kafkaSinkState)
static void	readOptionalConfigs(Properties props, String optionalConfigs)

Methods inherited from class io.siddhi.core.stream.output.sink.Sink

connectWithRetry, getHandler, getMapper, getServiceDeploymentInfoList, getStreamDefinition, getType, init, initOnlyTransport, isConnected, isStateful, publish, setConnected, shutdown

Methods inherited from class java.lang.Object

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

Field Detail

LAST_SENT_SEQ_NO_PERSIST_KEY

public static final String LAST_SENT_SEQ_NO_PERSIST_KEY

See Also:

Constant Field Values

SEQ_NO_HEADER_DELIMITER

public static final String SEQ_NO_HEADER_DELIMITER

See Also:

Constant Field Values

SEQ_NO_HEADER_FIELD_SEPERATOR

public static final String SEQ_NO_HEADER_FIELD_SEPERATOR

See Also:

Constant Field Values

KAFKA_PUBLISH_TOPIC

protected static final String KAFKA_PUBLISH_TOPIC

See Also:

Constant Field Values

KAFKA_BROKER_LIST

protected static final String KAFKA_BROKER_LIST

See Also:

Constant Field Values

KAFKA_MESSAGE_KEY

protected static final String KAFKA_MESSAGE_KEY

See Also:

Constant Field Values

KAFKA_OPTIONAL_CONFIGURATION_PROPERTIES

protected static final String KAFKA_OPTIONAL_CONFIGURATION_PROPERTIES

See Also:

Constant Field Values

HEADER_SEPARATOR

protected static final String HEADER_SEPARATOR

See Also:

Constant Field Values

ENTRY_SEPARATOR

protected static final String ENTRY_SEPARATOR

See Also:

Constant Field Values

KAFKA_PARTITION_NO

protected static final String KAFKA_PARTITION_NO

See Also:

Constant Field Values

SEQ_ID

protected static final String SEQ_ID

See Also:

Constant Field Values

IS_BINARY_MESSAGE

protected static final String IS_BINARY_MESSAGE

See Also:

Constant Field Values

topicOption

protected io.siddhi.core.util.transport.Option topicOption

bootstrapServers

protected String bootstrapServers

optionalConfigs

protected String optionalConfigs

partitionOption

protected io.siddhi.core.util.transport.Option partitionOption

isSequenced

protected Boolean isSequenced

sequenceId

protected String sequenceId

isBinaryMessage

protected Boolean isBinaryMessage

keyOption

protected io.siddhi.core.util.transport.Option keyOption

Constructor Detail

KafkaSink

public KafkaSink()

Method Detail

readOptionalConfigs

public static void readOptionalConfigs(Properties props,
                                       String optionalConfigs)

init

protected io.siddhi.core.util.snapshot.state.StateFactory<KafkaSink.KafkaSinkState> init(io.siddhi.query.api.definition.StreamDefinition outputStreamDefinition,
                                                                                         io.siddhi.core.util.transport.OptionHolder optionHolder,
                                                                                         io.siddhi.core.util.config.ConfigReader sinkConfigReader,
                                                                                         io.siddhi.core.config.SiddhiAppContext siddhiAppContext)

Specified by:

init in class io.siddhi.core.stream.output.sink.Sink<KafkaSink.KafkaSinkState>

publish

public void publish(Object payload,
                    io.siddhi.core.util.transport.DynamicOptions dynamicOptions,
                    KafkaSink.KafkaSinkState kafkaSinkState)
             throws io.siddhi.core.exception.ConnectionUnavailableException

Specified by:

publish in class io.siddhi.core.stream.output.sink.Sink<KafkaSink.KafkaSinkState>

Throws:

io.siddhi.core.exception.ConnectionUnavailableException

connect

public void connect()
             throws io.siddhi.core.exception.ConnectionUnavailableException

Specified by:

connect in class io.siddhi.core.stream.output.sink.Sink<KafkaSink.KafkaSinkState>

Throws:

io.siddhi.core.exception.ConnectionUnavailableException

disconnect

public void disconnect()

Specified by:

disconnect in class io.siddhi.core.stream.output.sink.Sink<KafkaSink.KafkaSinkState>

destroy

public void destroy()

Specified by:

destroy in class io.siddhi.core.stream.output.sink.Sink<KafkaSink.KafkaSinkState>

getSupportedInputEventClasses

public Class[] getSupportedInputEventClasses()

Specified by:

getSupportedInputEventClasses in class io.siddhi.core.stream.output.sink.Sink<KafkaSink.KafkaSinkState>

exposeServiceDeploymentInfo

protected io.siddhi.core.stream.ServiceDeploymentInfo exposeServiceDeploymentInfo()

Specified by:

exposeServiceDeploymentInfo in class io.siddhi.core.stream.output.sink.Sink<KafkaSink.KafkaSinkState>

getSupportedDynamicOptions

public String[] getSupportedDynamicOptions()

Specified by:

getSupportedDynamicOptions in class io.siddhi.core.stream.output.sink.Sink<KafkaSink.KafkaSinkState>

getSequencedBinaryPayloadToSend

public byte[] getSequencedBinaryPayloadToSend(byte[] payload,
                                              KafkaSink.KafkaSinkState kafkaSinkState)