| Package | Description | 
|---|---|
| org.apache.olingo.client.api | |
| org.apache.olingo.client.api.communication.request | |
| org.apache.olingo.client.api.communication.request.streamed | |
| org.apache.olingo.client.api.domain | |
| org.apache.olingo.client.api.serialization | |
| org.apache.olingo.commons.api.format | Contains all the format-related objects used for the handling of
 OData responses and OData requests. | 
| org.apache.olingo.netty.server.core | |
| org.apache.olingo.server.api | Olingo Server API
 The OData Library is a protocol implementation of the OData V4.0 standard. | 
| org.apache.olingo.server.api.processor | Olingo Processors
 Processors are used to handle OData requests and send back the OData reponse. | 
| org.apache.olingo.server.api.serializer | Olingo Server API - Serializer
 
 The serializer package is used to condense all about the Olingo serialization. | 
| Modifier and Type | Method and Description | 
|---|---|
| ContentType | Configuration. getDefaultBatchAcceptFormat()Gets the configured default Accept header value format for a batch request. | 
| ContentType | Configuration. getDefaultFormat()Gets the configured OData format. | 
| ContentType | Configuration. getDefaultMediaFormat()Gets the configured OData media format. | 
| ContentType | Configuration. getDefaultPubFormat()Gets the configured OData format for AtomPub exchanges. | 
| ContentType | Configuration. getDefaultValueFormat()Gets the configured OData value format. | 
| Modifier and Type | Method and Description | 
|---|---|
| ClientODataDeserializer | ODataClient. getDeserializer(ContentType contentType) | 
| ODataSerializer | ODataClient. getSerializer(ContentType contentType) | 
| void | Configuration. setDefaultBatchAcceptFormat(ContentType contentType)Set the default Accept header value format for a batch request. | 
| void | Configuration. setDefaultMediaFormat(ContentType format)Sets the default OData media format. | 
| void | Configuration. setDefaultPubFormat(ContentType format)Sets the default OData format for AtomPub exchanges. | 
| void | Configuration. setDefaultValueFormat(ContentType format)Sets the default OData value format. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | ODataBasicRequest. setFormat(ContentType contentType)Override configured request Content-Type. | 
| Modifier and Type | Method and Description | 
|---|---|
| ContentType | ODataStreamedEntityRequest. getFormat()Returns resource representation format. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | ODataStreamedEntityRequest. setFormat(ContentType contentType)Override configured request format. | 
| Constructor and Description | 
|---|
| ClientEntitySetIterator(ODataClient odataClient,
                       InputStream stream,
                       ContentType contentType)Constructor. | 
| Modifier and Type | Method and Description | 
|---|---|
| ClientEntity | ODataReader. readEntity(InputStream input,
          ContentType contentType)Parses a stream taking care to de-serializes the first OData entity found. | 
| ClientEntitySet | ODataReader. readEntitySet(InputStream input,
             ContentType contentType)De-Serializes a stream into an OData entity set. | 
| ODataError | ODataReader. readError(InputStream inputStream,
         ContentType contentType)Parses a stream into an OData error. | 
| ClientProperty | ODataReader. readProperty(InputStream input,
            ContentType contentType)Parses a stream taking care to de-serialize the first OData entity property found. | 
| ClientServiceDocument | ODataReader. readServiceDocument(InputStream input,
                   ContentType contentType)Parses an OData service document. | 
| InputStream | ODataWriter. writeEntities(Collection<ClientEntity> entities,
             ContentType contentType)Writes a collection of OData entities. | 
| InputStream | ODataWriter. writeEntity(ClientEntity entity,
           ContentType format)Serializes a single OData entity. | 
| InputStream | ODataWriter. writeLink(ClientLink link,
         ContentType format)Writes an OData link. | 
| InputStream | ODataWriter. writeProperty(ClientProperty property,
             ContentType format)Writes a single OData entity property. | 
