org.apache.olingo.client.api.serialization.CommonODataReader Maven / Gradle / Ivy

Go to download
/*
 * 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.olingo.client.api.serialization;

import org.apache.olingo.client.api.edm.xml.Schema;
import org.apache.olingo.commons.api.data.ResWrap;
import org.apache.olingo.commons.api.domain.CommonODataEntity;
import org.apache.olingo.commons.api.domain.CommonODataEntitySet;
import org.apache.olingo.commons.api.domain.CommonODataProperty;
import org.apache.olingo.commons.api.domain.ODataError;
import org.apache.olingo.commons.api.domain.ODataServiceDocument;
import org.apache.olingo.commons.api.edm.Edm;
import org.apache.olingo.commons.api.format.ODataFormat;
import org.apache.olingo.commons.api.serialization.ODataDeserializerException;

import java.io.InputStream;
import java.util.Map;

/**
 * OData reader.
 * 

 * Use this class to de-serialize an OData response body.
 * 

 * This class provides method helpers to de-serialize an entire entity set, a set of entities or a single entity.
 */
public interface CommonODataReader {

  /**
   * Parses a stream into metadata representation.
   *
   * @param input stream to de-serialize.
   * @return metadata representation.
   */
  Edm readMetadata(InputStream input);

  /**
   * Parses a stream into metadata representation, including referenced metadata documents.
   *
   * @param xmlSchemas XML representation of the requested metadata document + any other referenced (via
   * <edmx:Reference/>) metadata document
   * @return metadata representation.
   */
  Edm readMetadata(Map xmlSchemas);

  /**
   * Parses an OData service document.
   *
   * @param input stream to de-serialize.
   * @param format de-serialize as XML or JSON
   * @return List of URIs.
   * @throws ODataDeserializerException
   */
  ODataServiceDocument readServiceDocument(InputStream input, ODataFormat format) throws ODataDeserializerException;

  /**
   * De-Serializes a stream into an OData entity set.
   *
   * @param input stream to de-serialize.
   * @param format de-serialize format
   * @return de-serialized entity set.
   * @throws ODataDeserializerException
   */
  CommonODataEntitySet readEntitySet(InputStream input, ODataFormat format) throws ODataDeserializerException;

  /**
   * Parses a stream taking care to de-serializes the first OData entity found.
   *
   * @param input stream to de-serialize.
   * @param format de-serialize format
   * @return entity de-serialized.
   * @throws ODataDeserializerException
   */
  CommonODataEntity readEntity(InputStream input, ODataFormat format) throws ODataDeserializerException;

  /**
   * Parses a stream taking care to de-serialize the first OData entity property found.
   *
   * @param input stream to de-serialize.
   * @param format de-serialize as XML or JSON
   * @return OData entity property de-serialized.
   * @throws ODataDeserializerException
   */
  CommonODataProperty readProperty(InputStream input, ODataFormat format) throws ODataDeserializerException;

  /**
   * Parses a stream into an OData error.
   *
   * @param inputStream stream to de-serialize.
   * @param format format
   * @return OData error.
   * @throws ODataDeserializerException
   */
  ODataError readError(InputStream inputStream, ODataFormat format) throws ODataDeserializerException;

  /**
   * Parses a stream into the object type specified by the given reference.
   *
   * @param  expected object type.
   * @param src input stream.
   * @param format format
   * @param reference reference.
   * @return read object.
   * @throws ODataDeserializerException
   */
   ResWrap read(InputStream src, String format, Class reference) throws ODataDeserializerException;
}