org.openmrs.api.db.hibernate

Class AuditableInterceptor

java.lang.Object

org.hibernate.EmptyInterceptor

org.openmrs.api.db.hibernate.AuditableInterceptor

All Implemented Interfaces:

Serializable, org.hibernate.Interceptor

public class AuditableInterceptor
extends org.hibernate.EmptyInterceptor

This class looks for OpenmrsObject and Auditable that are being inserted into the database. The creator and dateCreated fields are set when inserting or updating objects and the fields are still null. If the class is an update (instead of an insert) then the changedBy and dateChanged fields are set to the current user and the current time.

This class replaces the logic that was in the AuditableSaveHandler. It is here so that the cascading does NOT happen for dateChanged/changedBy to child OpenmrsObjects (because all handlers recurse on lists of OpenmrsObjects.

Since:

1.9

See Also:

Serialized Form

Field Summary

Fields inherited from class org.hibernate.EmptyInterceptor

INSTANCE

Constructor Summary

Constructors

Constructor and Description
AuditableInterceptor()

Method Summary

Modifier and Type	Method and Description
void	onCollectionRecreate(Object collection, Serializable key)
void	onCollectionRemove(Object collection, Serializable key)
void	onCollectionUpdate(Object collection, Serializable key)
boolean	onFlushDirty(Object entity, Serializable id, Object[] currentState, Object[] previousState, String[] propertyNames, org.hibernate.type.Type[] types) This class method is only called when flushing an updated dirty object, not inserting objects
boolean	onSave(Object entity, Serializable id, Object[] entityCurrentState, String[] propertyNames, org.hibernate.type.Type[] types) This method is only called when inserting new objects.

Methods inherited from class org.hibernate.EmptyInterceptor

afterTransactionBegin, afterTransactionCompletion, beforeTransactionCompletion, findDirty, getEntity, getEntityName, instantiate, isTransient, onDelete, onLoad, onPrepareStatement, postFlush, preFlush

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuditableInterceptor

public AuditableInterceptor()

Method Detail

onSave

public boolean onSave(Object entity,
                      Serializable id,
                      Object[] entityCurrentState,
                      String[] propertyNames,
                      org.hibernate.type.Type[] types)

This method is only called when inserting new objects. Should return true if dateCreated was null Should return true if creator was null Should return false if dateCreated and creator was not null Should be called when saving OpenmrsObject

Specified by:

onSave in interface org.hibernate.Interceptor

Overrides:

onSave in class org.hibernate.EmptyInterceptor

Returns:

true if the object got the dateCreated and creator fields set

See Also:

EmptyInterceptor.onSave(java.lang.Object, java.io.Serializable, java.lang.Object[], java.lang.String[], org.hibernate.type.Type[])

onFlushDirty

public boolean onFlushDirty(Object entity,
                            Serializable id,
                            Object[] currentState,
                            Object[] previousState,
                            String[] propertyNames,
                            org.hibernate.type.Type[] types)
                     throws org.hibernate.CallbackException

This class method is only called when flushing an updated dirty object, not inserting objects

Specified by:

onFlushDirty in interface org.hibernate.Interceptor

Overrides:

onFlushDirty in class org.hibernate.EmptyInterceptor

Returns:

true if the object got the changedBy and dateChanged fields set Should set the dateChanged field Should set the changedBy field Should be called when saving an Auditable Should not enter into recursion on entity

Throws:

org.hibernate.CallbackException

See Also:

EmptyInterceptor.onFlushDirty(java.lang.Object, java.io.Serializable, java.lang.Object[], java.lang.Object[], java.lang.String[], org.hibernate.type.Type[])

onCollectionRecreate

public void onCollectionRecreate(Object collection,
                                 Serializable key)
                          throws org.hibernate.CallbackException

Specified by:

onCollectionRecreate in interface org.hibernate.Interceptor

Overrides:

onCollectionRecreate in class org.hibernate.EmptyInterceptor

Throws:

org.hibernate.CallbackException

onCollectionUpdate

public void onCollectionUpdate(Object collection,
                               Serializable key)
                        throws org.hibernate.CallbackException

Specified by:

onCollectionUpdate in interface org.hibernate.Interceptor

Overrides:

onCollectionUpdate in class org.hibernate.EmptyInterceptor

Throws:

org.hibernate.CallbackException

onCollectionRemove

public void onCollectionRemove(Object collection,
                               Serializable key)
                        throws org.hibernate.CallbackException

Specified by:

onCollectionRemove in interface org.hibernate.Interceptor

Overrides:

onCollectionRemove in class org.hibernate.EmptyInterceptor

Throws:

org.hibernate.CallbackException