org.nhindirect.common.audit

Class AbstractAuditor

java.lang.Object

org.nhindirect.common.audit.AbstractAuditor

All Implemented Interfaces:

Auditor

Direct Known Subclasses:

RDBMSAuditor

public abstract class AbstractAuditor
extends java.lang.Object
implements Auditor

Abstract base class Auditor that performs trivial sanity checks such as parameter validation. All calls are delegated to {@link #writeEvent(String, Calendar, String, String, Collection) which is implemented by a concrete sub class to commit the event to the underlying medium. Before calling {@link #writeEvent(String, Calendar, String, String, Collection), a unique event id and time stamp is generated.

Since:

1.0

Author:

Greg Meyer

Constructor Summary

Constructors

Constructor and Description
AbstractAuditor()

Method Summary

Modifier and Type	Method and Description
void	audit(java.lang.String principal, AuditEvent event) Writes an AuditEvent to the audit sub-system.
void	audit(java.lang.String principal, AuditEvent event, java.util.Collection<? extends AuditContext> contexts) Writes an AuditEvent to the audit sub-system with addition contextual data.
abstract 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 java.lang.Object

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

Constructor Detail

AbstractAuditor

public AbstractAuditor()

Method Detail

audit

public void audit(java.lang.String principal,
                  AuditEvent event)

Writes an AuditEvent to the audit sub-system.

Specified by:

audit in interface Auditor

Parameters:

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.

audit

public void audit(java.lang.String principal,
                  AuditEvent event,
                  java.util.Collection<? extends AuditContext> contexts)

Writes an AuditEvent to the audit sub-system with addition contextual data.

Specified by:

audit in interface Auditor

Parameters:

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.

writeEvent

public abstract 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.

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.