Package org.apache.olingo.odata2.core.ep

Class AtomEntityProvider

java.lang.Object

org.apache.olingo.odata2.core.ep.AtomEntityProvider

All Implemented Interfaces:

ContentTypeBasedEntityProvider

public class AtomEntityProvider
extends Object
implements ContentTypeBasedEntityProvider

Constructor Summary

Constructors

Constructor	Description
AtomEntityProvider()
AtomEntityProvider(ContentType.ODataFormat odataFormat)

Method Summary

Modifier and Type	Method	Description
ODataDeltaFeed	readDeltaFeed(EdmEntitySet entitySet, InputStream content, EntityProviderReadProperties properties)
ODataEntry	readEntry(EdmEntitySet entitySet, InputStream content, EntityProviderReadProperties properties)
ODataErrorContext	readErrorDocument(InputStream errorDocument)
ODataFeed	readFeed(EdmEntitySet entitySet, InputStream content, EntityProviderReadProperties properties)
Object	readFunctionImport(EdmFunctionImport functionImport, InputStream content, EntityProviderReadProperties properties)
String	readLink(EdmEntitySet entitySet, InputStream content)
List<String>	readLinks(EdmEntitySet entitySet, InputStream content)
Map<String,Object>	readProperty(EdmProperty edmProperty, InputStream content, EntityProviderReadProperties properties)
ServiceDocument	readServiceDocument(InputStream serviceDocument)
ODataResponse	writeEntry(EdmEntitySet entitySet, Map<String,Object> data, EntityProviderWriteProperties properties)
ODataResponse	writeErrorDocument(HttpStatusCodes status, String errorCode, String message, Locale locale, String innerError)	Serializes an error message according to the OData standard.
ODataResponse	writeFeed(EdmEntitySet entitySet, List<Map<String,Object>> data, EntityProviderWriteProperties properties)
ODataResponse	writeFunctionImport(EdmFunctionImport functionImport, Object data, EntityProviderWriteProperties properties)
ODataResponse	writeLink(EdmEntitySet entitySet, Map<String,Object> data, EntityProviderWriteProperties properties)
ODataResponse	writeLinks(EdmEntitySet entitySet, List<Map<String,Object>> data, EntityProviderWriteProperties properties)
ODataResponse	writeProperty(EdmProperty edmProperty, Object value)
ODataResponse	writeServiceDocument(Edm edm, String serviceRoot)	Write service document based on given Edm and service root as AtomPub Service Document/code> with charset encoding "utf-8".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AtomEntityProvider

public AtomEntityProvider()
                   throws EntityProviderException

Throws:

EntityProviderException

AtomEntityProvider

public AtomEntityProvider(ContentType.ODataFormat odataFormat)
                   throws EntityProviderException

Throws:

EntityProviderException

Method Detail

writeErrorDocument

public ODataResponse writeErrorDocument(HttpStatusCodes status,
                                        String errorCode,
                                        String message,
                                        Locale locale,
                                        String innerError)

Serializes an error message according to the OData standard.

In case an error occurs, it is logged. An exception is not thrown because this method is used in exception handling.

Specified by:

writeErrorDocument in interface ContentTypeBasedEntityProvider

Parameters:

status - the HttpStatusCodes associated with this error

errorCode - a String that serves as a substatus to the HTTP response code

message - a human-readable message describing the error

locale - the Locale that should be used to format the error message

innerError - the inner error for this message. If it is null or an empty String no inner error tag is shown inside the response xml

Returns:

an ODataResponse containing the serialized error message

writeServiceDocument

public ODataResponse writeServiceDocument(Edm edm,
                                          String serviceRoot)
                                   throws EntityProviderException

Write service document based on given Edm and service root as AtomPub Service Document/code> with charset encoding "utf-8".

Specified by:

writeServiceDocument in interface ContentTypeBasedEntityProvider

Parameters:

edm - the Entity Data Model

serviceRoot - the root URI of the service

Returns:

resulting ODataResponse with written service document

Throws:

EntityProviderException

writeEntry

public ODataResponse writeEntry(EdmEntitySet entitySet,
                                Map<String,Object> data,
                                EntityProviderWriteProperties properties)
                         throws EntityProviderException

Specified by:

writeEntry in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException

writeProperty

public ODataResponse writeProperty(EdmProperty edmProperty,
                                   Object value)
                            throws EntityProviderException

Specified by:

writeProperty in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException

writeFeed

public ODataResponse writeFeed(EdmEntitySet entitySet,
                               List<Map<String,Object>> data,
                               EntityProviderWriteProperties properties)
                        throws EntityProviderException

Specified by:

writeFeed in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException

writeLink

public ODataResponse writeLink(EdmEntitySet entitySet,
                               Map<String,Object> data,
                               EntityProviderWriteProperties properties)
                        throws EntityProviderException

Specified by:

writeLink in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException

writeLinks

public ODataResponse writeLinks(EdmEntitySet entitySet,
                                List<Map<String,Object>> data,
                                EntityProviderWriteProperties properties)
                         throws EntityProviderException

Specified by:

writeLinks in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException

writeFunctionImport

public ODataResponse writeFunctionImport(EdmFunctionImport functionImport,
                                         Object data,
                                         EntityProviderWriteProperties properties)
                                  throws EntityProviderException

Specified by:

writeFunctionImport in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException

readFeed

public ODataFeed readFeed(EdmEntitySet entitySet,
                          InputStream content,
                          EntityProviderReadProperties properties)
                   throws EntityProviderException

Specified by:

readFeed in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException

readDeltaFeed

public ODataDeltaFeed readDeltaFeed(EdmEntitySet entitySet,
                                    InputStream content,
                                    EntityProviderReadProperties properties)
                             throws EntityProviderException

Specified by:

readDeltaFeed in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException

readEntry

public ODataEntry readEntry(EdmEntitySet entitySet,
                            InputStream content,
                            EntityProviderReadProperties properties)
                     throws EntityProviderException

Specified by:

readEntry in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException

readProperty

public Map<String,Object> readProperty(EdmProperty edmProperty,
                                             InputStream content,
                                             EntityProviderReadProperties properties)
                                      throws EntityProviderException

Specified by:

readProperty in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException

readLink

public String readLink(EdmEntitySet entitySet,
                       InputStream content)
                throws EntityProviderException

Specified by:

readLink in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException

readLinks

public List<String> readLinks(EdmEntitySet entitySet,
                              InputStream content)
                       throws EntityProviderException

Specified by:

readLinks in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException

readServiceDocument

public ServiceDocument readServiceDocument(InputStream serviceDocument)
                                    throws EntityProviderException

Specified by:

readServiceDocument in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException

readErrorDocument

public ODataErrorContext readErrorDocument(InputStream errorDocument)
                                    throws EntityProviderException

Specified by:

readErrorDocument in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException

readFunctionImport

public Object readFunctionImport(EdmFunctionImport functionImport,
                                 InputStream content,
                                 EntityProviderReadProperties properties)
                          throws EntityProviderException

Specified by:

readFunctionImport in interface ContentTypeBasedEntityProvider

Throws:

EntityProviderException