Package com.apple.foundationdb.record.provider.common

Class DynamicMessageRecordSerializer

java.lang.Object

com.apple.foundationdb.record.provider.common.DynamicMessageRecordSerializer

All Implemented Interfaces:

RecordSerializer<Message>

@API(UNSTABLE)
public class DynamicMessageRecordSerializer
extends Object
implements RecordSerializer<Message>

Serialize records using default Protobuf serialization using DynamicMessage.

Nested Class Summary

Nested classes/interfaces inherited from interface com.apple.foundationdb.record.provider.common.RecordSerializer

RecordSerializer.Counts, RecordSerializer.Events

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DynamicMessageRecordSerializer()

Method Summary

Modifier and Type	Method	Description
Message	deserialize(RecordMetaData metaData, Tuple primaryKey, byte[] serialized, StoreTimer timer)	Convert a byte array to a Protobuf record.
protected DynamicMessage	deserializeFromBytes(Descriptors.Descriptor storedDescriptor, byte[] serialized)
protected DynamicMessage	deserializeUnion(Descriptors.Descriptor unionDescriptor, Tuple primaryKey, byte[] serialized, int metaDataVersion)
protected org.apache.commons.lang3.tuple.Pair<Descriptors.FieldDescriptor,DynamicMessage>	getUnionField(DynamicMessage unionMessage, Tuple primaryKey)
static RecordSerializer<Message>	instance()
byte[]	serialize(RecordMetaData metaData, RecordType recordType, Message record, StoreTimer timer)	Convert a Protobuf record to bytes.
protected byte[]	serializeToBytes(Message storedRecord)
RecordSerializer<Message>	widen()	Convert this typed record serializer to an untyped one.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicMessageRecordSerializer

protected DynamicMessageRecordSerializer()

Method Detail

instance

@Nonnull
public static RecordSerializer<Message> instance()

widen

@Nonnull
public RecordSerializer<Message> widen()

Description copied from interface: RecordSerializer

Convert this typed record serializer to an untyped one.

• If this serializer wraps another serializer, for example, because it does compressions, then widen that serializer and return the result wrapped equivalently.
• If this serializer parses messages in a type-sensitive way, return the closest general purpose way.
• If this serializer is inherently bound to its type parameter, throw an exception.

If a FDBTypedRecordStore is created without calling FDBTypedRecordStore.Builder.setUntypedSerializer(com.apple.foundationdb.record.provider.common.RecordSerializer<com.google.protobuf.Message>), then in order to make the untyped record store that is paired with the typed store (used, for instance, to rebuild indexes), the given typed serializer will be widened by calling this method.

Specified by:

widen in interface RecordSerializer<Message>

Returns:

a new serializer that works the same way but handles all record types.

serialize

@Nonnull
public byte[] serialize(@Nonnull
                        RecordMetaData metaData,
                        @Nonnull
                        RecordType recordType,
                        @Nonnull
                        Message record,
                        @Nullable
                        StoreTimer timer)

Description copied from interface: RecordSerializer

Convert a Protobuf record to bytes. While Protobuf messages provide their own MessageLite.toByteArray() method for serialization, record stores may elect to first wrap the raw Protobuf record in another wrapping type or perform additional transformations like encrypt or compress records. Implementors of this interface can control how exactly which transformations are done, with the main constraint being that whatever operation is done should be reversible by calling the deserialize() method on those bytes. Implementors should also be careful as they evolve this method that the deserialize method is still able to read older data unless they are certain that any record store that used the older implementation has since been cleared out or migrated to a newer format.

Specified by:

serialize in interface RecordSerializer<Message>

Parameters:

metaData - the store's meta-data

recordType - the record type of the message

record - the Protobuf record to serialize

timer - a timer used to instrument serialization

Returns:

the serialized record

serializeToBytes

@Nonnull
protected byte[] serializeToBytes(@Nonnull
                                  Message storedRecord)

deserialize

@Nonnull
public Message deserialize(@Nonnull
                           RecordMetaData metaData,
                           @Nonnull
                           Tuple primaryKey,
                           @Nonnull
                           byte[] serialized,
                           @Nullable
                           StoreTimer timer)

Description copied from interface: RecordSerializer

Convert a byte array to a Protobuf record. This should be the inverse of the serialize() method.

Specified by:

deserialize in interface RecordSerializer<Message>

Parameters:

metaData - the store's meta-data

primaryKey - the primary key of the record

serialized - the serialized bytes

timer - a timer used to instrument deserialization

Returns:

the deserialized record

deserializeUnion

@Nonnull
protected DynamicMessage deserializeUnion(@Nonnull
                                          Descriptors.Descriptor unionDescriptor,
                                          @Nonnull
                                          Tuple primaryKey,
                                          @Nonnull
                                          byte[] serialized,
                                          int metaDataVersion)

deserializeFromBytes

@Nonnull
protected DynamicMessage deserializeFromBytes(@Nonnull
                                              Descriptors.Descriptor storedDescriptor,
                                              @Nonnull
                                              byte[] serialized)

getUnionField

@Nonnull
protected org.apache.commons.lang3.tuple.Pair<Descriptors.FieldDescriptor,DynamicMessage> getUnionField(@Nonnull
                                                                                                              DynamicMessage unionMessage,
                                                                                                              @Nonnull
                                                                                                              Tuple primaryKey)