public class SessionDelegatorBaseImpl extends Object implements SessionImplementor, Session
SessionImplementor
and
a Session
. This is useful for custom implementations of this
API so that only some methods need to be overridden
(Used by Hibernate Search).LobCreationContext.Callback<T>
Session.LockRequest
Modifier and Type | Field and Description |
---|---|
protected Session |
session |
protected SessionImplementor |
sessionImplementor |
Constructor and Description |
---|
SessionDelegatorBaseImpl(SessionImplementor sessionImplementor,
Session session) |
Modifier and Type | Method and Description |
---|---|
void |
addEventListeners(SessionEventListener... listeners)
Add one or more listeners to the Session
|
void |
afterScrollOperation() |
Transaction |
beginTransaction()
Begin a unit of work and return the associated
Transaction object. |
String |
bestGuessEntityName(Object object)
The best guess entity name for an entity not in an association
|
Session.LockRequest |
buildLockRequest(LockOptions lockOptions)
Build a LockRequest that specifies the LockMode, pessimistic lock timeout and lock scope.
|
<T> IdentifierLoadAccess<T> |
byId(Class<T> entityClass)
Create an
IdentifierLoadAccess instance to retrieve the specified entity by
primary key. |
IdentifierLoadAccess |
byId(String entityName)
Create an
IdentifierLoadAccess instance to retrieve the specified entity type by
primary key. |
<T> MultiIdentifierLoadAccess<T> |
byMultipleIds(Class<T> entityClass)
Create a
MultiIdentifierLoadAccess instance to retrieve multiple entities at once
as specified by primary key values. |
MultiIdentifierLoadAccess |
byMultipleIds(String entityName)
Create a
MultiIdentifierLoadAccess instance to retrieve multiple entities at once
as specified by primary key values. |
<T> NaturalIdLoadAccess<T> |
byNaturalId(Class<T> entityClass)
Create an
NaturalIdLoadAccess instance to retrieve the specified entity by
its natural id. |
NaturalIdLoadAccess |
byNaturalId(String entityName)
Create an
NaturalIdLoadAccess instance to retrieve the specified entity by
its natural id. |
<T> SimpleNaturalIdLoadAccess<T> |
bySimpleNaturalId(Class<T> entityClass)
Create an
SimpleNaturalIdLoadAccess instance to retrieve the specified entity by
its simple (single attribute) natural id. |
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.
|
void |
close()
End the session by releasing the JDBC connection and cleaning up.
|
Connection |
connection() |
boolean |
contains(Object object)
Check if this instance is associated with this Session.
|
Criteria |
createCriteria(Class persistentClass)
Create
Criteria instance for the given class (entity or subclasses/implementors). |
Criteria |
createCriteria(Class persistentClass,
String alias)
Create
Criteria instance for the given class (entity or subclasses/implementors), using a specific
alias. |
Criteria |
createCriteria(String entityName)
Create
Criteria instance for the given entity name. |
Criteria |
createCriteria(String entityName,
String alias)
Create
Criteria instance for the given entity name, using a specific alias. |
Query |
createFilter(Object collection,
String queryString)
Create a
Query instance for the given collection and filter string. |
Query |
createQuery(NamedQueryDefinition namedQueryDefinition)
Used from EntityManager
|
Query |
createQuery(String queryString)
Create a
Query instance for the given HQL query string. |
SQLQuery |
createSQLQuery(NamedSQLQueryDefinition namedQueryDefinition)
Used from EntityManager
|
SQLQuery |
createSQLQuery(String queryString)
Create a
SQLQuery instance for the given SQL query string. |
ProcedureCall |
createStoredProcedureCall(String procedureName)
Creates a call to a stored procedure.
|
ProcedureCall |
createStoredProcedureCall(String procedureName,
Class... resultClasses)
Creates a call to a stored procedure with specific result set entity mappings.
|
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.
|
void |
disableTransactionAutoJoin()
Disable automatic transaction joining.
|
Connection |
disconnect()
Disconnect the session from its underlying JDBC connection.
|
<T> T |
doReturningWork(ReturningWork<T> work)
Controller for allowing users to perform JDBC related work using the Connection managed by this Session.
|
void |
doWork(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.
|
Filter |
enableFilter(String filterName)
Enable the named filter for this current session.
|
void |
evict(Object object)
Remove this instance from the session cache.
|
<T> T |
execute(LobCreationContext.Callback<T> callback)
Execute the given callback, making sure it has access to a viable JDBC
Connection . |
int |
executeNativeUpdate(NativeSQLQuerySpecification specification,
QueryParameters queryParameters)
Execute a native SQL update or delete query
|
int |
executeUpdate(String query,
QueryParameters queryParameters)
Execute a HQL update or delete query
|
void |
flush()
Force this session to flush.
|
EntityKey |
generateEntityKey(Serializable id,
EntityPersister persister)
Hide the changing requirements of entity key creation
|
<T> T |
get(Class<T> theClass,
Serializable id)
Return the persistent instance of the given entity class with the given identifier,
or null if there is no such persistent instance.
|
<T> T |
get(Class<T> theClass,
Serializable id,
LockMode lockMode)
Return the persistent instance of the given entity class with the given identifier,
or null if there is no such persistent instance.
|
<T> T |
get(Class<T> theClass,
Serializable id,
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,
LockMode lockMode)
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,
LockOptions lockOptions)
Return the persistent instance of the given entity class with the given identifier,
or null if there is no such persistent instance.
|
CacheMode |
getCacheMode()
Get the current cache mode.
|
Serializable |
getContextEntityIdentifier(Object object)
Return the identifier of the persistent object, or null if
not associated with the session
|
LockMode |
getCurrentLockMode(Object object)
Determine the current lock mode of the given object.
|
int |
getDontFlushFromFind() |
Filter |
getEnabledFilter(String filterName)
Retrieve a currently enabled filter by name.
|
String |
getEntityName(Object object)
Return the entity name for a persistent entity.
|
EntityPersister |
getEntityPersister(String entityName,
Object object)
Get the EntityPersister for any instance
|
Object |
getEntityUsingInterceptor(EntityKey key)
Get the entity instance associated with the given Key,
calling the Interceptor if necessary
|
SessionEventListenerManager |
getEventListenerManager() |
SessionFactoryImplementor |
getFactory()
Get the creating SessionFactoryImplementor
|
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.
|
Interceptor |
getInterceptor()
Retrieves the interceptor currently in use by this event source.
|
JdbcConnectionAccess |
getJdbcConnectionAccess()
Provides access to JDBC connections
|
JdbcCoordinator |
getJdbcCoordinator() |
LoadQueryInfluencers |
getLoadQueryInfluencers()
Get the load query influencers associated with this session.
|
LobHelper |
getLobHelper()
Retrieve this session's helper/delegate for creating LOB instances.
|
ProcedureCall |
getNamedProcedureCall(String name)
Gets a ProcedureCall based on a named template
|
Query |
getNamedQuery(String name)
Get a Query instance for a named query or named native SQL query
|
Query |
getNamedSQLQuery(String name)
Get a Query instance for a named native SQL query
|
PersistenceContext |
getPersistenceContext()
Get the persistence context for this session
|
SessionFactory |
getSessionFactory()
Get the session factory which created this session.
|
SessionStatistics |
getStatistics()
Get the statistics for this session.
|
String |
getTenantIdentifier()
Match te method on
Session and StatelessSession |
long |
getTimestamp()
System time before the start of the transaction
|
Transaction |
getTransaction()
Get the
Transaction instance associated with this session. |
TransactionCoordinator |
getTransactionCoordinator()
Retrieve access to the session's transaction coordinator.
|
TypeHelper |
getTypeHelper()
Convenience access to the
TypeHelper associated with this session's SessionFactory . |
WrapperOptions |
getWrapperOptions()
Obtain the WrapperOptions for this context.
|
String |
guessEntityName(Object entity)
The guessed entity name for an entity not in an association
|
Object |
immediateLoad(String entityName,
Serializable id)
Load an instance immediately.
|
void |
initializeCollection(PersistentCollection collection,
boolean writing)
Initialize the collection (if not already initialized)
|
Object |
instantiate(String entityName,
Serializable id)
Instantiate the entity class, initializing with the given identifier
|
Object |
internalLoad(String entityName,
Serializable id,
boolean eager,
boolean nullable)
Load an instance without checking if it was deleted.
|
boolean |
isAutoCloseSessionEnabled() |
boolean |
isClosed()
Determine whether the session is closed.
|
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?
To determine the read-only/modifiable setting for a particular entity
or proxy:
|
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?
|
boolean |
isEventSource() |
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?
To get the default read-only/modifiable setting used for
entities and proxies that are loaded into the session:
|
boolean |
isTransactionInProgress()
Does this Session have an active Hibernate transaction
or is there a JTA transaction in progress?
|
Iterator |
iterate(String query,
QueryParameters queryParameters)
Execute an iterate() query
|
Iterator |
iterateFilter(Object collection,
String filter,
QueryParameters queryParameters)
Iterate a filter
|
List |
list(Criteria criteria)
Execute a criteria query
|
List |
list(NativeSQLQuerySpecification spec,
QueryParameters queryParameters)
Execute a native SQL query, and return the results as a fully built list.
|
List |
list(String query,
QueryParameters queryParameters)
Execute a find() query
|
List |
listCustomQuery(CustomQuery customQuery,
QueryParameters queryParameters)
Execute an SQL Query
|
List |
listFilter(Object collection,
String filter,
QueryParameters queryParameters)
Execute a filter
|
<T> T |
load(Class<T> theClass,
Serializable id)
Return the persistent instance of the given entity class with the given identifier,
assuming that the instance exists.
|
<T> T |
load(Class<T> theClass,
Serializable id,
LockMode lockMode)
Return the persistent instance of the given entity class with the given identifier,
obtaining the specified lock mode, assuming the instance exists.
|
<T> T |
load(Class<T> theClass,
Serializable id,
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,
LockMode lockMode)
Return the persistent instance of the given entity class with the given identifier,
obtaining the specified lock mode, assuming the instance exists.
|
Object |
load(String entityName,
Serializable id,
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 |
lock(Object object,
LockMode lockMode)
Obtain the specified lock level upon the given object.
|
void |
lock(String entityName,
Object object,
LockMode lockMode)
Obtain the specified lock level upon the given object.
|
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 |
reconnect(Connection connection)
Reconnect to the given JDBC connection.
|
void |
refresh(Object object)
Re-read the state of the given instance from the underlying database.
|
void |
refresh(Object object,
LockMode lockMode)
Re-read the state of the given instance from the underlying database, with
the given LockMode.
|
void |
refresh(Object object,
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,
LockOptions lockOptions)
Re-read the state of the given instance from the underlying database, with
the given LockMode.
|
void |
replicate(Object object,
ReplicationMode replicationMode)
Persist the state of the given detached instance, reusing the current
identifier value.
|
void |
replicate(String entityName,
Object object,
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
Session.save(Object) or Session.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
Session.save(String, Object) or Session.update(String, Object)
the given instance, depending upon resolution of the unsaved-value checks
(see the manual for discussion of unsaved-value checking). |
ScrollableResults |
scroll(Criteria criteria,
ScrollMode scrollMode)
Execute a criteria query
|
ScrollableResults |
scroll(NativeSQLQuerySpecification spec,
QueryParameters queryParameters)
Execute a native SQL query, and return the results as a scrollable result.
|
ScrollableResults |
scroll(String query,
QueryParameters queryParameters)
Execute a scroll() query
|
ScrollableResults |
scrollCustomQuery(CustomQuery customQuery,
QueryParameters queryParameters)
Execute an SQL Query
|
SharedSessionBuilder |
sessionWithOptions()
Obtain a
Session builder with the ability to grab certain information from this session. |
void |
setAutoClear(boolean enabled)
Enable/disable automatic cache clearing from after transaction
completion (for EJB3)
|
void |
setCacheMode(CacheMode cm)
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(FlushMode fm)
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.
|
boolean |
shouldAutoClose() |
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.
|
protected final SessionImplementor sessionImplementor
protected final Session session
public SessionDelegatorBaseImpl(SessionImplementor sessionImplementor, Session session)
public <T> T execute(LobCreationContext.Callback<T> callback)
LobCreationContext
Connection
.execute
in interface LobCreationContext
T
- The Java type of the type of LOB being created. One of Blob
,
Clob
, NClob
callback
- The callback to execute .public String getTenantIdentifier()
SessionImplementor
Session
and StatelessSession
getTenantIdentifier
in interface SessionImplementor
getTenantIdentifier
in interface SharedSessionContract
public JdbcConnectionAccess getJdbcConnectionAccess()
SessionImplementor
getJdbcConnectionAccess
in interface SessionImplementor
public EntityKey generateEntityKey(Serializable id, EntityPersister persister)
SessionImplementor
generateEntityKey
in interface SessionImplementor
id
- The entity idpersister
- The entity persisterpublic Interceptor getInterceptor()
SessionImplementor
getInterceptor
in interface SessionImplementor
public void setAutoClear(boolean enabled)
SessionImplementor
setAutoClear
in interface SessionImplementor
public void disableTransactionAutoJoin()
SessionImplementor
Synchronization
).
JPA however defines an explicit join transaction operation.
See javax.persistence.EntityManager#joinTransactiondisableTransactionAutoJoin
in interface SessionImplementor
public boolean isTransactionInProgress()
SessionImplementor
isTransactionInProgress
in interface SessionImplementor
public void initializeCollection(PersistentCollection collection, boolean writing) throws HibernateException
SessionImplementor
initializeCollection
in interface SessionImplementor
HibernateException
public Object internalLoad(String entityName, Serializable id, boolean eager, boolean nullable) throws HibernateException
SessionImplementor
internalLoad
in interface SessionImplementor
HibernateException
public Object immediateLoad(String entityName, Serializable id) throws HibernateException
SessionImplementor
immediateLoad
in interface SessionImplementor
HibernateException
public long getTimestamp()
SessionImplementor
getTimestamp
in interface SessionImplementor
public SessionFactoryImplementor getFactory()
SessionImplementor
getFactory
in interface SessionImplementor
public List list(String query, QueryParameters queryParameters) throws HibernateException
SessionImplementor
list
in interface SessionImplementor
HibernateException
public Iterator iterate(String query, QueryParameters queryParameters) throws HibernateException
SessionImplementor
iterate
in interface SessionImplementor
HibernateException
public ScrollableResults scroll(String query, QueryParameters queryParameters) throws HibernateException
SessionImplementor
scroll
in interface SessionImplementor
HibernateException
public ScrollableResults scroll(Criteria criteria, ScrollMode scrollMode)
SessionImplementor
scroll
in interface SessionImplementor
public List list(Criteria criteria)
SessionImplementor
list
in interface SessionImplementor
public List listFilter(Object collection, String filter, QueryParameters queryParameters) throws HibernateException
SessionImplementor
listFilter
in interface SessionImplementor
HibernateException
public Iterator iterateFilter(Object collection, String filter, QueryParameters queryParameters) throws HibernateException
SessionImplementor
iterateFilter
in interface SessionImplementor
HibernateException
public EntityPersister getEntityPersister(String entityName, Object object) throws HibernateException
SessionImplementor
getEntityPersister
in interface SessionImplementor
entityName
- optional entity nameobject
- the entity instanceHibernateException
public Object getEntityUsingInterceptor(EntityKey key) throws HibernateException
SessionImplementor
getEntityUsingInterceptor
in interface SessionImplementor
HibernateException
public Serializable getContextEntityIdentifier(Object object)
SessionImplementor
getContextEntityIdentifier
in interface SessionImplementor
public String bestGuessEntityName(Object object)
SessionImplementor
bestGuessEntityName
in interface SessionImplementor
public String guessEntityName(Object entity) throws HibernateException
SessionImplementor
guessEntityName
in interface SessionImplementor
HibernateException
public Object instantiate(String entityName, Serializable id) throws HibernateException
SessionImplementor
instantiate
in interface SessionImplementor
HibernateException
public List listCustomQuery(CustomQuery customQuery, QueryParameters queryParameters) throws HibernateException
SessionImplementor
listCustomQuery
in interface SessionImplementor
HibernateException
public ScrollableResults scrollCustomQuery(CustomQuery customQuery, QueryParameters queryParameters) throws HibernateException
SessionImplementor
scrollCustomQuery
in interface SessionImplementor
HibernateException
public List list(NativeSQLQuerySpecification spec, QueryParameters queryParameters) throws HibernateException
SessionImplementor
list
in interface SessionImplementor
spec
- The specification of the native SQL query to execute.queryParameters
- The parameters by which to perform the execution.HibernateException
public ScrollableResults scroll(NativeSQLQuerySpecification spec, QueryParameters queryParameters) throws HibernateException
SessionImplementor
scroll
in interface SessionImplementor
spec
- The specification of the native SQL query to execute.queryParameters
- The parameters by which to perform the execution.HibernateException
public int getDontFlushFromFind()
getDontFlushFromFind
in interface SessionImplementor
public PersistenceContext getPersistenceContext()
SessionImplementor
getPersistenceContext
in interface SessionImplementor
public int executeUpdate(String query, QueryParameters queryParameters) throws HibernateException
SessionImplementor
executeUpdate
in interface SessionImplementor
HibernateException
public int executeNativeUpdate(NativeSQLQuerySpecification specification, QueryParameters queryParameters) throws HibernateException
SessionImplementor
executeNativeUpdate
in interface SessionImplementor
HibernateException
public CacheMode getCacheMode()
Session
getCacheMode
in interface SessionImplementor
getCacheMode
in interface Session
public void setCacheMode(CacheMode cm)
Session
setCacheMode
in interface SessionImplementor
setCacheMode
in interface Session
cm
- The new cache mode.public boolean isOpen()
Session
isOpen
in interface SessionImplementor
isOpen
in interface Session
public boolean isConnected()
Session
isConnected
in interface SessionImplementor
isConnected
in interface Session
public FlushMode getFlushMode()
Session
getFlushMode
in interface SessionImplementor
getFlushMode
in interface Session
public void setFlushMode(FlushMode fm)
Session
FlushMode.MANUAL
at the start of the session (in
order to achieve some extra performance).setFlushMode
in interface SessionImplementor
setFlushMode
in interface Session
fm
- the new flush modeFlushMode
public Connection connection()
connection
in interface SessionImplementor
public void flush()
Session
Session.setFlushMode(FlushMode)
,
Transaction.commit()
calls this method).
Flushing is the process of synchronizing the underlying persistent
store with persistable state held in memory.flush
in interface SessionImplementor
flush
in interface Session
public Query getNamedQuery(String name)
SessionImplementor
getNamedQuery
in interface SessionImplementor
getNamedQuery
in interface SharedSessionContract
name
- the name of a query defined externallypublic Query getNamedSQLQuery(String name)
SessionImplementor
getNamedSQLQuery
in interface SessionImplementor
public boolean isEventSource()
isEventSource
in interface SessionImplementor
public void afterScrollOperation()
afterScrollOperation
in interface SessionImplementor
public TransactionCoordinator getTransactionCoordinator()
SessionImplementor
getTransactionCoordinator
in interface SessionImplementor
public JdbcCoordinator getJdbcCoordinator()
getJdbcCoordinator
in interface SessionImplementor
public boolean isClosed()
SessionImplementor
SessionImplementor.isOpen()
as this method does not attempt any JTA synchronization
registration, where as SessionImplementor.isOpen()
does; which makes this one
nicer to use for most internal purposes.isClosed
in interface SessionImplementor
public boolean shouldAutoClose()
shouldAutoClose
in interface SessionImplementor
public boolean isAutoCloseSessionEnabled()
isAutoCloseSessionEnabled
in interface SessionImplementor
public LoadQueryInfluencers getLoadQueryInfluencers()
SessionImplementor
getLoadQueryInfluencers
in interface SessionImplementor
public Query createQuery(NamedQueryDefinition namedQueryDefinition)
SessionImplementor
createQuery
in interface SessionImplementor
namedQueryDefinition
- The named query definitionpublic SQLQuery createSQLQuery(NamedSQLQueryDefinition namedQueryDefinition)
SessionImplementor
createSQLQuery
in interface SessionImplementor
namedQueryDefinition
- The named query definitionpublic SessionEventListenerManager getEventListenerManager()
getEventListenerManager
in interface SessionImplementor
public Transaction beginTransaction()
SharedSessionContract
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.beginTransaction
in interface SharedSessionContract
SharedSessionContract.getTransaction()
public Transaction getTransaction()
SharedSessionContract
Transaction
instance associated with this session. The concrete type of the returned
Transaction
object is determined by the hibernate.transaction_factory
property.getTransaction
in interface SharedSessionContract
public Query createQuery(String queryString)
SharedSessionContract
Query
instance for the given HQL query string.createQuery
in interface SharedSessionContract
queryString
- The HQL querypublic SQLQuery createSQLQuery(String queryString)
SharedSessionContract
SQLQuery
instance for the given SQL query string.createSQLQuery
in interface SharedSessionContract
queryString
- The SQL querypublic ProcedureCall getNamedProcedureCall(String name)
SharedSessionContract
getNamedProcedureCall
in interface SharedSessionContract
name
- The name given to the templateNamedStoredProcedureQuery
public ProcedureCall createStoredProcedureCall(String procedureName)
SharedSessionContract
createStoredProcedureCall
in interface SharedSessionContract
procedureName
- The name of the procedure.public ProcedureCall createStoredProcedureCall(String procedureName, Class... resultClasses)
SharedSessionContract
createStoredProcedureCall
in interface SharedSessionContract
procedureName
- The name of the procedure.resultClasses
- The entity(s) to map the result on to.public ProcedureCall createStoredProcedureCall(String procedureName, String... resultSetMappings)
SharedSessionContract
createStoredProcedureCall
in interface SharedSessionContract
procedureName
- The name of the procedure.resultSetMappings
- The explicit result set mapping(s) to use for mapping the resultspublic Criteria createCriteria(Class persistentClass)
SharedSessionContract
Criteria
instance for the given class (entity or subclasses/implementors).createCriteria
in interface SharedSessionContract
persistentClass
- The class, which is an entity, or has entity subclasses/implementorspublic Criteria createCriteria(Class persistentClass, String alias)
SharedSessionContract
Criteria
instance for the given class (entity or subclasses/implementors), using a specific
alias.createCriteria
in interface SharedSessionContract
persistentClass
- The class, which is an entity, or has entity subclasses/implementorsalias
- The alias to usepublic Criteria createCriteria(String entityName)
SharedSessionContract
Criteria
instance for the given entity name.createCriteria
in interface SharedSessionContract
entityName
- The entity namepublic Criteria createCriteria(String entityName, String alias)
SharedSessionContract
Criteria
instance for the given entity name, using a specific alias.createCriteria
in interface SharedSessionContract
entityName
- The entity namealias
- The alias to usepublic SharedSessionBuilder sessionWithOptions()
Session
Session
builder with the ability to grab certain information from this session.sessionWithOptions
in interface Session
public SessionFactory getSessionFactory()
Session
getSessionFactory
in interface Session
SessionFactory
public void close() throws HibernateException
Session
Session.disconnect()
it.close
in interface Closeable
close
in interface AutoCloseable
close
in interface Session
HibernateException
- Indicates problems cleaning up.public void cancelQuery() throws HibernateException
Session
cancelQuery
in interface Session
HibernateException
- There was a problem canceling the querypublic boolean isDirty() throws HibernateException
Session
isDirty
in interface Session
HibernateException
- could not perform dirtying checkingpublic boolean isDefaultReadOnly()
Session
isDefaultReadOnly
in interface Session
Session.isReadOnly(Object)
public void setDefaultReadOnly(boolean readOnly)
Session
setDefaultReadOnly
in interface Session
readOnly
- true, the default for loaded entities/proxies is read-only;
false, the default for loaded entities/proxies is modifiableTo override this session's read-only/modifiable setting for entities
and proxies loaded by a Query:
,
Query.setReadOnly(boolean)
public Serializable getIdentifier(Object object)
Session
getIdentifier
in interface Session
object
- a persistent instancepublic boolean contains(Object object)
Session
public void evict(Object object)
Session
public <T> T load(Class<T> theClass, Serializable id, LockMode lockMode)
Session
Session.load(Class, Serializable, LockOptions)
load
in interface Session
theClass
- a persistent classid
- a valid identifier of an existing persistent instance of the classlockMode
- the lock levelSession.load(Class, Serializable, LockOptions)
public <T> T load(Class<T> theClass, Serializable id, LockOptions lockOptions)
Session
public Object load(String entityName, Serializable id, LockMode lockMode)
Session
Session.load(String, Serializable, LockOptions)
load
in interface Session
entityName
- a persistent classid
- a valid identifier of an existing persistent instance of the classlockMode
- the lock levelSession.load(String, Serializable, LockOptions)
public Object load(String entityName, Serializable id, LockOptions lockOptions)
Session
public <T> T load(Class<T> theClass, Serializable id)
Session
public Object load(String entityName, Serializable id)
Session
public void load(Object object, Serializable id)
Session
public void replicate(Object object, ReplicationMode replicationMode)
Session
cascade="replicate"
public void replicate(String entityName, Object object, ReplicationMode replicationMode)
Session
cascade="replicate"
public Serializable save(Object object)
Session
cascade="save-update"
public Serializable save(String entityName, Object object)
Session
cascade="save-update"
public void saveOrUpdate(Object object)
Session
Session.save(Object)
or Session.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"
saveOrUpdate
in interface Session
object
- a transient or detached instance containing new or updated stateSession.save(java.lang.Object)
,
Session.update(Object object)
public void saveOrUpdate(String entityName, Object object)
Session
Session.save(String, Object)
or Session.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"
saveOrUpdate
in interface Session
entityName
- The entity nameobject
- a transient or detached instance containing new or updated stateSession.save(String,Object)
,
Session.update(String,Object)
public void update(Object object)
Session
cascade="save-update"
public void update(String entityName, Object object)
Session
cascade="save-update"
public Object merge(Object object)
Session
cascade="merge"
The semantics of this method are defined by JSR-220.public Object merge(String entityName, Object object)
Session
cascade="merge"
The semantics of this method are defined by JSR-220.public void persist(Object object)
Session
cascade="persist"
The semantics of this method are defined by JSR-220.public void persist(String entityName, Object object)
Session
cascade="persist"
The semantics of this method are defined by JSR-220.public void delete(Object object)
Session
cascade="delete"
public void delete(String entityName, Object object)
Session
cascade="delete"
public void lock(Object object, LockMode lockMode)
Session
Session.LockRequest.lock(Object)
via Session.buildLockRequest(LockOptions)
lock
in interface Session
object
- a persistent or transient instancelockMode
- the lock levelSession.buildLockRequest(LockOptions)
,
Session.LockRequest.lock(Object)
public void lock(String entityName, Object object, LockMode lockMode)
Session
Session.LockRequest.lock(String, Object)
via Session.buildLockRequest(LockOptions)
lock
in interface Session
entityName
- The name of the entityobject
- a persistent or transient instancelockMode
- the lock levelSession.buildLockRequest(LockOptions)
,
Session.LockRequest.lock(String, Object)
public Session.LockRequest buildLockRequest(LockOptions lockOptions)
Session
session.buildLockRequest().setLockMode(LockMode.PESSIMISTIC_WRITE).setTimeOut(60000).lock(entity);
buildLockRequest
in interface Session
lockOptions
- contains the lock levelpublic void refresh(Object object)
Session
public void refresh(String entityName, Object object)
Session
public void refresh(Object object, LockMode lockMode)
Session
Session.refresh(Object, LockOptions)
refresh
in interface Session
object
- a persistent or detached instancelockMode
- the lock mode to useSession.refresh(Object, LockOptions)
public void refresh(Object object, LockOptions lockOptions)
Session
public void refresh(String entityName, Object object, LockOptions lockOptions)
Session
public LockMode getCurrentLockMode(Object object)
Session
getCurrentLockMode
in interface Session
object
- a persistent instancepublic Query createFilter(Object collection, String queryString)
Session
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.createFilter
in interface Session
collection
- a persistent collectionqueryString
- a Hibernate query fragment.public void clear()
Session
public <T> T get(Class<T> theClass, Serializable id)
Session
public <T> T get(Class<T> theClass, Serializable id, LockMode lockMode)
Session
Session.get(Class, Serializable, LockOptions)
get
in interface Session
theClass
- The entity typeid
- an identifierlockMode
- the lock modeSession.get(Class, Serializable, LockOptions)
public <T> T get(Class<T> theClass, Serializable id, LockOptions lockOptions)
Session
public Object get(String entityName, Serializable id)
Session
public Object get(String entityName, Serializable id, LockMode lockMode)
Session
Session.get(String, Serializable, LockOptions)
get
in interface Session
entityName
- the entity nameid
- an identifierlockMode
- the lock modeSession.get(String, Serializable, LockOptions)
public Object get(String entityName, Serializable id, LockOptions lockOptions)
Session
public String getEntityName(Object object)
Session
getEntityName
in interface Session
object
- a persistent entitypublic IdentifierLoadAccess byId(String entityName)
Session
IdentifierLoadAccess
instance to retrieve the specified entity type by
primary key.public <T> MultiIdentifierLoadAccess<T> byMultipleIds(Class<T> entityClass)
Session
MultiIdentifierLoadAccess
instance to retrieve multiple entities at once
as specified by primary key values.byMultipleIds
in interface Session
entityClass
- The entity type to be retrievedpublic MultiIdentifierLoadAccess byMultipleIds(String entityName)
Session
MultiIdentifierLoadAccess
instance to retrieve multiple entities at once
as specified by primary key values.byMultipleIds
in interface Session
entityName
- The entity name of the entity type to be retrievedpublic <T> IdentifierLoadAccess<T> byId(Class<T> entityClass)
Session
IdentifierLoadAccess
instance to retrieve the specified entity by
primary key.public NaturalIdLoadAccess byNaturalId(String entityName)
Session
NaturalIdLoadAccess
instance to retrieve the specified entity by
its natural id.byNaturalId
in interface Session
entityName
- The entity name of the entity type to be retrievedpublic <T> NaturalIdLoadAccess<T> byNaturalId(Class<T> entityClass)
Session
NaturalIdLoadAccess
instance to retrieve the specified entity by
its natural id.byNaturalId
in interface Session
entityClass
- The entity type to be retrievedpublic SimpleNaturalIdLoadAccess bySimpleNaturalId(String entityName)
Session
SimpleNaturalIdLoadAccess
instance to retrieve the specified entity by
its natural id.bySimpleNaturalId
in interface Session
entityName
- The entity name of the entity type to be retrievedpublic <T> SimpleNaturalIdLoadAccess<T> bySimpleNaturalId(Class<T> entityClass)
Session
SimpleNaturalIdLoadAccess
instance to retrieve the specified entity by
its simple (single attribute) natural id.bySimpleNaturalId
in interface Session
entityClass
- The entity type to be retrievedpublic Filter enableFilter(String filterName)
Session
enableFilter
in interface Session
filterName
- The name of the filter to be enabled.public Filter getEnabledFilter(String filterName)
Session
getEnabledFilter
in interface Session
filterName
- The name of the filter to be retrieved.public void disableFilter(String filterName)
Session
disableFilter
in interface Session
filterName
- The name of the filter to be disabled.public SessionStatistics getStatistics()
Session
getStatistics
in interface Session
public boolean isReadOnly(Object entityOrProxy)
Session
isReadOnly
in interface Session
entityOrProxy
- an entity or HibernateProxytrue
if the entity or proxy is read-only, false
if the entity or proxy is modifiable.Session.isDefaultReadOnly()
public void setReadOnly(Object entityOrProxy, boolean readOnly)
Session
setReadOnly
in interface Session
entityOrProxy
- an entity or HibernateProxyreadOnly
- true
if the entity or proxy should be made read-only; false
if the entity or
proxy should be made modifiableTo override this session's read-only/modifiable setting for entities
and proxies loaded by a Query:
,
Query.setReadOnly(boolean)
public void doWork(Work work) throws HibernateException
Session
doWork
in interface Session
work
- The work to be performed.HibernateException
- Generally indicates wrapped SQLException
public <T> T doReturningWork(ReturningWork<T> work) throws HibernateException
Session
ReturningWork.execute(java.sql.Connection)
call.doReturningWork
in interface Session
T
- The type of the result returned from the workwork
- The work to be performed.ReturningWork.execute(java.sql.Connection)
.HibernateException
- Generally indicates wrapped SQLException
public Connection disconnect()
Session
disconnect
in interface Session
null
Session.reconnect(Connection)
public void reconnect(Connection connection)
Session
reconnect
in interface Session
connection
- a JDBC connectionSession.disconnect()
public boolean isFetchProfileEnabled(String name) throws UnknownProfileException
Session
isFetchProfileEnabled
in interface Session
name
- The name of the profile to be checked.UnknownProfileException
- Indicates that the given name does not
match any known profile namesfor discussion of this feature
public void enableFetchProfile(String name) throws UnknownProfileException
Session
enableFetchProfile
in interface Session
name
- The name of the fetch profile to be enabled.UnknownProfileException
- Indicates that the given name does not
match any known profile namesfor discussion of this feature
public void disableFetchProfile(String name) throws UnknownProfileException
Session
disableFetchProfile
in interface Session
name
- The name of the fetch profile to be disabled.UnknownProfileException
- Indicates that the given name does not
match any known profile namesfor discussion of this feature
public TypeHelper getTypeHelper()
Session
TypeHelper
associated with this session's SessionFactory
.
Equivalent to calling Session.getSessionFactory()
.getTypeHelper()
getTypeHelper
in interface Session
TypeHelper
associated with this session's SessionFactory
public LobHelper getLobHelper()
Session
getLobHelper
in interface Session
public void addEventListeners(SessionEventListener... listeners)
Session
addEventListeners
in interface Session
listeners
- The listener(s) to addpublic WrapperOptions getWrapperOptions()
WrapperOptionsContext
getWrapperOptions
in interface WrapperOptionsContext
Copyright © 2017 JBoss by Red Hat. All rights reserved.