org.broadleafcommerce.common.audit

Class AbstractAuditableListener

java.lang.Object

org.broadleafcommerce.common.audit.AbstractAuditableListener

Direct Known Subclasses:

AuditableListener

public abstract class AbstractAuditableListener
extends Object

Implements behavior shared by auditable listener implementations

Author:

Chris Kittrell (ckittrell)

Constructor Summary

Constructors

Constructor and Description
AbstractAuditableListener()

Method Summary

Modifier and Type	Method and Description
protected String	getAuditableFieldName() Gathers the auditable field name.
abstract void	setAuditCreationAndUpdateData(Object entity) Method that will be invoked in a registered listener to set the entity's creation data.
protected void	setAuditCreationData(Object entity, Object auditableObject) Sets the value of the dateCreated, createdBy, and dateUpdated fields.
protected void	setAuditData(Object entity, Object auditableObject, String dateField, String userField)
abstract void	setAuditUpdateData(Object entity) Method that will be invoked in a registered listener to set the entity's update data.
protected void	setAuditUpdateData(Object entity, Object auditableObject) Sets the value of the dateUpdated and updatedBy fields.
protected abstract void	setAuditValueAgent(Field field, Object entity) Method that sets the user-related data.
protected void	setAuditValueTemporal(Field field, Object entity) Used to set the timestamp for dateCreated and dateUpdated.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAuditableListener

public AbstractAuditableListener()

Method Detail

setAuditCreationAndUpdateData

public abstract void setAuditCreationAndUpdateData(Object entity)
                                            throws Exception

Method that will be invoked in a registered listener to set the entity's creation data. In most cases, calling setAuditCreationData(Object, Object) should suffice.

Parameters:

entity -

Throws:

Exception

setAuditUpdateData

public abstract void setAuditUpdateData(Object entity)
                                 throws Exception

Method that will be invoked in a registered listener to set the entity's update data. In most cases, calling setAuditUpdateData(Object, Object) should suffice.

Parameters:

entity -

Throws:

Exception

setAuditValueAgent

protected abstract void setAuditValueAgent(Field field,
                                           Object entity)
                                    throws IllegalArgumentException,
                                           IllegalAccessException

Method that sets the user-related data.

Parameters:

field -

entity -

Throws:

IllegalArgumentException

IllegalAccessException

setAuditCreationData

protected void setAuditCreationData(Object entity,
                                    Object auditableObject)
                             throws Exception

Sets the value of the dateCreated, createdBy, and dateUpdated fields.

Parameters:

entity -

auditableObject -

Throws:

Exception

setAuditUpdateData

protected void setAuditUpdateData(Object entity,
                                  Object auditableObject)
                           throws Exception

Sets the value of the dateUpdated and updatedBy fields.

Parameters:

entity -

auditableObject -

Throws:

Exception

setAuditData

protected void setAuditData(Object entity,
                            Object auditableObject,
                            String dateField,
                            String userField)
                     throws Exception

Throws:

Exception

setAuditValueTemporal

protected void setAuditValueTemporal(Field field,
                                     Object entity)
                              throws IllegalArgumentException,
                                     IllegalAccessException

Used to set the timestamp for dateCreated and dateUpdated.

Parameters:

field -

entity -

Throws:

IllegalArgumentException

IllegalAccessException

getAuditableFieldName

protected String getAuditableFieldName()

Gathers the auditable field name. The major purpose of this method is to provide a hook point for extensions to declare a different field name.

Returns:

the name of the auditable field