| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| package org.apache.tinkerpop.gremlin.driver; |
| |
| import org.apache.tinkerpop.gremlin.driver.message.RequestMessage; |
| import org.apache.tinkerpop.gremlin.driver.message.ResponseMessage; |
| import org.apache.tinkerpop.gremlin.driver.ser.GraphSONMessageSerializerV1d0; |
| import org.apache.tinkerpop.gremlin.driver.ser.SerializationException; |
| import org.apache.tinkerpop.gremlin.structure.Graph; |
| import io.netty.buffer.ByteBuf; |
| import io.netty.buffer.ByteBufAllocator; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| import java.util.Iterator; |
| import java.util.Map; |
| import java.util.ServiceLoader; |
| |
| /** |
| * Serializes data to and from Gremlin Server. Typically the object being serialized or deserialized will be an item |
| * from an {@link Iterator} as returned from the {@code ScriptEngine} or an incoming {@link RequestMessage}. |
| * {@link MessageSerializer} instances are instantiated to a cache via {@link ServiceLoader} and indexed based on |
| * the mime types they support. If a mime type is supported more than once, the last {@link MessageSerializer} |
| * instance loaded for that mime type is assigned. If a mime type is not found the default |
| * {@link GraphSONMessageSerializerV1d0} is used to return the results. |
| * |
| * @author Stephen Mallette (http://stephen.genoprime.com) |
| */ |
| public interface MessageSerializer { |
| |
| static final Logger logger = LoggerFactory.getLogger(MessageSerializer.class); |
| |
| /** |
| * Serialize a {@link ResponseMessage} to a Netty {@code ByteBuf}. |
| * |
| * @param responseMessage The response message to serialize to bytes. |
| * @param allocator The Netty allocator for the {@code ByteBuf} to return back. |
| */ |
| public ByteBuf serializeResponseAsBinary(final ResponseMessage responseMessage, final ByteBufAllocator allocator) throws SerializationException; |
| |
| /** |
| * Serialize a {@link ResponseMessage} to a Netty {@code ByteBuf}. |
| * |
| * @param requestMessage The request message to serialize to bytes. |
| * @param allocator The Netty allocator for the {@code ByteBuf} to return back. |
| */ |
| public ByteBuf serializeRequestAsBinary(final RequestMessage requestMessage, final ByteBufAllocator allocator) throws SerializationException; |
| |
| /** |
| * Deserialize a Netty {@code ByteBuf} into a {@link RequestMessage}. |
| */ |
| public RequestMessage deserializeRequest(final ByteBuf msg) throws SerializationException; |
| |
| /** |
| * Deserialize a Netty {@code ByteBuf} into a {@link ResponseMessage}. |
| */ |
| public ResponseMessage deserializeResponse(final ByteBuf msg) throws SerializationException; |
| |
| /** |
| * The list of mime types that the serializer supports. |
| */ |
| public String[] mimeTypesSupported(); |
| |
| /** |
| * 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. |
| */ |
| public default void configure(final Map<String, Object> config, final Map<String, Graph> graphs) { |
| } |
| } |