Package | Description |
---|---|
org.apache.olingo.odata2.api |
OData Library API
OData Library is a protocol implementation of the OData V2.0 standard.
|
org.apache.olingo.odata2.api.batch | |
org.apache.olingo.odata2.api.ep |
Entity Provider
The org.apache.olingo.odata2.api.ep package contains all classes related and necessary to provide an
EntityProvider . |
org.apache.olingo.odata2.api.processor |
Data Processor
A data processor implements all create, read, update and delete (CRUD) methods of an OData service.
|
org.apache.olingo.odata2.api.processor.part |
Processor Parts
|
org.apache.olingo.odata2.client.api.ep | |
org.apache.olingo.odata2.client.core.ep | |
org.apache.olingo.odata2.jpa.processor.api |
OData JPA Processor API Library
The library provides a way for the developers to create an OData Service from a Java Persistence Model.
|
org.apache.olingo.odata2.jpa.processor.api.exception |
OData JPA Processor API Library - Exceptions
There are two main types of exceptions thrown from the library
Model Exception
Runtime Exception
The Model Exception is thrown while processing JPA metamodels and runtime exception is thrown while processing persistence data. |
org.apache.olingo.odata2.jpa.processor.ref.util | |
org.apache.olingo.odata2.ref.processor |
Modifier and Type | Method and Description |
---|---|
ODataResponse |
ODataDebugResponseWrapperCallback.handle(ODataContext context,
ODataRequest request,
ODataResponse response,
UriInfo uriInfo,
Exception exception)
Handles the output of a response helpful in case of debugging.
|
Modifier and Type | Method and Description |
---|---|
ODataResponse |
ODataDebugResponseWrapperCallback.handle(ODataContext context,
ODataRequest request,
ODataResponse response,
UriInfo uriInfo,
Exception exception)
Handles the output of a response helpful in case of debugging.
|
Modifier and Type | Method and Description |
---|---|
ODataResponse |
BatchHandler.handleRequest(ODataRequest request)
Delegates a handling of the request
ODataRequest to the request handler and provides ODataResponse
ODataResponse . |
Modifier and Type | Method and Description |
---|---|
abstract List<ODataResponse> |
BatchResponsePart.getResponses()
Get responses.
|
Modifier and Type | Method and Description |
---|---|
static BatchResponsePart.BatchResponsePartBuilder |
BatchResponsePart.responses(List<ODataResponse> responses) |
abstract BatchResponsePart.BatchResponsePartBuilder |
BatchResponsePart.BatchResponsePartBuilder.responses(List<ODataResponse> responses) |
Modifier and Type | Method and Description |
---|---|
static ODataResponse |
EntityProvider.writeBatchResponse(List<BatchResponsePart> batchResponseParts)
Write responses of Batch Response Parts in Batch Response as
ODataResponse . |
ODataResponse |
EntityProvider.EntityProviderInterface.writeBatchResponse(List<BatchResponsePart> batchResponseParts)
Write responses of Batch Response Parts in Batch Response as
ODataResponse . |
static ODataResponse |
EntityProvider.writeBinary(String mimeType,
byte[] data)
Write binary content with content type header set to given
mime type parameter. |
ODataResponse |
EntityProvider.EntityProviderInterface.writeBinary(String mimeType,
byte[] data)
Write binary content with content type header set to given
mime type parameter. |
static ODataResponse |
EntityProvider.writeEntry(String contentType,
EdmEntitySet entitySet,
Map<String,Object> data,
EntityProviderWriteProperties properties)
Write given
data (which is given in form of a Map for which contains all properties
as property name to property value mapping) for the entry in the specified
format (given as contentType ) based on entity data model for an entity set (given as
EdmEntitySet )
and properties for this entity provider (given as EntityProviderWriteProperties ). |
ODataResponse |
EntityProvider.EntityProviderInterface.writeEntry(String contentType,
EdmEntitySet entitySet,
Map<String,Object> data,
EntityProviderWriteProperties properties)
Write given
data (which is given in form of a Map for which contains all properties
as property name to property value mapping) for the entry in the specified
format (given as contentType ) based on entity data model for an entity set (given as
EdmEntitySet )
and properties for this entity provider (given as EntityProviderWriteProperties ). |
static ODataResponse |
EntityProvider.writeErrorDocument(ODataErrorContext context)
Serializes an error message according to the OData standard.
|
ODataResponse |
EntityProvider.EntityProviderInterface.writeErrorDocument(ODataErrorContext context)
Serializes an error message according to the OData standard.
|
static ODataResponse |
EntityProvider.writeFeed(String contentType,
EdmEntitySet entitySet,
List<Map<String,Object>> data,
EntityProviderWriteProperties properties)
|
ODataResponse |
EntityProvider.EntityProviderInterface.writeFeed(String contentType,
EdmEntitySet entitySet,
List<Map<String,Object>> data,
EntityProviderWriteProperties properties)
|
static ODataResponse |
EntityProvider.writeFunctionImport(String contentType,
EdmFunctionImport functionImport,
Object data,
EntityProviderWriteProperties properties)
Write
data result (given as Object ) of function import based on return type
of EdmFunctionImport in specified format (given as contentType ). |
ODataResponse |
EntityProvider.EntityProviderInterface.writeFunctionImport(String contentType,
EdmFunctionImport functionImport,
Object data,
EntityProviderWriteProperties properties)
Write
data result (given as Object ) of function import based on return type
of EdmFunctionImport in specified format (given as contentType ). |
static ODataResponse |
EntityProvider.writeLink(String contentType,
EdmEntitySet entitySet,
Map<String,Object> data,
EntityProviderWriteProperties properties)
Write link for key property based on
entity data model for an entity set (given as
EdmEntitySet )
in the specified format (given as contentType ). |
ODataResponse |
EntityProvider.EntityProviderInterface.writeLink(String contentType,
EdmEntitySet entitySet,
Map<String,Object> data,
EntityProviderWriteProperties properties)
Write link for key property based on
entity data model for an entity set (given as
EdmEntitySet )
in the specified format (given as contentType ). |
static ODataResponse |
EntityProvider.writeLinks(String contentType,
EdmEntitySet entitySet,
List<Map<String,Object>> data,
EntityProviderWriteProperties properties)
Write all links for key property based on
entity data model for an entity set (given as
EdmEntitySet )
in the specified format (given as contentType ) for a set of entries. |
ODataResponse |
EntityProvider.EntityProviderInterface.writeLinks(String contentType,
EdmEntitySet entitySet,
List<Map<String,Object>> data,
EntityProviderWriteProperties properties)
Write all links for key property based on
entity data model for an entity set (given as
EdmEntitySet )
in the specified format (given as contentType ) for a set of entries. |
static ODataResponse |
EntityProvider.writeMetadata(DataServices serviceMetadata,
Map<String,String> predefinedNamespaces)
Write metadata document in XML format for the given schemas and the provided predefined
namespaces at the EDMX element.
|
ODataResponse |
EntityProvider.EntityProviderInterface.writeMetadata(DataServices serviceMetadata,
Map<String,String> predefinedNamespaces)
Write metadata document in XML format for the given schemas and the provided predefined
namespaces at the EDMX element.
|
static ODataResponse |
EntityProvider.writeMetadata(List<Schema> schemas,
Map<String,String> predefinedNamespaces)
Write metadata document in XML format for the given schemas and the provided predefined
namespaces at the EDMX element.
|
ODataResponse |
EntityProvider.EntityProviderInterface.writeMetadata(List<Schema> schemas,
Map<String,String> predefinedNamespaces)
Write metadata document in XML format for the given schemas and the provided predefined
namespaces at the EDMX element.
|
static ODataResponse |
EntityProvider.writeProperty(String contentType,
EdmProperty edmProperty,
Object value)
Write given
value (which is given in form of an Object ) for the property in the specified
format (given as contentType ) based on given entity data model for an entity property
(given as EdmProperty ). |
ODataResponse |
EntityProvider.EntityProviderInterface.writeProperty(String contentType,
EdmProperty edmProperty,
Object value)
Write given
value (which is given in form of an Object ) for the property in the specified
format (given as contentType ) based on given entity data model for an entity property
(given as EdmProperty ). |
static ODataResponse |
EntityProvider.writePropertyValue(EdmProperty edmProperty,
Object value)
Write property as content type
application/octet-stream or text/plain . |
ODataResponse |
EntityProvider.EntityProviderInterface.writePropertyValue(EdmProperty edmProperty,
Object value)
Write property as content type
application/octet-stream or text/plain . |
static ODataResponse |
EntityProvider.writeServiceDocument(String contentType,
Edm edm,
String serviceRoot)
Write service document based on given
Edm and service root as
given content type. |
ODataResponse |
EntityProvider.EntityProviderInterface.writeServiceDocument(String contentType,
Edm edm,
String serviceRoot)
Write service document based on given
Edm and service root as
given content type. |
static ODataResponse |
EntityProvider.writeText(String value)
Write text value as content type
text/plain . |
ODataResponse |
EntityProvider.EntityProviderInterface.writeText(String value)
Write text value as content type
text/plain . |
Modifier and Type | Method and Description |
---|---|
static ODataResponse.ODataResponseBuilder |
ODataResponse.fromResponse(ODataResponse response) |
protected abstract ODataResponse.ODataResponseBuilder |
ODataResponse.ODataResponseBuilder.fromResponse(ODataResponse response) |
Modifier and Type | Method and Description |
---|---|
ODataResponse |
EntityLinksProcessor.countEntityLinks(GetEntitySetLinksCountUriInfo uriInfo,
String contentType)
Counts the number of target entities of a navigation property.
|
ODataResponse |
EntitySetProcessor.countEntitySet(GetEntitySetCountUriInfo uriInfo,
String contentType)
Counts the number of requested entities.
|
ODataResponse |
EntitySetProcessor.createEntity(PostUriInfo uriInfo,
InputStream content,
String requestContentType,
String contentType)
Creates an entity.
|
ODataResponse |
EntityLinksProcessor.createEntityLink(PostUriInfo uriInfo,
InputStream content,
String requestContentType,
String contentType)
Creates a new link to a target entity of a navigation property.
|
ODataResponse |
EntityProcessor.deleteEntity(DeleteUriInfo uriInfo,
String contentType)
Deletes an entity.
|
ODataResponse |
EntityLinkProcessor.deleteEntityLink(DeleteUriInfo uriInfo,
String contentType)
Deletes the link to the target entity of a navigation property.
|
ODataResponse |
EntityMediaProcessor.deleteEntityMedia(DeleteUriInfo uriInfo,
String contentType)
Deletes the media resource of an entity.
|
ODataResponse |
EntitySimplePropertyValueProcessor.deleteEntitySimplePropertyValue(DeleteUriInfo uriInfo,
String contentType)
Deletes the value of a simple property of an entity.
|
ODataResponse |
BatchProcessor.executeBatch(BatchHandler handler,
String contentType,
InputStream content)
Executes a OData batch request and provide Batch Response as
ODataResponse |
ODataResponse |
FunctionImportProcessor.executeFunctionImport(GetFunctionImportUriInfo uriInfo,
String contentType)
Executes a function import and returns the result.
|
ODataResponse |
FunctionImportValueProcessor.executeFunctionImportValue(GetFunctionImportUriInfo uriInfo,
String contentType)
Returns the unformatted value of a function import.
|
ODataResponse |
EntityProcessor.existsEntity(GetEntityCountUriInfo uriInfo,
String contentType)
Checks whether an entity exists.
|
ODataResponse |
EntityLinkProcessor.existsEntityLink(GetEntityLinkCountUriInfo uriInfo,
String contentType)
Returns whether the target entity of a navigation property exists.
|
ODataResponse |
EntityProcessor.readEntity(GetEntityUriInfo uriInfo,
String contentType)
Reads an entity.
|
ODataResponse |
EntityComplexPropertyProcessor.readEntityComplexProperty(GetComplexPropertyUriInfo uriInfo,
String contentType)
Reads a complex property of an entity.
|
ODataResponse |
EntityLinkProcessor.readEntityLink(GetEntityLinkUriInfo uriInfo,
String contentType)
Reads the URI of the target entity of a navigation property.
|
ODataResponse |
EntityLinksProcessor.readEntityLinks(GetEntitySetLinksUriInfo uriInfo,
String contentType)
Reads the URIs of the target entities of a navigation property.
|
ODataResponse |
EntityMediaProcessor.readEntityMedia(GetMediaResourceUriInfo uriInfo,
String contentType)
Reads the media resource of an entity.
|
ODataResponse |
EntitySetProcessor.readEntitySet(GetEntitySetUriInfo uriInfo,
String contentType)
Reads entities.
|
ODataResponse |
EntitySimplePropertyProcessor.readEntitySimpleProperty(GetSimplePropertyUriInfo uriInfo,
String contentType)
Reads a simple property of an entity.
|
ODataResponse |
EntitySimplePropertyValueProcessor.readEntitySimplePropertyValue(GetSimplePropertyUriInfo uriInfo,
String contentType)
Reads the unformatted value of a simple property of an entity.
|
ODataResponse |
MetadataProcessor.readMetadata(GetMetadataUriInfo uriInfo,
String contentType) |
ODataResponse |
ServiceDocumentProcessor.readServiceDocument(GetServiceDocumentUriInfo uriInfo,
String contentType) |
ODataResponse |
EntityProcessor.updateEntity(PutMergePatchUriInfo uriInfo,
InputStream content,
String requestContentType,
boolean merge,
String contentType)
Updates an entity.
|
ODataResponse |
EntityComplexPropertyProcessor.updateEntityComplexProperty(PutMergePatchUriInfo uriInfo,
InputStream content,
String requestContentType,
boolean merge,
String contentType)
Updates a complex property of an entity.
|
ODataResponse |
EntityLinkProcessor.updateEntityLink(PutMergePatchUriInfo uriInfo,
InputStream content,
String requestContentType,
String contentType)
Updates the link to the target entity of a navigation property.
|
ODataResponse |
EntityMediaProcessor.updateEntityMedia(PutMergePatchUriInfo uriInfo,
InputStream content,
String requestContentType,
String contentType)
Updates the media resource of an entity.
|
ODataResponse |
EntitySimplePropertyProcessor.updateEntitySimpleProperty(PutMergePatchUriInfo uriInfo,
InputStream content,
String requestContentType,
String contentType)
Updates a simple property of an entity.
|
ODataResponse |
EntitySimplePropertyValueProcessor.updateEntitySimplePropertyValue(PutMergePatchUriInfo uriInfo,
InputStream content,
String requestContentType,
String contentType)
Updates a simple property of an entity with an unformatted value.
|
Modifier and Type | Method and Description |
---|---|
ODataResponse |
ContentTypeBasedDeserializer.writeBatchResponse(List<BatchResponsePart> batchResponseParts)
Returns an ODataResponse
|
ODataResponse |
ContentTypeBasedSerializer.writeEntry(EdmEntitySet entitySet,
Entity data)
Returns an OData Response for a given entry
|
ODataResponse |
ContentTypeBasedSerializer.writeFeed(EdmEntitySet entitySet,
EntityCollection data)
Returns an OData Response for a given feed
|
Modifier and Type | Method and Description |
---|---|
ODataResponse |
JsonSerializerDeserializer.writeBatchResponse(List<BatchResponsePart> batchResponseParts) |
ODataResponse |
AtomSerializerDeserializer.writeBatchResponse(List<BatchResponsePart> batchResponseParts) |
ODataResponse |
JsonSerializerDeserializer.writeEntry(EdmEntitySet entitySet,
Entity data) |
ODataResponse |
AtomSerializerDeserializer.writeEntry(EdmEntitySet entitySet,
Entity data) |
ODataResponse |
JsonSerializerDeserializer.writeFeed(EdmEntitySet entitySet,
EntityCollection data) |
ODataResponse |
AtomSerializerDeserializer.writeFeed(EdmEntitySet entitySet,
EntityCollection data) |
Modifier and Type | Method and Description |
---|---|
ODataResponse |
ODataJPAResponseBuilder.build(DeleteUriInfo deleteUriInfo,
Object deletedObject)
The method builds an OData response for an OData Delete Request from a deleted JPA Entity
|
ODataResponse |
ODataJPAResponseBuilder.build(GetEntityLinkUriInfo readLinkUriInfo,
Object jpaEntity,
String contentType)
The method builds an OData response for an OData Read Link Request from a read JPA Entity and its related JPA
Entities.
|
ODataResponse |
ODataJPAResponseBuilder.build(GetEntitySetLinksUriInfo queryLinkUriInfo,
List<Object> jpaEntity,
String contentType)
The method builds an OData response for an OData Query Link Request from a queried JPA Entity and its related JPA
Entities.
|
ODataResponse |
ODataJPAResponseBuilder.build(GetEntitySetUriInfo queryUriInfo,
List<Object> jpaEntities,
String contentType)
The method builds an OData response for an OData Query Request from a queried list of JPA Entities.
|
ODataResponse |
ODataJPAResponseBuilder.build(GetEntityUriInfo readUriInfo,
Object jpaEntity,
String contentType)
The method builds an OData response for an OData Read Request from a read JPA Entity
|
ODataResponse |
ODataJPAResponseBuilder.build(GetFunctionImportUriInfo functionImportUriInfo,
List<Object> resultList,
String contentType)
The method builds an OData response for an OData function Import Request from a registered processor method's
return parameter.
|
ODataResponse |
ODataJPAResponseBuilder.build(GetFunctionImportUriInfo functionImportUriInfo,
Object result)
The method builds an OData response for an OData function Import Request from a registered processor method's
return parameter.
|
ODataResponse |
ODataJPAResponseBuilder.build(long jpaEntityCount)
The method builds an OData response from a count representing total number of JPA Entities
|
ODataResponse |
ODataJPAResponseBuilder.build(PostUriInfo postUriInfo,
Object createdObject,
String contentType)
The method builds an OData response for an OData Create Request from a created JPA entity.
|
ODataResponse |
ODataJPAResponseBuilder.build(PutMergePatchUriInfo putUriInfo,
Object updatedObject)
The method builds an OData response for an OData Update Request from an updated JPA Entity
|
ODataResponse |
ODataJPADefaultProcessor.countEntitySet(GetEntitySetCountUriInfo uriParserResultView,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.createEntity(PostUriInfo uriParserResultView,
InputStream content,
String requestContentType,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.createEntityLink(PostUriInfo uriParserResultView,
InputStream content,
String requestContentType,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.deleteEntity(DeleteUriInfo uriParserResultView,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.deleteEntityLink(DeleteUriInfo uriParserResultView,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.executeBatch(BatchHandler handler,
String contentType,
InputStream content) |
ODataResponse |
ODataJPADefaultProcessor.executeFunctionImport(GetFunctionImportUriInfo uriParserResultView,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.executeFunctionImportValue(GetFunctionImportUriInfo uriParserResultView,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.existsEntity(GetEntityCountUriInfo uriInfo,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.readEntity(GetEntityUriInfo uriParserResultView,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.readEntityLink(GetEntityLinkUriInfo uriParserResultView,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.readEntityLinks(GetEntitySetLinksUriInfo uriParserResultView,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.readEntitySet(GetEntitySetUriInfo uriParserResultView,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.updateEntity(PutMergePatchUriInfo uriParserResultView,
InputStream content,
String requestContentType,
boolean merge,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.updateEntityLink(PutMergePatchUriInfo uriParserResultView,
InputStream content,
String requestContentType,
String contentType) |
Modifier and Type | Method and Description |
---|---|
ODataResponse |
ODataJPAErrorCallback.handleError(ODataErrorContext context) |
Modifier and Type | Method and Description |
---|---|
ODataResponse |
CustomODataJPAProcessor.readEntitySet(GetEntitySetUriInfo uriParserResultView,
String contentType) |
Copyright © 2013-2019 The Apache Software Foundation. All Rights Reserved.