org.openmrs.api.db.hibernate

Class DbSession

java.lang.Object

org.openmrs.api.db.hibernate.DbSession

public class DbSession
extends Object

This class has been created to provide backwards compatibility for modules, which need to support OpenMRS 1.12 and before. It is because org.hibernate.classic.Session has been removed in Hibernate 4 (used in OpenMRS 1.12) and sessionFactory.getCurrentSession() has been changed to return org.hibernate.Session. It wraps SessionFactory so that any calls to getCurrentSession() are directed to the correct Session class.

Since:

1.12, 1.11.3, 1.10.2, 1.9.9

Constructor Summary

Constructors

Constructor and Description
DbSession(org.hibernate.SessionFactory sessionFactory)

Method Summary

Modifier and Type	Method and Description
void	addEventListeners(org.hibernate.SessionEventListener... listeners) Add one or more listeners to the Session
org.hibernate.Transaction	beginTransaction() Begin a unit of work and return the associated Transaction object.
org.hibernate.Session.LockRequest	buildLockRequest(org.hibernate.LockOptions lockOptions) Build a LockRequest that specifies the LockMode, pessimistic lock timeout and lock scope.
org.hibernate.IdentifierLoadAccess	byId(Class entityClass) Create an IdentifierLoadAccess instance to retrieve the specified entity by primary key.
org.hibernate.IdentifierLoadAccess	byId(String entityName) Create an IdentifierLoadAccess instance to retrieve the specified entity type by primary key.
org.hibernate.NaturalIdLoadAccess	byNaturalId(Class entityClass) Create an NaturalIdLoadAccess instance to retrieve the specified entity by its natural id.
org.hibernate.NaturalIdLoadAccess	byNaturalId(String entityName) Create an NaturalIdLoadAccess instance to retrieve the specified entity by its natural id.
org.hibernate.SimpleNaturalIdLoadAccess	bySimpleNaturalId(Class entityClass) Create an SimpleNaturalIdLoadAccess instance to retrieve the specified entity by its simple (single attribute) natural id.
org.hibernate.SimpleNaturalIdLoadAccess	bySimpleNaturalId(String entityName) Create an SimpleNaturalIdLoadAccess instance to retrieve the specified entity by its natural id.
void	cancelQuery() Cancel the execution of the current query.
void	clear() Completely clear the session.
Connection	close() End the session by releasing the JDBC connection and cleaning up.
boolean	contains(Object object) Check if this instance is associated with this Session.
org.hibernate.Criteria	createCriteria(Class persistentClass) Create Criteria instance for the given class (entity or subclasses/implementors).
org.hibernate.Criteria	createCriteria(Class persistentClass, String alias) Create Criteria instance for the given class (entity or subclasses/implementors), using a specific alias.
org.hibernate.Criteria	createCriteria(String entityName) Create Criteria instance for the given entity name.
org.hibernate.Criteria	createCriteria(String entityName, String alias) Create Criteria instance for the given entity name, using a specific alias.
org.hibernate.Query	createFilter(Object collection, String queryString) Create a Query instance for the given collection and filter string.
org.hibernate.Query	createQuery(String queryString) Create a Query instance for the given HQL query string.
org.hibernate.SQLQuery	createSQLQuery(String queryString) Create a SQLQuery instance for the given SQL query string.
org.hibernate.procedure.ProcedureCall	createStoredProcedureCall(String procedureName) Creates a call to a stored procedure.
org.hibernate.procedure.ProcedureCall	createStoredProcedureCall(String procedureName, Class... resultClasses) Creates a call to a stored procedure with specific result set entity mappings.
org.hibernate.procedure.ProcedureCall	createStoredProcedureCall(String procedureName, String... resultSetMappings) Creates a call to a stored procedure with specific result set entity mappings.
void	delete(Object object) Remove a persistent instance from the datastore.
void	delete(String entityName, Object object) Remove a persistent instance from the datastore.
void	disableFetchProfile(String name) Disable a particular fetch profile on this session.
void	disableFilter(String filterName) Disable the named filter for the current session.
<T> T	doReturningWork(org.hibernate.jdbc.ReturningWork<T> work) Controller for allowing users to perform JDBC related work using the Connection managed by this Session.
void	doWork(org.hibernate.jdbc.Work work) Controller for allowing users to perform JDBC related work using the Connection managed by this Session.
void	enableFetchProfile(String name) Enable a particular fetch profile on this session.
org.hibernate.Filter	enableFilter(String filterName) Enable the named filter for this current session.
void	evict(Object object) Remove this instance from the session cache.
void	flush() Force this session to flush.
Object	get(Class clazz, Serializable id) Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
Object	get(Class clazz, Serializable id, org.hibernate.LockOptions lockOptions) Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
Object	get(String entityName, Serializable id) Return the persistent instance of the given named entity with the given identifier, or null if there is no such persistent instance.
Object	get(String entityName, Serializable id, org.hibernate.LockOptions lockOptions) Return the persistent instance of the given entity class with the given identifier, or null if there is no such persistent instance.
org.hibernate.CacheMode	getCacheMode() Get the current cache mode.
org.hibernate.LockMode	getCurrentLockMode(Object object) Determine the current lock mode of the given object.
org.hibernate.Filter	getEnabledFilter(String filterName) Retrieve a currently enabled filter by name.
String	getEntityName(Object object) Return the entity name for a persistent entity.
org.hibernate.FlushMode	getFlushMode() Get the current flush mode for this session.
Serializable	getIdentifier(Object object) Return the identifier value of the given entity as associated with this session.
org.hibernate.LobHelper	getLobHelper() Retrieve this session's helper/delegate for creating LOB instances.
org.hibernate.procedure.ProcedureCall	getNamedProcedureCall(String name) Gets a ProcedureCall based on a named template
org.hibernate.Query	getNamedQuery(String queryName) Create a Query instance for the named query string defined in the metadata.
org.hibernate.SessionFactory	getSessionFactory() Get the session factory which created this session.
org.hibernate.stat.SessionStatistics	getStatistics() Get the statistics for this session.
String	getTenantIdentifier() Obtain the tenant identifier associated with this session.
org.hibernate.Transaction	getTransaction() Get the Transaction instance associated with this session.
org.hibernate.TypeHelper	getTypeHelper() Convenience access to the TypeHelper associated with this session's SessionFactory.
boolean	isConnected() Check if the session is currently connected.
boolean	isDefaultReadOnly() Will entities and proxies that are loaded into this session be made read-only by default?
boolean	isDirty() Does this session contain any changes which must be synchronized with the database?
boolean	isFetchProfileEnabled(String name) Is a particular fetch profile enabled on this session?
boolean	isOpen() Check if the session is still open.
boolean	isReadOnly(Object entityOrProxy) Is the specified entity or proxy read-only?
Object	load(Class theClass, Serializable id) Return the persistent instance of the given entity class with the given identifier, assuming that the instance exists.
Object	load(Class theClass, Serializable id, org.hibernate.LockOptions lockOptions) Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.
void	load(Object object, Serializable id) Read the persistent state associated with the given identifier into the given transient instance.
Object	load(String entityName, Serializable id) Return the persistent instance of the given entity class with the given identifier, assuming that the instance exists.
Object	load(String entityName, Serializable id, org.hibernate.LockOptions lockOptions) Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.
Object	merge(Object object) Copy the state of the given object onto the persistent object with the same identifier.
Object	merge(String entityName, Object object) Copy the state of the given object onto the persistent object with the same identifier.
void	persist(Object object) Make a transient instance persistent.
void	persist(String entityName, Object object) Make a transient instance persistent.
void	refresh(Object object) Re-read the state of the given instance from the underlying database.
void	refresh(Object object, org.hibernate.LockOptions lockOptions) Re-read the state of the given instance from the underlying database, with the given LockMode.
void	refresh(String entityName, Object object) Re-read the state of the given instance from the underlying database.
void	refresh(String entityName, Object object, org.hibernate.LockOptions lockOptions) Re-read the state of the given instance from the underlying database, with the given LockMode.
void	replicate(Object object, org.hibernate.ReplicationMode replicationMode) Persist the state of the given detached instance, reusing the current identifier value.
void	replicate(String entityName, Object object, org.hibernate.ReplicationMode replicationMode) Persist the state of the given detached instance, reusing the current identifier value.
Serializable	save(Object object) Persist the given transient instance, first assigning a generated identifier.
Serializable	save(String entityName, Object object) Persist the given transient instance, first assigning a generated identifier.
void	saveOrUpdate(Object object) Either save(Object) or update(Object) the given instance, depending upon resolution of the unsaved-value checks (see the manual for discussion of unsaved-value checking).
void	saveOrUpdate(String entityName, Object object) Either save(String, Object) or update(String, Object) the given instance, depending upon resolution of the unsaved-value checks (see the manual for discussion of unsaved-value checking).
org.hibernate.SharedSessionBuilder	sessionWithOptions() Obtain a Session builder with the ability to grab certain information from this session.
void	setCacheMode(org.hibernate.CacheMode cacheMode) Set the cache mode.
void	setDefaultReadOnly(boolean readOnly) Change the default for entities and proxies loaded into this session from modifiable to read-only mode, or from modifiable to read-only mode.
void	setFlushMode(org.hibernate.FlushMode flushMode) Set the flush mode for this session.
void	setReadOnly(Object entityOrProxy, boolean readOnly) Set an unmodified persistent object to read-only mode, or a read-only object to modifiable mode.
void	update(Object object) Update the persistent instance with the identifier of the given detached instance.
void	update(String entityName, Object object) Update the persistent instance with the identifier of the given detached instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbSession

