Session (Hibernate JavaDocs)
org.hibernate
Interface Session
All Superinterfaces: ,
All Known Subinterfaces:
All Known Implementing Classes:
public interface Sessionextends
The main runtime interface between a Java application and Hibernate. This is the
central API class abstracting the notion of a persistence service.
The lifecycle of a Session is bounded by the beginning and end of a logical
transaction. (Long transactions might span several database transactions.)
The main function of the Session is to offer create, read and delete operations
for instances of mapped entity classes. Instances may exist in one of three states:
transient: never persistent, not associated with any Session
persistent: associated with a unique Session
detached: previously persistent, not associated with any Session
Transient instances may be made persistent by calling save(),
persist() or saveOrUpdate(). Persistent instances may be made transient
by calling delete(). Any instance returned by a get() or
load() method is persistent. Detached instances may be made persistent
by calling update(), saveOrUpdate(), lock() or replicate().
The state of a transient or detached instance may also be made persistent as a new
persistent instance by calling merge().
save() and persist() result in an SQL INSERT, delete()
in an SQL DELETE and update() or merge() in an SQL UPDATE.
Changes to persistent instances are detected at flush time and also result in an SQL
UPDATE. saveOrUpdate() and replicate() result in either an
INSERT or an UPDATE.
It is not intended that implementors be threadsafe. Instead each thread/transaction
should obtain its own instance from a SessionFactory.
A Session instance is serializable if its persistent classes are serializable.
A typical transaction should use the following idiom:
Session sess = factory.openSession();
tx = sess.beginTransaction();
//do some work
tx.commit();
catch (Exception e) {
if (tx!=null) tx.rollback();
sess.close();
If the Session throws an exception, the transaction must be rolled back
and the session discarded. The internal state of the Session might not
be consistent with the database after the exception occurs.
static&interface
&&&&&&&&&&Contains locking details (LockMode, Timeout and Scope).
(&lockOptions)
&&&&&&&&&&Build a LockRequest that specifies the LockMode, pessimistic lock timeout and lock scope.
(&entityClass)
&&&&&&&&&&Create an
instance to retrieve the specified entity by
primary key.
(&entityName)
&&&&&&&&&&Create an
instance to retrieve the specified entity type by
primary key.
(&entityClass)
&&&&&&&&&&Create an
instance to retrieve the specified entity by
its natural id.
(&entityName)
&&&&&&&&&&Create an
instance to retrieve the specified entity by
its natural id.
(&entityClass)
&&&&&&&&&&Create an
instance to retrieve the specified entity by
its simple (single attribute) natural id.
(&entityName)
&&&&&&&&&&Create an
instance to retrieve the specified entity by
its natural id.
&&&&&&&&&&Cancel the execution of the current query.
&&&&&&&&&&Completely clear the session.
&&&&&&&&&&End the session by releasing the JDBC connection and cleaning up.
&&&&&&&&&&Check if this instance is associated with this Session.
(&collection,
&queryString)
&&&&&&&&&&Create a
instance for the given collection and filter string.
&&&&&&&&&&Remove a persistent instance from the datastore.
(&entityName,
&&&&&&&&&&Remove a persistent instance from the datastore.
&&&&&&&&&&Disable a particular fetch profile on this session.
(&filterName)
&&&&&&&&&&Disable the named filter for the current session.
&&&&&&&&&&Disconnect the session from its underlying JDBC connection.
(&T&&work)
&&&&&&&&&&Controller for allowing users to perform JDBC related work using the Connection managed by this Session.
&&&&&&&&&&Controller for allowing users to perform JDBC related work using the Connection managed by this Session.
&&&&&&&&&&Enable a particular fetch profile on this session.
(&filterName)
&&&&&&&&&&Enable the named filter for this current session.
&&&&&&&&&&Remove this instance from the session cache.
&&&&&&&&&&Force this session to flush.
&&&&&&&&&&Return the persistent instance of the given entity class with the given identifier,
or null if there is no such persistent instance.
&lockMode)
&&&&&&&&&&Deprecated.&LockMode parameter should be replaced with LockOptions
&lockOptions)
&&&&&&&&&&Return the persistent instance of the given entity class with the given identifier,
or null if there is no such persistent instance.
(&entityName,
&&&&&&&&&&Return the persistent instance of the given named entity with the given identifier,
or null if there is no such persistent instance.
(&entityName,
&lockMode)
&&&&&&&&&&Deprecated.&LockMode parameter should be replaced with LockOptions
(&entityName,
&lockOptions)
&&&&&&&&&&Return the persistent instance of the given entity class with the given identifier,
or null if there is no such persistent instance.
&&&&&&&&&&Get the current cache mode.
&&&&&&&&&&Determine the current lock mode of the given object.
(&filterName)
&&&&&&&&&&Retrieve a currently enabled filter by name.
&&&&&&&&&&Return the entity name for a persistent entity
&&&&&&&&&&Get the current flush mode for this session.
&&&&&&&&&&Return the identifier value of the given entity as associated with this
&&&&&&&&&&Retrieve this session's helper/delegate for creating LOB instances.
&&&&&&&&&&Get the session factory which created this session.
&&&&&&&&&&Get the statistics for this session.
&&&&&&&&&&Convenience access to the
associated with this session's .
&&&&&&&&&&Check if the session is currently connected.
&&&&&&&&&&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
&&&&&&&&&&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?
&&&&&&&&&&Is a particular fetch profile enabled on this session?
&&&&&&&&&&Check if the session is still open.
(&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:
(&theClass,
&&&&&&&&&&Return the persistent instance of the given entity class with the given identifier,
assuming that the instance exists.
(&theClass,
&lockMode)
&&&&&&&&&&Deprecated.&LockMode parameter should be replaced with LockOptions
(&theClass,
&lockOptions)
&&&&&&&&&&Return the persistent instance of the given entity class with the given identifier,
obtaining the specified lock mode, assuming the instance exists.
&&&&&&&&&&Read the persistent state associated with the given identifier into the given transient
(&entityName,
&&&&&&&&&&Return the persistent instance of the given entity class with the given identifier,
assuming that the instance exists.
(&entityName,
&lockMode)
&&&&&&&&&&Deprecated.&LockMode parameter should be replaced with LockOptions
(&entityName,
&lockOptions)
&&&&&&&&&&Return the persistent instance of the given entity class with the given identifier,
obtaining the specified lock mode, assuming the instance exists.
&lockMode)
&&&&&&&&&&Deprecated.&instead call buildLockRequest(LockMode).lock(object)
(&entityName,
&lockMode)
&&&&&&&&&&Deprecated.&instead call buildLockRequest(LockMode).lock(entityName, object)
&&&&&&&&&&Copy the state of the given object onto the persistent object with the same
identifier.
(&entityName,
&&&&&&&&&&Copy the state of the given object onto the persistent object with the same
identifier.
&&&&&&&&&&Make a transient instance persistent.
(&entityName,
&&&&&&&&&&Make a transient instance persistent.
(&connection)
&&&&&&&&&&Reconnect to the given JDBC connection.
&&&&&&&&&&Re-read the state of the given instance from the underlying database.
&lockMode)
&&&&&&&&&&Deprecated.&LockMode parameter should be replaced with LockOptions
&lockOptions)
&&&&&&&&&&Re-read the state of the given instance from the underlying database, with
the given LockMode.
(&entityName,
&&&&&&&&&&Re-read the state of the given instance from the underlying database.
(&entityName,
&lockOptions)
&&&&&&&&&&Re-read the state of the given instance from the underlying database, with
the given LockMode.
&replicationMode)
&&&&&&&&&&Persist the state of the given detached instance, reusing the current
identifier value.
(&entityName,
&replicationMode)
&&&&&&&&&&Persist the state of the given detached instance, reusing the current
identifier value.
&&&&&&&&&&Persist the given transient instance, first assigning a generated identifier.
(&entityName,
&&&&&&&&&&Persist the given transient instance, first assigning a generated identifier.
&&&&&&&&&&Either
instance, depending upon resolution of the unsaved-value checks (see the
manual for discussion of unsaved-value checking).
(&entityName,
&&&&&&&&&&Either
the given instance, depending upon resolution of the unsaved-value checks
(see the manual for discussion of unsaved-value checking).
&&&&&&&&&&Obtain a
builder with the ability to grab certain information from this session.
(&cacheMode)
&&&&&&&&&&Set the cache mode.
(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.
(&flushMode)
&&&&&&&&&&Set the flush mode for this session.
(&entityOrProxy,
boolean&readOnly)
&&&&&&&&&&Set an unmodified persistent object to read-only mode, or a read-only
object to modifiable mode.
&&&&&&&&&&Update the persistent instance with the identifier of the given detached
(&entityName,
&&&&&&&&&&Update the persistent instance with the identifier of the given detached
, , , , , , , , ,
sessionWithOptions
sessionWithOptions()
builder with the ability to grab certain information from this session.
Returns:The session builder
void flush()
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 ,
calls this method).
Flushing is the process of synchronizing the underlying persistent
store with persistable state held in memory.
- Indicates problems flushing the session or
talking to the database.
setFlushMode
void setFlushMode(&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
at the start of the session (in
order to achieve some extra performance).
Parameters:flushMode - the new flush modeSee Also:
getFlushMode
getFlushMode()
Get the current flush mode for this session.
Returns:The flush mode
setCacheMode
void setCacheMode(&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
getCacheMode()
Get the current cache mode.
Returns:The current cache mode.
getSessionFactory
getSessionFactory()
Get the session factory which created this session.
Returns:The session factory.See Also:
End the session by releasing the JDBC connection and cleaning up.
not strictly necessary to close the session but you must at least
Returns:the connection provided by the application or null.
- Indicates problems cleaning up.
cancelQuery
void cancelQuery()
Cancel the execution of the current query.
This is the sole method on session which may be safely called from
another thread.
- There was a problem canceling the query
boolean isOpen()
Check if the session is still open.
Returns:boolean
isConnected
boolean isConnected()
Check if the session is currently connected.
Returns:boolean
boolean isDirty()
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 cont false otherwise.
- could not perform dirtying checking
isDefaultReadOnly
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
Returns:true, loaded entities/proxies will be made read-
false, loaded entities/proxies will be made modifiable by default.See Also:
setDefaultReadOnly
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-
false, the default for loaded entities/proxies is modifiableSee Also:,
getIdentifier
getIdentifier(&object)
Return the identifier value of the given entity as associated with this
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
- if the instance is transient or associated with
a different session
boolean contains(&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
void evict(&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 - a persistent instance
load(&theClass,
&lockMode)
Deprecated.&LockMode parameter should be replaced with 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 classid - a valid identifier of an existing persistent instance of the classlockMode - the lock level
Returns:the persistent instance or proxy
load(&theClass,
&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 classid - a valid identifier of an existing persistent instance of the classlockOptions - contains the lock level
Returns:the persistent instance or proxy
load(&entityName,
&lockMode)
Deprecated.&LockMode parameter should be replaced with 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 classid - a valid identifier of an existing persistent instance of the classlockMode - the lock level
Returns:the persistent instance or proxy
load(&entityName,
&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 classid - a valid identifier of an existing persistent instance of the classlockOptions - contains the lock level
Returns:the persistent instance or proxy
load(&theClass,
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 classid - a valid identifier of an existing persistent instance of the class
Returns:the persistent instance or proxy
load(&entityName,
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 classid - a valid identifier of an existing persistent instance of the class
Returns:the persistent instance or proxy
void load(&object,
Read the persistent state associated with the given identifier into the given transient
Parameters:object - an "empty" instance of the persistent classid - a valid identifier of an existing persistent instance of the class
void replicate(&object,
&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 classreplicationMode - The replication mode to use
void replicate(&entityName,
&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 nameobject - a detached instance of a persistent classreplicationMode - The replication mode to use
save(&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(&entityName,
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 nameobject - a transient instance of a persistent class
Returns:the generated identifier
saveOrUpdate
void saveOrUpdate(&object)
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 stateSee Also:,
saveOrUpdate
void saveOrUpdate(&entityName,
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 nameobject - a transient or detached instance containing new or updated stateSee Also:,
void update(&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
void update(&entityName,
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 nameobject - a detached instance containing updated state
merge(&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(&entityName,
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 nameobject - a detached instance with state to be copied
Returns:an updated persistent instance
void persist(&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
void persist(&entityName,
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 nameobject - a transient instance to be made persistent
void delete(&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
void delete(&entityName,
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
void lock(&object,
&lockMode)
Deprecated.&instead call buildLockRequest(LockMode).lock(object)
Obtain the specified lock level upon the given object. This may be used to
perform a version check (LockMode.READ), to upgrade to a pessimistic
lock (LockMode.PESSIMISTIC_WRITE), or to simply reassociate a transient instance
with a session (LockMode.NONE). This operation cascades to associated
instances if the association is mapped with cascade="lock".
Parameters:object - a persistent or transient instancelockMode - the lock level
void lock(&entityName,
&lockMode)
Deprecated.&instead call buildLockRequest(LockMode).lock(entityName, object)
Obtain the specified lock level upon the given object. This may be used to
perform a version check (LockMode.OPTIMISTIC), to upgrade to a pessimistic
lock (LockMode.PESSIMISTIC_WRITE), or to simply reassociate a transient instance
with a session (LockMode.NONE). This operation cascades to associated
instances if the association is mapped with cascade="lock".
Parameters:object - a persistent or transient instancelockMode - the lock level
buildLockRequest
buildLockRequest(&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.
void refresh(&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
void refresh(&entityName,
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 classobject - a persistent or detached instance
void refresh(&object,
&lockMode)
Deprecated.&LockMode parameter should be replaced with 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 instancelockMode - the lock mode to use
void refresh(&object,
&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 instancelockOptions - contains the lock mode to use
void refresh(&entityName,
&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 classobject - a persistent or detached instancelockOptions - contains the lock mode to use
getCurrentLockMode
getCurrentLockMode(&object)
Determine the current lock mode of the given object.
Parameters:object - a persistent instance
Returns:the current lock mode
createFilter
createFilter(&collection,
&queryString)
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 collectionqueryString - a Hibernate query fragment.
Returns:The query instance for manipulation and execution
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(&clazz,
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 classid - an identifier
Returns:a persistent instance or null
get(&clazz,
&lockMode)
Deprecated.&LockMode parameter should be replaced with 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 classid - an identifierlockMode - the lock mode
Returns:a persistent instance or null
get(&clazz,
&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 classid - an identifierlockOptions - the lock mode
Returns:a persistent instance or null
get(&entityName,
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 nameid - an identifier
Returns:a persistent instance or null
get(&entityName,
&lockMode)
Deprecated.&LockMode parameter should be replaced with 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 nameid - an identifierlockMode - the lock mode
Returns:a persistent instance or null
get(&entityName,
&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 nameid - an identifierlockOptions - contains the lock mode
Returns:a persistent instance or null
getEntityName
getEntityName(&object)
Return the entity name for a persistent entity
Parameters:object - a persistent entity
Returns:the entity name
byId(&entityName)
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
- If the specified entity name cannot be resolved as an entity name
byId(&entityClass)
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
- If the specified Class cannot be resolved as a mapped entity
byNaturalId
byNaturalId(&entityName)
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
- If the specified entity name cannot be resolved as an entity name
byNaturalId
byNaturalId(&entityClass)
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
- If the specified Class cannot be resolved as a mapped entity
bySimpleNaturalId
bySimpleNaturalId(&entityName)
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
- 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
bySimpleNaturalId(&entityClass)
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
- 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
enableFilter(&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
getEnabledFilter(&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
void disableFilter(&filterName)
Disable the named filter for the current session.
Parameters:filterName - The name of the filter to be disabled.
getStatistics
getStatistics()
Get the statistics for this session.
Returns:The session statistics being collected for this session
isReadOnly
boolean isReadOnly(&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:
setReadOnly
void setReadOnly(&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 HibernateProxyreadOnly - true if the entity or proxy should be made read- false if the entity or
proxy should be made modifiableSee Also:,
void doWork(&work)
Controller for allowing users to perform JDBC related work using the Connection managed by this Session.
Parameters:work - The work to be performed.
- Generally indicates wrapped
doReturningWork
&T& T doReturningWork(&T&&work)
Controller for allowing users to perform JDBC related work using the Connection managed by this Session.
execution returns the result of the
Parameters:work - The work to be performed.
Returns:the result from calling .
- Generally indicates wrapped
disconnect
disconnect()
Disconnect the session from its underlying JDBC connection.
This is intended for use in cases where the
application has supplied the JDBC connection to the session and which require long-sessions (aka, conversations).
It is considered an error to call this method on a session which was not opened by supplying the JDBC connection
and an exception will be thrown.
For non-user-supplied scenarios, normal transaction management already handles disconnection and reconnection
automatically.
Returns:the application-supplied connection or nullSee Also:
void reconnect(&connection)
Reconnect to the given JDBC connection.
Parameters:connection - a JDBC connectionSee Also:
isFetchProfileEnabled
boolean isFetchProfileEnabled(&name)
Is a particular fetch profile enabled on this session?
Parameters:name - The name of the profile to be checked.
Returns:True if fetc false if not.
- Indicates that the given name does not
match any known profile namesSee Also:
enableFetchProfile
void enableFetchProfile(&name)
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.
- Indicates that the given name does not
match any known profile namesSee Also:
disableFetchProfile
void disableFetchProfile(&name)
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.
- Indicates that the given name does not
match any known profile namesSee Also:
getTypeHelper
getTypeHelper()
Convenience access to the
associated with this session's .
Equivalent to calling .
Returns:The
associated with this session's
getLobHelper
getLobHelper()
Retrieve this session's helper/delegate for creating LOB instances.
Returns:This session's LOB helper
Copyright &
All Rights Reserved.