Package org.hibernate.proxy

Class AbstractLazyInitializer

java.lang.Object
org.hibernate.proxy.AbstractLazyInitializer
All Implemented Interfaces:
LazyInitializer
Direct Known Subclasses:
BasicLazyInitializer, MapLazyInitializer
public abstract class AbstractLazyInitializer extends Object implements LazyInitializer
Convenience base class for lazy initialization handlers. Centralizes the basic plumbing of doing lazy initialization, freeing subclasses to acts as essentially adapters to their intended entity mode and/or proxy generation strategy.

  • Constructor Details

    • AbstractLazyInitializer

      protected AbstractLazyInitializer(String entityName, Object id, SharedSessionContractImplementor session)
      Main constructor.
      Parameters:
      entityName - The name of the entity being proxied.
      id - The identifier of the entity being proxied.
      session - The session owning the proxy.

  • Method Details

    • getEntityName

      public final String getEntityName()
      Description copied from interface: LazyInitializer
      The entity-name of the entity our owning proxy represents.
      Specified by:
      getEntityName in interface LazyInitializer
      Returns:
      The entity-name.

    • getInternalIdentifier

      public final Object getInternalIdentifier()
      Description copied from interface: LazyInitializer
      Retrieve the identifier value for the entity our owning proxy represents.
      Specified by:
      getInternalIdentifier in interface LazyInitializer
      Returns:
      The identifier value.

    • getIdentifier

      public final Object getIdentifier()
      Description copied from interface: LazyInitializer
      Retrieve the identifier value for the entity our owning proxy represents, without initializing the proxy.

      When JPA proxy compliance is enabled the proxy is initialized.

      Specified by:
      getIdentifier in interface LazyInitializer
      Returns:
      The identifier value.

    • setIdentifier

      public final void setIdentifier(Object id)
      Description copied from interface: LazyInitializer
      Set the identifier value for the entity our owning proxy represents.
      Specified by:
      setIdentifier in interface LazyInitializer
      Parameters:
      id - The identifier value.

    • isUninitialized

      public final boolean isUninitialized()
      Description copied from interface: LazyInitializer
      Is the proxy uninitialized?
      Specified by:
      isUninitialized in interface LazyInitializer
      Returns:
      True if uninitialized; false otherwise.
      See Also:

    • getSession

      public final SharedSessionContractImplementor getSession()
      Description copied from interface: LazyInitializer
      Get the session to which this proxy is associated, or null if it is not attached.
      Specified by:
      getSession in interface LazyInitializer
      Returns:
      The associated session.

    • setSession

      public final void setSession(SharedSessionContractImplementor session) throws HibernateException
      Description copied from interface: LazyInitializer
      Associate the proxy with the given session.

      Care should be given to make certain that the proxy is added to the session's persistence context as well to maintain the symmetry of the association. That must be done separately as this method simply sets an internal reference. We do also check that if there is already an associated session that the proxy reference was removed from that previous session's persistence context.

      Specified by:
      setSession in interface LazyInitializer
      Parameters:
      session - The session
      Throws:
      HibernateException - Indicates that the proxy was still contained in the persistence context of the "previous session".

    • unsetSession

      public final void unsetSession()
      Description copied from interface: LazyInitializer
      Unset this initializer's reference to session. It is assumed that the caller is also taking care or cleaning up the owning proxy's reference in the persistence context.

      Generally speaking this is intended to be called only during Session.evict(java.lang.Object) and Session.clear() processing; most other use-cases should call LazyInitializer.setSession(org.hibernate.engine.spi.SharedSessionContractImplementor) instead.

      Specified by:
      unsetSession in interface LazyInitializer

    • initialize

      public final void initialize() throws HibernateException
      Description copied from interface: LazyInitializer
      Initialize the proxy, fetching the target entity if necessary.
      Specified by:
      initialize in interface LazyInitializer
      Throws:
      HibernateException - Indicates a problem initializing the proxy.
      See Also:

    • permissiveInitialization

      protected void permissiveInitialization()

    • initializeWithoutLoadIfPossible

      public final void initializeWithoutLoadIfPossible()
      Attempt to initialize the proxy without loading anything from the database.

      This will only have an effect if the proxy is still attached to a session, and the entity being proxied has been loaded and added to the persistence context of that session since the proxy was created.

    • prepareForPossibleLoadingOutsideTransaction

      protected void prepareForPossibleLoadingOutsideTransaction()
      Initialize internal state based on the currently attached session, in order to be ready to load data even after the proxy is detached from the session.

    • isConnectedToSession

      protected final boolean isConnectedToSession()
      Getter for property 'connectedToSession'.
      Returns:
      Value for property 'connectedToSession'.

    • getImplementation

      public final Object getImplementation()
      Description copied from interface: LazyInitializer
      Return the underlying persistent object, initializing if necessary
      Specified by:
      getImplementation in interface LazyInitializer
      Returns:
      The underlying target entity.

    • setImplementation

      public final void setImplementation(Object target)
      Description copied from interface: LazyInitializer
      Initialize the proxy manually by injecting its target.
      Specified by:
      setImplementation in interface LazyInitializer
      Parameters:
      target - The proxy target (the actual entity being proxied).

    • getImplementation

      public final Object getImplementation(SharedSessionContractImplementor session) throws HibernateException
      Description copied from interface: LazyInitializer
      Return the underlying persistent object in the given session, or null if not contained in this session's persistence context.
      Specified by:
      getImplementation in interface LazyInitializer
      Parameters:
      session - The session to check
      Returns:
      The target, or null.
      Throws:
      HibernateException - Indicates problem locating the target.

    • getImplementationEntityName

      public String getImplementationEntityName()
      Description copied from interface: LazyInitializer
      Get the actual name of the entity, possibly initializing the entity if it has subclasses.
      Specified by:
      getImplementationEntityName in interface LazyInitializer
      Returns:
      The actual entity name.

    • getTarget

      protected final Object getTarget()
      Getter for property "target".

      Same as getImplementation() except that this method will not force initialization.

      Returns:
      Value for property "target".

    • isReadOnlySettingAvailable

      public final boolean isReadOnlySettingAvailable()
      Description copied from interface: LazyInitializer
      Is the proxy's read-only/modifiable setting available?
      Specified by:
      isReadOnlySettingAvailable in interface LazyInitializer
      Returns:
      true, if the setting is available false, if the proxy is detached or its associated session is closed

    • isReadOnly

      public final boolean isReadOnly()
      Description copied from interface: LazyInitializer
      Is the proxy read-only?

      The read-only/modifiable setting is not available when the proxy is detached or its associated session is closed.

      To check if the read-only/modifiable setting is available:

      Specified by:
      isReadOnly in interface LazyInitializer
      Returns:
      true, if this proxy is read-only; false, otherwise
      See Also:

    • setReadOnly

      public final void setReadOnly(boolean readOnly)
      Description copied from interface: LazyInitializer
      Set an associated modifiable proxy to read-only mode, or a read-only proxy to modifiable mode. If the proxy is currently initialized, its implementation will be set to the same mode; otherwise, when the proxy is initialized, its implementation will have the same read-only/ modifiable setting as the proxy. In read-only mode, no snapshot is maintained and the instance is never dirty checked.

      If the associated proxy already has the specified read-only/modifiable setting, then this method does nothing.

      Specified by:
      setReadOnly in interface LazyInitializer
      Parameters:
      readOnly - if true, the associated proxy is made read-only; if false, the associated proxy is made modifiable.
      See Also:

    • isReadOnlyBeforeAttachedToSession

      public final Boolean isReadOnlyBeforeAttachedToSession()
      Get the read-only/modifiable setting that should be put in effect when it is attached to a session.

      This method should only be called during serialization when read-only/modifiable setting is not available, that is, if isReadOnlySettingAvailable() == false

      Returns:
      null, if the default setting should be used; true, for read-only; false, for modifiable
      Throws:
      IllegalStateException - if isReadOnlySettingAvailable() == true

    • isAllowLoadOutsideTransaction

      protected boolean isAllowLoadOutsideTransaction()
      Get whether the proxy can load data even if it's not attached to a session with an ongoing transaction.

      This method should only be called during serialization, and only makes sense after a call to prepareForPossibleLoadingOutsideTransaction().

      Returns:
      true if out-of-transaction loads are allowed, false otherwise.

    • getSessionFactoryUuid

      protected String getSessionFactoryUuid()
      Get the session factory UUID.

      This method should only be called during serialization, and only makes sense after a call to prepareForPossibleLoadingOutsideTransaction().

      Returns:
      the session factory UUID.

    • getSessionFactoryName

      protected String getSessionFactoryName()
      Get the session factory name.

      This method should only be called during serialization, and only makes sense after a call to prepareForPossibleLoadingOutsideTransaction().

      Returns:
      the session factory name.

    • isUnwrap

      public boolean isUnwrap()
      Specified by:
      isUnwrap in interface LazyInitializer

    • setUnwrap

      public void setUnwrap(boolean unwrap)
      Specified by:
      setUnwrap in interface LazyInitializer