public DbSession(org.hibernate.SessionFactory sessionFactory)

Method Detail

getTenantIdentifier

public String getTenantIdentifier()

Obtain the tenant identifier associated with this session.

Returns:

The tenant identifier associated with this session, or null

beginTransaction

public org.hibernate.Transaction beginTransaction()

Begin a unit of work and return the associated Transaction object. If a new underlying transaction is required, begin the transaction. Otherwise continue the new work in the context of the existing underlying transaction.

Returns:

a Transaction instance

See Also:

getTransaction()

getTransaction

public org.hibernate.Transaction getTransaction()

Get the Transaction instance associated with this session. The concrete type of the returned Transaction object is determined by the hibernate.transaction_factory property.

Returns:

a Transaction instance

getNamedQuery

public org.hibernate.Query getNamedQuery(String queryName)

Create a Query instance for the named query string defined in the metadata.

Parameters:

queryName - the name of a query defined externally

Returns:

The query instance for manipulation and execution

createQuery

public org.hibernate.Query createQuery(String queryString)

Create a Query instance for the given HQL query string.

Parameters:

queryString - The HQL query

Returns:

The query instance for manipulation and execution

createSQLQuery

public org.hibernate.SQLQuery createSQLQuery(String queryString)

Create a SQLQuery instance for the given SQL query string.

