public interface Interceptor
SessionBuilder.interceptor(Interceptor)
,
SharedSessionBuilder.interceptor()
,
Configuration.setInterceptor(Interceptor)
,
EmptyInterceptor
Modifier and Type | Method and Description |
---|---|
void |
afterTransactionBegin(Transaction tx)
Called when a Hibernate transaction is begun via the Hibernate Transaction
API.
|
void |
afterTransactionCompletion(Transaction tx)
Called after a transaction is committed or rolled back.
|
void |
beforeTransactionCompletion(Transaction tx)
Called before a transaction is committed (but not before rollback).
|
int[] |
findDirty(Object entity,
Serializable id,
Object[] currentState,
Object[] previousState,
String[] propertyNames,
Type[] types)
Called from flush().
|
Object |
getEntity(String entityName,
Serializable id)
Get a fully loaded entity instance that is cached externally.
|
String |
getEntityName(Object object)
Get the entity name for a persistent or transient instance.
|
Object |
instantiate(String entityName,
EntityMode entityMode,
Serializable id)
Instantiate the entity class.
|
Boolean |
isTransient(Object entity)
Called to distinguish between transient and detached entities.
|
void |
onCollectionRecreate(Object collection,
Serializable key)
Called before a collection is (re)created.
|
void |
onCollectionRemove(Object collection,
Serializable key)
Called before a collection is deleted.
|
void |
onCollectionUpdate(Object collection,
Serializable key)
Called before a collection is updated.
|
void |
onDelete(Object entity,
Serializable id,
Object[] state,
String[] propertyNames,
Type[] types)
Called before an object is deleted.
|
boolean |
onFlushDirty(Object entity,
Serializable id,
Object[] currentState,
Object[] previousState,
String[] propertyNames,
Type[] types)
Called when an object is detected to be dirty, during a flush.
|
boolean |
onLoad(Object entity,
Serializable id,
Object[] state,
String[] propertyNames,
Type[] types)
Called just before an object is initialized.
|
String |
onPrepareStatement(String sql)
Deprecated.
Supply a
StatementInspector instead, if you wish
to inspect and alter SQL statements. |
boolean |
onSave(Object entity,
Serializable id,
Object[] state,
String[] propertyNames,
Type[] types)
Called before an object is saved.
|
void |
postFlush(Iterator entities)
Called after a flush that actually ends in execution of the SQL statements required to synchronize
in-memory state with the database.
|
void |
preFlush(Iterator entities)
Called before a flush.
|
boolean onLoad(Object entity, Serializable id, Object[] state, String[] propertyNames, Type[] types) throws CallbackException
entity
- The entity instance being loadedid
- The identifier value being loadedstate
- The entity state (which will be pushed into the entity instance)propertyNames
- The names of the entity properties, corresponding to the state.types
- The types of the entity properties, corresponding to the state.true
if the user modified the state in any way.CallbackException
- Thrown if the interceptor encounters any problems handling the callback.boolean onFlushDirty(Object entity, Serializable id, Object[] currentState, Object[] previousState, String[] propertyNames, Type[] types) throws CallbackException
entity
- The entity instance detected as being dirty and being flushedid
- The identifier of the entitycurrentState
- The entity's current statepreviousState
- The entity's previous (load time) state.propertyNames
- The names of the entity propertiestypes
- The types of the entity propertiestrue
if the user modified the currentState in any way.CallbackException
- Thrown if the interceptor encounters any problems handling the callback.boolean onSave(Object entity, Serializable id, Object[] state, String[] propertyNames, Type[] types) throws CallbackException
entity
- The entity instance whose state is being insertedid
- The identifier of the entitystate
- The state of the entity which will be insertedpropertyNames
- The names of the entity properties.types
- The types of the entity propertiesCallbackException
- Thrown if the interceptor encounters any problems handling the callback.void onDelete(Object entity, Serializable id, Object[] state, String[] propertyNames, Type[] types) throws CallbackException
entity
- The entity instance being deletedid
- The identifier of the entitystate
- The state of the entitypropertyNames
- The names of the entity properties.types
- The types of the entity propertiesCallbackException
- Thrown if the interceptor encounters any problems handling the callback.void onCollectionRecreate(Object collection, Serializable key) throws CallbackException
collection
- The collection instance.key
- The collection key value.CallbackException
- Thrown if the interceptor encounters any problems handling the callback.void onCollectionRemove(Object collection, Serializable key) throws CallbackException
collection
- The collection instance.key
- The collection key value.CallbackException
- Thrown if the interceptor encounters any problems handling the callback.void onCollectionUpdate(Object collection, Serializable key) throws CallbackException
collection
- The collection instance.key
- The collection key value.CallbackException
- Thrown if the interceptor encounters any problems handling the callback.void preFlush(Iterator entities) throws CallbackException
entities
- The entities to be flushed.CallbackException
- Thrown if the interceptor encounters any problems handling the callback.void postFlush(Iterator entities) throws CallbackException
entities
- The entities that were flushed.CallbackException
- Thrown if the interceptor encounters any problems handling the callback.Boolean isTransient(Object entity)
entity
- a transient or detached entityint[] findDirty(Object entity, Serializable id, Object[] currentState, Object[] previousState, String[] propertyNames, Type[] types)
entity
- The entity for which to find dirty properties.id
- The identifier of the entitycurrentState
- The current entity state as taken from the entity instancepreviousState
- The state of the entity when it was last synchronized (generally when it was loaded)propertyNames
- The names of the entity properties.types
- The types of the entity propertiesnull
to indicate Hibernate should perform default behaviourCallbackException
- Thrown if the interceptor encounters any problems handling the callback.Object instantiate(String entityName, EntityMode entityMode, Serializable id) throws CallbackException
entityName
- the name of the entityentityMode
- The type of entity instance to be returned.id
- the identifier of the new instanceCallbackException
- Thrown if the interceptor encounters any problems handling the callback.String getEntityName(Object object) throws CallbackException
object
- an entity instanceCallbackException
- Thrown if the interceptor encounters any problems handling the callback.Object getEntity(String entityName, Serializable id) throws CallbackException
entityName
- the name of the entityid
- the instance identifierCallbackException
- Thrown if the interceptor encounters any problems handling the callback.void afterTransactionBegin(Transaction tx)
tx
- The Hibernate transaction facade objectvoid beforeTransactionCompletion(Transaction tx)
tx
- The Hibernate transaction facade objectvoid afterTransactionCompletion(Transaction tx)
tx
- The Hibernate transaction facade object@Deprecated String onPrepareStatement(String sql)
StatementInspector
instead, if you wish
to inspect and alter SQL statements.sql
- sql to be preparedCopyright © 2016 JBoss by Red Hat. All rights reserved.