org.eclipse.persistence.jpa.rs

Class PersistenceContext

java.lang.Object

org.eclipse.persistence.jpa.rs.PersistenceContext

public class PersistenceContext
extends java.lang.Object

A wrapper around the JPA and JAXB artifacts used to persist an application. A PersistenceContext provides the capability of using the same persistence unit in JPA to to interact with a Database or other JPA-capable data source and in JAXB to interact with either XML or JSON. A PersistenceContext can wrap either an existing persistence unit (EntityManagerFactory), or it can be used to bootstrap a fully dynamic persistence unit.

Author:

douglas.clarke, tom.ware

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JPARS_CONTEXT

Constructor Summary

Constructors

Constructor and Description
PersistenceContext(java.lang.String emfName, EntityManagerFactoryImpl emf, java.net.URI defaultURI) Instantiates a new persistence context.

Method Summary

Modifier and Type	Method and Description
javax.persistence.Query	buildQuery(java.util.Map<java.lang.String,java.lang.String> tenantId, java.lang.String name, java.util.Map<?,?> parameters, java.util.Map<java.lang.String,?> hints)
void	create(java.util.Map<java.lang.String,java.lang.String> tenantId, java.lang.Object entity) A part of the facade over the JPA API Persist an entity in JPA and commit
void	delete(java.util.Map<java.lang.String,java.lang.String> tenantId, java.lang.String type, java.lang.Object id) A part of the facade over the JPA API Delete the given entity in JPA and commit the changes
boolean	doesExist(java.util.Map<java.lang.String,java.lang.String> tenantId, java.lang.Object entity) Does exist.
void	finalize() Finalize.
java.lang.Object	find(java.util.Map<java.lang.String,java.lang.String> tenantId, java.lang.String entityName, java.lang.Object id) A part of the facade over the JPA API Find an entity with the given name and id in JPA
java.lang.Object	find(java.util.Map<java.lang.String,java.lang.String> tenantId, java.lang.String entityName, java.lang.Object id, java.util.Map<java.lang.String,java.lang.Object> properties) A part of the facade over the JPA API Find an entity with the given name and id in JPA
java.lang.Object	find(java.lang.String entityName, java.lang.Object id) A part of the facade over the JPA API Find an entity with the given name and id in JPA
java.lang.Object	findAttribute(java.util.Map<java.lang.String,java.lang.String> tenantId, java.lang.String entityName, java.lang.Object id, java.util.Map<java.lang.String,java.lang.Object> properties, java.lang.String attribute) Find attribute.
java.net.URI	getBaseURI() Gets the base uri.
java.lang.Class<?>	getClass(java.lang.String entityName) Look-up the given entity name in the EntityManagerFactory and return the class is describes
ClassDescriptor	getDescriptor(java.lang.String entityName) Lookup the descriptor for the given entity name.
ClassDescriptor	getDescriptorForClass(java.lang.Class clazz) Gets the descriptor for class.
javax.persistence.EntityManagerFactory	getEmf() Gets the emf.
JAXBContext	getJAXBContext() Gets the jAXB context.
ClassDescriptor	getJAXBDescriptorForClass(java.lang.Class clazz) Gets the jAXB descriptor for class.
DatabaseSession	getJpaSession() Gets the jpa session.
java.lang.String	getName() Gets the name.
java.lang.String	getVersion()
boolean	isWeavingEnabled()
void	marshallEntity(java.lang.Object object, javax.ws.rs.core.MediaType mediaType, java.io.OutputStream output) Marshall an entity to either JSON or XML Calling this method, will treat relationships as unfetched in the XML/JSON and marshall them as links rather than attempting to marshall the data in those relationships
void	marshallEntity(java.lang.Object object, javax.ws.rs.core.MediaType mediaType, java.io.OutputStream output, boolean sendRelationships) Marshall an entity to either JSON or XML
java.lang.Object	merge(java.util.Map<java.lang.String,java.lang.String> tenantId, java.lang.Object entity) A part of the facade over the JPA API Call jpa merge on the given object and commit If the passed object is a list, we will iterate through the list and merge each member
DynamicEntity	newEntity(java.util.Map<java.lang.String,java.lang.String> tenantId, java.lang.String type) A convenience method to create a new dynamic entity of the given type
DynamicEntity	newEntity(java.lang.String type) A convenience method to create a new dynamic entity of the given type
int	queryExecuteUpdate(java.util.Map<java.lang.String,java.lang.String> tenantId, java.lang.String name, java.util.Map<?,?> parameters, java.util.Map<java.lang.String,?> hints) Query execute update.
java.util.List	queryMultipleResults(java.util.Map<java.lang.String,java.lang.String> tenantId, java.lang.String name, java.util.Map<?,?> parameters, java.util.Map<java.lang.String,?> hints) Query multiple results.
java.lang.Object	removeAttribute(java.util.Map<java.lang.String,java.lang.String> tenantId, java.lang.String entityName, java.lang.Object id, java.lang.String attribute, java.lang.String listItemId, java.lang.Object entity, java.lang.String partner) Removes the attribute.
void	setBaseURI(java.net.URI baseURI) Sets the base uri.
void	setVersion(java.lang.String version)
void	stop() Stop the current application instance
java.lang.String	toString() To string.
java.lang.Object	unmarshalEntity(java.lang.Class type, javax.ws.rs.core.MediaType acceptedMedia, java.io.InputStream in) Marshall an entity to either JSON or XML
java.lang.Object	unmarshalEntity(java.lang.String type, javax.ws.rs.core.MediaType acceptedMedia, java.io.InputStream in) Marshall an entity to either JSON or XML Calling this method, will treat relationships as unfetched in the XML/JSON and marshall them as links rather than attempting to marshall the data in those relationships
java.lang.Object	updateOrAddAttribute(java.util.Map<java.lang.String,java.lang.String> tenantId, java.lang.String entityName, java.lang.Object id, java.util.Map<java.lang.String,java.lang.Object> properties, java.lang.String attribute, java.lang.Object attributeValue, java.lang.String partner) Update or add attribute.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