Parameters:

queryString - The SQL query

Returns:

The query instance for manipulation and execution

getNamedProcedureCall

public org.hibernate.procedure.ProcedureCall getNamedProcedureCall(String name)

Gets a ProcedureCall based on a named template

Parameters:

name - The name given to the template

Returns:

The ProcedureCall

See Also:

NamedStoredProcedureQuery

createStoredProcedureCall

public org.hibernate.procedure.ProcedureCall createStoredProcedureCall(String procedureName)

Creates a call to a stored procedure.

Parameters:

procedureName - The name of the procedure.

Returns:

The representation of the procedure call.

createStoredProcedureCall

public org.hibernate.procedure.ProcedureCall createStoredProcedureCall(String procedureName,
                                                                       Class... resultClasses)

Creates a call to a stored procedure with specific result set entity mappings. Each class named is considered a "root return".

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 org.hibernate.procedure.ProcedureCall createStoredProcedureCall(String procedureName,
                                                                       String... resultSetMappings)

Creates a call to a stored procedure with specific result set entity mappings.

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.

createCriteria

public org.hibernate.Criteria createCriteria(Class persistentClass)

Create Criteria instance for the given class (entity or subclasses/implementors).

Parameters:

persistentClass - The class, which is an entity, or has entity subclasses/implementors

Returns:

The criteria instance for manipulation and execution

createCriteria

public org.hibernate.Criteria createCriteria(Class persistentClass,
                                             String alias)

Create Criteria instance for the given class (entity or subclasses/implementors), using a specific alias.

Parameters:

persistentClass - The class, which is an entity, or has entity subclasses/implementors

alias - The alias to use

Returns:

The criteria instance for manipulation and execution

createCriteria

public org.hibernate.Criteria createCriteria(String entityName)

Create Criteria instance for the given entity name.

Parameters:

entityName - The entity name @return The criteria instance for manipulation and execution

createCriteria

public org.hibernate.Criteria createCriteria(String entityName,
                                             String alias)

Create Criteria instance for the given entity name, using a specific alias.

Parameters:

