org.apache.olingo.server.sample.processor

Class CarsProcessor

java.lang.Object

org.apache.olingo.server.sample.processor.CarsProcessor

All Implemented Interfaces:

ComplexProcessor, EntityCollectionProcessor, EntityProcessor, PrimitiveProcessor, PrimitiveValueProcessor, Processor

public class CarsProcessor
extends Object
implements EntityCollectionProcessor, EntityProcessor, PrimitiveProcessor, PrimitiveValueProcessor, ComplexProcessor

This processor will deliver entity collections, single entities as well as properties of an entity. This is a very simple example which should give you a rough guideline on how to implement such an processor. See the JavaDoc of the server.api interfaces for more information.

Constructor Summary

Constructors

Constructor and Description
CarsProcessor(DataProvider dataProvider)

Method Summary

Methods

Modifier and Type	Method and Description
void	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	deleteComplex(ODataRequest request, ODataResponse response, UriInfo uriInfo) Deletes complex-type value from an entity and puts the status into the response.
void	deleteEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo) Deletes entity from persistence and puts the status into the response.
void	deletePrimitive(ODataRequest request, ODataResponse response, UriInfo uriInfo) Deletes primitive-type value from an entity and puts the status into the response.
void	deletePrimitiveValue(ODataRequest request, ODataResponse response, UriInfo uriInfo) Deletes primitive-type raw value from an entity and puts the status into the response.
void	init(OData odata, ServiceMetadata edm) Initializes the processor for each HTTP request - response cycle.
static boolean	isODataMetadataNone(ContentType contentType)
void	readComplex(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType format) Reads complex-type instance.
void	readEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType requestedContentType) Reads entity data from persistence and puts serialized content and status into the response.
void	readEntityCollection(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType requestedContentType) Reads entities data from persistence and puts serialized content and status into the response.
void	readPrimitive(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType format) Reads primitive-type instance.
void	readPrimitiveValue(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType format) Reads raw value of a primitive-type instance, e.g., of a primitive property of an entity.
void	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	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	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	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CarsProcessor

public CarsProcessor(DataProvider dataProvider)

Method Detail

init

public void init(OData odata,
        ServiceMetadata edm)

Description copied from interface: Processor

Initializes the processor for each HTTP request - response cycle.

Specified by:

init in interface Processor

Parameters:

odata - Olingo's root object, acting as a factory for various object types

edm - metadata of the OData service like the EDM that have to be created before the OData request handling takes place

readEntityCollection

public void readEntityCollection(ODataRequest request,
                        ODataResponse response,
                        UriInfo uriInfo,
                        ContentType requestedContentType)
                          throws ODataApplicationException,
                                 SerializerException

Description copied from interface: EntityCollectionProcessor

Reads entities data from persistence and puts serialized content and status into the response.

Specified by:

readEntityCollection in interface EntityCollectionProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

requestedContentType - requested content type after content negotiation

Throws:

ODataApplicationException - if the service implementation encounters a failure

SerializerException

readEntity

public void readEntity(ODataRequest request,
              ODataResponse response,
              UriInfo uriInfo,
              ContentType requestedContentType)
                throws ODataApplicationException,
                       SerializerException

Description copied from interface: EntityProcessor

Reads entity data from persistence and puts serialized content and status into the response.

Specified by:

readEntity in interface EntityProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

requestedContentType - requested content type after content negotiation

Throws:

ODataApplicationException - if the service implementation encounters a failure

SerializerException

createEntity

public void createEntity(ODataRequest request,
                ODataResponse response,
                UriInfo uriInfo,
                ContentType requestFormat,
                ContentType responseFormat)
                  throws ODataApplicationException,
                         DeserializerException,
                         SerializerException

Description copied from interface: EntityProcessor

Creates an entity with send data in the persistence and puts content, status, and Location into the response.

Specified by:

createEntity in interface EntityProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

requestFormat - content type of body sent with request

responseFormat - requested content type after content negotiation

Throws:

ODataApplicationException - if the service implementation encounters a failure

DeserializerException

SerializerException

deleteEntity

public void deleteEntity(ODataRequest request,
                ODataResponse response,
                UriInfo uriInfo)
                  throws ODataApplicationException

Description copied from interface: EntityProcessor

Deletes entity from persistence and puts the status into the response.

Specified by:

deleteEntity in interface EntityProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

Throws:

ODataApplicationException - if the service implementation encounters a failure

readPrimitive

public void readPrimitive(ODataRequest request,
                 ODataResponse response,
                 UriInfo uriInfo,
                 ContentType format)
                   throws ODataApplicationException,
                          SerializerException

Description copied from interface: PrimitiveProcessor

Reads primitive-type instance. If its value is null, the service responds with 204 No Content. If it is not available, for example due to permissions, the service responds with 404 Not Found.

Specified by:

readPrimitive in interface PrimitiveProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

format - requested content type after content negotiation

Throws:

ODataApplicationException - if the service implementation encounters a failure

SerializerException

readComplex

public void readComplex(ODataRequest request,
               ODataResponse response,
               UriInfo uriInfo,
               ContentType format)
                 throws ODataApplicationException,
                        SerializerException

