com.linkedin.restli.internal.common.DataMapConverter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restli-common Show documentation
Pegasus is a framework for building robust, scalable service architectures using dynamic discovery and simple asychronous type-checked REST + JSON APIs.
There is a newer version: 27.7.18
Show newest version
/*
   Copyright (c) 2015 LinkedIn Corp.

   Licensed 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 com.linkedin.restli.internal.common;

import com.linkedin.data.ByteString;
import com.linkedin.data.DataMap;
import com.linkedin.restli.common.ContentType;
import com.linkedin.restli.common.RestConstants;
import java.io.IOException;
import java.util.Map;
import javax.activation.MimeTypeParseException;


/**
 * Converter that converts DataMap to JSON/PSON byteString and vice versa
 */
public class DataMapConverter
{
  /**
   * Convert from DataMap to ByteString based on the given Content-Type header value
   * @param headers headers of the HTTP request or response
   * @param dataMap data map to convert
   * @return converted ByString encoded based on content-type specified in the headers
   * @throws MimeTypeParseException throws this exception when content type is not parsable.
   * @throws IOException throws this exception when serializing to ByteString failed.
   */
  public static ByteString dataMapToByteString(Map headers, DataMap dataMap) throws MimeTypeParseException, IOException
  {
    return dataMapToByteString(getContentTypeHeader(headers), dataMap);
  }

  /**
   * Convert from ByteString to DataMap based on the given Content-Type header value
   * @param headers headers of the HTTP request or response
   * @param bytes ByteString to convert
   * @return converted DataMap.  ByteString is decoded based on content-type specified in the headers
   * @throws MimeTypeParseException throws this exception when content type is not parsable.
   * @throws IOException throws this exception when serializing to ByteString failed.
   */
  public static DataMap bytesToDataMap(Map headers, ByteString bytes) throws MimeTypeParseException, IOException
  {
    return bytesToDataMap(getContentTypeHeader(headers), bytes);
  }

  /**
   * Convert from DataMap to ByteString based on the given Content-Type header value
   * @param contentTypeHeaderValue type of ByteString to convert to
   * @param dataMap data map to convert
   * @return converted ByString encoded based on content-type specified in the headers
   * @throws MimeTypeParseException throws this exception when content type is not parsable.
   * @throws IOException throws this exception when serializing to ByteString failed.
   */
  public static ByteString dataMapToByteString(String contentTypeHeaderValue, DataMap dataMap) throws MimeTypeParseException, IOException
  {
    // TODO: We should throw an exception instead of using JSON for an unknown content type. This behavior was introduced
    // in commit d149605e4181349b64180bdfe0b4d24a294dc6f6 when this logic is refactored from DataMapUtils.readMapWithExceptions.
    ContentType contentType  = ContentType.getContentType(contentTypeHeaderValue).orElse(ContentType.JSON);

    return ByteString.unsafeWrap(contentType.getCodec().mapToBytes(dataMap));
  }

  /**
   * Convert from ByteString to DataMap based on the given Content-Type header value
   * @param contentTypeHeaderValue type of ByteString to convert from
   * @param bytes ByteString to convert
   * @return converted DataMap.  ByteString is decoded based on content-type specified in the headers
   * @throws MimeTypeParseException throws this exception when content type is not parsable.
   * @throws IOException throws this exception when serializing to ByteString failed.
   */
  public static DataMap bytesToDataMap(String contentTypeHeaderValue, ByteString bytes) throws MimeTypeParseException, IOException
  {
    ContentType contentType = ContentType.getContentType(contentTypeHeaderValue).orElse(ContentType.JSON);

    return contentType.getCodec().readMap(bytes.asInputStream());
  }

  private static String getContentTypeHeader(Map headers)
  {
    return headers.get(RestConstants.HEADER_CONTENT_TYPE);
  }
}