org.apache.pulsar.client.impl.schema

Class KeyValueSchemaImpl<K,V>

java.lang.Object

org.apache.pulsar.client.impl.schema.AbstractSchema<KeyValue<K,V>>

org.apache.pulsar.client.impl.schema.KeyValueSchemaImpl<K,V>

All Implemented Interfaces:

Cloneable, Schema<KeyValue<K,V>>, KeyValueSchema<K,V>

public class KeyValueSchemaImpl<K,V>
extends AbstractSchema<KeyValue<K,V>>
implements KeyValueSchema<K,V>

[Key, Value] pair schema definition.

Field Summary

Fields

Modifier and Type	Field and Description
protected SchemaInfoProvider	schemaInfoProvider

Fields inherited from interface org.apache.pulsar.client.api.Schema

BOOL, BYTEBUFFER, BYTES, DATE, DOUBLE, FLOAT, INSTANT, INT16, INT32, INT64, INT8, LOCAL_DATE, LOCAL_DATE_TIME, LOCAL_TIME, STRING, TIME, TIMESTAMP

Method Summary

Modifier and Type	Method and Description
Schema<?>	atSchemaVersion(byte[] schemaVersion) Return an instance of this schema at the given version.
Schema<KeyValue<K,V>>	clone()
void	configureSchemaInfo(String topicName, String componentName, SchemaInfo schemaInfo)
KeyValue<K,V>	decode(byte[] bytes)
KeyValue<K,V>	decode(byte[] bytes, byte[] schemaVersion)
KeyValue<K,V>	decode(byte[] keyBytes, byte[] valueBytes, byte[] schemaVersion)
KeyValue<K,V>	decode(io.netty.buffer.ByteBuf byteBuf) Decode a byteBuf into an object using the schema definition and deserializer implementation
KeyValue<K,V>	decode(io.netty.buffer.ByteBuf byteBuf, byte[] schemaVersion) Decode a byteBuf into an object using a given version.
byte[]	encode(KeyValue<K,V> message)
void	fetchSchemaIfNeeded(String topicName, SchemaVersion schemaVersion) It may happen that the schema is not loaded but we need it, for instance in order to call getSchemaInfo() We cannot call this method in getSchemaInfo.
Schema<K>	getKeySchema() Get the Schema of the Key.
KeyValueEncodingType	getKeyValueEncodingType() Get the KeyValueEncodingType.
SchemaInfo	getSchemaInfo()
Schema<V>	getValueSchema() Get the Schema of the Value.
static Schema<KeyValue<byte[],byte[]>>	kvBytes()
static <K,V> Schema<KeyValue<K,V>>	of(Class<K> key, Class<V> value, SchemaType type) Key Value Schema using passed in schema type, support JSON and AVRO currently.
static <K,V> Schema<KeyValue<K,V>>	of(Schema<K> keySchema, Schema<V> valueSchema)
static <K,V> Schema<KeyValue<K,V>>	of(Schema<K> keySchema, Schema<V> valueSchema, KeyValueEncodingType keyValueEncodingType)
boolean	requireFetchingSchemaInfo()
void	setSchemaInfoProvider(SchemaInfoProvider schemaInfoProvider)
boolean	supportSchemaVersioning()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.client.api.Schema

AUTO_CONSUME, AUTO_PRODUCE_BYTES, AUTO_PRODUCE_BYTES, AUTO, AVRO, AVRO, decode, generic, getNativeSchema, getSchema, JSON, JSON, KeyValue, KeyValue, KeyValue, KeyValue, KV_BYTES, NATIVE_AVRO, PROTOBUF_NATIVE, PROTOBUF_NATIVE, PROTOBUF, PROTOBUF, validate

Field Detail

schemaInfoProvider

protected SchemaInfoProvider schemaInfoProvider

Method Detail

of

public static <K,V> Schema<KeyValue<K,V>> of(Class<K> key,
                                             Class<V> value,
                                             SchemaType type)

Key Value Schema using passed in schema type, support JSON and AVRO currently.

of

public static <K,V> Schema<KeyValue<K,V>> of(Schema<K> keySchema,
                                             Schema<V> valueSchema)

of

public static <K,V> Schema<KeyValue<K,V>> of(Schema<K> keySchema,
                                             Schema<V> valueSchema,
                                             KeyValueEncodingType keyValueEncodingType)