JPARS_CONTEXT

public static final java.lang.String JPARS_CONTEXT

See Also:

Constant Field Values

Constructor Detail

PersistenceContext

public PersistenceContext(java.lang.String emfName,
                          EntityManagerFactoryImpl emf,
                          java.net.URI defaultURI)

Instantiates a new persistence context.

Parameters:

emfName - the emf name

emf - the emf

defaultURI - the default uri

Method Detail

isWeavingEnabled

public boolean isWeavingEnabled()

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

create

public void create(java.util.Map<java.lang.String,java.lang.String> tenantId,
                   java.lang.Object entity)

A part of the facade over the JPA API Persist an entity in JPA and commit

Parameters:

tenantId -

entity -

delete

public void delete(java.util.Map<java.lang.String,java.lang.String> tenantId,
                   java.lang.String type,
                   java.lang.Object id)

A part of the facade over the JPA API Delete the given entity in JPA and commit the changes

doesExist

public boolean doesExist(java.util.Map<java.lang.String,java.lang.String> tenantId,
                         java.lang.Object entity)

Does exist.

Parameters:

tenantId - the tenant id

entity - the entity

Returns:

true, if successful

finalize

public void finalize()

Finalize.

Overrides:

finalize in class java.lang.Object

find

public java.lang.Object find(java.lang.String entityName,
                             java.lang.Object id)

A part of the facade over the JPA API Find an entity with the given name and id in JPA

Parameters:

entityName -

id -

Returns:

find

public java.lang.Object find(java.util.Map<java.lang.String,java.lang.String> tenantId,
                             java.lang.String entityName,
                             java.lang.Object id)

A part of the facade over the JPA API Find an entity with the given name and id in JPA

Parameters:

tenantId -

entityName -

id -

Returns:

find

public java.lang.Object find(java.util.Map<java.lang.String,java.lang.String> tenantId,
                             java.lang.String entityName,
                             java.lang.Object id,
                             java.util.Map<java.lang.String,java.lang.Object> properties)

A part of the facade over the JPA API Find an entity with the given name and id in JPA

Parameters:

tenantId -

entityName -

id -

properties - - query hints used on the find

Returns:

findAttribute

public java.lang.Object findAttribute(java.util.Map<java.lang.String,java.lang.String> tenantId,
                                      java.lang.String entityName,
                                      java.lang.Object id,
                                      java.util.Map<java.lang.String,java.lang.Object> properties,
                                      java.lang.String attribute)

Find attribute.

Parameters:

tenantId - the tenant id

entityName - the entity name

id - the id

properties - the properties

attribute - the attribute

Returns:

the object

updateOrAddAttribute

public java.lang.Object updateOrAddAttribute(java.util.Map<java.lang.String,java.lang.String> tenantId,
                                             java.lang.String entityName,
                                             java.lang.Object id,
                                             java.util.Map<java.lang.String,java.lang.Object> properties,
                                             java.lang.String attribute,
                                             java.lang.Object attributeValue,
                                             java.lang.String partner)

Update or add attribute.

Parameters:

tenantId - the tenant id

entityName - the entity name

id - the id

properties - the properties

attribute - the attribute

attributeValue - the attribute value

partner - the partner

Returns:

the object

removeAttribute

public java.lang.Object removeAttribute(java.util.Map<java.lang.String,java.lang.String> tenantId,
                                        java.lang.String entityName,
                                        java.lang.Object id,
                                        java.lang.String attribute,
                                        java.lang.String listItemId,
                                        java.lang.Object entity,
                                        java.lang.String partner)

Removes the attribute.

Parameters:

tenantId - the tenant id

entityName - the entity name

id - the id

properties - the properties

attribute - the attribute

attributeValue - the attribute value

partner - the partner

Returns:

the object

getBaseURI

public java.net.URI getBaseURI()

Gets the base uri.

Returns:

the base uri

getClass

public java.lang.Class<?> getClass(java.lang.String entityName)

Look-up the given entity name in the EntityManagerFactory and return the class is describes

Parameters:

entityName -

Returns:

getJpaSession

public DatabaseSession getJpaSession()

