Package org.hibernate.event.internal

Class AbstractSaveEventListener<C>

java.lang.Object
org.hibernate.event.internal.AbstractSaveEventListener<C>
All Implemented Interfaces:
CallbackRegistryConsumer
Direct Known Subclasses:
DefaultMergeEventListener, DefaultPersistEventListener, DefaultReplicateEventListener
public abstract class AbstractSaveEventListener<C> extends Object implements CallbackRegistryConsumer
A convenience base class for listeners responding to persist or merge events.

This class contains common functionality for persisting new transient instances.

  • Constructor Details

    • AbstractSaveEventListener

      public AbstractSaveEventListener()

  • Method Details

    • injectCallbackRegistry

      public void injectCallbackRegistry(CallbackRegistry callbackRegistry)
      Description copied from interface: CallbackRegistryConsumer
      Injection of the CallbackRegistry
      Specified by:
      injectCallbackRegistry in interface CallbackRegistryConsumer
      Parameters:
      callbackRegistry - The CallbackRegistry

    • saveWithRequestedId

      protected Object saveWithRequestedId(Object entity, Object requestedId, String entityName, C context, EventSource source)
      Prepares the persist call using the given requested id.
      Parameters:
      entity - The entity to be persisted
      requestedId - The id with which to associate the entity
      entityName - The name of the entity being persisted
      context - Generally cascade-specific information
      source - The session which is the source of this event
      Returns:
      The id used to save the entity.

    • saveWithGeneratedId

      protected Object saveWithGeneratedId(Object entity, String entityName, C context, EventSource source, boolean requiresImmediateIdAccess)
      Prepares the persist call using a newly generated id.
      Parameters:
      entity - The entity to be persisted
      entityName - The entity-name for the entity to be persisted
      context - Generally cascade-specific information
      source - The session which is the source of this persist event
      requiresImmediateIdAccess - does the event context require access to the identifier immediately after execution of this method (if not, post-insert style id generators may be postponed if we are outside a transaction).
      Returns:
      The id used to persist the entity; may be null depending on the type of id generator used and the requiresImmediateIdAccess value

    • performSave

      protected Object performSave(Object entity, Object id, EntityPersister persister, boolean useIdentityColumn, C context, EventSource source, boolean delayIdentityInserts)
      Prepares the persist call by checking the session caches for a pre-existing entity and performing any lifecycle callbacks.
      Parameters:
      entity - The entity to be persisted
      id - The id by which to persist the entity
      persister - The entity's persister instance
      useIdentityColumn - Is an identity column being used?
      context - Generally cascade-specific information
      source - The session from which the event originated
      delayIdentityInserts - Should the identity insert be delayed?
      Returns:
      The id used to persist the entity; may be null depending on the type of id generator used and on delayIdentityInserts

    • performSaveOrReplicate

      protected Object performSaveOrReplicate(Object entity, EntityKey key, EntityPersister persister, boolean useIdentityColumn, C context, EventSource source, boolean delayIdentityInserts)
      Performs all the actual work needed to persist an entity (well to get the persist action moved to the execution queue).
      Parameters:
      entity - The entity to be persisted
      key - The id to be used for saving the entity (or null, in the case of identity columns)
      persister - The persister for the entity
      useIdentityColumn - Should an identity column be used for id generation?
      context - Generally cascade-specific information
      source - The session which is the source of the current event
      delayIdentityInserts - Should the identity insert be delayed?
      Returns:
      The id used to persist the entity; may be null depending on the type of id generator used and the requiresImmediateIdAccess value

    • getMergeMap

      protected Map<Object,Object> getMergeMap(C anything)

    • isVersionIncrementDisabled

      protected boolean isVersionIncrementDisabled()
      After the persist, will the version number be incremented if the instance is modified?
      Returns:
      True if the version will be incremented on an entity change after persist; false otherwise.

    • visitCollectionsBeforeSave

      protected boolean visitCollectionsBeforeSave(Object entity, Object id, Object[] values, Type[] types, EventSource source)

    • substituteValuesIfNecessary

      protected boolean substituteValuesIfNecessary(Object entity, Object id, Object[] values, EntityPersister persister, SessionImplementor source)
      Perform any property value substitution that is necessary (interceptor callback, version initialization...)
      Parameters:
      entity - The entity
      id - The entity identifier
      values - The snapshot entity state
      persister - The entity persister
      source - The originating session
      Returns:
      True if the snapshot state changed such that reinjection of the values into the entity is required.

    • cascadeBeforeSave

      protected void cascadeBeforeSave(EventSource source, EntityPersister persister, Object entity, C context)
      Handles the calls needed to perform pre-persist cascades for the given entity.
      Parameters:
      source - The session from which the persist event originated
      persister - The persister for the entity
      entity - The entity to be persisted
      context - Generally cascade-specific data

    • cascadeAfterSave

      protected void cascadeAfterSave(EventSource source, EntityPersister persister, Object entity, C context)
      Handles calls needed to perform post-persist cascades.
      Parameters:
      source - The session from which the event originated
      persister - The persister for the entity
      entity - The entity being persisted
      context - Generally cascade-specific data

    • getCascadeAction

      protected abstract CascadingAction<C> getCascadeAction()