/*******************************************************************************
* 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.odata2.core.ep;
import java.io.BufferedWriter;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import org.apache.olingo.odata2.api.ODataServiceVersion;
import org.apache.olingo.odata2.api.commons.HttpStatusCodes;
import org.apache.olingo.odata2.api.commons.InlineCount;
import org.apache.olingo.odata2.api.commons.ODataHttpHeaders;
import org.apache.olingo.odata2.api.edm.Edm;
import org.apache.olingo.odata2.api.edm.EdmEntitySet;
import org.apache.olingo.odata2.api.edm.EdmException;
import org.apache.olingo.odata2.api.edm.EdmFunctionImport;
import org.apache.olingo.odata2.api.edm.EdmMultiplicity;
import org.apache.olingo.odata2.api.edm.EdmProperty;
import org.apache.olingo.odata2.api.edm.EdmTypeKind;
import org.apache.olingo.odata2.api.ep.EntityProviderException;
import org.apache.olingo.odata2.api.ep.EntityProviderReadProperties;
import org.apache.olingo.odata2.api.ep.EntityProviderWriteProperties;
import org.apache.olingo.odata2.api.ep.entry.ODataEntry;
import org.apache.olingo.odata2.api.ep.feed.ODataDeltaFeed;
import org.apache.olingo.odata2.api.ep.feed.ODataFeed;
import org.apache.olingo.odata2.api.processor.ODataErrorContext;
import org.apache.olingo.odata2.api.processor.ODataResponse;
import org.apache.olingo.odata2.api.processor.ODataResponse.ODataResponseBuilder;
import org.apache.olingo.odata2.api.servicedocument.ServiceDocument;
import org.apache.olingo.odata2.core.ep.aggregator.EntityInfoAggregator;
import org.apache.olingo.odata2.core.ep.aggregator.EntityPropertyInfo;
import org.apache.olingo.odata2.core.ep.consumer.JsonEntityConsumer;
import org.apache.olingo.odata2.core.ep.consumer.JsonErrorDocumentConsumer;
import org.apache.olingo.odata2.core.ep.consumer.JsonServiceDocumentConsumer;
import org.apache.olingo.odata2.core.ep.producer.JsonCollectionEntityProducer;
import org.apache.olingo.odata2.core.ep.producer.JsonEntryEntityProducer;
import org.apache.olingo.odata2.core.ep.producer.JsonErrorDocumentProducer;
import org.apache.olingo.odata2.core.ep.producer.JsonFeedEntityProducer;
import org.apache.olingo.odata2.core.ep.producer.JsonLinkEntityProducer;
import org.apache.olingo.odata2.core.ep.producer.JsonLinksEntityProducer;
import org.apache.olingo.odata2.core.ep.producer.JsonPropertyEntityProducer;
import org.apache.olingo.odata2.core.ep.producer.JsonServiceDocumentProducer;
import org.apache.olingo.odata2.core.ep.util.CircleStreamBuffer;
import org.apache.olingo.odata2.core.exception.ODataRuntimeException;
/**
*
*/
public class JsonEntityProvider implements ContentTypeBasedEntityProvider {
private static final String DEFAULT_CHARSET = "UTF-8";
/**
* <p>Serializes an error message according to the OData standard.</p>
* <p>In case an error occurs, it is logged.
* An exception is not thrown because this method is used in exception handling.</p>
* @param status the {@link HttpStatusCodes status code} associated with this error
* @param errorCode a String that serves as a substatus to the HTTP response code
* @param message a human-readable message describing the error
* @param locale the {@link Locale} that should be used to format the error message
* @param innerError the inner error for this message; if it is null or an empty String
* no inner error tag is shown inside the response structure
* @return an {@link ODataResponse} containing the serialized error message
*/
@Override
public ODataResponse writeErrorDocument(final HttpStatusCodes status, final String errorCode, final String message,
final Locale locale, final String innerError) {
CircleStreamBuffer buffer = new CircleStreamBuffer();
try {
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(buffer.getOutputStream(), DEFAULT_CHARSET));
new JsonErrorDocumentProducer().writeErrorDocument(writer, errorCode, message, locale, innerError);
writer.flush();
buffer.closeWrite();
return ODataResponse.status(status)
.entity(buffer.getInputStream())
.header(ODataHttpHeaders.DATASERVICEVERSION, ODataServiceVersion.V10)
.build();
} catch (Exception e) {
buffer.close();
throw new ODataRuntimeException(e);
}
}
/**
* Writes service document based on given {@link Edm} and <code>service root</code>.
* @param edm the Entity Data Model
* @param serviceRoot the root URI of the service
* @return resulting {@link ODataResponse} with written service document
* @throws EntityProviderException
*/
@Override
public ODataResponse writeServiceDocument(final Edm edm, final String serviceRoot) throws EntityProviderException {
CircleStreamBuffer buffer = new CircleStreamBuffer();
try {
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(buffer.getOutputStream(), DEFAULT_CHARSET));
JsonServiceDocumentProducer.writeServiceDocument(writer, edm);
writer.flush();
buffer.closeWrite();
return ODataResponse.entity(buffer.getInputStream())
.header(ODataHttpHeaders.DATASERVICEVERSION, ODataServiceVersion.V10)
.build();
} catch (Exception e) {
buffer.close();
throw new ODataRuntimeException(e);
}
}
@Override
public ODataResponse writeEntry(final EdmEntitySet entitySet, final Map<String, Object> data,
final EntityProviderWriteProperties properties) throws EntityProviderException {
final EntityInfoAggregator entityInfo = EntityInfoAggregator.create(entitySet, properties.getExpandSelectTree());
CircleStreamBuffer buffer = new CircleStreamBuffer();
try {
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(buffer.getOutputStream(), DEFAULT_CHARSET));
JsonEntryEntityProducer producer = new JsonEntryEntityProducer(properties);
producer.append(writer, entityInfo, data, true);
writer.flush();
buffer.closeWrite();
return ODataResponse.entity(buffer.getInputStream())
.eTag(producer.getETag())
.idLiteral(producer.getLocation())
.build();
} catch (EntityProviderException e) {
buffer.close();
throw e;
} catch (Exception e) {
buffer.close();
throw new EntityProviderException(EntityProviderException.EXCEPTION_OCCURRED.addContent(e.getClass()
.getSimpleName()), e);
}
}
@Override
public ODataResponse writeProperty(final EdmProperty edmProperty, final Object value) throws EntityProviderException {
return writeSingleTypedElement(EntityInfoAggregator.create(edmProperty), value);
}
private ODataResponse writeSingleTypedElement(final EntityPropertyInfo propertyInfo, final Object value)
throws EntityProviderException {
CircleStreamBuffer buffer = new CircleStreamBuffer();
try {
OutputStream outStream = buffer.getOutputStream();
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(outStream, DEFAULT_CHARSET));
new JsonPropertyEntityProducer().append(writer, propertyInfo, value);
writer.flush();
buffer.closeWrite();
return ODataResponse.entity(buffer.getInputStream())
.header(ODataHttpHeaders.DATASERVICEVERSION, ODataServiceVersion.V10)
.build();
} catch (EntityProviderException e) {
buffer.close();
throw e;
} catch (Exception e) {
buffer.close();
throw new EntityProviderException(EntityProviderException.EXCEPTION_OCCURRED.addContent(e.getClass()
.getSimpleName()), e);
}
}
@Override
public ODataResponse writeFeed(final EdmEntitySet entitySet, final List<Map<String, Object>> data,
final EntityProviderWriteProperties properties) throws EntityProviderException {
final EntityInfoAggregator entityInfo = EntityInfoAggregator.create(entitySet, properties.getExpandSelectTree());
CircleStreamBuffer buffer = new CircleStreamBuffer();
try {
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(buffer.getOutputStream(), DEFAULT_CHARSET));
new JsonFeedEntityProducer(properties).append(writer, entityInfo, data, true);
writer.flush();
buffer.closeWrite();
return ODataResponse.entity(buffer.getInputStream()).build();
} catch (EntityProviderException e) {
buffer.close();
throw e;
} catch (Exception e) {
buffer.close();
throw new EntityProviderException(EntityProviderException.EXCEPTION_OCCURRED.addContent(e.getClass()
.getSimpleName()), e);
}
}
@Override
public ODataResponse writeLink(final EdmEntitySet entitySet, final Map<String, Object> data,
final EntityProviderWriteProperties properties) throws EntityProviderException {
final EntityInfoAggregator entityInfo = EntityInfoAggregator.create(entitySet, properties.getExpandSelectTree());
CircleStreamBuffer buffer = new CircleStreamBuffer();
try {
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(buffer.getOutputStream(), DEFAULT_CHARSET));
new JsonLinkEntityProducer(properties).append(writer, entityInfo, data);
writer.flush();
buffer.closeWrite();
return ODataResponse.entity(buffer.getInputStream())
.header(ODataHttpHeaders.DATASERVICEVERSION, ODataServiceVersion.V10)
.build();
} catch (EntityProviderException e) {
buffer.close();
throw e;
} catch (Exception e) {
buffer.close();
throw new EntityProviderException(EntityProviderException.EXCEPTION_OCCURRED.addContent(e.getClass()
.getSimpleName()), e);
}
}
@Override
public ODataResponse writeLinks(final EdmEntitySet entitySet, final List<Map<String, Object>> data,
final EntityProviderWriteProperties properties) throws EntityProviderException {
final EntityInfoAggregator entityInfo = EntityInfoAggregator.create(entitySet, properties.getExpandSelectTree());
CircleStreamBuffer buffer = new CircleStreamBuffer();
try {
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(buffer.getOutputStream(), DEFAULT_CHARSET));
new JsonLinksEntityProducer(properties).append(writer, entityInfo, data);
writer.flush();
buffer.closeWrite();
ODataResponseBuilder response = ODataResponse.entity(buffer.getInputStream());
if (properties.getInlineCountType() != InlineCount.ALLPAGES) {
response = response.header(ODataHttpHeaders.DATASERVICEVERSION, ODataServiceVersion.V10);
}
return response.build();
} catch (EntityProviderException e) {
buffer.close();
throw e;
} catch (Exception e) {
buffer.close();
throw new EntityProviderException(EntityProviderException.EXCEPTION_OCCURRED.addContent(e.getClass()
.getSimpleName()), e);
}
}
private ODataResponse writeCollection(final EntityPropertyInfo propertyInfo, final List<?> data)
throws EntityProviderException {
CircleStreamBuffer buffer = new CircleStreamBuffer();
try {
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(buffer.getOutputStream(), DEFAULT_CHARSET));
new JsonCollectionEntityProducer().append(writer, propertyInfo, data);
writer.flush();
buffer.closeWrite();
return ODataResponse.entity(buffer.getInputStream()).build();
} catch (EntityProviderException e) {
buffer.close();
throw e;
} catch (Exception e) {
buffer.close();
throw new EntityProviderException(EntityProviderException.EXCEPTION_OCCURRED.addContent(e.getClass()
.getSimpleName()), e);
}
}
@Override
public ODataResponse writeFunctionImport(final EdmFunctionImport functionImport, final Object data,
final EntityProviderWriteProperties properties) throws EntityProviderException {
try {
if (functionImport.getReturnType().getType().getKind() == EdmTypeKind.ENTITY) {
@SuppressWarnings("unchecked")
Map<String, Object> map = (Map<String, Object>) data;
return writeEntry(functionImport.getEntitySet(), map, properties);
}
final EntityPropertyInfo info = EntityInfoAggregator.create(functionImport);
if (functionImport.getReturnType().getMultiplicity() == EdmMultiplicity.MANY) {
return writeCollection(info, (List<?>) data);
} else {
return writeSingleTypedElement(info, data);
}
} catch (final EdmException e) {
throw new EntityProviderException(EntityProviderException.EXCEPTION_OCCURRED.addContent(e.getClass()
.getSimpleName()), e);
}
}
@Override
public ODataFeed readFeed(final EdmEntitySet entitySet, final InputStream content,
final EntityProviderReadProperties properties) throws EntityProviderException {
return new JsonEntityConsumer().readFeed(entitySet, content, properties);
}
@Override
public ODataEntry readEntry(final EdmEntitySet entitySet, final InputStream content,
final EntityProviderReadProperties properties) throws EntityProviderException {
return new JsonEntityConsumer().readEntry(entitySet, content, properties);
}
@Override
public Map<String, Object> readProperty(final EdmProperty edmProperty, final InputStream content,
final EntityProviderReadProperties properties) throws EntityProviderException {
return new JsonEntityConsumer().readProperty(edmProperty, content, properties);
}
@Override
public String readLink(final EdmEntitySet entitySet, final InputStream content) throws EntityProviderException {
return new JsonEntityConsumer().readLink(entitySet, content);
}
@Override
public List<String> readLinks(final EdmEntitySet entitySet, final InputStream content)
throws EntityProviderException {
return new JsonEntityConsumer().readLinks(entitySet, content);
}
@Override
public ServiceDocument readServiceDocument(final InputStream serviceDocument) throws EntityProviderException {
return new JsonServiceDocumentConsumer().parseJson(serviceDocument);
}
@Override
public ODataDeltaFeed readDeltaFeed(final EdmEntitySet entitySet, final InputStream content,
final EntityProviderReadProperties properties) throws EntityProviderException {
return new JsonEntityConsumer().readDeltaFeed(entitySet, content, properties);
}
@Override
public ODataErrorContext readErrorDocument(final InputStream errorDocument) throws EntityProviderException {
return new JsonErrorDocumentConsumer().readError(errorDocument);
}
}