| InputStream | ODataWriter. writeReference(ResWrap<URI> reference,
              ContentType format)Writes a entity reference | 
| Modifier and Type | Method and Description | 
|---|---|
| static ContentType | ContentType. create(ContentType contentType,
      String parameterName,
      String parameterValue)Creates a content type from an existing content type and an additional parameter as key-value pair. | 
| static ContentType | ContentType. create(String format)Creates a  ContentTypebased on given input string (format). | 
| static ContentType | ContentType. fromAcceptHeader(String accept)Uses the first MIME type from the accept header to determine the content type. | 
| static ContentType | ContentType. parse(String format)Parses the given input string ( format) and returns createdContentTypeif input was valid or
 returnNULLif input was not parseable. | 
| Modifier and Type | Method and Description | 
|---|---|
| static ContentType | ContentType. create(ContentType contentType,
      String parameterName,
      String parameterValue)Creates a content type from an existing content type and an additional parameter as key-value pair. | 
| static List<AcceptType> | AcceptType. fromContentType(ContentType contentType)Creates a list of  AcceptTypeobjects based on given content type. | 
| boolean | ContentType. isCompatible(ContentType other) | 
| boolean | AcceptType. matches(ContentType contentType)Determines whether this accept type matches a given content type. | 
| Modifier and Type | Method and Description | 
|---|---|
| abstract ODataDeserializer | OData. createDeserializer(ContentType contentType)Creates a new deserializer object for reading content in the specified format. | 
| abstract ODataDeserializer | OData. createDeserializer(ContentType contentType,
                  List<String> versions)Creates a new deserializer object for reading content in the specified format. | 
| abstract ODataDeserializer | OData. createDeserializer(ContentType contentType,
                  ServiceMetadata metadata)Creates a new deserializer object for reading content in the specified format. | 
| abstract ODataDeserializer | OData. createDeserializer(ContentType contentType,
                  ServiceMetadata metadata,
                  List<String> versions)Creates a new deserializer object for reading content in the specified format. | 
| abstract EdmAssistedSerializer | OData. createEdmAssistedSerializer(ContentType contentType)Creates a new serializer object capable of working without EDM information
 for rendering content in the specified format. | 
| abstract EdmAssistedSerializer | OData. createEdmAssistedSerializer(ContentType contentType,
                           List<String> versions)Creates a new serializer object capable of working without EDM information
 for rendering content in the specified format. | 
| abstract EdmDeltaSerializer | OData. createEdmDeltaSerializer(ContentType contentType,
                        List<String> versions)Creates a new serializer object capable of working without EDM information
 for rendering delta content in the specified format. | 
| abstract ODataSerializer | OData. createSerializer(ContentType contentType)Creates a new serializer object for rendering content in the specified format. | 
| abstract ODataSerializer | OData. createSerializer(ContentType contentType,
                List<String> versions)Creates a new serializer object for rendering content in the specified format. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | EntityProcessor. createEntity(ODataRequest request,
            ODataResponse response,
            UriInfo uriInfo,
            ContentType requestFormat,
            ContentType responseFormat)Creates an entity with send data in the persistence and puts content, status, and Location into the response. | 
| void | MediaEntityProcessor. createMediaEntity(ODataRequest request,
                 ODataResponse response,
                 UriInfo uriInfo,
                 ContentType requestFormat,
                 ContentType responseFormat)Creates an entity with sent media data in the persistence and puts content, status and Location into the response. | 
| void | ReferenceProcessor. createReference(ODataRequest request,
               ODataResponse response,
               UriInfo uriInfo,
               ContentType requestFormat)Creates entity reference in the persistence and puts content, status, and Location into the response. | 
| void | ActionComplexProcessor. processActionComplex(ODataRequest request,
                    ODataResponse response,
                    UriInfo uriInfo,
                    ContentType requestFormat,
                    ContentType responseFormat)Process an action which has as return type a complex type. | 
