Package org.apache.olingo.odata2.jpa.processor.api

Class ODataJPAQueryExtensionEntityListener

java.lang.Object

org.apache.olingo.odata2.jpa.processor.api.ODataJPATombstoneEntityListener

org.apache.olingo.odata2.jpa.processor.api.ODataJPAQueryExtensionEntityListener

public abstract class ODataJPAQueryExtensionEntityListener
extends ODataJPATombstoneEntityListener

Extend this class to build JPA Query object for a given OData request. The extended class can be registered as JPA entity listeners.The implemented JPA Entity Listener classes will be called back from OData JPA Processor Library.

Constructor Summary

Constructors

Constructor	Description
ODataJPAQueryExtensionEntityListener()

Method Summary

Modifier and Type	Method	Description
boolean	authorizeProperty(EdmEntityType entityType, EdmProperty property)
boolean	authorizeProperty(EdmEntityType entityType, EdmProperty property, String method)
boolean	canOverrideDelete(UriInfo infoView)
boolean	canOverridePost(UriInfo infoView)
boolean	canOverridePut(UriInfo infoView)
boolean	canRefreshEntity(UriInfo infoView)
void	checkAuthorization(DeleteUriInfo deleteView)
void	checkAuthorization(PostUriInfo postView)
void	checkAuthorization(PutMergePatchUriInfo putView)
void	checkEntityGetAuthorization(EdmEntityType entityType)
void	checkFilter(EdmEntityType entityType, FilterExpression filter)
Object	convert(Object obj, Class clazz)
protected ODataJPARuntimeException	createApplicationError(String message, Locale locale)
Object	execEvent(UriInfo infoView, EdmEntityType entityType, String type, Object data, Map<String,Object> customValues)
String	generateDeltaToken(List<Object> deltas, jakarta.persistence.Query query)	Implement this method to create a delta token.
Map<String,Object>	getCalcFieldValues(EdmEntityType entityType, Object data)
List<ClientCallback>	getClientCallbacks()
Map<String,Object>	getDefaultFieldValues(EdmEntityType entityType, Object data)
jakarta.persistence.Query	getQuery(DeleteUriInfo uriInfo, jakarta.persistence.EntityManager em)	Override this method to build JPA Query for OData request - Delete; SELECT SINGLE with key in WHERE clause
jakarta.persistence.Query	getQuery(GetEntityCountUriInfo uriInfo, jakarta.persistence.EntityManager em)	Override this method to build JPA Query for OData request - GetEntity Count; SELECT SINGLE with key in WHERE clause
jakarta.persistence.Query	getQuery(GetEntitySetCountUriInfo uriInfo, jakarta.persistence.EntityManager em)	Override this method to build JPA Query for OData request - GetEntitySet Count; SELECT COUNT(*)
jakarta.persistence.Query	getQuery(GetEntitySetUriInfo uriInfo, jakarta.persistence.EntityManager em)	Override this method to build JPA Query for OData request - GetEntitySet; SELECT *
jakarta.persistence.Query	getQuery(GetEntityUriInfo uriInfo, jakarta.persistence.EntityManager em)	Override this method to build JPA Query for OData request - GetEntity; SELECT SINGLE with key in WHERE clause
jakarta.persistence.Query	getQuery(PutMergePatchUriInfo uriInfo, jakarta.persistence.EntityManager em)	Override this method to build JPA Query for OData request - Update; SELECT SINGLE with key in WHERE clause
boolean	isTombstoneSupported()	Implement this method to indicate whether the extended class can handle OData Tombstone feature as well
boolean	overrideDelete(UriInfo infoView, Object entity, jakarta.persistence.EntityManager em)
Object	overridePost(UriInfo infoView, Object entity, jakarta.persistence.EntityManager em)
Object	overridePut(UriInfo infoView, Object entity, jakarta.persistence.EntityManager em)
void	prepareQuery(jakarta.persistence.Query query)
Object	processNew(UriInfo infoView)

Methods inherited from class org.apache.olingo.odata2.jpa.processor.api.ODataJPATombstoneEntityListener

addToDelta

Methods inherited from class java.lang.Object

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

Constructor Details

ODataJPAQueryExtensionEntityListener

public ODataJPAQueryExtensionEntityListener()

Method Details

getQuery

public jakarta.persistence.Query getQuery(GetEntitySetUriInfo uriInfo,
 jakarta.persistence.EntityManager em)
                                   throws ODataJPARuntimeException

Override this method to build JPA Query for OData request - GetEntitySet; SELECT *

Specified by:

getQuery in class ODataJPATombstoneEntityListener

Parameters:

uriInfo - is a reference to OData request

em - is a reference to

invalid reference

javax.persistence.EntityManager

Returns:

an instance of type

invalid reference

javax.persistence.Query

Throws:

ODataJPARuntimeException - Caso ocorra exceção

getQuery

public jakarta.persistence.Query getQuery(GetEntityUriInfo uriInfo,
 jakarta.persistence.EntityManager em)
                                   throws ODataJPARuntimeException

Override this method to build JPA Query for OData request - GetEntity; SELECT SINGLE with key in WHERE clause

Parameters:

uriInfo - is a reference to OData request

em - is a reference to

invalid reference

javax.persistence.EntityManager

Returns:

an instance of type

invalid reference

javax.persistence.Query

Throws:

ODataJPARuntimeException - Caso ocorra exceção

getQuery

public jakarta.persistence.Query getQuery(GetEntityCountUriInfo uriInfo,
 jakarta.persistence.EntityManager em)
                                   throws ODataJPARuntimeException

