org.broadleafcommerce.common.audit

Class AuditableListener

java.lang.Object

org.broadleafcommerce.common.audit.AuditableListener

public class AuditableListener
extends Object

Implements behavior shared by auditable listener implementations

Author:

Chris Kittrell (ckittrell)

Constructor Summary

Constructors

Constructor and Description
AuditableListener()

Method Summary

Modifier and Type	Method and Description
protected String	getAuditableFieldName() Gathers the auditable field name.
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, Auditable auditable) Sets the value of the dateCreated, createdBy, and dateUpdated fields.
protected void	setAuditData(Object entity, Auditable auditableObject, String dateField)
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, Auditable auditable) Sets the value of the dateUpdated and updatedBy fields.
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

AuditableListener

public AuditableListener()

Method Detail

setAuditCreationAndUpdateData

public 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, Auditable) should suffice.

Parameters:

entity -

Throws:

Exception

setAuditUpdateData

public 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, Auditable) should suffice.

Parameters:

entity -

Throws:

Exception

setAuditCreationData

protected void setAuditCreationData(Object entity,
                                    Auditable auditable)
                             throws Exception

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

Parameters:

entity -

auditable -

Throws:

Exception

setAuditUpdateData

protected void setAuditUpdateData(Object entity,
                                  Auditable auditable)
                           throws Exception

Sets the value of the dateUpdated and updatedBy fields.

Parameters:

entity -

auditable -

Throws:

Exception

setAuditData

protected void setAuditData(Object entity,
                            Auditable auditableObject,
                            String dateField)
                     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