org.nhindirect.common.audit.impl

Class LoggingAuditor

java.lang.Object

org.nhindirect.common.audit.impl.AbstractAuditor

org.nhindirect.common.audit.impl.LoggingAuditor

All Implemented Interfaces:

Auditor

public class LoggingAuditor
extends AbstractAuditor

Auditor implementation that utilizes the Apache Commons logging framework as the storage medium for auditing events. Audit events are distinguished from other log entries with the tag [DIRECT AUDIT EVENT] in the log text.

Since:

1.0

Author:

Greg Meyer

Constructor Summary

Constructors

Constructor and Description
LoggingAuditor() Default constructor

Method Summary

Modifier and Type	Method and Description
void	writeEvent(java.util.UUID eventId, java.util.Calendar eventTimeStamp, java.lang.String principal, AuditEvent event, java.util.Collection<? extends AuditContext> contexts) Writes the auditable event to the storage medium.

Methods inherited from class org.nhindirect.common.audit.impl.AbstractAuditor

audit, audit

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingAuditor

public LoggingAuditor()

Default constructor

Method Detail

writeEvent

public void writeEvent(java.util.UUID eventId,
                       java.util.Calendar eventTimeStamp,
                       java.lang.String principal,
                       AuditEvent event,
                       java.util.Collection<? extends AuditContext> contexts)

Writes the auditable event to the storage medium.

Specified by:

writeEvent in class AbstractAuditor

Parameters:

eventId - An arbitrary unique ID for the event.

eventTimeStamp - The date/time that the event record was created.

principal - An identifier of the entity that performed the event. This may be an actual user performing a workflow or a system entity performing back office processing. Cannot be null or empty.

event - The event that was performed and that will be audited. Cannot be null

contexts - A collection of contexts that provide additional information for the event.