entityName - The entity name

alias - The alias to use

Returns:

The criteria instance for manipulation and execution

sessionWithOptions

public org.hibernate.SharedSessionBuilder sessionWithOptions()

Obtain a Session builder with the ability to grab certain information from this session.

Returns:

The session builder

flush

public void flush()
           throws org.hibernate.HibernateException

Force this session to flush. Must be called at the end of a unit of work, before committing the transaction and closing the session (depending on setFlushMode(FlushMode), EntityTransaction.commit() calls this method).

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

Throws:

org.hibernate.HibernateException - Indicates problems flushing the session or talking to the database.

setFlushMode

public void setFlushMode(org.hibernate.FlushMode flushMode)

Set the flush mode for this session.

The flush mode determines the points at which the session is flushed. Flushing is the process of synchronizing the underlying persistent store with persistable state held in memory.

For a logically "read only" session, it is reasonable to set the session's flush mode to FlushMode.MANUAL at the start of the session (in order to achieve some extra performance).

Parameters:

flushMode - the new flush mode

See Also:

FlushMode

getFlushMode

public org.hibernate.FlushMode getFlushMode()

Get the current flush mode for this session.

Returns:

The flush mode

setCacheMode

public void setCacheMode(org.hibernate.CacheMode cacheMode)

Set the cache mode.

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

Parameters:

cacheMode - The new cache mode.

getCacheMode

public org.hibernate.CacheMode getCacheMode()

Get the current cache mode.

Returns:

The current cache mode.

getSessionFactory

public org.hibernate.SessionFactory getSessionFactory()

Get the session factory which created this session.

Returns:

The session factory.

See Also:

SessionFactory

close

public Connection close()
                 throws org.hibernate.HibernateException

End the session by releasing the JDBC connection and cleaning up. It is not strictly necessary to close the session but you must at least disconnect() it.

Returns:

the connection provided by the application or null.

Throws:

org.hibernate.HibernateException - Indicates problems cleaning up.

cancelQuery

public void cancelQuery()
                 throws org.hibernate.HibernateException

Cancel the execution of the current query.

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

Throws:

org.hibernate.HibernateException - There was a problem canceling the query

isOpen

public boolean isOpen()

Check if the session is still open.

Returns:

boolean

isConnected

public boolean isConnected()

Check if the session is currently connected.

Returns:

boolean

isDirty

public boolean isDirty()
                throws org.hibernate.HibernateException

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?

Returns:

True if the session contains pending changes; false otherwise.

Throws:

org.hibernate.HibernateException - could not perform dirtying checking

isDefaultReadOnly

public boolean isDefaultReadOnly()

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:

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)

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 is already in this session:

Parameters:

readOnly - true, the default for loaded entities/proxies is read-only; false, the default for loaded entities/proxies is modifiable

See Also:

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

getIdentifier

public Serializable getIdentifier(Object object)

Return the identifier value of the given entity as associated with this session. An exception is thrown if the given entity instance is transient or detached in relation to this session.

Parameters:

object - a persistent instance

Returns:

the identifier

Throws:

org.hibernate.TransientObjectException - if the instance is transient or associated with a different session

contains

public boolean contains(Object object)

Check if this instance is associated with this Session.

Parameters:

object - an instance of a persistent class

Returns:

true if the given instance is associated with this Session

evict

public void evict(Object object)

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 cascade="evict".

Parameters:

object - The entity to evict

Throws:

NullPointerException - if the passed object is null

IllegalArgumentException - if the passed object is not defined as an entity

load

public Object load(Class theClass,
                   Serializable id,
                   org.hibernate.LockOptions lockOptions)

Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.

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

public Object load(String entityName,
                   Serializable id,
                   org.hibernate.LockOptions lockOptions)

Return the persistent instance of the given entity class with the given identifier, obtaining the specified lock mode, assuming the instance exists.

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

public Object load(Class theClass,
                   Serializable id)

Return the persistent instance of the given entity class with the given identifier, assuming that the instance exists. 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 (use get() instead). Use this only to retrieve an instance that you assume exists, where non-existence would be an actual error.

Parameters:

theClass - a persistent class

id - a valid identifier of an existing persistent instance of the class

Returns:

the persistent instance or proxy

load

public Object load(String entityName,
                   Serializable id)

