uk.nhs.interoperability.capabilities

Interface AuditService

All Known Implementing Classes:

ITKSimpleAudit

public interface AuditService

An representation of an ITK compliant* audit service that has the capability to audit ITK messaging related events In general the expected usage pattern is to audit on both the client and service provider sides of any ITK operation. Additionally the intent to do something should be audited - e.g. intention to send a message or call a service MESSAGE_SENT_EVENT. An additional audit call may then be required for the same logical action should any processing errors occur - e.g. connection timeouts MESSAGE_PROCESSING_FAILURE

*TODO note further work is required to understand the audit requirements around the human actors (patient and carer) in the audit

Since:

version 0.1

Author:

Michael Odling-Smee, Nicholas Jones

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_PROCESSING_FAILURE Constant representing the event of message processing failure
static String	MESSAGE_RECEIPT_EVENT Constant representing the receipt of an ITK message
static String	MESSAGE_SENT_EVENT Constant representing the sending of an ITK message

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.

Field Detail

MESSAGE_RECEIPT_EVENT

static final String MESSAGE_RECEIPT_EVENT

Constant representing the receipt of an ITK message

See Also:

Constant Field Values

MESSAGE_SENT_EVENT

static final String MESSAGE_SENT_EVENT

Constant representing the sending of an ITK message

See Also:

Constant Field Values

MESSAGE_PROCESSING_FAILURE

static final String MESSAGE_PROCESSING_FAILURE

Constant representing the event of message processing failure

See Also:

Constant Field Values

Method Detail

auditEvent

@Requirement(traceTo="IFA-SEC-02",
             status="abstract")
void auditEvent(String event,
                          long eventTime,
                          ITKMessageProperties itkMessageProperties)
                throws AuditException

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

Parameters:

event - The string description of the event - e.g. MESSAGE_PROCESSING_FAILURE, MESSAGE_RECEIPT_EVENT, 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