PersistenceContext

java.lang.Object
- org.eclipse.persistence.jpa.rs.PersistenceContext

```
public class PersistenceContext
extends 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 String JPARS_CONTEXT

Fields
Modifier and Type	Field and Description
`static String`	`JPARS_CONTEXT`

Constructor Summary

Constructors
Constructor and Description
`PersistenceContext(String emfName, org.eclipse.persistence.internal.jpa.EntityManagerFactoryImpl emf, URI defaultURI)` Instantiates a new persistence context.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.persistence.Query`	`buildQuery(Map<String,String> tenantId, String name, Map<?,?> parameters, Map<String,?> hints)`
`void`	`create(Map<String,String> tenantId, Object entity)` A part of the facade over the JPA API Persist an entity in JPA and commit
`void`	`delete(Map<String,String> tenantId, String type, Object id)` A part of the facade over the JPA API Delete the given entity in JPA and commit the changes
`boolean`	`doesExist(Map<String,String> tenantId, Object entity)` Does exist.
`void`	`finalize()` Finalize.
`Object`	`find(Map<String,String> tenantId, String entityName, Object id)` A part of the facade over the JPA API Find an entity with the given name and id in JPA
`Object`	`find(Map<String,String> tenantId, String entityName, Object id, Map<String,Object> properties)` A part of the facade over the JPA API Find an entity with the given name and id in JPA
`Object`	`find(String entityName, Object id)` A part of the facade over the JPA API Find an entity with the given name and id in JPA
`Object`	`findAttribute(Map<String,String> tenantId, String entityName, Object id, Map<String,Object> properties, String attribute)` Find attribute.
`URI`	`getBaseURI()` Gets the base uri.
`Class<?>`	`getClass(String entityName)` Look-up the given entity name in the EntityManagerFactory and return the class is describes
`ClassDescriptor`	`getDescriptor(String entityName)` Lookup the descriptor for the given entity name.
`ClassDescriptor`	`getDescriptorForClass(Class clazz)` Gets the descriptor for class.
`javax.persistence.EntityManagerFactory`	`getEmf()` Gets the emf.
`JAXBContext`	`getJAXBContext()` Gets the jAXB context.
`ClassDescriptor`	`getJAXBDescriptorForClass(Class clazz)` Gets the jAXB descriptor for class.
`DatabaseSession`	`getJpaSession()` Gets the jpa session.
`String`	`getName()` Gets the name.
`String`	`getVersion()`
`boolean`	`isWeavingEnabled()`
`void`	`marshallEntity(Object object, javax.ws.rs.core.MediaType mediaType, 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(Object object, javax.ws.rs.core.MediaType mediaType, OutputStream output, boolean sendRelationships)` Marshall an entity to either JSON or XML
`Object`	`merge(Map<String,String> tenantId, 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(Map<String,String> tenantId, String type)` A convenience method to create a new dynamic entity of the given type
`DynamicEntity`	`newEntity(String type)` A convenience method to create a new dynamic entity of the given type
`int`	`queryExecuteUpdate(Map<String,String> tenantId, String name, Map<?,?> parameters, Map<String,?> hints)` Query execute update.
`List`	`queryMultipleResults(Map<String,String> tenantId, String name, Map<?,?> parameters, Map<String,?> hints)` Query multiple results.
`Object`	`removeAttribute(Map<String,String> tenantId, String entityName, Object id, String attribute, String listItemId, Object entity, String partner)` Removes the attribute.
`void`	`setBaseURI(URI baseURI)` Sets the base uri.
`void`	`setVersion(String version)`
`void`	`stop()` Stop the current application instance
`String`	`toString()` To string.
`Object`	`unmarshalEntity(Class type, javax.ws.rs.core.MediaType acceptedMedia, InputStream in)` Marshall an entity to either JSON or XML
`Object`	`unmarshalEntity(String type, javax.ws.rs.core.MediaType acceptedMedia, 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
`Object`	`updateOrAddAttribute(Map<String,String> tenantId, String entityName, Object id, Map<String,Object> properties, String attribute, Object attributeValue, 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 String JPARS_CONTEXT
```
  See Also:
  
  Constant Field Values

Constructor Detail

PersistenceContext

public PersistenceContext(String emfName,
                          org.eclipse.persistence.internal.jpa.EntityManagerFactoryImpl emf,
                          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 String getVersion()
```

setVersion

public void setVersion(String version)

create

public void create(Map<String,String> tenantId,
                   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(Map<String,String> tenantId,
                   String type,
                   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(Map<String,String> tenantId,
                         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 Object

find
```
public Object find(String entityName,
                   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 Object find(Map<String,String> tenantId,
                   String entityName,
                   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 Object find(Map<String,String> tenantId,
                   String entityName,
                   Object id,
                   Map<String,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 Object findAttribute(Map<String,String> tenantId,
                            String entityName,
                            Object id,
                            Map<String,Object> properties,
                            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 Object updateOrAddAttribute(Map<String,String> tenantId,
                                   String entityName,
                                   Object id,
                                   Map<String,Object> properties,
                                   String attribute,
                                   Object attributeValue,
                                   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 Object removeAttribute(Map<String,String> tenantId,
                              String entityName,
                              Object id,
                              String attribute,
                              String listItemId,
                              Object entity,
                              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 URI getBaseURI()
```
Gets the base uri.

Returns:

the base uri

getClass
```
public Class<?> getClass(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(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(Class clazz)
```
Gets the descriptor for class.

Parameters:

clazz - the clazz

Returns:

the descriptor for class

getJAXBDescriptorForClass
```
public ClassDescriptor getJAXBDescriptorForClass(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 String getName()
```
Gets the name.

Returns:

the name

merge
```
public Object merge(Map<String,String> tenantId,
                    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(String type)
```
A convenience method to create a new dynamic entity of the given type

Parameters:

type -

Returns:

newEntity

public DynamicEntity newEntity(Map<String,String> tenantId,
                               String type)

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

Parameters:: tenantId -; type -
Returns:

queryExecuteUpdate

public int queryExecuteUpdate(Map<String,String> tenantId,
                              String name,
                              Map<?,?> parameters,
                              Map<String,?> hints)

Query execute update.

Parameters:: tenantId - the tenant id; name - the name; parameters - the parameters; hints - the hints
Returns:: the int

queryMultipleResults

public List queryMultipleResults(Map<String,String> tenantId,
                                 String name,
                                 Map<?,?> parameters,
                                 Map<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(Map<String,String> tenantId,
                                          String name,
                                          Map<?,?> parameters,
                                          Map<String,?> hints)

setBaseURI
```
public void setBaseURI(URI baseURI)
```
Sets the base uri.

Parameters:

baseURI - the new base uri

stop
```
public void stop()
```
Stop the current application instance

toString
```
public String toString()
```
To string.

Overrides:

toString in class Object

Returns:

the string

unmarshalEntity
```
public Object unmarshalEntity(String type,
                              javax.ws.rs.core.MediaType acceptedMedia,
                              InputStream in)
                       throws 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:

JAXBException

unmarshalEntity
```
public Object unmarshalEntity(Class type,
                              javax.ws.rs.core.MediaType acceptedMedia,
                              InputStream in)
                       throws 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:

JAXBException

marshallEntity
```
public void marshallEntity(Object object,
                           javax.ws.rs.core.MediaType mediaType,
                           OutputStream output)
                    throws 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:

JAXBException

marshallEntity

public void marshallEntity(Object object,
                           javax.ws.rs.core.MediaType mediaType,
                           OutputStream output,
                           boolean sendRelationships)
                    throws 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:: JAXBException

Class PersistenceContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JPARS_CONTEXT

Constructor Detail

PersistenceContext

Method Detail

isWeavingEnabled

getVersion

setVersion

create

delete

doesExist

finalize

find

find

find

findAttribute

updateOrAddAttribute

removeAttribute

getBaseURI

getClass

getJpaSession

getDescriptor

getDescriptorForClass

getJAXBDescriptorForClass

getEmf

getJAXBContext

getName

merge

newEntity

newEntity

queryExecuteUpdate

queryMultipleResults

buildQuery

setBaseURI

stop

toString

unmarshalEntity

unmarshalEntity

marshallEntity

marshallEntity