org.apache.kafka.server.common.serialization

Class AbstractApiMessageSerde

java.lang.Object

org.apache.kafka.server.common.serialization.AbstractApiMessageSerde

All Implemented Interfaces:

RecordSerde<ApiMessageAndVersion>

public abstract class AbstractApiMessageSerde
extends Object
implements RecordSerde<ApiMessageAndVersion>

This is an implementation of RecordSerde with ApiMessageAndVersion but implementors need to implement apiMessageFor(short) to return a ApiMessage instance for the given apiKey. This can be used as the underlying serialization mechanism for records defined with ApiMessages.

Serialization format for the given ApiMessageAndVersion is below:

     [data_frame_version header message]
     header => [api_key version]

     data_frame_version   : This is the header version, current value is 0. Header includes both api_key and version.
     api_key              : apiKey of  ApiMessageAndVersion object.
     version              : version of  ApiMessageAndVersion object.
     message              : serialized message of  ApiMessageAndVersion object.
 

Constructor Summary

Constructors

Constructor and Description
AbstractApiMessageSerde()

Method Summary

Modifier and Type	Method and Description
abstract org.apache.kafka.common.protocol.ApiMessage	apiMessageFor(short apiKey) Return ApiMessage instance for the given apiKey.
ApiMessageAndVersion	read(org.apache.kafka.common.protocol.Readable input, int size) Read a record from a Readable input.
int	recordSize(ApiMessageAndVersion data, org.apache.kafka.common.protocol.ObjectSerializationCache serializationCache) Get the size of a record.
void	write(ApiMessageAndVersion data, org.apache.kafka.common.protocol.ObjectSerializationCache serializationCache, org.apache.kafka.common.protocol.Writable out) Write the record to the output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractApiMessageSerde

public AbstractApiMessageSerde()

Method Detail

recordSize

public int recordSize(ApiMessageAndVersion data,
                      org.apache.kafka.common.protocol.ObjectSerializationCache serializationCache)

Description copied from interface: RecordSerde

Get the size of a record. This must be called first before writing the data through RecordSerde.write(Object, ObjectSerializationCache, Writable).

Specified by:

recordSize in interface RecordSerde<ApiMessageAndVersion>

Parameters:

data - the record that will be serialized

serializationCache - serialization cache

Returns:

the size in bytes of the serialized record

write

public void write(ApiMessageAndVersion data,
                  org.apache.kafka.common.protocol.ObjectSerializationCache serializationCache,
                  org.apache.kafka.common.protocol.Writable out)

Description copied from interface: RecordSerde

Write the record to the output stream. This must be called after computing the size with RecordSerde.recordSize(Object, ObjectSerializationCache). The same ObjectSerializationCache instance must be used in both calls.

Specified by:

write in interface RecordSerde<ApiMessageAndVersion>

Parameters:

data - the record to serialize and write

serializationCache - serialization cache

out - the output stream to write the record to

read

public ApiMessageAndVersion read(org.apache.kafka.common.protocol.Readable input,
                                 int size)

Description copied from interface: RecordSerde

Read a record from a Readable input.

Specified by:

read in interface RecordSerde<ApiMessageAndVersion>

Parameters:

input - the input stream to deserialize

size - the size of the record in bytes

Returns:

the deserialized record

apiMessageFor

public abstract org.apache.kafka.common.protocol.ApiMessage apiMessageFor(short apiKey)

Return ApiMessage instance for the given apiKey. This is used while deserializing the bytes payload into the respective ApiMessage in read(Readable, int) method.

Parameters:

apiKey - apiKey for which a ApiMessage to be created.