uk.nhs.interoperability.service

Class ITKSimpleAudit

java.lang.Object

uk.nhs.interoperability.service.ITKSimpleAudit

All Implemented Interfaces:

AuditService

@Requirement(traceTo="IFA-SEC-02",
             status="in-progress")
public class ITKSimpleAudit
extends Object
implements AuditService

The Class ITKSimpleAudit.

Since:

0.1

Author:

Michael Odling-Smee, Nicholas Jones

Field Summary

Fields inherited from interface uk.nhs.interoperability.capabilities.AuditService

MESSAGE_PROCESSING_FAILURE, MESSAGE_RECEIPT_EVENT, MESSAGE_SENT_EVENT

Constructor Summary

Constructors

Constructor and Description
ITKSimpleAudit()

Method Summary

Methods

Modifier and Type	Method and Description
void	auditEvent(String event, long eventTime, ITKMessageProperties itkMessageProperties) Writes an audit event to the audit service using the supplied information.
static AuditService	getInstance() Gets the single instance of ITKSimpleAudit.

Methods inherited from class java.lang.Object

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

Constructor Detail

ITKSimpleAudit

public ITKSimpleAudit()

Method Detail

auditEvent

@Requirement(traceTo="COR-DEH-04",
             status="in-progress")
public void auditEvent(String event,
                          long eventTime,
                          ITKMessageProperties itkMessageProperties)
                throws AuditException

Description copied from interface: AuditService

Writes an audit event to the audit service using the supplied information.

Specified by:

auditEvent in interface AuditService

Parameters:

event - The string description of the event - e.g. AuditService.MESSAGE_PROCESSING_FAILURE, AuditService.MESSAGE_RECEIPT_EVENT, AuditService.MESSAGE_SENT_EVENT

eventTime - The time the event occurred (in unix time). Note depending on the implementation this may differ from the time at which the audit record is actually committed

itkMessageProperties - The properties of the message to which this event pertains

Throws:

AuditException - If there are any issues accessing the underlying audit implementation (e.g. I/O exception) or if the event and/or itkMessageProperties is null

getInstance

public static final AuditService getInstance()

Gets the single instance of ITKSimpleAudit.

Returns:

single instance of ITKSimpleAudit