Override this method to build JPA Query for OData request - GetEntity Count; SELECT SINGLE with key in WHERE clause

Parameters:

uriInfo - is a reference to OData request

em - is a reference to

invalid reference

javax.persistence.EntityManager

Returns:

an instance of type

invalid reference

javax.persistence.Query

Throws:

ODataJPARuntimeException - Caso ocorra exceção

getQuery

public jakarta.persistence.Query getQuery(GetEntitySetCountUriInfo uriInfo,
 jakarta.persistence.EntityManager em)
                                   throws ODataJPARuntimeException

Override this method to build JPA Query for OData request - GetEntitySet Count; SELECT COUNT(*)

Parameters:

uriInfo - is a reference to OData request

em - is a reference to

invalid reference

javax.persistence.EntityManager

Returns:

an instance of type

invalid reference

javax.persistence.Query

Throws:

ODataJPARuntimeException - Caso ocorra exceção

getQuery

public jakarta.persistence.Query getQuery(PutMergePatchUriInfo uriInfo,
 jakarta.persistence.EntityManager em)
                                   throws ODataJPARuntimeException

Override this method to build JPA Query for OData request - Update; SELECT SINGLE with key in WHERE clause

Parameters:

uriInfo - is a reference to OData request

em - is a reference to

invalid reference

javax.persistence.EntityManager

Returns:

an instance of type

invalid reference

javax.persistence.Query

Throws:

ODataJPARuntimeException - Caso ocorra exceção

getQuery

public jakarta.persistence.Query getQuery(DeleteUriInfo uriInfo,
 jakarta.persistence.EntityManager em)
                                   throws ODataJPARuntimeException

Override this method to build JPA Query for OData request - Delete; SELECT SINGLE with key in WHERE clause

Parameters:

uriInfo - is a reference to OData request

em - is a reference to

invalid reference

javax.persistence.EntityManager

Returns:

an instance of type

invalid reference

javax.persistence.Query

Throws:

ODataJPARuntimeException - Caso ocorra exceção

generateDeltaToken

public String generateDeltaToken(List<Object> deltas,
 jakarta.persistence.Query query)

Description copied from class: ODataJPATombstoneEntityListener

Implement this method to create a delta token.

Specified by:

generateDeltaToken in class ODataJPATombstoneEntityListener

Parameters:

deltas - is list of delta JPA Entities

query - is an instance of type

invalid reference

javax.persistence.Query

that was used for handling delta entites

Returns:

a delta token of type String

isTombstoneSupported

public boolean isTombstoneSupported()

Implement this method to indicate whether the extended class can handle OData Tombstone feature as well

Overrides:

isTombstoneSupported in class ODataJPATombstoneEntityListener

Returns:

false by default

createApplicationError

protected ODataJPARuntimeException createApplicationError(String message,
 Locale locale)

authorizeProperty

public boolean authorizeProperty(EdmEntityType entityType,
 EdmProperty property,
 String method)

authorizeProperty

public boolean authorizeProperty(EdmEntityType entityType,
 EdmProperty property)

checkAuthorization

public void checkAuthorization(PostUriInfo postView)
                        throws ODataJPARuntimeException

Throws:

ODataJPARuntimeException

checkAuthorization

public void checkAuthorization(PutMergePatchUriInfo putView)
                        throws ODataJPARuntimeException

Throws:

ODataJPARuntimeException

checkAuthorization

public void checkAuthorization(DeleteUriInfo deleteView)
                        throws ODataJPARuntimeException

Throws:

ODataJPARuntimeException

checkEntityGetAuthorization

public void checkEntityGetAuthorization(EdmEntityType entityType)
                                 throws ODataJPARuntimeException

Throws:

ODataJPARuntimeException

getDefaultFieldValues

public Map<String,Object> getDefaultFieldValues(EdmEntityType entityType,
 Object data)
                                         throws ODataJPARuntimeException

Throws:

ODataJPARuntimeException

getCalcFieldValues

public Map<String,Object> getCalcFieldValues(EdmEntityType entityType,
 Object data)
                                      throws ODataJPARuntimeException

Throws:

ODataJPARuntimeException

checkFilter

public void checkFilter(EdmEntityType entityType,
 FilterExpression filter)
                 throws ODataJPARuntimeException

Throws:

ODataJPARuntimeException

getClientCallbacks

public List<ClientCallback> getClientCallbacks()

execEvent

public Object execEvent(UriInfo infoView,
 EdmEntityType entityType,
 String type,
 Object data,
 Map<String,Object> customValues)
                 throws ODataJPARuntimeException

Throws:

ODataJPARuntimeException

processNew

public Object processNew(UriInfo infoView)

overridePost

public Object overridePost(UriInfo infoView,
 Object entity,
 jakarta.persistence.EntityManager em)

overridePut

public Object overridePut(UriInfo infoView,
 Object entity,
 jakarta.persistence.EntityManager em)

overrideDelete

public boolean overrideDelete(UriInfo infoView,
 Object entity,
 jakarta.persistence.EntityManager em)

canOverridePut

public boolean canOverridePut(UriInfo infoView)

canOverridePost

public boolean canOverridePost(UriInfo infoView)

canOverrideDelete

public boolean canOverrideDelete(UriInfo infoView)

canRefreshEntity

public boolean canRefreshEntity(UriInfo infoView)

convert

public Object convert(Object obj,
 Class clazz)

prepareQuery

public void prepareQuery(jakarta.persistence.Query query)