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

Class AbstractGraphSONMessageSerializerV4

java.lang.Object

org.apache.tinkerpop.gremlin.util.ser.AbstractMessageSerializer<org.apache.tinkerpop.shaded.jackson.databind.ObjectMapper>

org.apache.tinkerpop.gremlin.util.ser.AbstractGraphSONMessageSerializerV4

All Implemented Interfaces:

MessageSerializer<org.apache.tinkerpop.shaded.jackson.databind.ObjectMapper>

Direct Known Subclasses:

GraphSONMessageSerializerV4, GraphSONUntypedMessageSerializerV4

public abstract class AbstractGraphSONMessageSerializerV4
extends AbstractMessageSerializer<org.apache.tinkerpop.shaded.jackson.databind.ObjectMapper>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AbstractGraphSONMessageSerializerV4.GremlinServerModuleV4
static final class	AbstractGraphSONMessageSerializerV4.RequestMessageDeserializer
static final class	AbstractGraphSONMessageSerializerV4.RequestMessageSerializer
static final class	AbstractGraphSONMessageSerializerV4.ResponseMessageDeserializer
static final class	AbstractGraphSONMessageSerializerV4.ResponseMessageFooterSerializer
static final class	AbstractGraphSONMessageSerializerV4.ResponseMessageHeaderSerializer
static final class	AbstractGraphSONMessageSerializerV4.ResponseMessageSerializer

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

MessageSerializer.MessageParts

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.tinkerpop.shaded.jackson.databind.ObjectMapper	mapper

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

TOKEN_IO_REGISTRIES

Constructor Summary

Constructors

Constructor	Description
AbstractGraphSONMessageSerializerV4()
AbstractGraphSONMessageSerializerV4(GraphSONMapper.Builder mapperBuilder)

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.
org.apache.tinkerpop.shaded.jackson.databind.ObjectMapper	getMapper()	Gets the "mapper" that performs the underlying serialization work.
protected boolean	isTyped()
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

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

mimeTypesSupported

Field Details

mapper

protected org.apache.tinkerpop.shaded.jackson.databind.ObjectMapper mapper

Constructor Details

AbstractGraphSONMessageSerializerV4

public AbstractGraphSONMessageSerializerV4()

AbstractGraphSONMessageSerializerV4

public AbstractGraphSONMessageSerializerV4(GraphSONMapper.Builder mapperBuilder)

Method Details

getMapper

public org.apache.tinkerpop.shaded.jackson.databind.ObjectMapper 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.

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

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

isTyped

protected boolean isTyped()

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

readChunk

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

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