org.apache.olingo.server.tecsvc.processor

Class TechnicalEntityProcessor

java.lang.Object

org.apache.olingo.server.tecsvc.processor.TechnicalProcessor

org.apache.olingo.server.tecsvc.processor.TechnicalEntityProcessor

All Implemented Interfaces:

CountEntityCollectionProcessor, EntityCollectionProcessor, EntityProcessor, MediaEntityProcessor, Processor, ReferenceCollectionProcessor, ReferenceProcessor

public class TechnicalEntityProcessor
extends TechnicalProcessor
implements EntityCollectionProcessor, CountEntityCollectionProcessor, EntityProcessor, MediaEntityProcessor, ReferenceCollectionProcessor, ReferenceProcessor

Technical Processor for entity-related functionality.

Field Summary

Fields inherited from class org.apache.olingo.server.tecsvc.processor.TechnicalProcessor

dataProvider, odata, serviceMetadata

Constructor Summary

Constructors

Constructor and Description
TechnicalEntityProcessor(DataProvider dataProvider, ServiceMetadata serviceMetadata)

Method Summary

Methods

Modifier and Type	Method and Description
void	countEntityCollection(ODataRequest request, ODataResponse response, UriInfo uriInfo) Counts entities from persistence and puts serialized content and status into the response.
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	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	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	deleteEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo) Deletes entity from persistence and puts the status into the response.
void	deleteMediaEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo) Deletes entity media data and associated entity from persistence and puts the status into the response.
void	deleteReference(ODataRequest request, ODataResponse response, UriInfo uriInfo) Deletes reference to an entity from persistence and puts the status into the response.
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	readMediaEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType responseFormat) Reads entity media data from persistence and puts content and status into the response.
void	readReference(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType requestedContentType) Reads entity reference from persistence and put it as serialized content and status into the response.
void	readReferenceCollection(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType requestedContentType) Reads entity references from persistence and put them as serialized content and with according status 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	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	updateReference(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType requestFormat) Update entity reference in the persistence and puts content, status, and Location into the response.

Methods inherited from class org.apache.olingo.server.tecsvc.processor.TechnicalProcessor

blockBoundActions, checkRequestFormat, getEdmEntitySet, getLastNavigation, init, isODataMetadataNone, readEntity, readEntity, readEntityCollection, validateOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

TechnicalEntityProcessor

public TechnicalEntityProcessor(DataProvider dataProvider,
                        ServiceMetadata serviceMetadata)

Method Detail

readEntityCollection

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

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

ODataLibraryException

countEntityCollection

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

Description copied from interface: CountEntityCollectionProcessor

Counts entities from persistence and puts serialized content and status into the response. Response content type is text/plain by default.

Specified by:

countEntityCollection in interface CountEntityCollectionProcessor

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

readEntity

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

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

ODataLibraryException

readMediaEntity

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

Description copied from interface: MediaEntityProcessor

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

Specified by:

readMediaEntity in interface MediaEntityProcessor

Parameters:

request - OData request object containing raw HTTP information

response - OData response object for collecting response data

uriInfo - information of a parsed OData URI

responseFormat - requested content type after content negotiation

Throws:

ODataApplicationException - if the service implementation encounters a failure

ODataLibraryException

createMediaEntity

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

Description copied from interface: MediaEntityProcessor

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

Specified by:

createMediaEntity in interface MediaEntityProcessor

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

createEntity

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

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

ODataLibraryException

updateEntity

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

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

ODataLibraryException

updateMediaEntity

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

Description copied from interface: MediaEntityProcessor

Updates entity media data in the persistence and puts content and status into the response.

Specified by:

updateMediaEntity in interface MediaEntityProcessor

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

deleteEntity

public void deleteEntity(ODataRequest request,
                ODataResponse response,
                UriInfo uriInfo)
                  throws ODataLibraryException,
                         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:

ODataLibraryException

ODataApplicationException - if the service implementation encounters a failure

deleteMediaEntity

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

Description copied from interface: MediaEntityProcessor

Deletes entity media data and associated entity from persistence and puts the status into the response.

Specified by:

deleteMediaEntity in interface MediaEntityProcessor

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:

ODataLibraryException

ODataApplicationException - if the service implementation encounters a failure

readReference

public void readReference(ODataRequest request,
                 ODataResponse response,
                 UriInfo uriInfo,
                 ContentType requestedContentType)
                   throws ODataApplicationException,
                          ODataLibraryException

Description copied from interface: ReferenceProcessor

Reads entity reference from persistence and put it as serialized content and status into the response.

Specified by:

readReference in interface ReferenceProcessor

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

ODataLibraryException

createReference

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

Description copied from interface: ReferenceProcessor

Creates entity reference in the persistence and puts content, status, and Location into the response.

Specified by:

createReference in interface ReferenceProcessor

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

Throws:

ODataApplicationException - if the service implementation encounters a failure

ODataLibraryException

updateReference

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

Description copied from interface: ReferenceProcessor

Update entity reference in the persistence and puts content, status, and Location into the response.

Specified by:

updateReference in interface ReferenceProcessor

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

Throws:

ODataApplicationException - if the service implementation encounters a failure

ODataLibraryException

deleteReference

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

Description copied from interface: ReferenceProcessor

Deletes reference to an entity from persistence and puts the status into the response. Delete on a reference only removes the reference to and not the entity itself (see chapter "11.4.6.2 Remove a Reference to an Entity")

Specified by:

deleteReference in interface ReferenceProcessor

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

readReferenceCollection

public void readReferenceCollection(ODataRequest request,
                           ODataResponse response,
                           UriInfo uriInfo,
                           ContentType requestedContentType)
                             throws ODataApplicationException,
                                    ODataLibraryException

Description copied from interface: ReferenceCollectionProcessor

Reads entity references from persistence and put them as serialized content and with according status into the response.

Specified by:

readReferenceCollection in interface ReferenceCollectionProcessor

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

ODataLibraryException