Class SessionLazyDelegator

  • All Implemented Interfaces:
    jakarta.persistence.EntityManager, Closeable, Serializable, AutoCloseable, QueryProducer, Session, SharedSessionContract

    public class SessionLazyDelegator
    extends Object
    implements Session
    This helper class allows decorating a Session instance, while the instance itself is lazily provided via a Supplier. When the decorated instance is readily available, one should prefer using SessionDelegatorBaseImpl. Another difference with SessionDelegatorBaseImpl is that this type only implements Session.
    See Also:
    Serialized Form
    • Constructor Detail

      • SessionLazyDelegator

        public SessionLazyDelegator​(Supplier<Session> lazySessionLookup)
    • Method Detail

      • flush

        public void flush()
        Description copied from interface: Session
        Force this session to flush. Must be called at the end of a unit of work, before the transaction is committed. Depending on the current Session.setHibernateFlushMode(FlushMode) flush mode}, the session might automatically flush when EntityTransaction.commit() is called, and it is not necessary to call this method directly.

        Flushing is the process of synchronizing the underlying persistent store with persistable state held in memory.

        Specified by:
        flush in interface jakarta.persistence.EntityManager
        Specified by:
        flush in interface Session
      • setFlushMode

        public void setFlushMode​(jakarta.persistence.FlushModeType flushMode)
        Description copied from interface: Session
        Set the current JPA flush mode for this session.

        Flushing is the process of synchronizing the underlying persistent store with persistable state held in memory. The current flush mode determines when the session is automatically flushed.

        Specified by:
        setFlushMode in interface jakarta.persistence.EntityManager
        Specified by:
        setFlushMode in interface Session
        Parameters:
        flushMode - the new FlushModeType
        See Also:
        for additional options
      • setHibernateFlushMode

        public void setHibernateFlushMode​(FlushMode flushMode)
        Description copied from interface: Session
        Set the current flush mode for this session.

        Flushing is the process of synchronizing the underlying persistent store with persistable state held in memory. The current flush mode determines when the session is automatically flushed.

        The default flush mode is sometimes unnecessarily aggressive. For a logically "read only" session, it's reasonable to set the session's flush mode to FlushMode.MANUAL at the start of the session in order to avoid some unnecessary work.

        Note that FlushMode defines more options than FlushModeType.

        Specified by:
        setHibernateFlushMode in interface Session
        Parameters:
        flushMode - the new FlushMode
      • getFlushMode

        public jakarta.persistence.FlushModeType getFlushMode()
        Description copied from interface: Session
        Get the current JPA flush mode for this session.
        Specified by:
        getFlushMode in interface jakarta.persistence.EntityManager
        Specified by:
        getFlushMode in interface Session
        Returns:
        the FlushModeType currently in effect
      • setCacheMode

        public void setCacheMode​(CacheMode cacheMode)
        Description copied from interface: Session
        Set the current cache mode for this session.

        The cache mode determines the manner in which this session can interact with the second level cache.

        Specified by:
        setCacheMode in interface Session
        Parameters:
        cacheMode - the new cache mode
      • cancelQuery

        public void cancelQuery()
        Description copied from interface: Session
        Cancel the execution of the current query.

        This is the sole method on session which may be safely called from another thread.

        Specified by:
        cancelQuery in interface Session
      • isDirty

        public boolean isDirty()
        Description copied from interface: Session
        Does this session contain any changes which must be synchronized with the database? In other words, would any DML operations be executed if we flushed this session?
        Specified by:
        isDirty in interface Session
        Returns:
        true if the session contains pending changes; false otherwise.
      • isDefaultReadOnly

        public boolean isDefaultReadOnly()
        Description copied from interface: Session
        Will entities and proxies that are loaded into this session be made read-only by default?

        To determine the read-only/modifiable setting for a particular entity or proxy use Session.isReadOnly(Object).

        Specified by:
        isDefaultReadOnly in interface Session
        Returns:
        true, loaded entities/proxies will be made read-only by default; false, loaded entities/proxies will be made modifiable by default.
        See Also:
        Session.isReadOnly(Object)
      • setDefaultReadOnly

        public void setDefaultReadOnly​(boolean readOnly)
        Description copied from interface: Session
        Change the default for entities and proxies loaded into this session from modifiable to read-only mode, or from modifiable to read-only mode.

        Read-only entities are not dirty-checked and snapshots of persistent state are not maintained. Read-only entities can be modified, but changes are not persisted.

        When a proxy is initialized, the loaded entity will have the same read-only/modifiable setting as the uninitialized proxy has, regardless of the session's current setting.

        To change the read-only/modifiable setting for a particular entity or proxy that already belongs to this session use Session.setReadOnly(Object, boolean).

        To override this session's read-only/modifiable setting for all entities and proxies loaded by a certain Query use Query.setReadOnly(boolean).

        Specified by:
        setDefaultReadOnly in interface Session
        Parameters:
        readOnly - true, the default for loaded entities/proxies is read-only; false, the default for loaded entities/proxies is modifiable
        See Also:
        Session.setReadOnly(Object,boolean), Query.setReadOnly(boolean)
      • getIdentifier

        public Object getIdentifier​(Object object)
        Description copied from interface: Session
        Return the identifier value of the given entity associated with this session. An exception is thrown if the given entity instance is transient or detached in relation to this session.
        Specified by:
        getIdentifier in interface Session
        Parameters:
        object - a persistent instance associated with this session
        Returns:
        the identifier
      • contains

        public boolean contains​(String entityName,
                                Object object)
        Description copied from interface: Session
        Determine if the given entity is associated with this session.
        Specified by:
        contains in interface Session
        Parameters:
        entityName - the entity name
        object - an instance of a persistent class
        Returns:
        true if the given instance is associated with this Session
      • detach

        public void detach​(Object object)
        Description copied from interface: Session
        Remove this instance from the session cache. Changes to the instance will not be synchronized with the database. This operation cascades to associated instances if the association is mapped with CascadeType.DETACH.
        Specified by:
        detach in interface jakarta.persistence.EntityManager
        Specified by:
        detach in interface Session
        Parameters:
        object - the managed instance to detach
      • evict

        public void evict​(Object object)
        Description copied from interface: Session
        Remove this instance from the session cache. Changes to the instance will not be synchronized with the database. This operation cascades to associated instances if the association is mapped with CascadeType.DETACH.

        This operation is a synonym for Session.detach(Object).

        Specified by:
        evict in interface Session
        Parameters:
        object - the managed entity to evict
      • load

        @Deprecated
        public <T> T load​(Class<T> theClass,
                          Object id,
                          LockOptions lockOptions)
        Deprecated.
        Description copied from interface: Session
        Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.
        Specified by:
        load in interface Session
        Parameters:
        theClass - a persistent class
        id - a valid identifier of an existing persistent instance of the class
        lockOptions - contains the lock level
        Returns:
        the persistent instance or proxy
      • load

        @Deprecated
        public Object load​(String entityName,
                           Object id,
                           LockOptions lockOptions)
        Deprecated.
        Description copied from interface: Session
        Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.
        Specified by:
        load in interface Session
        Parameters:
        entityName - a persistent class
        id - a valid identifier of an existing persistent instance of the class
        lockOptions - contains the lock level
        Returns:
        the persistent instance or proxy
      • load

        @Deprecated
        public <T> T load​(Class<T> theClass,
                          Object id)
        Deprecated.
        Description copied from interface: Session
        Return the persistent instance of the given entity class with the given identifier, making the assumption that the instance exists in the database. This method might return a proxied instance that is initialized on-demand, when a non-identifier method is accessed.

        You should not use this method to determine if an instance exists in the database (use get() instead). Use this only to retrieve an instance that you assume exists, where non-existence would be an actual error.

        This operation is very similar to Session.getReference(Class, Object).

        Specified by:
        load in interface Session
        Parameters:
        theClass - a persistent class
        id - a valid identifier of an existing persistent instance of the class
        Returns:
        the persistent instance or proxy
      • load

        @Deprecated
        public Object load​(String entityName,
                           Object id)
        Deprecated.
        Description copied from interface: Session
        Return the persistent instance of the given entity class with the given identifier, making the assumption that the instance exists in the database. This method might return a proxied instance that is initialized on-demand, when a non-identifier method is accessed.

        You should not use this method to determine if an instance exists in the database (use get() instead). Use this only to retrieve an instance that you assume exists, where non-existence would be an actual error.

        Specified by:
        load in interface Session
        Parameters:
        entityName - a persistent class
        id - a valid identifier of an existing persistent instance of the class
        Returns:
        the persistent instance or proxy
      • load

        public void load​(Object object,
                         Object id)
        Description copied from interface: Session
        Read the persistent state associated with the given identifier into the given transient instance.
        Specified by:
        load in interface Session
      • replicate

        @Deprecated
        public void replicate​(Object object,
                              ReplicationMode replicationMode)
        Deprecated.
        Description copied from interface: Session
        Persist the state of the given detached instance, reusing the current identifier value. This operation cascades to associated instances if the association is mapped with CascadeType.REPLICATE.
        Specified by:
        replicate in interface Session
        Parameters:
        object - a detached instance of a persistent class
        replicationMode - the replication mode to use
      • replicate

        @Deprecated
        public void replicate​(String entityName,
                              Object object,
                              ReplicationMode replicationMode)
        Deprecated.
        Description copied from interface: Session
        Persist the state of the given detached instance, reusing the current identifier value. This operation cascades to associated instances if the association is mapped with CascadeType.REPLICATE.
        Specified by:
        replicate in interface Session
        Parameters:
        entityName - the entity name
        object - a detached instance of a persistent class
        replicationMode - the replication mode to use
      • save

        @Deprecated
        public Object save​(Object object)
        Deprecated.
        Description copied from interface: Session
        Persist the given transient instance, first assigning a generated identifier. (Or using the current value of the identifier property if the assigned generator is used.) This operation cascades to associated instances if the association is mapped with CascadeType.SAVE_UPDATE.

        This operation is very similar to Session.persist(Object).

        Specified by:
        save in interface Session
        Parameters:
        object - a transient instance of a persistent class
        Returns:
        the generated identifier
      • save

        @Deprecated
        public Object save​(String entityName,
                           Object object)
        Deprecated.
        Description copied from interface: Session
        Persist the given transient instance, first assigning a generated identifier. (Or using the current value of the identifier property if the assigned generator is used.) This operation cascades to associated instances if the association is mapped with CascadeType.SAVE_UPDATE.
        Specified by:
        save in interface Session
        Parameters:
        entityName - the entity name
        object - a transient instance of a persistent class
        Returns:
        the generated identifier
      • update

        @Deprecated
        public void update​(Object object)
        Deprecated.
        Description copied from interface: Session
        Update the persistent instance with the identifier of the given detached instance. If there is a persistent instance with the same identifier, an exception is thrown. This operation cascades to associated instances if the association is mapped with CascadeType.SAVE_UPDATE.
        Specified by:
        update in interface Session
        Parameters:
        object - a detached instance containing updated state
      • update

        @Deprecated
        public void update​(String entityName,
                           Object object)
        Deprecated.
        Description copied from interface: Session
        Update the persistent instance with the identifier of the given detached instance. If there is a persistent instance with the same identifier, an exception is thrown. This operation cascades to associated instances if the association is mapped with CascadeType.SAVE_UPDATE.
        Specified by:
        update in interface Session
        Parameters:
        entityName - the entity name
        object - a detached instance containing updated state
      • merge

        public <T> T merge​(T object)
        Description copied from interface: Session
        Copy the state of the given object onto the persistent object with the same identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If the given instance is unsaved, save a copy and return it as a newly persistent instance. The given instance does not become associated with the session. This operation cascades to associated instances if the association is mapped with CascadeType.MERGE.
        Specified by:
        merge in interface jakarta.persistence.EntityManager
        Specified by:
        merge in interface Session
        Parameters:
        object - a detached instance with state to be copied
        Returns:
        an updated persistent instance
      • merge

        public <T> T merge​(String entityName,
                           T object)
        Description copied from interface: Session
        Copy the state of the given object onto the persistent object with the same identifier. If there is no persistent instance currently associated with the session, it will be loaded. Return the persistent instance. If the given instance is unsaved, save a copy and return it as a newly persistent instance. The given instance does not become associated with the session. This operation cascades to associated instances if the association is mapped with CascadeType.MERGE.
        Specified by:
        merge in interface Session
        Parameters:
        entityName - the entity name
        object - a detached instance with state to be copied
        Returns:
        an updated persistent instance
      • persist

        public void persist​(Object object)
        Description copied from interface: Session
        Make a transient instance persistent and mark it for later insertion in the database. This operation cascades to associated instances if the association is mapped with CascadeType.PERSIST.

        For entities with a generated id, persist() ultimately results in generation of an identifier for the given instance. But this may happen asynchronously, when the session is flushed, depending on the identifier generation strategy.

        Specified by:
        persist in interface jakarta.persistence.EntityManager
        Specified by:
        persist in interface Session
        Parameters:
        object - a transient instance to be made persistent
      • persist

        public void persist​(String entityName,
                            Object object)
        Description copied from interface: Session
        Make a transient instance persistent and mark it for later insertion in the database. This operation cascades to associated instances if the association is mapped with CascadeType.PERSIST.

        For entities with a generated id, persist() ultimately results in generation of an identifier for the given instance. But this may happen asynchronously, when the session is flushed, depending on the identifier generation strategy.

        Specified by:
        persist in interface Session
        Parameters:
        entityName - the entity name
        object - a transient instance to be made persistent
      • delete

        @Deprecated
        public void delete​(Object object)
        Deprecated.
        Description copied from interface: Session
        Remove a persistent instance from the datastore. The argument may be an instance associated with the receiving Session or a transient instance with an identifier associated with existing persistent state. This operation cascades to associated instances if the association is mapped with CascadeType.REMOVE.
        Specified by:
        delete in interface Session
        Parameters:
        object - the instance to be removed
      • delete

        @Deprecated
        public void delete​(String entityName,
                           Object object)
        Deprecated.
        Description copied from interface: Session
        Remove a persistent instance from the datastore. The second argument may be an instance associated with the receiving Session or a transient instance with an identifier associated with existing persistent state. This operation cascades to associated instances if the association is mapped with CascadeType.REMOVE.
        Specified by:
        delete in interface Session
        Parameters:
        entityName - the entity name for the instance to be removed.
        object - the instance to be removed
      • buildLockRequest

        public Session.LockRequest buildLockRequest​(LockOptions lockOptions)
        Description copied from interface: Session
        Build a new lock request that specifies:
        • the LockMode to use,
        • the pessimistic lock timeout, and
        • the scope of the lock.
        Timeout and scope are ignored if the specified LockMode represents a form of optimistic locking.

        Call Session.LockRequest.lock(Object) to actually obtain the requested lock on a managed entity instance.

        Example usage: session.buildLockRequest().setLockMode(LockMode.PESSIMISTIC_WRITE).setTimeOut(60000).lock(entity);

        Specified by:
        buildLockRequest in interface Session
        Parameters:
        lockOptions - contains the lock level
        Returns:
        a Session.LockRequest that can be used to lock any given object.
      • refresh

        public void refresh​(Object object)
        Description copied from interface: Session
        Reread the state of the given managed instance associated with this session from the underlying database. This may be useful:
        • when a database trigger alters the object state upon insert or update
        • after executing any HQL update or delete statement
        • after executing a native SQL statement
        • after inserting a Blob or Clob
        This operation cascades to associated instances if the association is mapped with CascadeType.REFRESH.
        Specified by:
        refresh in interface jakarta.persistence.EntityManager
        Specified by:
        refresh in interface Session
        Parameters:
        object - a persistent or detached instance
      • refresh

        @Deprecated
        public void refresh​(String entityName,
                            Object object)
        Deprecated.
        Description copied from interface: Session
        Reread the state of the given managed instance associated with this session from the underlying database. This may be useful:
        • when a database trigger alters the object state upon insert or update
        • after executing any HQL update or delete statement
        • after executing a native SQL statement
        • after inserting a Blob or Clob
        This operation cascades to associated instances if the association is mapped with CascadeType.REFRESH.
        Specified by:
        refresh in interface Session
        Parameters:
        entityName - a persistent class
        object - a persistent or detached instance
      • refresh

        public void refresh​(Object object,
                            LockOptions lockOptions)
        Description copied from interface: Session
        Reread the state of the given managed instance from the underlying database, obtaining the given LockMode.
        Specified by:
        refresh in interface Session
        Parameters:
        object - a persistent or detached instance
        lockOptions - contains the lock mode to use
      • refresh

        @Deprecated
        public void refresh​(String entityName,
                            Object object,
                            LockOptions lockOptions)
        Deprecated.
        Description copied from interface: Session
        Reread the state of the given managed instance from the underlying database, obtaining the given LockMode.
        Specified by:
        refresh in interface Session
        Parameters:
        entityName - a persistent class
        object - a persistent or detached instance
        lockOptions - contains the lock mode to use
      • remove

        public void remove​(Object object)
        Description copied from interface: Session
        Mark a persistence instance associated with this session for removal from the underlying database. Ths operation cascades to associated instances if the association is mapped CascadeType.REMOVE.
        Specified by:
        remove in interface jakarta.persistence.EntityManager
        Specified by:
        remove in interface Session
        Parameters:
        object - the managed persistent instance to remove
      • getCurrentLockMode

        public LockMode getCurrentLockMode​(Object object)
        Description copied from interface: Session
        Determine the current LockMode of the given managed instance associated with this session.
        Specified by:
        getCurrentLockMode in interface Session
        Parameters:
        object - a persistent instance
        Returns:
        the current lock mode
      • clear

        public void clear()
        Description copied from interface: Session
        Completely clear the session. Evict all loaded instances and cancel all pending saves, updates and deletions. Do not close open iterators or instances of ScrollableResults.
        Specified by:
        clear in interface jakarta.persistence.EntityManager
        Specified by:
        clear in interface Session
      • get

        public <T> T get​(Class<T> entityType,
                         Object id)
        Description copied from interface: Session
        Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance.

        This operation is very similar to EntityManager.find(Class, Object).

        Specified by:
        get in interface Session
        Parameters:
        entityType - the entity type
        id - an identifier
        Returns:
        a persistent instance or null
      • get

        public <T> T get​(Class<T> entityType,
                         Object id,
                         LockMode lockMode)
        Description copied from interface: Session
        Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance. Obtain the specified lock mode if the instance exists.

        Convenient form of Session.get(Class, Object, LockOptions).

        This operation is very similar to EntityManager.find(Class, Object, jakarta.persistence.LockModeType).

        Specified by:
        get in interface Session
        Parameters:
        entityType - the entity type
        id - an identifier
        lockMode - the lock mode
        Returns:
        a persistent instance or null
        See Also:
        Session.get(Class, Object, LockOptions)
      • get

        public <T> T get​(Class<T> entityType,
                         Object id,
                         LockOptions lockOptions)
        Description copied from interface: Session
        Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance. Obtain the specified lock mode if the instance exists.
        Specified by:
        get in interface Session
        Parameters:
        entityType - the entity type
        id - an identifier
        lockOptions - the lock mode
        Returns:
        a persistent instance or null
      • get

        public Object get​(String entityName,
                          Object id)
        Description copied from interface: Session
        Return the persistent instance of the given named entity with the given identifier, or null if there is no such persistent instance. If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance.
        Specified by:
        get in interface Session
        Parameters:
        entityName - the entity name
        id - an identifier
        Returns:
        a persistent instance or null
      • get

        public Object get​(String entityName,
                          Object id,
                          LockMode lockMode)
        Description copied from interface: Session
        Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. (If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance.) Obtain the specified lock mode if the instance exists.

        Convenient form of Session.get(String, Object, LockOptions)

        Specified by:
        get in interface Session
        Parameters:
        entityName - the entity name
        id - an identifier
        lockMode - the lock mode
        Returns:
        a persistent instance or null
        See Also:
        Session.get(String, Object, LockOptions)
      • get

        public Object get​(String entityName,
                          Object id,
                          LockOptions lockOptions)
        Description copied from interface: Session
        Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance. If the instance is already associated with the session, return that instance. This method never returns an uninitialized instance. Obtain the specified lock mode if the instance exists.
        Specified by:
        get in interface Session
        Parameters:
        entityName - the entity name
        id - an identifier
        lockOptions - contains the lock mode
        Returns:
        a persistent instance or null
      • getEntityName

        public String getEntityName​(Object object)
        Description copied from interface: Session
        Return the entity name for a persistent entity.
        Specified by:
        getEntityName in interface Session
        Parameters:
        object - a persistent entity associated with this session
        Returns:
        the entity name
      • getReference

        public <T> T getReference​(Class<T> entityType,
                                  Object id)
        Description copied from interface: Session
        Return a reference to the persistent instance with the given class and identifier, making the assumption that the instance is still persistent in the database. This method never results in access to the underlying data store, and thus might return a proxy that is initialized on-demand, when a non-identifier method is accessed.

        Note that Hibernate.createDetachedProxy(SessionFactory, Class, Object) may be used to obtain a detached reference.

        Specified by:
        getReference in interface jakarta.persistence.EntityManager
        Specified by:
        getReference in interface Session
        Parameters:
        entityType - the entity type
        id - the identifier of a persistent instance that exists in the database
        Returns:
        the persistent instance or proxy
      • getReference

        public Object getReference​(String entityName,
                                   Object id)
        Description copied from interface: Session
        Return a reference to the persistent instance of the given named entity with the given identifier, making the assumption that the instance is still persistent in the database. This method never results in access to the underlying data store, and thus might return a proxy that is initialized on-demand, when a non-identifier method is accessed.
        Specified by:
        getReference in interface Session
        Parameters:
        entityName - the entity name
        id - the identifier of a persistent instance that exists in the database
        Returns:
        the persistent instance or proxy
      • getReference

        public <T> T getReference​(T object)
        Description copied from interface: Session
        Return a reference to the persistent instance with the same identity as the given instance, which might be detached, making the assumption that the instance is still persistent in the database. This method never results in access to the underlying data store, and thus might return a proxy that is initialized on-demand, when a non-identifier method is accessed.
        Specified by:
        getReference in interface Session
        Parameters:
        object - a detached persistent instance
        Returns:
        the persistent instance or proxy
      • byId

        public <T> IdentifierLoadAccess<T> byId​(String entityName)
        Description copied from interface: Session
        Create an IdentifierLoadAccess instance to retrieve the specified entity type by primary key.
        Specified by:
        byId in interface Session
        Parameters:
        entityName - the entity name of the entity type to be retrieved
        Returns:
        load delegate for loading the specified entity type by primary key
      • byMultipleIds

        public <T> MultiIdentifierLoadAccess<T> byMultipleIds​(Class<T> entityClass)
        Description copied from interface: Session
        Create a MultiIdentifierLoadAccess instance to retrieve multiple entities at once as specified by primary key values.
        Specified by:
        byMultipleIds in interface Session
        Parameters:
        entityClass - the entity type to be retrieved
        Returns:
        load delegate for loading the specified entity type by primary key values
      • byMultipleIds

        public <T> MultiIdentifierLoadAccess<T> byMultipleIds​(String entityName)
        Description copied from interface: Session
        Create a MultiIdentifierLoadAccess instance to retrieve multiple entities at once as specified by primary key values.
        Specified by:
        byMultipleIds in interface Session
        Parameters:
        entityName - the entity name of the entity type to be retrieved
        Returns:
        load delegate for loading the specified entity type by primary key values
      • byId

        public <T> IdentifierLoadAccess<T> byId​(Class<T> entityClass)
        Description copied from interface: Session
        Create an IdentifierLoadAccess instance to retrieve the specified entity by primary key.
        Specified by:
        byId in interface Session
        Parameters:
        entityClass - the entity type to be retrieved
        Returns:
        load delegate for loading the specified entity type by primary key
      • byNaturalId

        public <T> NaturalIdLoadAccess<T> byNaturalId​(String entityName)
        Description copied from interface: Session
        Create a NaturalIdLoadAccess instance to retrieve the specified entity by its natural id.
        Specified by:
        byNaturalId in interface Session
        Parameters:
        entityName - the entity name of the entity type to be retrieved
        Returns:
        load delegate for loading the specified entity type by natural id
      • byNaturalId

        public <T> NaturalIdLoadAccess<T> byNaturalId​(Class<T> entityClass)
        Description copied from interface: Session
        Create a NaturalIdLoadAccess instance to retrieve the specified entity by its natural id.
        Specified by:
        byNaturalId in interface Session
        Parameters:
        entityClass - the entity type to be retrieved
        Returns:
        load delegate for loading the specified entity type by natural id
      • enableFilter

        public Filter enableFilter​(String filterName)
        Description copied from interface: Session
        Enable the named filter for this current session.
        Specified by:
        enableFilter in interface Session
        Parameters:
        filterName - the name of the filter to be enabled.
        Returns:
        the Filter instance representing the enabled filter.
      • getEnabledFilter

        public Filter getEnabledFilter​(String filterName)
        Description copied from interface: Session
        Retrieve a currently enabled filter by name.
        Specified by:
        getEnabledFilter in interface Session
        Parameters:
        filterName - the name of the filter to be retrieved.
        Returns:
        the Filter instance representing the enabled filter.
      • disableFilter

        public void disableFilter​(String filterName)
        Description copied from interface: Session
        Disable the named filter for the current session.
        Specified by:
        disableFilter in interface Session
        Parameters:
        filterName - the name of the filter to be disabled.
      • isReadOnly

        public boolean isReadOnly​(Object entityOrProxy)
        Description copied from interface: Session
        Is the specified entity or proxy read-only?

        To get the default read-only/modifiable setting used for entities and proxies that are loaded into the session use Session.isDefaultReadOnly()

        Specified by:
        isReadOnly in interface Session
        Parameters:
        entityOrProxy - an entity or proxy
        Returns:
        true if the entity or proxy is read-only, false if the entity or proxy is modifiable.
        See Also:
        Session.isDefaultReadOnly()
      • setReadOnly

        public void setReadOnly​(Object entityOrProxy,
                                boolean readOnly)
        Description copied from interface: Session
        Set an unmodified persistent object to read-only mode, or a read-only object to modifiable mode. In read-only mode, no snapshot is maintained, the instance is never dirty checked, and changes are not persisted.

        If the entity or proxy already has the specified read-only/modifiable setting, then this method does nothing.

        To set the default read-only/modifiable setting used for all entities and proxies that are loaded into the session use Session.setDefaultReadOnly(boolean).

        To override this session's read-only/modifiable setting for entities and proxies loaded by a Query use Query.setReadOnly(boolean)

        Specified by:
        setReadOnly in interface Session
        Parameters:
        entityOrProxy - an entity or proxy
        readOnly - true if the entity or proxy should be made read-only; false if the entity or proxy should be made modifiable
        See Also:
        Session.setDefaultReadOnly(boolean), Query.setReadOnly(boolean)
      • getLobHelper

        public LobHelper getLobHelper()
        Description copied from interface: Session
        Retrieve this session's helper/delegate for creating LOB instances.
        Specified by:
        getLobHelper in interface Session
        Returns:
        this session's LOB helper
      • addEventListeners

        public void addEventListeners​(SessionEventListener... listeners)
        Description copied from interface: Session
        Add one or more listeners to the Session
        Specified by:
        addEventListeners in interface Session
        Parameters:
        listeners - the listener(s) to add
      • createEntityGraph

        public <T> RootGraph<T> createEntityGraph​(Class<T> rootType)
        Specified by:
        createEntityGraph in interface jakarta.persistence.EntityManager
        Specified by:
        createEntityGraph in interface Session
      • createEntityGraph

        public RootGraph<?> createEntityGraph​(String graphName)
        Specified by:
        createEntityGraph in interface jakarta.persistence.EntityManager
        Specified by:
        createEntityGraph in interface Session
      • getEntityGraph

        public RootGraph<?> getEntityGraph​(String graphName)
        Specified by:
        getEntityGraph in interface jakarta.persistence.EntityManager
        Specified by:
        getEntityGraph in interface Session
      • getEntityGraphs

        public <T> List<jakarta.persistence.EntityGraph<? super T>> getEntityGraphs​(Class<T> entityClass)
        Specified by:
        getEntityGraphs in interface jakarta.persistence.EntityManager
        Specified by:
        getEntityGraphs in interface Session
      • createQuery

        public <R> Query<R> createQuery​(String queryString,
                                        Class<R> resultClass)
        Description copied from interface: QueryProducer
        Create a typed Query instance for the given HQL query string.

        The returned Query may be executed by calling Query.getResultList() or Query.getSingleResult().

        Specified by:
        createQuery in interface jakarta.persistence.EntityManager
        Specified by:
        createQuery in interface QueryProducer
        Specified by:
        createQuery in interface Session
        Parameters:
        queryString - The HQL query
        resultClass - The type of the query result
        Returns:
        The Query instance for manipulation and execution
        See Also:
        EntityManager.createQuery(String,Class)
      • createQuery

        @Deprecated
        public Query createQuery​(String queryString)
        Deprecated.
        Description copied from interface: QueryProducer
        Create a Query instance for the given HQL query, or HQL insert, update, or delete statement.
        Specified by:
        createQuery in interface jakarta.persistence.EntityManager
        Specified by:
        createQuery in interface QueryProducer
        Specified by:
        createQuery in interface Session
        Parameters:
        queryString - The HQL query
        Returns:
        The Query instance for manipulation and execution
        See Also:
        EntityManager.createQuery(String)
      • createNamedQuery

        public <R> Query<R> createNamedQuery​(String name,
                                             Class<R> resultClass)
        Description copied from interface: QueryProducer
        Create a typed Query instance for the given named query. The named query might be defined in HQL or in native SQL.
        Specified by:
        createNamedQuery in interface jakarta.persistence.EntityManager
        Specified by:
        createNamedQuery in interface QueryProducer
        Specified by:
        createNamedQuery in interface Session
        Parameters:
        name - the name of a query defined in metadata
        resultClass - the type of the query result
        Returns:
        The Query instance for manipulation and execution
        See Also:
        EntityManager.createNamedQuery(String,Class)
      • createNamedQuery

        @Deprecated
        public Query createNamedQuery​(String name)
        Deprecated.
        Description copied from interface: QueryProducer
        Create a typed Query instance for the given named query. The named query might be defined in HQL or in native SQL.
        Specified by:
        createNamedQuery in interface jakarta.persistence.EntityManager
        Specified by:
        createNamedQuery in interface QueryProducer
        Specified by:
        createNamedQuery in interface Session
        Parameters:
        name - the name of a pre-defined, named query
        Returns:
        The Query instance for manipulation and execution
        See Also:
        EntityManager.createNamedQuery(String)
      • createQuery

        public <R> Query<R> createQuery​(jakarta.persistence.criteria.CriteriaQuery<R> criteriaQuery)
        Description copied from interface: QueryProducer
        Create a Query for the given JPA CriteriaQuery
        Specified by:
        createQuery in interface jakarta.persistence.EntityManager
        Specified by:
        createQuery in interface QueryProducer
        Specified by:
        createQuery in interface Session
      • createQuery

        @Deprecated
        public Query createQuery​(jakarta.persistence.criteria.CriteriaDelete deleteQuery)
        Deprecated.
        Description copied from interface: Session
        Create a Query for the given JPA CriteriaDelete
        Specified by:
        createQuery in interface jakarta.persistence.EntityManager
        Specified by:
        createQuery in interface QueryProducer
        Specified by:
        createQuery in interface Session
      • createQuery

        @Deprecated
        public Query createQuery​(jakarta.persistence.criteria.CriteriaUpdate updateQuery)
        Deprecated.
        Description copied from interface: Session
        Create a Query for the given JPA CriteriaUpdate
        Specified by:
        createQuery in interface jakarta.persistence.EntityManager
        Specified by:
        createQuery in interface QueryProducer
        Specified by:
        createQuery in interface Session
      • isOpen

        public boolean isOpen()
        Description copied from interface: SharedSessionContract
        Check if the session is still open.
        Specified by:
        isOpen in interface jakarta.persistence.EntityManager
        Specified by:
        isOpen in interface SharedSessionContract
        Returns:
        boolean
      • createStoredProcedureCall

        public ProcedureCall createStoredProcedureCall​(String procedureName,
                                                       Class<?>... resultClasses)
        Description copied from interface: SharedSessionContract
        Create a ProcedureCall to a stored procedure with the given result set entity mappings. Each given class is considered a "root return".
        Specified by:
        createStoredProcedureCall in interface SharedSessionContract
        Parameters:
        procedureName - The name of the procedure.
        resultClasses - The entity(s) to map the result on to.
        Returns:
        The representation of the procedure call.
      • createStoredProcedureCall

        public ProcedureCall createStoredProcedureCall​(String procedureName,
                                                       String... resultSetMappings)
        Description copied from interface: SharedSessionContract
        Create a ProcedureCall to a stored procedure with the given result set entity mappings.
        Specified by:
        createStoredProcedureCall in interface SharedSessionContract
        Parameters:
        procedureName - The name of the procedure.
        resultSetMappings - The explicit result set mapping(s) to use for mapping the results
        Returns:
        The representation of the procedure call.
      • createStoredProcedureQuery

        public ProcedureCall createStoredProcedureQuery​(String procedureName,
                                                        Class... resultClasses)
        Description copied from interface: SharedSessionContract
        Create a ProcedureCall to a stored procedure with the given result set entity mappings. Each given class is considered a "root return".
        Specified by:
        createStoredProcedureQuery in interface jakarta.persistence.EntityManager
        Specified by:
        createStoredProcedureQuery in interface SharedSessionContract
        Parameters:
        procedureName - The name of the procedure.
        resultClasses - The entity(s) to map the result on to.
        Returns:
        The representation of the procedure call.
      • createStoredProcedureQuery

        public ProcedureCall createStoredProcedureQuery​(String procedureName,
                                                        String... resultSetMappings)
        Description copied from interface: SharedSessionContract
        Create a ProcedureCall to a stored procedure with the given result set entity mappings.
        Specified by:
        createStoredProcedureQuery in interface jakarta.persistence.EntityManager
        Specified by:
        createStoredProcedureQuery in interface SharedSessionContract
        Parameters:
        procedureName - The name of the procedure.
        resultSetMappings - The explicit result set mapping(s) to use for mapping the results
        Returns:
        The representation of the procedure call.
      • createNativeQuery

        @Deprecated
        public NativeQuery createNativeQuery​(String sqlString)
        Deprecated.
        Description copied from interface: QueryProducer
        Create a NativeQuery instance for the given native (SQL) query
        Specified by:
        createNativeQuery in interface jakarta.persistence.EntityManager
        Specified by:
        createNativeQuery in interface QueryProducer
        Parameters:
        sqlString - a native SQL query string
        Returns:
        The NativeQuery instance for manipulation and execution
        See Also:
        EntityManager.createNativeQuery(String)
      • createNativeQuery

        public NativeQuery createNativeQuery​(String sqlString,
                                             Class resultClass)
        Description copied from interface: QueryProducer
        Create a NativeQuery instance for the given native (SQL) query using implicit mapping to the specified Java type.

        If the given class is an entity class, this method is equivalent to createNativeQuery(sqlString).addEntity("alias1", resultClass).

        Specified by:
        createNativeQuery in interface jakarta.persistence.EntityManager
        Specified by:
        createNativeQuery in interface QueryProducer
        Parameters:
        sqlString - The native (SQL) query string
        resultClass - The Java entity type to map results to
        Returns:
        The NativeQuery instance for manipulation and execution
        See Also:
        EntityManager.createNativeQuery(String,Class)
      • createNativeQuery

        public <R> NativeQuery<R> createNativeQuery​(String sqlString,
                                                    Class<R> resultClass,
                                                    String tableAlias)
        Description copied from interface: QueryProducer
        Create a NativeQuery instance for the given native (SQL) query using implicit mapping to the specified Java type.

        If the given class is an entity class, this method is equivalent to createNativeQuery(sqlString).addEntity(tableAlias, resultClass).

        Specified by:
        createNativeQuery in interface QueryProducer
        Parameters:
        sqlString - Native (SQL) query string
        resultClass - The Java entity type to map results to
        tableAlias - The table alias for columns in the result set
        Returns:
        The NativeQuery instance for manipulation and execution
        See Also:
        EntityManager.createNativeQuery(String,Class)
      • createNativeQuery

        @Deprecated
        public NativeQuery createNativeQuery​(String sqlString,
                                             String resultSetMappingName)
        Deprecated.
        Description copied from interface: QueryProducer
        Create a NativeQuery instance for the given native (SQL) query using implicit mapping to the specified Java type.
        Specified by:
        createNativeQuery in interface jakarta.persistence.EntityManager
        Specified by:
        createNativeQuery in interface QueryProducer
        Parameters:
        sqlString - The native (SQL) query string
        resultSetMappingName - The explicit result mapping name
        Returns:
        The NativeQuery instance for manipulation and execution
        See Also:
        EntityManager.createNativeQuery(String,Class), SqlResultSetMapping
      • createNativeQuery

        public <R> NativeQuery<R> createNativeQuery​(String sqlString,
                                                    String resultSetMappingName,
                                                    Class<R> resultClass)
        Description copied from interface: QueryProducer
        Create a NativeQuery instance for the given native (SQL) query using implicit mapping to the specified Java type.
        Specified by:
        createNativeQuery in interface QueryProducer
        Parameters:
        sqlString - The native (SQL) query string
        resultSetMappingName - The explicit result mapping name
        Returns:
        The NativeQuery instance for manipulation and execution
        See Also:
        EntityManager.createNativeQuery(String,Class), SqlResultSetMapping
      • getNamedQuery

        @Deprecated
        public Query getNamedQuery​(String queryName)
        Deprecated.
        Description copied from interface: QueryProducer
        Create a Query instance for the named query.
        Specified by:
        getNamedQuery in interface QueryProducer
        Parameters:
        queryName - the name of a pre-defined, named query
        Returns:
        The Query instance for manipulation and execution
      • find

        public <T> T find​(Class<T> entityClass,
                          Object primaryKey)
        Specified by:
        find in interface jakarta.persistence.EntityManager
      • find

        public <T> T find​(Class<T> entityClass,
                          Object primaryKey,
                          Map<String,​Object> properties)
        Specified by:
        find in interface jakarta.persistence.EntityManager
      • find

        public <T> T find​(Class<T> entityClass,
                          Object primaryKey,
                          jakarta.persistence.LockModeType lockMode)
        Specified by:
        find in interface jakarta.persistence.EntityManager
      • find

        public <T> T find​(Class<T> entityClass,
                          Object primaryKey,
                          jakarta.persistence.LockModeType lockMode,
                          Map<String,​Object> properties)
        Specified by:
        find in interface jakarta.persistence.EntityManager
      • lock

        public void lock​(Object entity,
                         jakarta.persistence.LockModeType lockMode)
        Specified by:
        lock in interface jakarta.persistence.EntityManager
      • lock

        public void lock​(Object entity,
                         jakarta.persistence.LockModeType lockMode,
                         Map<String,​Object> properties)
        Specified by:
        lock in interface jakarta.persistence.EntityManager
      • refresh

        public void refresh​(Object entity,
                            Map<String,​Object> properties)
        Specified by:
        refresh in interface jakarta.persistence.EntityManager
      • refresh

        public void refresh​(Object entity,
                            jakarta.persistence.LockModeType lockMode)
        Specified by:
        refresh in interface jakarta.persistence.EntityManager
      • refresh

        public void refresh​(Object entity,
                            jakarta.persistence.LockModeType lockMode,
                            Map<String,​Object> properties)
        Specified by:
        refresh in interface jakarta.persistence.EntityManager
      • contains

        public boolean contains​(Object entity)
        Specified by:
        contains in interface jakarta.persistence.EntityManager
      • getLockMode

        public jakarta.persistence.LockModeType getLockMode​(Object entity)
        Specified by:
        getLockMode in interface jakarta.persistence.EntityManager
      • setProperty

        public void setProperty​(String propertyName,
                                Object value)
        Specified by:
        setProperty in interface jakarta.persistence.EntityManager
      • getProperties

        public Map<String,​Object> getProperties()
        Specified by:
        getProperties in interface jakarta.persistence.EntityManager
      • joinTransaction

        public void joinTransaction()
        Specified by:
        joinTransaction in interface jakarta.persistence.EntityManager
      • isJoinedToTransaction

        public boolean isJoinedToTransaction()
        Specified by:
        isJoinedToTransaction in interface jakarta.persistence.EntityManager
      • unwrap

        public <T> T unwrap​(Class<T> cls)
        Specified by:
        unwrap in interface jakarta.persistence.EntityManager
      • getDelegate

        public Object getDelegate()
        Specified by:
        getDelegate in interface jakarta.persistence.EntityManager
      • getEntityManagerFactory

        public jakarta.persistence.EntityManagerFactory getEntityManagerFactory()
        Specified by:
        getEntityManagerFactory in interface jakarta.persistence.EntityManager
      • getMetamodel

        public jakarta.persistence.metamodel.Metamodel getMetamodel()
        Specified by:
        getMetamodel in interface jakarta.persistence.EntityManager