Description copied from interface: ComplexProcessor

Reads complex-type instance. If it is not available, for example due to permissions, the service responds with 404 Not Found.

Specified by:

readComplex in interface ComplexProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

format - requested content type after content negotiation

Throws:

ODataApplicationException - if the service implementation encounters a failure

SerializerException

readPrimitiveValue

public void readPrimitiveValue(ODataRequest request,
                      ODataResponse response,
                      UriInfo uriInfo,
                      ContentType format)
                        throws ODataApplicationException,
                               SerializerException

Description copied from interface: PrimitiveValueProcessor

Reads raw value of a primitive-type instance, e.g., of a primitive property of an entity. If the value is null, the service responds with 204 No Content. If it is not available, for example due to permissions, the service responds with 404 Not Found.

Specified by:

readPrimitiveValue in interface PrimitiveValueProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

format - requested content type after content negotiation

Throws:

ODataApplicationException - if the service implementation encounters a failure

SerializerException

updatePrimitive

public void updatePrimitive(ODataRequest request,
                   ODataResponse response,
                   UriInfo uriInfo,
                   ContentType requestFormat,
                   ContentType responseFormat)
                     throws ODataApplicationException,
                            DeserializerException,
                            SerializerException

Description copied from interface: PrimitiveProcessor

Update primitive-type instance with send data in the persistence and puts content, status, and Location into the response.

Specified by:

updatePrimitive in interface PrimitiveProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

requestFormat - content type of body sent with request

responseFormat - requested content type after content negotiation

Throws:

ODataApplicationException - if the service implementation encounters a failure

DeserializerException

SerializerException

updatePrimitiveValue

public void updatePrimitiveValue(ODataRequest request,
                        ODataResponse response,
                        UriInfo uriInfo,
                        ContentType requestFormat,
                        ContentType responseFormat)
                          throws ODataApplicationException,
                                 ODataLibraryException

Description copied from interface: PrimitiveValueProcessor

Update primitive-type instance with sent raw data in the persistence and puts content, status, and Location into the response.

Specified by:

updatePrimitiveValue in interface PrimitiveValueProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

requestFormat - content type of body sent with request

responseFormat - requested content type after content negotiation

Throws:

ODataApplicationException - if the service implementation encounters a failure

ODataLibraryException

deletePrimitive

public void deletePrimitive(ODataRequest request,
                   ODataResponse response,
                   UriInfo uriInfo)
                     throws ODataApplicationException

Description copied from interface: PrimitiveProcessor

Deletes primitive-type value from an entity and puts the status into the response. Deletion for primitive-type values is equal to set the value to NULL (see chapter "11.4.9.2 Set a Value to Null")

Specified by:

deletePrimitive in interface PrimitiveProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

Throws:

ODataApplicationException - if the service implementation encounters a failure

deletePrimitiveValue

public void deletePrimitiveValue(ODataRequest request,
                        ODataResponse response,
                        UriInfo uriInfo)
                          throws ODataApplicationException,
                                 ODataLibraryException

Description copied from interface: PrimitiveValueProcessor

Deletes primitive-type raw value from an entity and puts the status into the response. Deletion of a primitive-type value is equivalent to setting the value to null.

Specified by:

deletePrimitiveValue in interface PrimitiveValueProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

Throws:

ODataApplicationException - if the service implementation encounters a failure

ODataLibraryException

updateComplex

public void updateComplex(ODataRequest request,
                 ODataResponse response,
                 UriInfo uriInfo,
                 ContentType requestFormat,
                 ContentType responseFormat)
                   throws ODataApplicationException,
                          DeserializerException,
                          SerializerException

Description copied from interface: ComplexProcessor

Update complex-type instance with send data in the persistence and puts content, status, and Location into the response.

Specified by:

updateComplex in interface ComplexProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

requestFormat - content type of body sent with request

responseFormat - requested content type after content negotiation

Throws:

ODataApplicationException - if the service implementation encounters a failure

DeserializerException

SerializerException

deleteComplex

public void deleteComplex(ODataRequest request,
                 ODataResponse response,
                 UriInfo uriInfo)
                   throws ODataApplicationException

Description copied from interface: ComplexProcessor

Deletes complex-type value from an entity and puts the status into the response. Deletion for complex-type values is equal to set the value to NULL (see chapter "11.4.9.2 Set a Value to Null")

Specified by:

deleteComplex in interface ComplexProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

Throws:

ODataApplicationException - if the service implementation encounters a failure

updateEntity

public void updateEntity(ODataRequest request,
                ODataResponse response,
                UriInfo uriInfo,
                ContentType requestFormat,
                ContentType responseFormat)
                  throws ODataApplicationException,
                         DeserializerException,
                         SerializerException

Description copied from interface: EntityProcessor

Update entity data with send data in the persistence and puts content, status, and Location into the response.

Specified by:

updateEntity in interface EntityProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

requestFormat - content type of body sent with request

responseFormat - requested content type after content negotiation

Throws:

ODataApplicationException - if the service implementation encounters a failure

DeserializerException

SerializerException

isODataMetadataNone

public static boolean isODataMetadataNone(ContentType contentType)