org.apache.olingo.server.core

Interface ServiceHandler

All Superinterfaces:

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

All Known Implementing Classes:

ProcessorServiceHandler

public interface ServiceHandler
extends org.apache.olingo.server.api.processor.Processor

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
<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	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 interface org.apache.olingo.server.api.processor.Processor

init

Method Detail

readMetadata

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

Read CSDL document of the Service

Parameters:

request -

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

readServiceDocument

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

Read ServiceDocument of the service

Parameters:

request -

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

read

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

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.

Parameters:

request -

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

createEntity

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

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

Parameters:

request -

entity -

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

updateEntity

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

Update the entity object.

Parameters:

request -

entity -

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

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

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

upsertEntity

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

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

Parameters:

request -

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.

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

deleteEntity

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

Delete the Entity

Parameters:

request -

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

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

updateProperty

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

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

Parameters:

request -

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.

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

upsertStreamProperty

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

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

Parameters:

request -

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

streamContent - - updated stream content

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

invoke

<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

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

Parameters:

request -

method -

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

invoke

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

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

Parameters:

request -

eTag -

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

readMediaStream

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

Read media stream content of a Entity

Parameters:

request -

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

upsertMediaStream

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

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

Parameters:

request -

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

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

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

anyUnsupported

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

Any Unsupported one will be directed here.

Parameters:

request -

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

addReference

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

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

Parameters:

request -

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

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

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

Parameters:

request -

entityETag -

referenceId -

response - - always should be 204

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

deleteReference

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

Delete references (relationships) in an Entity

Parameters:

request -

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

entityETag -

response - - always should be 204

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

startTransaction

String startTransaction()
                        throws org.apache.olingo.server.api.ODataLibraryException,
                               org.apache.olingo.server.api.ODataApplicationException

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

Returns:

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

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

commit

void commit(String txnId)
            throws org.apache.olingo.server.api.ODataLibraryException,
                   org.apache.olingo.server.api.ODataApplicationException

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.

Parameters:

txnId -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

rollback

void rollback(String txnId)
              throws org.apache.olingo.server.api.ODataLibraryException,
                     org.apache.olingo.server.api.ODataApplicationException

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.

Parameters:

txnId -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException

crossJoin

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

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

Parameters:

dataRequest -

entitySetNames -

response -

Throws:

org.apache.olingo.server.api.ODataLibraryException

org.apache.olingo.server.api.ODataApplicationException