io.virtualan.cucumblan.message.type

Interface MessageType<T,TT>

Type Parameters:

T - the type parameter

TT - the type parameter

All Known Implementing Classes:

JSONMessage

public interface MessageType<T,TT>

This helps to define application specific kafka message user application needs and Easy to customizable

Author:

Elan Thangmani

Method Summary

Modifier and Type	Method and Description
MessageType	buildConsumerMessage(org.apache.kafka.clients.consumer.ConsumerRecord<T,TT> record, T key, TT value) Build message while consuming the message for your specific needs Refer io.virtualan.cucumblan.message.typeimpl.JSONMessage
MessageType	buildProducerMessage(Object tt) Build message object build logic for the application specific need.
List<org.apache.kafka.common.header.Header>	getHeaders() Kafka message headers to be added to produce messages
Object	getId() Gets unique identifier of the message
T	getKey() Gets Kafka message key for kafka
TT	getMessage() Gets Kafka message to be used for Kafka
Object	getMessageAsJson() Mandatory JSON Should be defined and Used for Verification process.
String	getType() define a unique type of the message would be used.

Method Detail

getType

String getType()

define a unique type of the message would be used.

Returns:

the type

getId

Object getId()

Gets unique identifier of the message

Returns:

the id

getKey

T getKey()

Gets Kafka message key for kafka

Returns:

the id

getMessage

TT getMessage()

Gets Kafka message to be used for Kafka

Returns:

the message

getMessageAsJson

Object getMessageAsJson()

Mandatory JSON Should be defined and Used for Verification process. this should be either org.json.JSONArray or org.json.JSONObject

Returns:

the JsonArray or message

getHeaders

List<org.apache.kafka.common.header.Header> getHeaders()

Kafka message headers to be added to produce messages

Returns:

the kafka headers

buildProducerMessage

MessageType buildProducerMessage(Object tt)
                          throws MessageNotDefinedException

Build message object build logic for the application specific need. Build and produce events for your specific needs Refer io.virtualan.cucumblan.message.typeimpl.JSONMessage

Parameters:

tt - the tt

Returns:

the message type

Throws:

MessageNotDefinedException

buildConsumerMessage

MessageType buildConsumerMessage(org.apache.kafka.clients.consumer.ConsumerRecord<T,TT> record,
                                 T key,
                                 TT value)
                          throws MessageNotDefinedException

Build message while consuming the message for your specific needs Refer io.virtualan.cucumblan.message.typeimpl.JSONMessage

Parameters:

record - ConsumerRecord object available in the context

key - the kafka message key

value - the kafka message object

Returns:

the message type used for Pre defined verification steps

Throws:

MessageNotDefinedException - the message not defined exception