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

Class AbstractGraphSONMessageSerializerV2

java.lang.Object

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

org.apache.tinkerpop.gremlin.util.ser.AbstractGraphSONMessageSerializerV2

All Implemented Interfaces:

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

Direct Known Subclasses:

GraphSONMessageSerializerV2, GraphSONMessageSerializerV3, GraphSONUntypedMessageSerializerV2, GraphSONUntypedMessageSerializerV3

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

Author:

Stephen Mallette (http://stephen.genoprime.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractGraphSONMessageSerializerV2.GremlinServerModule
static class	AbstractGraphSONMessageSerializerV2.RequestMessageDeserializer
static class	AbstractGraphSONMessageSerializerV2.RequestMessageSerializer
static class	AbstractGraphSONMessageSerializerV2.ResponseMessageDeserializer
static class	AbstractGraphSONMessageSerializerV2.ResponseMessageSerializer

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
AbstractGraphSONMessageSerializerV2()
AbstractGraphSONMessageSerializerV2(GraphSONMapper mapper)	Deprecated.
AbstractGraphSONMessageSerializerV2(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	deserializeRequest(io.netty.buffer.ByteBuf msg)	Deserialize a Netty ByteBuf into a RequestMessage.
ResponseMessage	deserializeResponse(io.netty.buffer.ByteBuf msg)	Deserialize a Netty ByteBuf into a ResponseMessage.
org.apache.tinkerpop.shaded.jackson.databind.ObjectMapper	getMapper()	Gets the "mapper" that performs the underlying serialization work.
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.

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 Detail

mapper

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

Constructor Detail

AbstractGraphSONMessageSerializerV2

public AbstractGraphSONMessageSerializerV2()

AbstractGraphSONMessageSerializerV2

@Deprecated
public AbstractGraphSONMessageSerializerV2(GraphSONMapper mapper)

Deprecated.

AbstractGraphSONMessageSerializerV2

public AbstractGraphSONMessageSerializerV2(GraphSONMapper.Builder mapperBuilder)

Method Detail

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

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

deserializeRequest

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

Description copied from interface: MessageSerializer

Deserialize a Netty ByteBuf into a RequestMessage.

Throws:

SerializationException

deserializeResponse

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

Description copied from interface: MessageSerializer

Deserialize a Netty ByteBuf into a ResponseMessage.

Throws:

SerializationException

getMapper

public org.apache.tinkerpop.shaded.jackson.databind.ObjectMapper getMapper()

Description copied from interface: MessageSerializer

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