org.apache.pulsar.client.impl.schema

Class StructSchema<T>

java.lang.Object

org.apache.pulsar.client.impl.schema.StructSchema<T>

All Implemented Interfaces:

Schema<T>

Direct Known Subclasses:

AvroSchema, GenericSchemaImpl, JSONSchema, ProtobufSchema

public abstract class StructSchema<T>
extends Object

This is a base schema implementation for `Struct` types. A struct type is used for presenting records (objects) which have multiple fields.

Currently Pulsar supports 3 `Struct` types - SchemaType.AVRO, SchemaType.JSON, and SchemaType.PROTOBUF.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG
protected SchemaReader<T>	reader
protected org.apache.avro.Schema	schema
protected SchemaInfo	schemaInfo
protected SchemaInfoProvider	schemaInfoProvider
protected SchemaWriter<T>	writer

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

BOOL, BYTEBUFFER, BYTES, DATE, DOUBLE, FLOAT, INT16, INT32, INT64, INT8, STRING, TIME, TIMESTAMP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StructSchema(SchemaInfo schemaInfo)

Method Summary

Modifier and Type	Method and Description
protected static org.apache.avro.Schema	createAvroSchema(SchemaDefinition schemaDefinition)
T	decode(byte[] bytes)
T	decode(byte[] bytes, byte[] schemaVersion)
T	decode(io.netty.buffer.ByteBuf byteBuf) Decode a byteBuf into an object using the schema definition and deserializer implementation
T	decode(io.netty.buffer.ByteBuf byteBuf, byte[] schemaVersion) Decode a byteBuf into an object using a given version.
byte[]	encode(T message)
org.apache.avro.Schema	getAvroSchema()
protected SchemaReader<T>	getReader()
SchemaInfo	getSchemaInfo()
protected SchemaInfo	getSchemaInfoByVersion(byte[] schemaVersion) TODO: think about how to make this async
protected abstract SchemaReader<T>	loadReader(BytesSchemaVersion schemaVersion) Load the schema reader for reading messages encoded by the given schema version.
protected static org.apache.avro.Schema	parseAvroSchema(String schemaJson)
protected static <T> SchemaInfo	parseSchemaInfo(SchemaDefinition<T> schemaDefinition, SchemaType schemaType)
protected void	setReader(SchemaReader<T> reader)
void	setSchemaInfoProvider(SchemaInfoProvider schemaInfoProvider)
protected void	setWriter(SchemaWriter<T> writer)

Methods inherited from class java.lang.Object

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

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

AUTO_CONSUME, AUTO_PRODUCE_BYTES, AUTO_PRODUCE_BYTES, AUTO, AVRO, AVRO, configureSchemaInfo, generic, getSchema, JSON, JSON, KeyValue, KeyValue, KeyValue, KeyValue, KV_BYTES, PROTOBUF, PROTOBUF, requireFetchingSchemaInfo, supportSchemaVersioning, validate

Field Detail

LOG

protected static final org.slf4j.Logger LOG

schema

protected final org.apache.avro.Schema schema

schemaInfo

protected final SchemaInfo schemaInfo

reader

protected SchemaReader<T> reader

writer

protected SchemaWriter<T> writer

schemaInfoProvider

protected SchemaInfoProvider schemaInfoProvider

Constructor Detail

StructSchema

protected StructSchema(SchemaInfo schemaInfo)

Method Detail

getAvroSchema

public org.apache.avro.Schema getAvroSchema()

encode

public byte[] encode(T message)

decode

public T decode(byte[] bytes)

decode

public T decode(byte[] bytes,
                byte[] schemaVersion)

decode

public T decode(io.netty.buffer.ByteBuf byteBuf)

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

Parameters:

byteBuf - the byte buffer to decode

Returns:

the deserialized object

decode

public T decode(io.netty.buffer.ByteBuf byteBuf,
                byte[] schemaVersion)

Decode a byteBuf into an object using a given version.

Parameters:

byteBuf - the byte array to decode

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

Returns:

the deserialized object

getSchemaInfo

public SchemaInfo getSchemaInfo()

createAvroSchema

protected static org.apache.avro.Schema createAvroSchema(SchemaDefinition schemaDefinition)

parseAvroSchema

protected static org.apache.avro.Schema parseAvroSchema(String schemaJson)

parseSchemaInfo

protected static <T> SchemaInfo parseSchemaInfo(SchemaDefinition<T> schemaDefinition,
                                                SchemaType schemaType)

setSchemaInfoProvider

public void setSchemaInfoProvider(SchemaInfoProvider schemaInfoProvider)

loadReader

protected abstract SchemaReader<T> loadReader(BytesSchemaVersion schemaVersion)

Load the schema reader for reading messages encoded by the given schema version.

Parameters:

schemaVersion - the provided schema version

Returns:

the schema reader for decoding messages encoded by the provided schema version.

getSchemaInfoByVersion

protected SchemaInfo getSchemaInfoByVersion(byte[] schemaVersion)

TODO: think about how to make this async

setWriter

protected void setWriter(SchemaWriter<T> writer)

setReader

protected void setReader(SchemaReader<T> reader)

getReader

protected SchemaReader<T> getReader()