Package | Description |
---|---|
org.apache.olingo.odata2.annotation.processor.api |
Annotations-API for Entity Data Model definition
The core API package contains contains the AnnotationServiceFactory as entry point
to an implementation (core) of the Annotations-API for Entity Data Model definition.
|
org.apache.olingo.odata2.annotation.processor.ref | |
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.edm |
Entity Data Model API
The Entity Data Model is described in the OData protocol specification
as well as in the Conceptual Schema Definition for the OData Protocol.
|
org.apache.olingo.odata2.api.edm.provider |
Entity Data Model Provider API
Classes in this package are used to provide an EDM to the library as well as to the application.
|
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.exception |
Exception Classes used in the OData library as well as the implementing application
APPLICATION DEVELOPERS: Please use
ODataApplicationException for
custom exceptions. |
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.feature |
Processor Features
Optional feature interfaces.
|
org.apache.olingo.odata2.api.processor.part |
Processor Parts
|
org.apache.olingo.odata2.api.uri |
URI Parser Facade
The URI package has one central class
UriParser to parse a request URI
as well as several interfaces that provide access to parsed parts of the URI. |
org.apache.olingo.odata2.api.uri.expression |
Expression Parser
This package contains all classes necessary to decribe an expression tree(e.g. a filter or order by tree)
Trees can be traversed by implementing the
ExpressionVisitor
interface and calling the accept() method. |
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.extension | |
org.apache.olingo.odata2.jpa.processor.ref.util | |
org.apache.olingo.odata2.ref.edm | |
org.apache.olingo.odata2.ref.processor |
Modifier and Type | Method and Description |
---|---|
static ODataService |
AnnotationServiceFactory.createAnnotationService(Collection<Class<?>> annotatedClasses)
Create an
ODataService which is based on an EDM and Processor which are using the annotations from
org.apache.olingo.olingo-odata2-api-annotation module
(see package org.apache.olingo.odata2.api.annotation.edm ) to define the model and access the data. |
ODataService |
AnnotationServiceFactory.AnnotationServiceFactoryInstance.createAnnotationService(Collection<Class<?>> annotatedClasses)
Create an
ODataService which is based on an EDM and Processor which are using the annotations from
org.apache.olingo.olingo-odata2-api-annotation module
(see package org.apache.olingo.odata2.api.annotation.edm ) to define the model and access the data. |
static ODataService |
AnnotationServiceFactory.createAnnotationService(String modelPackage)
Create an
ODataService which is based on an EDM and Processor which are using the annotations from
org.apache.olingo.olingo-odata2-api-annotation module
(see package org.apache.olingo.odata2.api.annotation.edm ) to define the model and access the data. |
ODataService |
AnnotationServiceFactory.AnnotationServiceFactoryInstance.createAnnotationService(String modelPackage)
Create an
ODataService which is based on an EDM and Processor which are using the annotations from
org.apache.olingo.olingo-odata2-api-annotation module
(see package org.apache.olingo.odata2.api.annotation.edm ) to define the model and access the data. |
Modifier and Type | Method and Description |
---|---|
ODataService |
AnnotationRefServiceFactory.createService(ODataContext context) |
Modifier and Type | Class and Description |
---|---|
class |
BatchException |
Modifier and Type | Method and Description |
---|---|
BatchResponsePart |
BatchHandler.handleBatchPart(BatchRequestPart batchRequestPart)
Handles the
BatchRequestPart in a way that it results in a corresponding BatchResponsePart . |
ODataResponse |
BatchHandler.handleRequest(ODataRequest request)
Delegates a handling of the request
ODataRequest to the request handler and provides ODataResponse
ODataResponse . |
Modifier and Type | Class and Description |
---|---|
class |
EdmException |
class |
EdmLiteralException |
class |
EdmSimpleTypeException |
Modifier and Type | Method and Description |
---|---|
String |
EdmServiceMetadata.getDataServiceVersion() |
List<EdmEntitySetInfo> |
EdmServiceMetadata.getEntitySetInfos() |
InputStream |
EdmServiceMetadata.getMetadata() |
Modifier and Type | Method and Description |
---|---|
List<AliasInfo> |
EdmProvider.getAliasInfos()
This method should return a list of all defined aliases and their associated namespace.
|
Association |
EdmProvider.getAssociation(FullQualifiedName edmFQName)
This method should return an
Association or null if nothing is found |
AssociationSet |
EdmProvider.getAssociationSet(String entityContainer,
FullQualifiedName association,
String sourceEntitySetName,
String sourceEntitySetRole)
This method should return an
AssociationSet or null if nothing is found |
ComplexType |
EdmProvider.getComplexType(FullQualifiedName edmFQName)
This method should return a
ComplexType or null if nothing is found |
EntityContainerInfo |
EdmProvider.getEntityContainerInfo(String name)
This method should return an
EntityContainerInfo or null if nothing is found |
EntitySet |
EdmProvider.getEntitySet(String entityContainer,
String name)
This method should return an
EntitySet or null if nothing is found |
EntityType |
EdmProvider.getEntityType(FullQualifiedName edmFQName)
This method should return an
EntityType or null if nothing is found |
FunctionImport |
EdmProvider.getFunctionImport(String entityContainer,
String name)
This method should return a
FunctionImport or null if nothing is found |
List<Schema> |
EdmProvider.getSchemas()
This method should return a collection of all
Schema or null if nothing is found |
Modifier and Type | Class and Description |
---|---|
class |
EntityProviderException
An
EntityProviderException is the base exception for all EntityProvider related exceptions. |
Modifier and Type | Class and Description |
---|---|
class |
ODataApplicationException
This class represents a translated application exception.
|
class |
ODataBadRequestException
Exceptions of this class will result in a HTTP status 400 bad request
|
class |
ODataConflictException
Exceptions of this class will result in a HTTP status 409 Conflict
|
class |
ODataForbiddenException
Exceptions of this class will result in a HTTP status 403 forbidden
|
class |
ODataHttpException
ODataMessageException with a HTTP status code. |
class |
ODataInternalServerErrorException |
class |
ODataMessageException
DO NOT EXTEND THIS EXCEPTION
APPLICATION DEVELOPERS: please use
ODataApplicationException o throw custom exceptions. |
class |
ODataMethodNotAllowedException
Exceptions of this class will result in a HTTP status 405 (method not allowed).
|
class |
ODataNotAcceptableException
Exceptions of this class will result in a HTTP status 406 not acceptable
|
class |
ODataNotFoundException
Exceptions of this class will result in a HTTP status 404 not found
|
class |
ODataNotImplementedException
Exceptions of this class will result in a HTTP status 501 (Not implemented).
|
class |
ODataPreconditionFailedException
Exceptions of this class will result in a HTTP Status 412 Precondition Failed.
|
class |
ODataPreconditionRequiredException
Exceptions of this class will result in a HTTP status 428 precondition required
|
class |
ODataServiceUnavailableException
Exceptions of this class will result in a HTTP status 503 service unavailable
|
class |
ODataUnsupportedMediaTypeException
Exceptions of this class will result in a HTTP status 415 unsupported media type
|
Modifier and Type | Method and Description |
---|---|
static MessageReference |
MessageReference.create(Class<? extends ODataException> clazz,
String key)
|
Modifier and Type | Method and Description |
---|---|
List<String> |
CustomContentType.getCustomContentTypes(Class<? extends ODataProcessor> processorFeature)
The OData library will consider these additional content types during negotiation of http content type header.
|
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 |
BatchResponsePart |
BatchProcessor.executeChangeSet(BatchHandler handler,
List<ODataRequest> requests)
Executes a Change Set and provide BatchResponsePart as
BatchResponsePart that contains the responses to
change requests. |
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 | Class and Description |
---|---|
class |
UriNotMatchingException
URI-parsing exception resulting in a 404 Not Found response.
|
class |
UriSyntaxException
Exception for violation of the OData URI construction rules,
resulting in a 400 Bad Request response.
|
Modifier and Type | Method and Description |
---|---|
abstract List<KeyPredicate> |
UriParser.getKeyFromEntityLink(EdmEntitySet entitySet,
String entityLink,
URI serviceRoot)
Retrieves the key predicates from a canonical link to an entity.
|
static List<KeyPredicate> |
UriParser.getKeyPredicatesFromEntityLink(EdmEntitySet entitySet,
String entityLink,
URI serviceRoot)
Retrieves the key predicates from a canonical link to an entity.
|
static UriInfo |
UriParser.parse(Edm edm,
List<PathSegment> pathSegments,
Map<String,String> queryParameters)
Parses path segments and query parameters for the given EDM.
|
Modifier and Type | Class and Description |
---|---|
class |
ExceptionVisitExpression
Exception thrown while traversing/visiting a filter expression tree
|
class |
ExpressionParserException
Exception thrown while parsing a filter or orderby expression
|
Modifier and Type | Method and Description |
---|---|
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) |
ODataService |
ODataJPAServiceFactory.createService(ODataContext ctx)
Creates an OData Service based on the values set in
ODataJPAContext and
ODataContext . |
ODataResponse |
ODataJPADefaultProcessor.deleteEntity(DeleteUriInfo uriParserResultView,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.deleteEntityLink(DeleteUriInfo uriParserResultView,
String contentType) |
ODataResponse |
ODataJPADefaultProcessor.executeBatch(BatchHandler handler,
String contentType,
InputStream content) |
BatchResponsePart |
ODataJPADefaultProcessor.executeChangeSet(BatchHandler handler,
List<ODataRequest> requests) |
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 | Class and Description |
---|---|
class |
ODataJPAException
The exception class is the base of OData JPA exceptions.
|
class |
ODataJPAModelException
The exception is thrown for any unexpected errors raising while
accessing/transforming Java Persistence Models.
|
class |
ODataJPARuntimeException
The exception is thrown for any unexpected errors raising while accessing
data from Java Persistence Models.
|
Modifier and Type | Method and Description |
---|---|
SalesOrderHeader |
SalesOrderHeaderProcessor.calculateNetAmount(Long soID) |
Modifier and Type | Method and Description |
---|---|
ODataResponse |
CustomODataJPAProcessor.readEntitySet(GetEntitySetUriInfo uriParserResultView,
String contentType) |
Modifier and Type | Method and Description |
---|---|
Association |
ScenarioEdmProvider.getAssociation(FullQualifiedName edmFQName) |
AssociationSet |
ScenarioEdmProvider.getAssociationSet(String entityContainer,
FullQualifiedName association,
String sourceEntitySetName,
String sourceEntitySetRole) |
ComplexType |
ScenarioEdmProvider.getComplexType(FullQualifiedName edmFQName) |
EntityContainerInfo |
ScenarioEdmProvider.getEntityContainerInfo(String name) |
EntitySet |
ScenarioEdmProvider.getEntitySet(String entityContainer,
String name) |
EntityType |
ScenarioEdmProvider.getEntityType(FullQualifiedName edmFQName) |
FunctionImport |
ScenarioEdmProvider.getFunctionImport(String entityContainer,
String name) |
List<Schema> |
ScenarioEdmProvider.getSchemas() |
Copyright © 2013-2019 The Apache Software Foundation. All Rights Reserved.