Return the persistent instance of the given entity class with the given identifier, assuming that the instance exists. 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 (use get() instead). Use this only to retrieve an instance that you assume exists, where non-existence would be an actual error.

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,
                 Serializable id)

Read the persistent state associated with the given identifier into the given transient instance.

Parameters:

object - an "empty" instance of the persistent class

id - a valid identifier of an existing persistent instance of the class

replicate

public void replicate(Object object,
                      org.hibernate.ReplicationMode replicationMode)

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 cascade="replicate"

Parameters:

object - a detached instance of a persistent class

replicationMode - The replication mode to use

replicate

public void replicate(String entityName,
                      Object object,
                      org.hibernate.ReplicationMode replicationMode)

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 cascade="replicate"

Parameters:

entityName - The entity name

object - a detached instance of a persistent class

replicationMode - The replication mode to use

save

public Serializable save(Object object)

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 cascade="save-update"

Parameters:

object - a transient instance of a persistent class

Returns:

the generated identifier

save

public Serializable save(String entityName,
                         Object object)

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 cascade="save-update"

Parameters:

entityName - The entity name

object - a transient instance of a persistent class

Returns:

the generated identifier

saveOrUpdate

public void saveOrUpdate(Object object)

Either save(Object) or update(Object) the given instance, depending upon resolution of the unsaved-value checks (see the manual for discussion of unsaved-value checking).

This operation cascades to associated instances if the association is mapped with cascade="save-update"

Parameters:

object - a transient or detached instance containing new or updated state

See Also:

Session.save(java.lang.Object), Session.update(Object object)

saveOrUpdate

public void saveOrUpdate(String entityName,
                         Object object)

Either save(String, Object) or update(String, Object) the given instance, depending upon resolution of the unsaved-value checks (see the manual for discussion of unsaved-value checking).

This operation cascades to associated instances if the association is mapped with cascade="save-update"

Parameters:

entityName - The entity name

object - a transient or detached instance containing new or updated state

See Also:

Session.save(String,Object), Session.update(String,Object)

update

public void update(Object object)

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 cascade="save-update"

Parameters:

object - a detached instance containing updated state

update

public void update(String entityName,
                   Object object)

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 cascade="save-update"

Parameters:

entityName - The entity name

object - a detached instance containing updated state

merge

public Object merge(Object object)

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 of 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 cascade="merge"

The semantics of this method are defined by JSR-220.

Parameters:

object - a detached instance with state to be copied

Returns:

an updated persistent instance

merge

public Object merge(String entityName,
                    Object object)

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 of 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 cascade="merge"

The semantics of this method are defined by JSR-220.

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)

Make a transient instance persistent. This operation cascades to associated instances if the association is mapped with cascade="persist"

The semantics of this method are defined by JSR-220.

Parameters:

object - a transient instance to be made persistent

persist

public void persist(String entityName,
                    Object object)

Make a transient instance persistent. This operation cascades to associated instances if the association is mapped with cascade="persist"

The semantics of this method are defined by JSR-220.

Parameters:

entityName - The entity name

object - a transient instance to be made persistent

delete

public void delete(Object object)

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 cascade="delete"

Parameters:

object - the instance to be removed

delete

public void delete(String entityName,
                   Object object)

Remove a persistent instance from the datastore. The object 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 cascade="delete"

Parameters:

entityName - The entity name for the instance to be removed.

object - the instance to be removed

buildLockRequest

public org.hibernate.Session.LockRequest buildLockRequest(org.hibernate.LockOptions lockOptions)

Build a LockRequest that specifies the LockMode, pessimistic lock timeout and lock scope. timeout and scope is ignored for optimistic locking. After building the LockRequest, call LockRequest.lock to perform the requested locking.

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

Parameters:

lockOptions - contains the lock level

Returns:

a lockRequest that can be used to lock the passed object.

refresh

public void refresh(Object object)

Re-read the state of the given instance from the underlying database. It is inadvisable to use this to implement long-running sessions that span many business tasks. This method is, however, useful in certain special circumstances. For example

• where a database trigger alters the object state upon insert or update
• after executing direct SQL (eg. a mass update) in the same session
• after inserting a Blob or Clob

Parameters:

object - a persistent or detached instance

refresh

public void refresh(String entityName,
                    Object object)

Re-read the state of the given instance from the underlying database. It is inadvisable to use this to implement long-running sessions that span many business tasks. This method is, however, useful in certain special circumstances. For example

