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

Class TextPlainMessageSerializer

java.lang.Object

org.apache.tinkerpop.gremlin.util.ser.AbstractMessageSerializer<Function<Object,String>>

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

All Implemented Interfaces:

MessageSerializer<Function<Object,String>>

public class TextPlainMessageSerializer
extends AbstractMessageSerializer<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.

Nested Class Summary

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

MessageSerializer.MessageParts

Field Summary

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
TextPlainMessageSerializer()

Method Summary

Modifier and Type	Method	Description
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.
Function<Object,String>	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

Methods inherited from interface org.apache.tinkerpop.gremlin.util.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.

serializeResponseAsBinary

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

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.

writeHeader

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

writeChunk

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

writeFooter

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

writeErrorFooter

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

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)

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.

deserializeBinaryRequest

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

Description copied from interface: MessageSerializer

Deserialize a Netty ByteBuf into a RequestMessage.

deserializeBinaryResponse

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

Description copied from interface: MessageSerializer

Deserialize a Netty ByteBuf into a RequestMessage.

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.