Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.classic.Lifecycle

Provides callbacks from the Session to the persistent object. Persistent classes may implement this interface but they are not required to.

onSave: called just before the object is saved
onUpdate: called just before an object is updated, ie. when Session.update() is called
onDelete: called just before an object is deleted onLoad: called just after an object is loaded

onLoad() may be used to initialize transient properties of the object from its persistent state. It may not be used to load dependent objects since the Session interface may not be invoked from inside this method.

A further intended usage of onLoad(), onSave() and onUpdate() is to store a reference to the Session for later use.

If onSave(), onUpdate() or onDelete() return VETO, the operation is silently vetoed. If a CallbackException is thrown, the operation is vetoed and the exception is passed back to the application.

Note that onSave() is called after an identifier is assigned to the object, except when identity column key generation is used.

Field Summary

Modifier and Type	Field and Description
public static final boolean	NO_VETO Return value to accept the action (false)
public static final boolean	VETO Return value to veto the action (true)

Method Summary

Modifier and Type	Method and Description
public default boolean	Returns: true to veto delete onDelete(Session the session s) Called when an entity is deleted.
public default void	onLoad(Session the session s, Object the identifier id) Called after an entity is loaded.
public default void	onLoad(Session the session s, Serializable the identifier id) Deprecated since 6.0. use `onLoad(Session, Object)` Called after an entity is loaded.
public default boolean	Returns: true to veto save onSave(Session the session s) Called when an entity is saved.
public default boolean	Returns: true to veto update onUpdate(Session the session s) Called when an entity is passed to `Session.update()`.

Field Detail

NO_VETO	back to summary
public static final boolean NO_VETO Return value to accept the action (false)

VETO	back to summary
public static final boolean VETO Return value to veto the action (true)

Method Detail

onDelete	back to summary
public default boolean onDelete(Session s) throws CallbackException Called when an entity is deleted. Parameters s:Session the session Returns:boolean true to veto delete Exceptions CallbackException: Indicates a problem happened during callback

onDelete

back to summary

public default boolean onDelete(Session s) throws CallbackException

Called when an entity is deleted.

Parameters

s:Session: the session

Returns:boolean

true to veto delete

Exceptions

CallbackException:: Indicates a problem happened during callback

onLoad back to summary

onLoad	back to summary
public default void onLoad(Session s, Object id) Called after an entity is loaded. It is illegal to access the `Session` from inside this method. However, the object may keep a reference to the session for later use. Parameters s:Session the session id:Object the identifier

public default void onLoad(Session s, Object id)

Called after an entity is loaded. It is illegal to access the Session from inside this method. However, the object may keep a reference to the session for later use.

Parameters

s:Session: the session
id:Object: the identifier

onLoad back to summary

onLoad	back to summary
public default void onLoad(Session s, Serializable id) Deprecated since 6.0. use `onLoad(Session, Object)` Called after an entity is loaded. It is illegal to access the `Session` from inside this method. However, the object may keep a reference to the session for later use. Parameters s:Session the session id:Serializable the identifier Annotations @Deprecated since:6.0

public default void onLoad(Session s, Serializable id)

Deprecated

since 6.0.

use onLoad(Session, Object)

Called after an entity is loaded. It is illegal to access the Session from inside this method. However, the object may keep a reference to the session for later use.

Parameters

s:Session: the session
id:Serializable: the identifier

Annotations

@Deprecated
since:6.0

onSave	back to summary
public default boolean onSave(Session s) throws CallbackException Called when an entity is saved. Parameters s:Session the session Returns:boolean true to veto save Exceptions CallbackException: Indicates a problem happened during callback

onSave

back to summary

public default boolean onSave(Session s) throws CallbackException

Called when an entity is saved.

Parameters

s:Session: the session

Returns:boolean

true to veto save

Exceptions

CallbackException:: Indicates a problem happened during callback

onUpdate back to summary

onUpdate	back to summary
public default boolean onUpdate(Session s) throws CallbackException Called when an entity is passed to `Session.update()`. This method is not called every time the object's state is persisted during a flush. Parameters s:Session the session Returns:boolean true to veto update Exceptions CallbackException: Indicates a problem happened during callback

public default boolean onUpdate(Session s) throws CallbackException

Called when an entity is passed to Session.update(). This method is not called every time the object's state is persisted during a flush.

Parameters

s:Session: the session

Returns:boolean

true to veto update

Exceptions

CallbackException:: Indicates a problem happened during callback

public Interface Lifecycle

Field Summary

Method Summary

Field Detail

Method Detail