Package org.apache.tinkerpop.gremlin.server.util

Class TextPlainMessageSerializer

java.lang.Object

org.apache.tinkerpop.gremlin.server.util.TextPlainMessageSerializer

All Implemented Interfaces:

MessageSerializer<Function<Object,String>>, MessageTextSerializer<Function<Object,String>>

public class TextPlainMessageSerializer
extends Object
implements MessageTextSerializer<Function<Object,String>>

A highly use-case specific serializer that only has context for HTTP where results simply need to be converted to string in a line by line fashion for text based returns.

Field Summary

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

logger

Constructor Summary

Constructors

Constructor	Description
TextPlainMessageSerializer()

Method Summary

Modifier and Type	Method	Description
RequestMessage	deserializeRequest(io.netty.buffer.ByteBuf msg)	Deserialize a Netty ByteBuf into a RequestMessage.
RequestMessage	deserializeRequest(String msg)
ResponseMessage	deserializeResponse(io.netty.buffer.ByteBuf msg)	Deserialize a Netty ByteBuf into a ResponseMessage.
ResponseMessage	deserializeResponse(String msg)
Function<Object,String>	getMapper()	Gets the "mapper" that performs the underlying serialization work.
String[]	mimeTypesSupported()	The list of mime types that the serializer supports.
io.netty.buffer.ByteBuf	serializeRequestAsBinary(RequestMessage requestMessage, io.netty.buffer.ByteBufAllocator allocator)	Serialize a ResponseMessage to a Netty ByteBuf.
String	serializeRequestAsString(RequestMessage requestMessage, io.netty.buffer.ByteBufAllocator allocator)
io.netty.buffer.ByteBuf	serializeResponseAsBinary(ResponseMessage responseMessage, io.netty.buffer.ByteBufAllocator allocator)	Serialize a ResponseMessage to a Netty ByteBuf.
String	serializeResponseAsString(ResponseMessage responseMessage, io.netty.buffer.ByteBufAllocator allocator)

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.driver.MessageSerializer

configure

Constructor Detail

TextPlainMessageSerializer

public TextPlainMessageSerializer()

Method Detail

getMapper

public Function<Object,String> getMapper()

Description copied from interface: MessageSerializer

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

Specified by:

getMapper in interface MessageSerializer<Function<Object,String>>

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.

Specified by:

serializeResponseAsBinary in interface MessageSerializer<Function<Object,String>>

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.

Specified by:

serializeRequestAsBinary in interface MessageSerializer<Function<Object,String>>

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.

Specified by:

deserializeRequest in interface MessageSerializer<Function<Object,String>>

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.

Specified by:

deserializeResponse in interface MessageSerializer<Function<Object,String>>

Throws:

SerializationException

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.

Specified by:

mimeTypesSupported in interface MessageSerializer<Function<Object,String>>

serializeResponseAsString

public String serializeResponseAsString(ResponseMessage responseMessage,
                                        io.netty.buffer.ByteBufAllocator allocator)
                                 throws SerializationException

Specified by:

serializeResponseAsString in interface MessageTextSerializer<Function<Object,String>>

Throws:

SerializationException

serializeRequestAsString

public String serializeRequestAsString(RequestMessage requestMessage,
                                       io.netty.buffer.ByteBufAllocator allocator)
                                throws SerializationException

Specified by:

serializeRequestAsString in interface MessageTextSerializer<Function<Object,String>>

Throws:

SerializationException

deserializeRequest

public RequestMessage deserializeRequest(String msg)
                                  throws SerializationException

Specified by:

deserializeRequest in interface MessageTextSerializer<Function<Object,String>>

Throws:

SerializationException

deserializeResponse

public ResponseMessage deserializeResponse(String msg)
                                    throws SerializationException

Specified by:

deserializeResponse in interface MessageTextSerializer<Function<Object,String>>

Throws:

SerializationException