Package com.sap.olingo.jpa.processor.core.api.example

Class JPAExampleCUDRequestHandler

java.lang.Object

com.sap.olingo.jpa.processor.core.api.JPAAbstractCUDRequestHandler

com.sap.olingo.jpa.processor.core.api.example.JPAExampleCUDRequestHandler

All Implemented Interfaces:

JPACUDRequestHandler

public class JPAExampleCUDRequestHandler
extends JPAAbstractCUDRequestHandler

Example implementation at a CUD handler. The main purpose is rapid prototyping.

The implementation requires Getter and Setter. This includes getter for collection properties and collection navigation properties that return at least empty collections.
To link entities constructor injection is used. So each dependent entity needs a constructor that takes a entity type it depends on as parameter.

Author:

Oliver Grande

Constructor Summary

Constructors

Constructor	Description
JPAExampleCUDRequestHandler()

Method Summary

Modifier and Type	Method	Description
Object	createEntity(JPARequestEntity requestEntity, javax.persistence.EntityManager em)	Hook to create an entity.
void	deleteEntity(JPARequestEntity requestEntity, javax.persistence.EntityManager em)
JPAUpdateResult	updateEntity(JPARequestEntity requestEntity, javax.persistence.EntityManager em, org.apache.olingo.commons.api.http.HttpMethod method)	Hook to handle all request that change an existing entity.
void	validateChanges(javax.persistence.EntityManager em)	Hook that is called after all changes of one transaction have been processed.

Methods inherited from class java.lang.Object

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

Constructor Details

JPAExampleCUDRequestHandler

public JPAExampleCUDRequestHandler()

Method Details

createEntity

public Object createEntity(JPARequestEntity requestEntity,
 javax.persistence.EntityManager em)
                    throws ODataJPAProcessException

Description copied from interface: JPACUDRequestHandler

Hook to create an entity. Transaction handling is done outside to guarantee transactional behavior of change sets in batch requests. This method has to return the newly create entity even so validateChanges is implemented.

Specified by:

createEntity in interface JPACUDRequestHandler

Overrides:

createEntity in class JPAAbstractCUDRequestHandler

Returns:

The newly created instance or map of created attributes including default and added values following the same rules as jpaAttributes

Throws:

ODataJPAProcessException

deleteEntity

public void deleteEntity(JPARequestEntity requestEntity,
 javax.persistence.EntityManager em)
                  throws ODataJPAProcessException

Specified by:

deleteEntity in interface JPACUDRequestHandler

Overrides:

deleteEntity in class JPAAbstractCUDRequestHandler

Throws:

ODataJPAProcessException

updateEntity

public JPAUpdateResult updateEntity(JPARequestEntity requestEntity,
 javax.persistence.EntityManager em,
 org.apache.olingo.commons.api.http.HttpMethod method)
                             throws ODataJPAProcessException

Description copied from interface: JPACUDRequestHandler

Hook to handle all request that change an existing entity. This includes update and upsert on entities, updates on properties and values, updates on relations as well as deletions on values and properties.
Note: Deviating from the OData standard changes on collection properties will be provided as PATCH, as it is from an entity point of view is the partial change. An implementation needs to take care that all elements of the collection are exchanged!

Specified by:

updateEntity in interface JPACUDRequestHandler

Overrides:

updateEntity in class JPAAbstractCUDRequestHandler

Parameters:

requestEntity - See JPARequestEntity

em - Instance of an entity manager with an open transaction.

method - The original http method: PATCH, PUT, DELETE

Returns:

The response describes the performed changes (Created or Updated) as well as the result of the operation. It must not be null. Even if nothing was changed => update is idempotent

Throws:

ODataJPAProcessException

See Also:

OData Version 4.0 Part 1 - 11.4.3 Update an Entity
OData Version 4.0 Part 1 - 11.4.4 Upsert an Entity
OData Version 4.0 Part 1 - 11.4.6 Modifying Relationships between Entities
OData Version 4.0 Part 1 - 11.4.9 Managing Values and Properties Directly

validateChanges

public void validateChanges(javax.persistence.EntityManager em)
                     throws ODataJPAProcessException

Description copied from interface: JPACUDRequestHandler

Hook that is called after all changes of one transaction have been processed. The method shall enable a check of all modification within the new context. This can be imported if multiple entities are changes with the same request (batch request or deep-insert) and consistency constrains exist between them.

Specified by:

validateChanges in interface JPACUDRequestHandler

Overrides:

validateChanges in class JPAAbstractCUDRequestHandler

Throws:

ODataJPAProcessException