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

Interface MessageTextSerializer<M>

All Superinterfaces:

MessageSerializer<M>

All Known Implementing Classes:

GraphBinaryMessageSerializerV1, GraphSONMessageSerializerV1, GraphSONMessageSerializerV2, GraphSONMessageSerializerV3, GraphSONUntypedMessageSerializerV1, GraphSONUntypedMessageSerializerV2, GraphSONUntypedMessageSerializerV3, TextPlainMessageSerializer

public interface MessageTextSerializer<M>
extends MessageSerializer<M>

An extension to the MessageSerializer interface that allows a format to be compatible with text-based websocket messages. This interface is for internal purposes only. Implementers who have mapper serialization needs should NOT implement this interface as it will not be used. Gremlin Server only supports plain JSON for text-based requests.

Author:

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

Field Summary

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

logger

Method Summary

Modifier and Type	Method	Description
RequestMessage	deserializeRequest(String msg)
ResponseMessage	deserializeResponse(String msg)
String	serializeRequestAsString(RequestMessage requestMessage, io.netty.buffer.ByteBufAllocator allocator)
String	serializeResponseAsString(ResponseMessage responseMessage, io.netty.buffer.ByteBufAllocator allocator)

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

configure, deserializeRequest, deserializeResponse, getMapper, mimeTypesSupported, serializeRequestAsBinary, serializeResponseAsBinary

Method Detail

serializeResponseAsString

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

Throws:

SerializationException

serializeRequestAsString

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

Throws:

SerializationException

deserializeRequest

RequestMessage deserializeRequest(String msg)
                           throws SerializationException

Throws:

SerializationException

deserializeResponse

ResponseMessage deserializeResponse(String msg)
                             throws SerializationException

Throws:

SerializationException