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

Class JPAODataServiceContext

java.lang.Object

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

All Implemented Interfaces:

JPAODataCRUDContext, JPAODataCRUDContextAccess, JPAODataGetContext

public final class JPAODataServiceContext
extends Object
implements JPAODataCRUDContext, JPAODataCRUDContextAccess

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JPAODataServiceContext.Builder

Method Summary

Modifier and Type	Method	Description
JPACUDRequestHandler	getCUDRequestHandler()
JPAODataDatabaseProcessor	getDatabaseProcessor()
org.apache.olingo.server.api.debug.DebugSupport	getDebugSupport()
com.sap.olingo.jpa.metadata.api.JPAEdmProvider	getEdmProvider()
com.sap.olingo.jpa.metadata.api.JPAEdmProvider	getEdmProvider(javax.persistence.EntityManager em)
Optional<javax.persistence.EntityManagerFactory>	getEntityManagerFactory()
org.apache.olingo.server.api.processor.ErrorProcessor	getErrorProcessor()
String	getMappingPath()
JPAODataDatabaseOperations	getOperationConverter()
String[]	getPackageName()	Returns a list of packages that may contain Enumerations of Java implemented OData operations
JPAODataPagingProvider	getPagingProvider()	If server side paging shall be supported getPagingProvider returns an implementation of a paging provider.
List<org.apache.olingo.commons.api.edmx.EdmxReference>	getReferences()
void	initDebugger(String debugFormat)	Deprecated. will be removed with 1.0.0;
void	setCUDRequestHandler(JPACUDRequestHandler jpaCUDRequestHandler)	Deprecated. will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead
void	setDatabaseProcessor(JPAODataDatabaseProcessor databaseProcessor)	Deprecated. will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead
void	setDebugSupport(org.apache.olingo.server.api.debug.DebugSupport jpaDebugSupport)	Deprecated. will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead
void	setErrorProcessor(org.apache.olingo.server.api.processor.ErrorProcessor errorProcessor)	Deprecated. will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead
void	setMetadataPostProcessor(com.sap.olingo.jpa.metadata.api.JPAEdmMetadataPostProcessor postProcessor)	Deprecated. will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead
void	setOperationConverter(JPAODataDatabaseOperations jpaOperationConverter)	Deprecated. will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead
void	setPagingProvider(JPAODataPagingProvider provider)	Deprecated. will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead
void	setReferences(List<org.apache.olingo.commons.api.edmx.EdmxReference> references)	Deprecated. will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead
void	setTypePackage(String... packageName)	Deprecated. will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead
boolean	useAbsoluteContextURL()
static JPAODataServiceContext.Builder	with()

Methods inherited from class java.lang.Object

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

Method Details

with

public static JPAODataServiceContext.Builder with()

getCUDRequestHandler

public JPACUDRequestHandler getCUDRequestHandler()

Specified by:

getCUDRequestHandler in interface JPAODataCRUDContextAccess

Returns:

getDatabaseProcessor

public JPAODataDatabaseProcessor getDatabaseProcessor()

Specified by:

getDatabaseProcessor in interface JPAODataCRUDContextAccess

getDebugSupport

public org.apache.olingo.server.api.debug.DebugSupport getDebugSupport()

Specified by:

getDebugSupport in interface JPAODataCRUDContextAccess

Returns:

getEdmProvider

public com.sap.olingo.jpa.metadata.api.JPAEdmProvider getEdmProvider()
                                                              throws org.apache.olingo.commons.api.ex.ODataException

Specified by:

getEdmProvider in interface JPAODataCRUDContextAccess

Throws:

org.apache.olingo.commons.api.ex.ODataException

getEdmProvider

public com.sap.olingo.jpa.metadata.api.JPAEdmProvider getEdmProvider(@Nonnull
 javax.persistence.EntityManager em)
                                                              throws org.apache.olingo.commons.api.ex.ODataException

Throws:

org.apache.olingo.commons.api.ex.ODataException

getEntityManagerFactory

public Optional<javax.persistence.EntityManagerFactory> getEntityManagerFactory()

Specified by:

getEntityManagerFactory in interface JPAODataCRUDContextAccess

getErrorProcessor

public org.apache.olingo.server.api.processor.ErrorProcessor getErrorProcessor()

Specified by:

