Package org.apache.tinkerpop.gremlin.util.ser

Class GraphBinaryMessageSerializerV4

java.lang.Object

org.apache.tinkerpop.gremlin.util.ser.AbstractMessageSerializer<GraphBinaryMapper>

org.apache.tinkerpop.gremlin.util.ser.GraphBinaryMessageSerializerV4

All Implemented Interfaces:

MessageSerializer<GraphBinaryMapper>

public class GraphBinaryMessageSerializerV4
extends AbstractMessageSerializer<GraphBinaryMapper>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.util.MessageSerializer

MessageSerializer.MessageParts

Field Summary

Fields

Modifier and Type	Field	Description
static String	TOKEN_BUILDER
static String	TOKEN_CUSTOM

Fields inherited from class org.apache.tinkerpop.gremlin.util.ser.AbstractMessageSerializer

TOKEN_IO_REGISTRIES

Fields inherited from interface org.apache.tinkerpop.gremlin.util.MessageSerializer

logger

Constructor Summary

Constructors

Constructor	Description
GraphBinaryMessageSerializerV4()	Creates a new instance of the message serializer using the default type serializers.
GraphBinaryMessageSerializerV4(TypeSerializerRegistry registry)
GraphBinaryMessageSerializerV4(TypeSerializerRegistry.Builder builder)

Method Summary

Modifier and Type	Method	Description
void	configure(Map<String,Object> config, Map<String,Graph> graphs)	Configure the serializer with mapper settings as required.
RequestMessage	deserializeBinaryRequest(io.netty.buffer.ByteBuf msg)	Deserialize a Netty ByteBuf into a RequestMessage.
ResponseMessage	deserializeBinaryResponse(io.netty.buffer.ByteBuf msg)	Deserialize a Netty ByteBuf into a RequestMessage.
GraphBinaryMapper	getMapper()	Gets the "mapper" that performs the underlying serialization work.
String[]	mimeTypesSupported()	The list of mime types that the serializer supports.
ResponseMessage	readChunk(io.netty.buffer.ByteBuf byteBuf, boolean isFirstChunk)
io.netty.buffer.ByteBuf	serializeRequestAsBinary(RequestMessage requestMessage, io.netty.buffer.ByteBufAllocator allocator)	Serialize a ResponseMessage to a Netty ByteBuf.
io.netty.buffer.ByteBuf	serializeResponseAsBinary(ResponseMessage responseMessage, io.netty.buffer.ByteBufAllocator allocator)	Serialize a ResponseMessage to a Netty ByteBuf.
io.netty.buffer.ByteBuf	writeChunk(Object aggregate, io.netty.buffer.ByteBufAllocator allocator)
io.netty.buffer.ByteBuf	writeErrorFooter(ResponseMessage responseMessage, io.netty.buffer.ByteBufAllocator allocator)
io.netty.buffer.ByteBuf	writeFooter(ResponseMessage responseMessage, io.netty.buffer.ByteBufAllocator allocator)
io.netty.buffer.ByteBuf	writeHeader(ResponseMessage responseMessage, io.netty.buffer.ByteBufAllocator allocator)

Methods inherited from class org.apache.tinkerpop.gremlin.util.ser.AbstractMessageSerializer

addIoRegistries, getListStringFromConfig, tryInstanceMethod

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_CUSTOM

public static final String TOKEN_CUSTOM

See Also:

Constant Field Values

TOKEN_BUILDER

public static final String TOKEN_BUILDER

See Also:

Constant Field Values

Constructor Detail

GraphBinaryMessageSerializerV4

public GraphBinaryMessageSerializerV4()

Creates a new instance of the message serializer using the default type serializers.

GraphBinaryMessageSerializerV4

public GraphBinaryMessageSerializerV4(TypeSerializerRegistry registry)

GraphBinaryMessageSerializerV4

public GraphBinaryMessageSerializerV4(TypeSerializerRegistry.Builder builder)

Method Detail

getMapper

public GraphBinaryMapper getMapper()

Description copied from interface: MessageSerializer

Gets the "mapper" that performs the underlying serialization work.

configure

public void configure(Map<String,Object> config,
                      Map<String,Graph> graphs)

Description copied from interface: MessageSerializer

Configure the serializer with mapper settings as required. The default implementation does not perform any function and it is up to the interface implementation to determine how the configuration will be executed and what its requirements are. An implementation may choose to use the list of available graphs to help initialize a serializer. The implementation should account for the possibility of a null value being provided for that parameter.

mimeTypesSupported

public String[] mimeTypesSupported()

Description copied from interface: MessageSerializer

The list of mime types that the serializer supports. They should be ordered in preferred ordered where the greatest fidelity match is first.

serializeRequestAsBinary

public io.netty.buffer.ByteBuf serializeRequestAsBinary(RequestMessage requestMessage,
                                                        io.netty.buffer.ByteBufAllocator allocator)
                                                 throws SerializationException

Description copied from interface: MessageSerializer

Serialize a ResponseMessage to a Netty ByteBuf.

Parameters:

requestMessage - The request message to serialize to bytes.

allocator - The Netty allocator for the ByteBuf to return back.

Throws:

SerializationException

deserializeBinaryRequest

public RequestMessage deserializeBinaryRequest(io.netty.buffer.ByteBuf msg)
                                        throws SerializationException

Description copied from interface: MessageSerializer

Deserialize a Netty ByteBuf into a RequestMessage.

Throws:

SerializationException

serializeResponseAsBinary

public io.netty.buffer.ByteBuf serializeResponseAsBinary(ResponseMessage responseMessage,
                                                         io.netty.buffer.ByteBufAllocator allocator)
                                                  throws SerializationException

Description copied from interface: MessageSerializer

Serialize a ResponseMessage to a Netty ByteBuf.

Parameters:

responseMessage - The response message to serialize to bytes.

allocator - The Netty allocator for the ByteBuf to return back.

Throws:

SerializationException

writeHeader

public io.netty.buffer.ByteBuf writeHeader(ResponseMessage responseMessage,
                                           io.netty.buffer.ByteBufAllocator allocator)
                                    throws SerializationException

Throws:

SerializationException

writeChunk

public io.netty.buffer.ByteBuf writeChunk(Object aggregate,
                                          io.netty.buffer.ByteBufAllocator allocator)
                                   throws SerializationException

Throws:

SerializationException

writeFooter

public io.netty.buffer.ByteBuf writeFooter(ResponseMessage responseMessage,
                                           io.netty.buffer.ByteBufAllocator allocator)
                                    throws SerializationException

Throws:

SerializationException

writeErrorFooter

public io.netty.buffer.ByteBuf writeErrorFooter(ResponseMessage responseMessage,
                                                io.netty.buffer.ByteBufAllocator allocator)
                                         throws SerializationException

Throws:

SerializationException

deserializeBinaryResponse

public ResponseMessage deserializeBinaryResponse(io.netty.buffer.ByteBuf msg)
                                          throws SerializationException

Description copied from interface: MessageSerializer

Deserialize a Netty ByteBuf into a RequestMessage.

Throws:

SerializationException

readChunk

public ResponseMessage readChunk(io.netty.buffer.ByteBuf byteBuf,
                                 boolean isFirstChunk)
                          throws SerializationException

Throws:

SerializationException