org.openmrs.api.db.hibernate

Class ImmutableEntityInterceptor

java.lang.Object

org.hibernate.EmptyInterceptor

org.openmrs.api.db.hibernate.ImmutableEntityInterceptor

All Implemented Interfaces:

Serializable, org.hibernate.Interceptor

Direct Known Subclasses:

ImmutableObsInterceptor, ImmutableOrderInterceptor

public abstract class ImmutableEntityInterceptor
extends org.hibernate.EmptyInterceptor

Superclass for all Interceptors that would like to ensure that changes to immutable entities of specific types don't get persisted to the database, more granularity of the immutable properties is also supported so as to allow editing some properties while not for others

 NOTE: Subclasses MUST not make any changes to the persistent object because they get 
 called last, if they make any changes other interceptors would never know about them.
 

Since:

1.10

See Also:

Serialized Form

Field Summary

Fields inherited from class org.hibernate.EmptyInterceptor

INSTANCE

Constructor Summary

Constructors

Constructor and Description
ImmutableEntityInterceptor()

Method Summary

Modifier and Type	Method and Description
void	addMutablePropertiesForThread(String... properties) This allows code that is attempting to save immutable entities to bypass standard validation by allowing additional properties to be considered mutable for the duration of the thread.
protected String[]	getMutablePropertyNames() Subclasses can override this to return fields that are allowed to be edited, returning null or an empty array implies the entity is immutable
protected abstract Class<?>	getSupportedType() Returns the class handled by the interceptor
protected boolean	ignoreVoidedOrRetiredObjects() Subclasses can override this to specify whether voided or retired items are mutable
boolean	onFlushDirty(Object entity, Serializable id, Object[] currentState, Object[] previousState, String[] propertyNames, org.hibernate.type.Type[] types)
void	removeMutablePropertiesForThread() If any additional properties were added for a given thread by invoking addMutablePropertiesForThread(java.lang.String...), this removes them.

Methods inherited from class org.hibernate.EmptyInterceptor

afterTransactionBegin, afterTransactionCompletion, beforeTransactionCompletion, findDirty, getEntity, getEntityName, instantiate, isTransient, onCollectionRecreate, onCollectionRemove, onCollectionUpdate, onDelete, onLoad, onPrepareStatement, onSave, postFlush, preFlush

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableEntityInterceptor

public ImmutableEntityInterceptor()

Method Detail

getSupportedType

protected abstract Class<?> getSupportedType()

Returns the class handled by the interceptor

getMutablePropertyNames

protected String[] getMutablePropertyNames()

Subclasses can override this to return fields that are allowed to be edited, returning null or an empty array implies the entity is immutable

Returns:

an array of properties

ignoreVoidedOrRetiredObjects

protected boolean ignoreVoidedOrRetiredObjects()

Subclasses can override this to specify whether voided or retired items are mutable

Returns:

true if voided or retired objects are mutable otherwise false means they are immutable

onFlushDirty

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

Specified by:

onFlushDirty in interface org.hibernate.Interceptor

Overrides:

onFlushDirty in class org.hibernate.EmptyInterceptor

See Also:

Should fail if an entity has a changed property Should pass if an entity has changes for an allowed mutable property Should pass if the edited object is voided or retired and ignore is set to true Should fail if the edited object is voided or retired and ignore is set to false

addMutablePropertiesForThread

public void addMutablePropertiesForThread(String... properties)

This allows code that is attempting to save immutable entities to bypass standard validation by allowing additional properties to be considered mutable for the duration of the thread. Note that the caller should ensure that removeMutablePropertiesForThread() is invoked when the operation is done

Parameters:

properties - any additional properties that one wishes to make mutable for a given thread

removeMutablePropertiesForThread

public void removeMutablePropertiesForThread()

If any additional properties were added for a given thread by invoking addMutablePropertiesForThread(java.lang.String...), this removes them. NOTE, any usage of addMutablePropertiesForThread(java.lang.String...) should typically be followed by an invocation of this method in a finally block