org.apache.olingo.server.core.legacy

Class ProcessorServiceHandler

java.lang.Object

org.apache.olingo.server.core.legacy.ProcessorServiceHandler

All Implemented Interfaces:

org.apache.olingo.server.api.processor.Processor, ServiceHandler

public class ProcessorServiceHandler
extends Object
implements ServiceHandler

Constructor Summary

Constructors

Constructor and Description
ProcessorServiceHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	addReference(DataRequest request, String entityETag, URI referenceId, NoContentResponse response) Add references (relationships) to Entity.
void	anyUnsupported(org.apache.olingo.server.api.ODataRequest request, org.apache.olingo.server.api.ODataResponse response) Any Unsupported one will be directed here.
void	commit(String txnId) When a batch operation is complete and all the intermediate service requests are successful, then commit is called with transaction id returned in the startTransaction method.
void	createEntity(DataRequest request, org.apache.olingo.commons.api.data.Entity entity, EntityResponse response) Create new entity in the service based on the entity object provided
void	crossJoin(DataRequest dataRequest, List<String> entitySetNames, org.apache.olingo.server.api.ODataResponse response) This is not complete, more URL parsing changes required.
void	deleteEntity(DataRequest request, String entityETag, EntityResponse response) Delete the Entity
void	deleteReference(DataRequest request, URI deleteId, String entityETag, NoContentResponse response) Delete references (relationships) in an Entity
void	init(org.apache.olingo.server.api.OData odata, org.apache.olingo.server.api.ServiceMetadata serviceMetadata)
<T extends ServiceResponse> void	invoke(ActionRequest request, String eTag, T response) Invocation of a Function.
<T extends ServiceResponse> void	invoke(FunctionRequest request, org.apache.olingo.commons.api.http.HttpMethod method, T response) Invocation of a Function.
<T extends ServiceResponse> void	read(DataRequest request, T response) Read operation for EntitySets, Entities, Properties, Media etc.
void	readMediaStream(MediaRequest request, StreamResponse response) Read media stream content of a Entity
void	readMetadata(MetadataRequest request, MetadataResponse response) Read CSDL document of the Service
void	readServiceDocument(ServiceDocumentRequest request, ServiceDocumentResponse response) Read ServiceDocument of the service
void	register(org.apache.olingo.server.api.processor.Processor processor)
void	rollback(String txnId) When a batch operation is in-complete due to an error in the middle of changeset, then rollback is called with transaction id, that returned from startTransaction method.
String	startTransaction() During a batch operation, this method starts the transaction (if any) before any operation is handled by the service.
void	updateEntity(DataRequest request, org.apache.olingo.commons.api.data.Entity entity, boolean merge, String entityETag, EntityResponse response) Update the entity object.
void	updateProperty(DataRequest request, org.apache.olingo.commons.api.data.Property property, boolean merge, String entityETag, PropertyResponse response) Update a non-media/stream property.if the value of property NULL, it should be treated as DeleteProperty 11.4.9.2
void	updateReference(DataRequest request, String entityETag, URI referenceId, NoContentResponse response) Update references (relationships) in an Entity; This is always against single valued navigation property
void	upsertEntity(DataRequest request, org.apache.olingo.commons.api.data.Entity entity, boolean merge, String entityETag, EntityResponse response) Update or create the entity object.
void	upsertMediaStream(MediaRequest request, String entityETag, InputStream mediaContent, NoContentResponse response) Update of Media Stream Content of a Entity.
void	upsertStreamProperty(DataRequest request, String entityETag, InputStream streamContent, NoContentResponse response) Update Stream property, if StreamContent is null, it should treated as delete request

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessorServiceHandler

public ProcessorServiceHandler()

Method Detail

init

public void init(org.apache.olingo.server.api.OData odata,
        org.apache.olingo.server.api.ServiceMetadata serviceMetadata)

Specified by:

init in interface org.apache.olingo.server.api.processor.Processor

register