getErrorProcessor in interface JPAODataCRUDContextAccess

getOperationConverter

public JPAODataDatabaseOperations getOperationConverter()

Specified by:

getOperationConverter in interface JPAODataCRUDContextAccess

getPackageName

public String[] getPackageName()

Description copied from interface: JPAODataCRUDContextAccess

Returns a list of packages that may contain Enumerations of Java implemented OData operations

Specified by:

getPackageName in interface JPAODataCRUDContextAccess

Returns:

getPagingProvider

public JPAODataPagingProvider getPagingProvider()

Description copied from interface: JPAODataCRUDContextAccess

If server side paging shall be supported getPagingProvider returns an implementation of a paging provider. Details about the OData specification can be found under OData Version 4.0 Part 1 - 11.2.5.7 Server-Driven Paging

Specified by:

getPagingProvider in interface JPAODataCRUDContextAccess

Returns:

getReferences

public List<org.apache.olingo.commons.api.edmx.EdmxReference> getReferences()

Specified by:

getReferences in interface JPAODataCRUDContextAccess

getMappingPath

public String getMappingPath()

Specified by:

getMappingPath in interface JPAODataCRUDContextAccess

useAbsoluteContextURL

public boolean useAbsoluteContextURL()

Specified by:

useAbsoluteContextURL in interface JPAODataCRUDContextAccess

initDebugger

@Deprecated
public void initDebugger(String debugFormat)

Deprecated.

will be removed with 1.0.0;

Specified by:

initDebugger in interface JPAODataGetContext

setCUDRequestHandler

@Deprecated
public void setCUDRequestHandler(JPACUDRequestHandler jpaCUDRequestHandler)

Deprecated.

will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead

Specified by:

setCUDRequestHandler in interface JPAODataCRUDContext

setDatabaseProcessor

@Deprecated
public void setDatabaseProcessor(JPAODataDatabaseProcessor databaseProcessor)

Deprecated.

will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead

Specified by:

setDatabaseProcessor in interface JPAODataGetContext

setDebugSupport

@Deprecated
public void setDebugSupport(org.apache.olingo.server.api.debug.DebugSupport jpaDebugSupport)

Deprecated.

will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead

Specified by:

setDebugSupport in interface JPAODataGetContext

setErrorProcessor

@Deprecated
public void setErrorProcessor(org.apache.olingo.server.api.processor.ErrorProcessor errorProcessor)

Deprecated.

will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead

Description copied from interface: JPAODataGetContext

Allows to provide an Olingo error processor. The error processor allows to enrich an error response. See JSON Error Response or Atom Error Response.

Specified by:

setErrorProcessor in interface JPAODataGetContext

setMetadataPostProcessor

@Deprecated
public void setMetadataPostProcessor(com.sap.olingo.jpa.metadata.api.JPAEdmMetadataPostProcessor postProcessor)
                              throws org.apache.olingo.commons.api.ex.ODataException

Deprecated.

will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead

Specified by:

setMetadataPostProcessor in interface JPAODataGetContext

Throws:

org.apache.olingo.commons.api.ex.ODataException

setOperationConverter

@Deprecated
public void setOperationConverter(JPAODataDatabaseOperations jpaOperationConverter)

Deprecated.

will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead

Specified by:

setOperationConverter in interface JPAODataGetContext

setPagingProvider

@Deprecated
public void setPagingProvider(JPAODataPagingProvider provider)

Deprecated.

will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead

Description copied from interface: JPAODataGetContext

Register a provider that is able to decides based on a given query if the server like to return only a sub set of the requested results as well as a $skiptoken.

Specified by:

setPagingProvider in interface JPAODataGetContext

setReferences

@Deprecated
public void setReferences(List<org.apache.olingo.commons.api.edmx.EdmxReference> references)

Deprecated.

will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead

Description copied from interface: JPAODataGetContext

Registers the debug support handler.

Specified by:

setReferences in interface JPAODataGetContext

setTypePackage

@Deprecated
public void setTypePackage(String... packageName)

Deprecated.

will be removed with 1.0.0; use newly created builder (JPAODataServiceContext.with()) instead

Description copied from interface: JPAODataGetContext

Name of the top level package to look for

• Enumeration Types
• Java class based Functions

Specified by:

setTypePackage in interface JPAODataGetContext