Gets the jpa session.

Returns:

the jpa session

getDescriptor

public ClassDescriptor getDescriptor(java.lang.String entityName)

Lookup the descriptor for the given entity name. This method will look first in the EntityManagerFactory wrapped by this persistence context and return that descriptor. If one does not exist, it search the JAXBContext and return a descriptor from there.

Parameters:

entityName -

Returns:

getDescriptorForClass

public ClassDescriptor getDescriptorForClass(java.lang.Class clazz)

Gets the descriptor for class.

Parameters:

clazz - the clazz

Returns:

the descriptor for class

getJAXBDescriptorForClass

public ClassDescriptor getJAXBDescriptorForClass(java.lang.Class clazz)

Gets the jAXB descriptor for class.

Parameters:

clazz - the clazz

Returns:

the jAXB descriptor for class

getEmf

public javax.persistence.EntityManagerFactory getEmf()

Gets the emf.

Returns:

the emf

getJAXBContext

public JAXBContext getJAXBContext()

Gets the jAXB context.

Returns:

the jAXB context

getName

public java.lang.String getName()

Gets the name.

Returns:

the name

merge

public java.lang.Object merge(java.util.Map<java.lang.String,java.lang.String> tenantId,
                              java.lang.Object entity)

A part of the facade over the JPA API Call jpa merge on the given object and commit If the passed object is a list, we will iterate through the list and merge each member

Parameters:

tenantId -

entity -

Returns:

newEntity

public DynamicEntity newEntity(java.lang.String type)

A convenience method to create a new dynamic entity of the given type

Parameters:

type -

Returns:

newEntity

public DynamicEntity newEntity(java.util.Map<java.lang.String,java.lang.String> tenantId,
                               java.lang.String type)

A convenience method to create a new dynamic entity of the given type

Parameters:

tenantId -

type -

Returns:

queryExecuteUpdate

public int queryExecuteUpdate(java.util.Map<java.lang.String,java.lang.String> tenantId,
                              java.lang.String name,
                              java.util.Map<?,?> parameters,
                              java.util.Map<java.lang.String,?> hints)

Query execute update.

Parameters:

tenantId - the tenant id

name - the name

parameters - the parameters

hints - the hints

Returns:

the int

queryMultipleResults

public java.util.List queryMultipleResults(java.util.Map<java.lang.String,java.lang.String> tenantId,
                                           java.lang.String name,
                                           java.util.Map<?,?> parameters,
                                           java.util.Map<java.lang.String,?> hints)

Query multiple results.

Parameters:

tenantId - the tenant id

name - the name

parameters - the parameters

hints - the hints

Returns:

the list

buildQuery

public javax.persistence.Query buildQuery(java.util.Map<java.lang.String,java.lang.String> tenantId,
                                          java.lang.String name,
                                          java.util.Map<?,?> parameters,
                                          java.util.Map<java.lang.String,?> hints)

setBaseURI

public void setBaseURI(java.net.URI baseURI)

Sets the base uri.

Parameters:

baseURI - the new base uri

stop

public void stop()

Stop the current application instance

toString

public java.lang.String toString()

To string.

Overrides:

toString in class java.lang.Object

Returns:

the string

unmarshalEntity

public java.lang.Object unmarshalEntity(java.lang.String type,
                                        javax.ws.rs.core.MediaType acceptedMedia,
                                        java.io.InputStream in)
                                 throws javax.xml.bind.JAXBException

Marshall an entity to either JSON or XML Calling this method, will treat relationships as unfetched in the XML/JSON and marshall them as links rather than attempting to marshall the data in those relationships

Parameters:

object -

mediaType -

output -

Throws:

javax.xml.bind.JAXBException

unmarshalEntity

public java.lang.Object unmarshalEntity(java.lang.Class type,
                                        javax.ws.rs.core.MediaType acceptedMedia,
                                        java.io.InputStream in)
                                 throws javax.xml.bind.JAXBException

Marshall an entity to either JSON or XML

Parameters:

object -

mediaType -

output -

sendRelationships - if this is set to true, relationships will be sent as links instead of sending the actual objects in the relationships

Throws:

javax.xml.bind.JAXBException

marshallEntity

public void marshallEntity(java.lang.Object object,
                           javax.ws.rs.core.MediaType mediaType,
                           java.io.OutputStream output)
                    throws javax.xml.bind.JAXBException

Marshall an entity to either JSON or XML Calling this method, will treat relationships as unfetched in the XML/JSON and marshall them as links rather than attempting to marshall the data in those relationships

Parameters:

object -

mediaType -

output -

Throws:

javax.xml.bind.JAXBException

marshallEntity

public void marshallEntity(java.lang.Object object,
                           javax.ws.rs.core.MediaType mediaType,
                           java.io.OutputStream output,
                           boolean sendRelationships)
                    throws javax.xml.bind.JAXBException

Marshall an entity to either JSON or XML

Parameters:

object -

mediaType -

output -

sendRelationships - if this is set to true, relationships will be sent as links instead of sending the actual objects in the relationships

Throws:

javax.xml.bind.JAXBException