| void | ActionComplexCollectionProcessor. processActionComplexCollection(ODataRequest request,
                              ODataResponse response,
                              UriInfo uriInfo,
                              ContentType requestFormat,
                              ContentType responseFormat)Process an action which has as return type a complex-type collection. | 
| void | ActionEntityProcessor. processActionEntity(ODataRequest request,
                   ODataResponse response,
                   UriInfo uriInfo,
                   ContentType requestFormat,
                   ContentType responseFormat)Process an action which has as return type an entity. | 
| void | ActionEntityCollectionProcessor. processActionEntityCollection(ODataRequest request,
                             ODataResponse response,
                             UriInfo uriInfo,
                             ContentType requestFormat,
                             ContentType responseFormat)Process an action which has as return type a collection of entities. | 
| void | ActionPrimitiveProcessor. processActionPrimitive(ODataRequest request,
                      ODataResponse response,
                      UriInfo uriInfo,
                      ContentType requestFormat,
                      ContentType responseFormat)Process an action which has as return type a primitive-type. | 
| void | ActionPrimitiveCollectionProcessor. processActionPrimitiveCollection(ODataRequest request,
                                ODataResponse response,
                                UriInfo uriInfo,
                                ContentType requestFormat,
                                ContentType responseFormat)Process an action which has as return type a primitive-type collection. | 
| void | ActionVoidProcessor. processActionVoid(ODataRequest request,
                 ODataResponse response,
                 UriInfo uriInfo,
                 ContentType requestFormat)Process an action which has no return type. | 
| void | DefaultProcessor. processError(ODataRequest request,
            ODataResponse response,
            ODataServerError serverError,
            ContentType requestedContentType) | 
| void | ErrorProcessor. processError(ODataRequest request,
            ODataResponse response,
            ODataServerError serverError,
            ContentType responseFormat)Processes an error/exception. | 
| void | ComplexProcessor. readComplex(ODataRequest request,
           ODataResponse response,
           UriInfo uriInfo,
           ContentType responseFormat)Reads complex-type instance. | 
| void | ComplexCollectionProcessor. readComplexCollection(ODataRequest request,
                     ODataResponse response,
                     UriInfo uriInfo,
                     ContentType responseFormat)Reads complex-type collection. | 
| void | EntityProcessor. readEntity(ODataRequest request,
          ODataResponse response,
          UriInfo uriInfo,
          ContentType responseFormat)Reads entity data from persistence and puts serialized content and status into the response. | 
| void | EntityCollectionProcessor. readEntityCollection(ODataRequest request,
                    ODataResponse response,
                    UriInfo uriInfo,
                    ContentType responseFormat)Reads entities data from persistence and puts serialized content and status into the response. | 
| void | MediaEntityProcessor. readMediaEntity(ODataRequest request,
               ODataResponse response,
               UriInfo uriInfo,
               ContentType responseFormat)Reads entity media data from persistence and puts content and status into the response. | 
| void | DefaultProcessor. readMetadata(ODataRequest request,
            ODataResponse response,
            UriInfo uriInfo,
            ContentType requestedContentType) | 
| void | MetadataProcessor. readMetadata(ODataRequest request,
            ODataResponse response,
            UriInfo uriInfo,
            ContentType responseFormat)Reads data from persistence and puts serialized content and status into the response. | 
| void | PrimitiveProcessor. readPrimitive(ODataRequest request,
             ODataResponse response,
             UriInfo uriInfo,
             ContentType responseFormat)Reads primitive-type instance. | 
| void | PrimitiveCollectionProcessor. readPrimitiveCollection(ODataRequest request,
                       ODataResponse response,
                       UriInfo uriInfo,
                       ContentType responseFormat)Reads primitive-type collection. | 