kvBytes

public static Schema<KeyValue<byte[],byte[]>> kvBytes()

supportSchemaVersioning

public boolean supportSchemaVersioning()

Specified by:

supportSchemaVersioning in interface Schema<KeyValue<K,V>>

encode

public byte[] encode(KeyValue<K,V> message)

Specified by:

encode in interface Schema<KeyValue<K,V>>

decode

public KeyValue<K,V> decode(byte[] bytes)

Specified by:

decode in interface Schema<KeyValue<K,V>>

decode

public KeyValue<K,V> decode(byte[] bytes,
                            byte[] schemaVersion)

Specified by:

decode in interface Schema<KeyValue<K,V>>

decode

public KeyValue<K,V> decode(io.netty.buffer.ByteBuf byteBuf)

Description copied from class: AbstractSchema

Decode a byteBuf into an object using the schema definition and deserializer implementation

Do not modify reader/writer index of ByteBuf so, it can be reused to access correct data.

Specified by:

decode in class AbstractSchema<KeyValue<K,V>>

Parameters:

byteBuf - the byte buffer to decode

Returns:

the deserialized object

decode

public KeyValue<K,V> decode(io.netty.buffer.ByteBuf byteBuf,
                            byte[] schemaVersion)

Description copied from class: AbstractSchema

Decode a byteBuf into an object using a given version.

Overrides:

decode in class AbstractSchema<KeyValue<K,V>>

Parameters:

byteBuf - the byte array to decode

schemaVersion - the schema version to decode the object. null indicates using latest version.

Returns:

the deserialized object

decode

public KeyValue<K,V> decode(byte[] keyBytes,
                            byte[] valueBytes,
                            byte[] schemaVersion)

getSchemaInfo

public SchemaInfo getSchemaInfo()

Specified by:

getSchemaInfo in interface Schema<KeyValue<K,V>>

setSchemaInfoProvider

public void setSchemaInfoProvider(SchemaInfoProvider schemaInfoProvider)

Specified by:

setSchemaInfoProvider in interface Schema<KeyValue<K,V>>

requireFetchingSchemaInfo

public boolean requireFetchingSchemaInfo()

Specified by:

requireFetchingSchemaInfo in interface Schema<KeyValue<K,V>>

configureSchemaInfo

public void configureSchemaInfo(String topicName,
                                String componentName,
                                SchemaInfo schemaInfo)

Specified by:

configureSchemaInfo in interface Schema<KeyValue<K,V>>

clone

public Schema<KeyValue<K,V>> clone()

Specified by:

clone in interface Schema<KeyValue<K,V>>

Overrides:

clone in class AbstractSchema<KeyValue<K,V>>

toString

public String toString()

Overrides:

toString in class Object

atSchemaVersion

public Schema<?> atSchemaVersion(byte[] schemaVersion)
                          throws SchemaSerializationException

Description copied from class: AbstractSchema

Return an instance of this schema at the given version.

Overrides:

atSchemaVersion in class AbstractSchema<KeyValue<K,V>>

Parameters:

schemaVersion - the version

Returns:

the schema at that specific version

Throws:

SchemaSerializationException - in case of unknown schema version

getKeySchema

public Schema<K> getKeySchema()

Get the Schema of the Key.

Specified by:

getKeySchema in interface KeyValueSchema<K,V>

Returns:

the Schema of the Key

getValueSchema

public Schema<V> getValueSchema()

Get the Schema of the Value.

Specified by:

getValueSchema in interface KeyValueSchema<K,V>

Returns:

the Schema of the Value

getKeyValueEncodingType

public KeyValueEncodingType getKeyValueEncodingType()

Get the KeyValueEncodingType.

Specified by:

getKeyValueEncodingType in interface KeyValueSchema<K,V>

Returns:

the KeyValueEncodingType

See Also:

KeyValueEncodingType.INLINE, KeyValueEncodingType.SEPARATED

fetchSchemaIfNeeded

public void fetchSchemaIfNeeded(String topicName,
                                SchemaVersion schemaVersion)
                         throws SchemaSerializationException

It may happen that the schema is not loaded but we need it, for instance in order to call getSchemaInfo() We cannot call this method in getSchemaInfo.

Throws:

SchemaSerializationException

See Also:

AutoConsumeSchema.fetchSchemaIfNeeded(SchemaVersion)