org.nhindirect.common.audit.impl

Class FileAuditor

java.lang.Object

org.nhindirect.common.audit.impl.AbstractAuditor

org.nhindirect.common.audit.impl.FileAuditor

All Implemented Interfaces:

Auditor, AuditorMBean

public class FileAuditor
extends AbstractAuditor
implements AuditorMBean

File based auditor. Events are stored in a non-circular flat file that is not truncated. Each event is appended to the end of the audit file.

Since:

1.0

Author:

Greg Meyer

Constructor Summary

Constructors

Constructor and Description
FileAuditor(File auditFile) Constructor.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the audit repository.
Integer	getEventCount() Gets the number of events in the event the auditing system.
CompositeData[]	getEvents(Integer eventCount) Gets the event data in the audit system.
CompositeData	getLastEvent() Gets the latest event to be written to the audit system.
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

FileAuditor

public FileAuditor(File auditFile)

Constructor. If the audit file does not exist, then a new file is created barring access permissions or illegal file names or locations. If the file already existing, then the file opened in append mode and new events are written to the end of the file.

Parameters:

auditFile - File descriptor of the audit file.

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.

getEventCount

public Integer getEventCount()

Gets the number of events in the event the auditing system.

Specified by:

getEventCount in interface AuditorMBean

Returns:

The number of events in the event the auditing system.

getEvents

public CompositeData[] getEvents(Integer eventCount)

Gets the event data in the audit system.

Specified by:

getEvents in interface AuditorMBean

Parameters:

eventCount - The number of events to retrieve. Events are retrieved from the most recent event.

Returns:

Event data in the audit system.

getLastEvent

public CompositeData getLastEvent()

Gets the latest event to be written to the audit system.

Specified by:

getLastEvent in interface AuditorMBean

Returns:

The latest event to be written to the audit system.

clear

public void clear()

Clears the audit repository.

Specified by:

clear in interface AuditorMBean