• where a database trigger alters the object state upon insert or update
• after executing direct SQL (eg. a mass update) in the same session
• after inserting a Blob or Clob

Parameters:

entityName - a persistent class

object - a persistent or detached instance

refresh

public void refresh(Object object,
                    org.hibernate.LockOptions lockOptions)

Re-read the state of the given instance from the underlying database, with the given LockMode. It is inadvisable to use this to implement long-running sessions that span many business tasks. This method is, however, useful in certain special circumstances.

Parameters:

object - a persistent or detached instance

lockOptions - contains the lock mode to use

refresh

public void refresh(String entityName,
                    Object object,
                    org.hibernate.LockOptions lockOptions)

Re-read the state of the given instance from the underlying database, with the given LockMode. It is inadvisable to use this to implement long-running sessions that span many business tasks. This method is, however, useful in certain special circumstances.

Parameters:

entityName - a persistent class

object - a persistent or detached instance

lockOptions - contains the lock mode to use

getCurrentLockMode

public org.hibernate.LockMode getCurrentLockMode(Object object)

Determine the current lock mode of the given object.

Parameters:

object - a persistent instance

Returns:

the current lock mode

createFilter

public org.hibernate.Query createFilter(Object collection,
                                        String queryString)

Create a Query instance for the given collection and filter string. Contains an implicit FROM element named this which refers to the defined table for the collection elements, as well as an implicit WHERE restriction for this particular collection instance's key value.

Parameters:

collection - a persistent collection

queryString - a Hibernate query fragment.

Returns:

The query instance for manipulation and execution

clear

public void clear()

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 .

get

public Object get(Class clazz,
                  Serializable id)

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.)

Parameters:

clazz - a persistent class

id - an identifier

Returns:

a persistent instance or null

get

public Object get(Class clazz,
                  Serializable id,
                  org.hibernate.LockOptions lockOptions)

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.

Parameters:

clazz - a persistent class

id - an identifier

lockOptions - the lock mode

Returns:

a persistent instance or null

get

public Object get(String entityName,
                  Serializable id)

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.)

Parameters:

entityName - the entity name

id - an identifier

Returns:

a persistent instance or null

get

public Object get(String entityName,
                  Serializable id,
                  org.hibernate.LockOptions lockOptions)

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.

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)

Return the entity name for a persistent entity.

Parameters:

object - a persistent entity

Returns:

the entity name

byId

public org.hibernate.IdentifierLoadAccess byId(String entityName)

Create an IdentifierLoadAccess instance to retrieve the specified entity type by primary key.

Parameters:

entityName - The entity name of the entity type to be retrieved

Returns:

load delegate for loading the specified entity type by primary key

Throws:

org.hibernate.HibernateException - If the specified entity name cannot be resolved as an entity name

byId

public org.hibernate.IdentifierLoadAccess byId(Class entityClass)

Create an IdentifierLoadAccess instance to retrieve the specified entity by primary key.

Parameters:

entityClass - The entity type to be retrieved

Returns:

load delegate for loading the specified entity type by primary key

Throws:

org.hibernate.HibernateException - If the specified Class cannot be resolved as a mapped entity

byNaturalId

public org.hibernate.NaturalIdLoadAccess byNaturalId(String entityName)

Create an NaturalIdLoadAccess instance to retrieve the specified entity by its natural id.

Parameters:

entityName - The entity name of the entity type to be retrieved

Returns:

load delegate for loading the specified entity type by natural id

Throws:

org.hibernate.HibernateException - If the specified entity name cannot be resolved as an entity name

byNaturalId

public org.hibernate.NaturalIdLoadAccess byNaturalId(Class entityClass)

Create an NaturalIdLoadAccess instance to retrieve the specified entity by its natural id.

Parameters:

entityClass - The entity type to be retrieved

Returns:

load delegate for loading the specified entity type by natural id

Throws:

org.hibernate.HibernateException - If the specified Class cannot be resolved as a mapped entity

bySimpleNaturalId

public org.hibernate.SimpleNaturalIdLoadAccess bySimpleNaturalId(String entityName)

Create an SimpleNaturalIdLoadAccess instance to retrieve the specified entity by its natural id.

Parameters:

entityName - The entity name of the entity type to be retrieved

Returns:

load delegate for loading the specified entity type by natural id

Throws:

org.hibernate.HibernateException - If the specified entityClass cannot be resolved as a mapped entity, or if the entity does not define a natural-id or if its natural-id is made up of multiple attributes.

