org.nhindirect.common.audit.impl

Class NoOpAuditor

java.lang.Object

org.nhindirect.common.audit.impl.AbstractAuditor

org.nhindirect.common.audit.impl.NoOpAuditor

All Implemented Interfaces:

Auditor

public class NoOpAuditor
extends AbstractAuditor

Auditor implementation that effectively does nothing. Generally used for unit tests where auditing is not required.

Since:

1.0

Author:

Greg Meyer

Constructor Summary

Constructors

Constructor and Description
NoOpAuditor()

Method Summary

Modifier and Type	Method and Description
void	writeEvent(UUID eventId, Calendar eventTimeStamp, String principal, AuditEvent event, 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

NoOpAuditor

public NoOpAuditor()

Method Detail

writeEvent

public void writeEvent(UUID eventId,
                       Calendar eventTimeStamp,
                       String principal,
                       AuditEvent event,
                       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.