Module eclipselink
Package org.eclipse.persistence.jpa.rs

Class 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 Detail

      • CLASS_NAME

        public static final String CLASS_NAME

      • adapters

        protected List<jakarta.xml.bind.annotation.adapters.XmlAdapter<?,​?>> adapters

      • name

        protected String name
        The name of the persistence context is used to look it up. By default it will be the persistence unit name of the JPA persistence unit.

      • emf

        protected jakarta.persistence.EntityManagerFactory emf
        The EntityManagerFactory used to interact using JPA

      • jaxbContext

        protected JAXBContext jaxbContext
        The JAXBConext used to produce JSON or XML

      • baseURI

        protected URI baseURI
        The URI of the Persistence context. This is used to build Links in JSON and XML

    • Constructor Detail

      • PersistenceContext

        protected PersistenceContext()

      • PersistenceContext

        public PersistenceContext​(String emfName,
                          jakarta.persistence.EntityManagerFactory emf,
                          URI defaultURI)
        Instantiates a new persistence context.
        Parameters:
        emfName - the emf name
        emf - the emf
        defaultURI - the default uri

      • PersistenceContext

        public PersistenceContext​(String emfName,
                          jakarta.persistence.EntityManagerFactory emf,
                          URI defaultURI,
                          ServiceVersion version)
        Instantiates a new persistence context.
        Parameters:
        emfName - the emf name
        emf - the emf
        defaultURI - the default uri
        version - REST service version

    • Method Detail

      • isWeavingEnabled

        public boolean isWeavingEnabled()
        Checks if is weaving enabled.
        Returns:
        true, if is weaving enabled

      • getVersion

        public String getVersion()
        Gets the version as it appears in URI.
        Returns:
        The version.

      • getServiceVersion

        public ServiceVersion getServiceVersion()
        Gets JPARS version.
        Returns:
        JPARS version.

      • addDynamicXMLMetadataSources

        protected void addDynamicXMLMetadataSources​(List<Object> metadataSources,
                                            Session session)
        This method is used to help construct a JAXBContext from an existing EntityManagerFactory. For each package in the EntityManagerFactory, a MetadataSource that is capable of building a JAXBContext that creates the same mappings in JAXB is created. These MetadataSources are used to constuct the JAXContext that is used for JSON and XML translation.

      • createDynamicJAXBContext

        protected JAXBContext createDynamicJAXBContext​(Session session)
                                        throws jakarta.xml.bind.JAXBException,
                                               IOException
        Create a JAXBContext based on the EntityManagerFactory for this PersistenceContext.
        Throws:
        jakarta.xml.bind.JAXBException
        IOException

      • createEntityManagerFactory

        protected jakarta.persistence.EntityManagerFactory createEntityManagerFactory​(jakarta.persistence.spi.PersistenceUnitInfo info,
                                                                              Map<String,​?> properties)
        A part of the facade over the JPA API. Create an EntityManagerFactory using the given PersistenceUnitInfo and properties.

      • createEntityManager

        protected jakarta.persistence.EntityManager createEntityManager​(String tenantId)
        A part of the facade over the JPA API Create an EntityManager from the EntityManagerFactory wrapped by this persistence context

      • createJAXBProperties

        protected Map<String,​Object> createJAXBProperties​(Session session)
                                                 throws IOException
        Build the set of properties used to create the JAXBContext based on the EntityManagerFactory that this PersistenceContext wraps
        Throws:
        IOException

      • 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

      • 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

      • 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

      • 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:
        properties - - query hints used on the find

      • 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
        attribute - the attribute
        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

      • getServerSession

        public DatabaseSession getServerSession()
        Gets the jpa server session.
        Returns:
        the jpa server session

      • getClientSession

        public org.eclipse.persistence.internal.sessions.AbstractSession getClientSession​(jakarta.persistence.EntityManager em)
        Gets the client session.
        Parameters:
        em - the em
        Returns:
        the client 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.

      • 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 jakarta.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

      • getSessionLog

        public SessionLog getSessionLog()

      • 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

      • newEntity

        public DynamicEntity newEntity​(String type)
        A convenience method to create a new dynamic entity of the given type

      • 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

      • constructQuery

        protected jakarta.persistence.Query constructQuery​(jakarta.persistence.EntityManager em,
                                                   String name,
                                                   Map<?,​?> parameters,
                                                   Map<String,​?> hints)

      • buildQuery

        public jakarta.persistence.Query buildQuery​(Map<String,​String> tenantId,
                                            String name,
                                            Map<?,​?> parameters,
                                            Map<String,​?> hints)
        Builds the query.
        Parameters:
        tenantId - the tenant id
        name - the name
        parameters - the parameters
        hints - the hints
        Returns:
        the query

      • 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,
                              jakarta.ws.rs.core.MediaType acceptedMediaType,
                              InputStream in)
                       throws jakarta.xml.bind.JAXBException
        Unmarshal entity.
        Parameters:
        type - the type of the entity to unmarshal
        acceptedMediaType - the accepted media type
        in - the input stream to unmarshal
        Returns:
        the object
        Throws:
        jakarta.xml.bind.JAXBException - the JAXB exception

      • unmarshal

        public Object unmarshal​(Class type,
                        jakarta.ws.rs.core.MediaType acceptedMediaType,
                        InputStream in)
                 throws jakarta.xml.bind.JAXBException
        Unmarshal.
        Parameters:
        type - the type of the entity to unmarshal
        acceptedMediaType - the accepted media type
        in - the input stream to unmarshal
        Returns:
        the object
        Throws:
        jakarta.xml.bind.JAXBException - the JAXB exception

      • wrap

        protected Object wrap​(Object entity)
        Make adjustments to an unmarshalled entity based on what is found in the weaved fields

      • marshallEntity

        public void marshallEntity​(Object object,
                           jakarta.ws.rs.core.MediaType mediaType,
                           OutputStream output)
                    throws jakarta.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
        Throws:
        jakarta.xml.bind.JAXBException

      • marshallEntity

        public void marshallEntity​(Object object,
                           FieldsFilter filter,
                           jakarta.ws.rs.core.MediaType mediaType,
                           OutputStream output)
                    throws jakarta.xml.bind.JAXBException
        Marshall an entity to either JSON or XML.
        Parameters:
        object - the object to marshal.
        filter - the filter (included/excluded fields) to use.
        mediaType - the media type (XML/JSON).
        output - the result.
        Throws:
        jakarta.xml.bind.JAXBException

      • marshall

        public void marshall​(Object object,
                     jakarta.ws.rs.core.MediaType mediaType,
                     OutputStream output,
                     boolean sendRelationships)
              throws jakarta.xml.bind.JAXBException
        Marshall an entity to either JSON or XML.
        Parameters:
        sendRelationships - if this is set to true, relationships will be sent as links instead of sending. the actual objects in the relationships
        Throws:
        jakarta.xml.bind.JAXBException

      • marshall

        public void marshall​(Object object,
                     jakarta.ws.rs.core.MediaType mediaType,
                     OutputStream output,
                     boolean sendRelationships,
                     FieldsFilter fieldsFilter)
              throws jakarta.xml.bind.JAXBException
        Marshall an entity to either JSON or XML.
        Parameters:
        object - the object to marshal.
        mediaType - the media type (XML/JSON).
        output - the result.
        sendRelationships - if this is set to true, relationships will be sent as links instead of sending the actual objects in the relationships.
        fieldsFilter - Specifies fields to include/exclude from the response.
        Throws:
        jakarta.xml.bind.JAXBException

      • preMarshallEntity

        protected void preMarshallEntity​(Object object)
        Process an entity and add any additional data that needs to be added prior to marshalling This method will both single entities and lists of entities

      • preMarshallIndividualEntity

        protected void preMarshallIndividualEntity​(Object entity)
        Add any data required prior to marshalling an entity to XML or JSON In general, this will only affect fields that have been weaved into the object

      • postMarshallEntity

        protected void postMarshallEntity​(Object object)

      • getSupportedFeatureSet

        public FeatureSet getSupportedFeatureSet()
        Gets the supported feature set.
        Returns:
        the supported feature set.

      • isQueryPageable

        public boolean isQueryPageable​(String queryName)
        Finds out is given query pageable or not.
        Parameters:
        queryName - named query to check.
        Returns:
        true if pageable, false if not.

      • getPageableQuery

        public RestPageableQuery getPageableQuery​(String queryName)
        Gets REST pageable query details by query name.
        Parameters:
        queryName - named query name.
        Returns:
        RestPageableQuery or null if query couldn't be found.

      • setVersion

        public void setVersion​(String version)
        Sets the version.
        Parameters:
        version - the new version.

      • setBaseURI

        public void setBaseURI​(URI baseURI)
        Sets the base uri.
        Parameters:
        baseURI - the new base uri

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object