| void | PrimitiveValueProcessor. readPrimitiveValue(ODataRequest request,
                  ODataResponse response,
                  UriInfo uriInfo,
                  ContentType responseFormat)Reads raw value of a primitive-type instance, e.g., of a primitive property of an entity. | 
| void | ReferenceProcessor. readReference(ODataRequest request,
             ODataResponse response,
             UriInfo uriInfo,
             ContentType responseFormat)Reads entity reference from persistence and put it as serialized content and status into the response. | 
| void | ReferenceCollectionProcessor. readReferenceCollection(ODataRequest request,
                       ODataResponse response,
                       UriInfo uriInfo,
                       ContentType responseFormat)Reads entity references from persistence and put them as serialized content and with
 according status into the response. | 
| void | ServiceDocumentProcessor. readServiceDocument(ODataRequest request,
                   ODataResponse response,
                   UriInfo uriInfo,
                   ContentType responseFormat)Reads service-document information from persistence and puts serialized content and status into the response. | 
| void | DefaultProcessor. readServiceDocument(ODataRequest request,
                   ODataResponse response,
                   UriInfo uriInfo,
                   ContentType requestedContentType) | 
| void | ComplexProcessor. updateComplex(ODataRequest request,
             ODataResponse response,
             UriInfo uriInfo,
             ContentType requestFormat,
             ContentType responseFormat)Update complex-type instance with send data in the persistence and
 puts content, status, and Location into the response. | 
| void | ComplexCollectionProcessor. updateComplexCollection(ODataRequest request,
                       ODataResponse response,
                       UriInfo uriInfo,
                       ContentType requestFormat,
                       ContentType responseFormat)Update (replace) complex-type collection with send data in the persistence and
 puts content, status, and Location into the response. | 
| void | EntityProcessor. updateEntity(ODataRequest request,
            ODataResponse response,
            UriInfo uriInfo,
            ContentType requestFormat,
            ContentType responseFormat)Update entity data with send data in the persistence and puts content, status, and Location into the response. | 
| void | MediaEntityProcessor. updateMediaEntity(ODataRequest request,
                 ODataResponse response,
                 UriInfo uriInfo,
                 ContentType requestFormat,
                 ContentType responseFormat)Updates entity media data in the persistence and puts content and status into the response. | 
| void | PrimitiveProcessor. updatePrimitive(ODataRequest request,
               ODataResponse response,
               UriInfo uriInfo,
               ContentType requestFormat,
               ContentType responseFormat)Update primitive-type instance with send data in the persistence and
 puts content, status, and Location into the response. | 
| void | PrimitiveCollectionProcessor. updatePrimitiveCollection(ODataRequest request,
                         ODataResponse response,
                         UriInfo uriInfo,
                         ContentType requestFormat,
                         ContentType responseFormat)Update (replace) primitive-type collection with send data in the persistence and
 puts content, status, and Location into the response. | 
| void | PrimitiveValueProcessor. updatePrimitiveValue(ODataRequest request,
                    ODataResponse response,
                    UriInfo uriInfo,
                    ContentType requestFormat,
                    ContentType responseFormat)Update primitive-type instance with sent raw data in the persistence and
 puts content, status, and Location into the response. | 
| void | ReferenceProcessor. updateReference(ODataRequest request,
               ODataResponse response,
               UriInfo uriInfo,
               ContentType requestFormat)Update entity reference in the persistence and puts content, status, and Location into the response. | 
| Modifier and Type | Method and Description | 
|---|---|
| List<ContentType> | CustomContentTypeSupport. modifySupportedContentTypes(List<ContentType> defaultContentTypes,
                           RepresentationType type)Returns a list of supported content types. | 
| Modifier and Type | Method and Description | 
|---|---|
| List<ContentType> | CustomContentTypeSupport. modifySupportedContentTypes(List<ContentType> defaultContentTypes,
                           RepresentationType type)Returns a list of supported content types. | 
Copyright © 2013–2023 The Apache Software Foundation. All rights reserved.