org.nhindirect.common.audit

Interface Auditor

All Known Implementing Classes:

AbstractAuditor, AbstractAuditor, FileAuditor, LoggingAuditor, MultiProviderAuditor, NoOpAuditor, RDBMSAuditor

public interface Auditor

The auditor interface defines the auditing sub-system of the Direct Project. Auditable events consists of event descriptor, a principal, and a collection of contextual information. The auditing implementation may use any appropriate medium and format to store audit events. Some implementations may even consist of multiple audit implementation providers.

Auditor implementations should be thread safe and not block for relatively long periods of time to commit audit events to the underlying storage medium.

Since:

1.0

Author:

Greg Meyer

Method Summary

Modifier and Type	Method and Description
void	audit(String principal, AuditEvent event) Writes an AuditEvent to the audit sub-system.
void	audit(String principal, AuditEvent event, Collection<? extends AuditContext> contexts) Writes an AuditEvent to the audit sub-system with addition contextual data.

Method Detail

audit

void audit(String principal,
           AuditEvent event)

Writes an AuditEvent to the audit sub-system.

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

void audit(String principal,
           AuditEvent event,
           Collection<? extends AuditContext> contexts)

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

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.