org.bitrepository.service.audit
Interface AuditTrailManager

All Known Implementing Classes:

AuditTrailContributerDAO

public interface AuditTrailManager

The interface for the audit trail handler.

Method Summary

void	addAuditEvent(String collectionId, String fileId, String actor, String info, String auditTrail, FileAction operation) Adds an audit trail event to the manager.
AuditTrailDatabaseResults	getAudits(String collectionId, String fileId, Long minSeqNumber, Long maxSeqNumber, Date minDate, Date maxDate, Long maxNumberOfResults) Method for extracting all the audit trails.

Method Detail

addAuditEvent

void addAuditEvent(String collectionId,
                   String fileId,
                   String actor,
                   String info,
                   String auditTrail,
                   FileAction operation)

Adds an audit trail event to the manager.

Parameters:

collectionId - The id of the collection for whom the audit applies.

fileId - The id of the file, where the operation has been performed. Use the argument null for indicating all file ids.

actor - The name of the actor.

info - Information about the reason for the audit trail to be logged.

auditTrail - The string for the audit trail information from the message performing the operation.

operation - The performed operation.

getAudits

AuditTrailDatabaseResults getAudits(String collectionId,
                                    String fileId,
                                    Long minSeqNumber,
                                    Long maxSeqNumber,
                                    Date minDate,
                                    Date maxDate,
                                    Long maxNumberOfResults)

Method for extracting all the audit trails.

Parameters:

collectionId - The id of the collection for whom the audit applies.

fileId - [OPTIONAL] The id of the file to request audits for.

minSeqNumber - [OPTIONAL] The lower sequence number requested.

maxSeqNumber - [OPTIONAL] The upper sequence number requested.

minDate - [OPTIONAL] The earliest date requested.

maxDate - [OPTIONAL] The newest date requested.

maxNumberOfResults - [OPTIONAL] The maximum number of results.

Returns:

The audit trails corresponding to the requested arguments.