public void register(org.apache.olingo.server.api.processor.Processor processor)

readMetadata

public void readMetadata(MetadataRequest request,
                MetadataResponse response)
                  throws org.apache.olingo.server.api.ODataLibraryException,
                         org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Read CSDL document of the Service

Specified by:

readMetadata in interface ServiceHandler

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

readServiceDocument

public void readServiceDocument(ServiceDocumentRequest request,
                       ServiceDocumentResponse response)
                         throws org.apache.olingo.server.api.ODataLibraryException,
                                org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Read ServiceDocument of the service

Specified by:

readServiceDocument in interface ServiceHandler

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

read

public <T extends ServiceResponse> void read(DataRequest request,
                                    T response)
          throws org.apache.olingo.server.api.ODataLibraryException,
                 org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Read operation for EntitySets, Entities, Properties, Media etc. Based on the type of request the response object is different. Even the navigation based queries are handled by this method.

Specified by:

read in interface ServiceHandler

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

createEntity

public void createEntity(DataRequest request,
                org.apache.olingo.commons.api.data.Entity entity,
                EntityResponse response)
                  throws org.apache.olingo.server.api.ODataLibraryException,
                         org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Create new entity in the service based on the entity object provided

Specified by:

createEntity in interface ServiceHandler

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

updateEntity

public void updateEntity(DataRequest request,
                org.apache.olingo.commons.api.data.Entity entity,
                boolean merge,
                String entityETag,
                EntityResponse response)
                  throws org.apache.olingo.server.api.ODataLibraryException,
                         org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Update the entity object.

Specified by:

updateEntity in interface ServiceHandler

merge - - true if merge operation, false it needs to be replaced

entityETag - - previous entity tag if provided by the user. "*" means allow.

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

deleteEntity

public void deleteEntity(DataRequest request,
                String entityETag,
                EntityResponse response)
                  throws org.apache.olingo.server.api.ODataLibraryException,
                         org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Delete the Entity

Specified by:

deleteEntity in interface ServiceHandler

entityETag - - entity tag to match, if provided by the user. "*" means allow

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

updateProperty

public void updateProperty(DataRequest request,
                  org.apache.olingo.commons.api.data.Property property,
                  boolean merge,
                  String entityETag,
                  PropertyResponse response)
                    throws org.apache.olingo.server.api.ODataLibraryException,
                           org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Update a non-media/stream property.if the value of property NULL, it should be treated as DeleteProperty 11.4.9.2

Specified by:

updateProperty in interface ServiceHandler

property - - Updated property.

merge - - if the property is complex, true here means merge, false is replace

entityETag - - entity tag to match before update operation, "*" allows all.

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

upsertStreamProperty

public void upsertStreamProperty(DataRequest request,
                        String entityETag,
                        InputStream streamContent,
                        NoContentResponse response)
                          throws org.apache.olingo.server.api.ODataLibraryException,
                                 org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Update Stream property, if StreamContent is null, it should treated as delete request

Specified by:

upsertStreamProperty in interface ServiceHandler

entityETag - - entity tag to match before update operation, "*" allows all.

streamContent - - updated stream content

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

invoke

public <T extends ServiceResponse> void invoke(FunctionRequest request,
                                      org.apache.olingo.commons.api.http.HttpMethod method,
                                      T response)
            throws org.apache.olingo.server.api.ODataLibraryException,
                   org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Invocation of a Function. The response object will be based on metadata defined for service

Specified by:

invoke in interface ServiceHandler

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

invoke

public <T extends ServiceResponse> void invoke(ActionRequest request,
                                      String eTag,
                                      T response)
            throws org.apache.olingo.server.api.ODataLibraryException,
                   org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Invocation of a Function. The response object will be based on metadata defined for service

Specified by:

invoke in interface ServiceHandler

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

readMediaStream

public void readMediaStream(MediaRequest request,
                   StreamResponse response)
                     throws org.apache.olingo.server.api.ODataLibraryException,
                            org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Read media stream content of a Entity