bySimpleNaturalId

public org.hibernate.SimpleNaturalIdLoadAccess bySimpleNaturalId(Class entityClass)

Create an SimpleNaturalIdLoadAccess instance to retrieve the specified entity by its simple (single attribute) natural id.

Parameters:

entityClass - The entity type to be retrieved

Returns:

load delegate for loading the specified entity type by natural id

Throws:

org.hibernate.HibernateException - If the specified entityClass cannot be resolved as a mapped entity, or if the entity does not define a natural-id or if its natural-id is made up of multiple attributes.

enableFilter

public org.hibernate.Filter enableFilter(String filterName)

Enable the named filter for this current session.

Parameters:

filterName - The name of the filter to be enabled.

Returns:

The Filter instance representing the enabled filter.

getEnabledFilter

public org.hibernate.Filter getEnabledFilter(String filterName)

Retrieve a currently enabled filter by name.

Parameters:

filterName - The name of the filter to be retrieved.

Returns:

The Filter instance representing the enabled filter.

disableFilter

public void disableFilter(String filterName)

Disable the named filter for the current session.

Parameters:

filterName - The name of the filter to be disabled.

getStatistics

public org.hibernate.stat.SessionStatistics getStatistics()

Get the statistics for this session.

Returns:

The session statistics being collected for this session

isReadOnly

public boolean isReadOnly(Object entityOrProxy)

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:

Parameters:

entityOrProxy - an entity or HibernateProxy

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)

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 entities and proxies that are loaded into the session:

Parameters:

entityOrProxy - an entity or HibernateProxy

readOnly - true if the entity or proxy should be made read-only; false if the entity or proxy should be made modifiable

See Also:

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

doWork

public void doWork(org.hibernate.jdbc.Work work)
            throws org.hibernate.HibernateException

Controller for allowing users to perform JDBC related work using the Connection managed by this Session.

Parameters:

work - The work to be performed.

Throws:

org.hibernate.HibernateException - Generally indicates wrapped SQLException

doReturningWork

public <T> T doReturningWork(org.hibernate.jdbc.ReturningWork<T> work)
                      throws org.hibernate.HibernateException

Controller for allowing users to perform JDBC related work using the Connection managed by this Session. After execution returns the result of the ReturningWork.execute(java.sql.Connection) call.

Type Parameters:

T - The type of the result returned from the work

Parameters:

work - The work to be performed.

Returns:

the result from calling ReturningWork.execute(java.sql.Connection).

Throws:

org.hibernate.HibernateException - Generally indicates wrapped SQLException

isFetchProfileEnabled

public boolean isFetchProfileEnabled(String name)
                              throws org.hibernate.UnknownProfileException

Is a particular fetch profile enabled on this session?

Parameters:

name - The name of the profile to be checked.

Returns:

True if fetch profile is enabled; false if not.

Throws:

org.hibernate.UnknownProfileException - Indicates that the given name does not match any known profile names

See Also:

for discussion of this feature

enableFetchProfile

public void enableFetchProfile(String name)
                        throws org.hibernate.UnknownProfileException

Enable a particular fetch profile on this session. No-op if requested profile is already enabled.

Parameters:

name - The name of the fetch profile to be enabled.

Throws:

org.hibernate.UnknownProfileException - Indicates that the given name does not match any known profile names

See Also:

for discussion of this feature

disableFetchProfile

public void disableFetchProfile(String name)
                         throws org.hibernate.UnknownProfileException

Disable a particular fetch profile on this session. No-op if requested profile is already disabled.

Parameters:

name - The name of the fetch profile to be disabled.

Throws:

org.hibernate.UnknownProfileException - Indicates that the given name does not match any known profile names

See Also:

for discussion of this feature

getTypeHelper

public org.hibernate.TypeHelper getTypeHelper()

Convenience access to the TypeHelper associated with this session's SessionFactory.

Equivalent to calling getSessionFactory().getTypeHelper()

Returns:

The TypeHelper associated with this session's SessionFactory

getLobHelper

public org.hibernate.LobHelper getLobHelper()

Retrieve this session's helper/delegate for creating LOB instances.

Returns:

This session's LOB helper

addEventListeners

public void addEventListeners(org.hibernate.SessionEventListener... listeners)

Add one or more listeners to the Session

Parameters:

listeners - The listener(s) to add