Specified by:

readMediaStream in interface ServiceHandler

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

upsertMediaStream

public void upsertMediaStream(MediaRequest request,
                     String entityETag,
                     InputStream mediaContent,
                     NoContentResponse response)
                       throws org.apache.olingo.server.api.ODataLibraryException,
                              org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Update of Media Stream Content of a Entity. If the mediaContent is null it should be treated as delete request.

Specified by:

upsertMediaStream in interface ServiceHandler

entityETag - - entity etag to match before update operation, "*" allows all.

mediaContent - - if null, must be treated as delete request

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

anyUnsupported

public void anyUnsupported(org.apache.olingo.server.api.ODataRequest request,
                  org.apache.olingo.server.api.ODataResponse response)
                    throws org.apache.olingo.server.api.ODataLibraryException,
                           org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Any Unsupported one will be directed here.

Specified by:

anyUnsupported in interface ServiceHandler

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

addReference

public void addReference(DataRequest request,
                String entityETag,
                URI referenceId,
                NoContentResponse response)
                  throws org.apache.olingo.server.api.ODataLibraryException,
                         org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Add references (relationships) to Entity. This is always on collection valued navigation property

Specified by:

addReference in interface ServiceHandler

entityETag - - entity etag to match before add operation, "*" allows all.

referenceId - - references to add

response - - return always should be 204

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

updateReference

public void updateReference(DataRequest request,
                   String entityETag,
                   URI referenceId,
                   NoContentResponse response)
                     throws org.apache.olingo.server.api.ODataLibraryException,
                            org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Update references (relationships) in an Entity; This is always against single valued navigation property

Specified by:

updateReference in interface ServiceHandler

response - - always should be 204

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

deleteReference

public void deleteReference(DataRequest request,
                   URI deleteId,
                   String entityETag,
                   NoContentResponse response)
                     throws org.apache.olingo.server.api.ODataLibraryException,
                            org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Delete references (relationships) in an Entity

Specified by:

deleteReference in interface ServiceHandler

deleteId - for collection valued navigation this will be non-null value; for single valued navigation property, this will be null

response - - always should be 204

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

startTransaction

public String startTransaction()

Description copied from interface: ServiceHandler

During a batch operation, this method starts the transaction (if any) before any operation is handled by the service. No nested transactions.

Specified by:

startTransaction in interface ServiceHandler

Returns:

must return a unique transaction id that references a atomic operation.

commit

public void commit(String txnId)

Description copied from interface: ServiceHandler

When a batch operation is complete and all the intermediate service requests are successful, then commit is called with transaction id returned in the startTransaction method.

Specified by:

commit in interface ServiceHandler

rollback

public void rollback(String txnId)

Description copied from interface: ServiceHandler

When a batch operation is in-complete due to an error in the middle of changeset, then rollback is called with transaction id, that returned from startTransaction method.

Specified by:

rollback in interface ServiceHandler

crossJoin

public void crossJoin(DataRequest dataRequest,
             List<String> entitySetNames,
             org.apache.olingo.server.api.ODataResponse response)
               throws org.apache.olingo.server.api.ODataLibraryException,
                      org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

This is not complete, more URL parsing changes required. Cross join between two entities.

Specified by:

crossJoin in interface ServiceHandler

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

upsertEntity

public void upsertEntity(DataRequest request,
                org.apache.olingo.commons.api.data.Entity entity,
                boolean merge,
                String entityETag,
                EntityResponse response)
                  throws org.apache.olingo.server.api.ODataLibraryException,
                         org.apache.olingo.server.api.ODataApplicationException

Description copied from interface: ServiceHandler

Update or create the entity object. If based on passed in entity object's key value, if entity exists update the entity, else create a new entity

Specified by:

upsertEntity in interface ServiceHandler

entity - - Entity to create or update

merge - - in the case of update, true to do merge operation with current entity, false the entity needs to be replaced

entityETag - - previous entity tag if provided by the user. "*" means allow.

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException