org.eclipse.ohf.ihe.atna.audit.client
Class ATNAAuditClientDummy

java.lang.Object
  org.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClientDummy

All Implemented Interfaces:

ATNAAuditClient

public class ATNAAuditClientDummy
extends java.lang.Object
implements ATNAAuditClient

Dummy audit client until we can decide what to do about auditing. Implementation for IHE clients to record audit events (Transaction ITI-20: Record Audit Event)

Author:

Sarah Knoop

See Also:

IHE Technical Framework

Field Summary

Fields inherited from interface org.eclipse.ohf.ihe.atna.audit.client.ATNAAuditClient

MINOR_FAILURE_EVENT_OUTCOME, NODE_AUTHENTICATION_FAILURE, SERIOUS_FAILURE_EVENT_OUTCOME, SUCCESS_EVENT_OUTCOME

Constructor Summary

ATNAAuditClientDummy()

Method Summary

void	audit(int eventOutcome, java.lang.String initiatingUser, java.lang.String transactionPayload) Dummy implementation until we can decide what to do about auditing
void	auditActorStartEvent(int eventOutcome, java.lang.String applicationName, java.lang.String userName) Transaction ITI-20: Record Audit Event Method to call that will send a Application Start Audit Event to the Audit Repository.
void	auditActorStopEvent(int eventOutcome, java.lang.String applicationName, java.lang.String userName) Transaction ITI-20: Record Audit Event Method to call that will send a Application Stop Audit Event to the Audit Repository.
void	auditPatientRecordCreateEvent(int eventOutcome, java.lang.String initiatingUser, java.lang.String patientId) Transaction ITI-20: Record Audit Event Method to call that will send a Patient Record Audit Event, which indicates that a CREATING of a patient record took place, to the Audit Repository.
void	auditPatientRecordDeleteEvent(int eventOutcome, java.lang.String initiatingUser, java.lang.String patientId) Transaction ITI-20: Record Audit Event Method to call that will send a Patient Record Audit Event, which indicates that a DELETING of a patient record took place, to the Audit Repository.
void	auditPatientRecordReadEvent(int eventOutcome, java.lang.String initiatingUser, java.lang.String patientId) Transaction ITI-20: Record Audit Event Method to call that will send a Patient Record Audit Event, which indicates that a READING of a patient record took place, to the Audit Repository.
void	auditPatientRecordUpdateEvent(int eventOutcome, java.lang.String initiatingUser, java.lang.String patientId) Transaction ITI-20: Record Audit Event Method to call that will send a Patient Record Audit Event, which indicates that a UPDATING of a patient record took place, to the Audit Repository.
void	auditPHIExportEvent(int eventOutcome, java.lang.String initatingUser, java.lang.String dataRecipientId, java.lang.String exportedDataId, java.lang.String patientId) Method to call that will send a PHI Export Audit Event to the Audit Repository.
void	auditPHIImportEvent(int eventOutcome, java.lang.String initatingUser, java.lang.String dataSourceId, java.lang.String[] patientId, java.lang.String importedData) Method to call that will send a PHI Import Audit Event to the Audit Repository.
void	auditQueryEvent(int eventOutcome, java.lang.String initiatingUser, java.lang.String registryID, java.lang.String queryText) Method to call that will send a Query Audit Event to the Audit Repository.
void	auditUserAuthenticationLoginEvent(int eventOutcome, java.lang.String initiatingUser, java.lang.String initiatingUserName, java.lang.String initiatingUserNodeIP, java.lang.String authenticatingNodeIP) Transaction ITI-20: Record Audit Event Method to call that will send a User Authentication Event, which indicates that a LOGIN took place, to the Audit Repository.
void	auditUserAuthenticationLogoutEvent(int eventOutcome, java.lang.String initiatingUser, java.lang.String initiatingUserName, java.lang.String initiatingUserNodeIP, java.lang.String authenticatingNodeIP) Transaction ITI-20: Record Audit Event Method to call that will send a User Authentication Event, which indicates that a LOGIN took place, to the Audit Repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

ATNAAuditClientDummy

public ATNAAuditClientDummy()

Method Detail

audit

public void audit(int eventOutcome,
                  java.lang.String initiatingUser,
                  java.lang.String transactionPayload)

Dummy implementation until we can decide what to do about auditing

Specified by:

audit in interface ATNAAuditClient

Parameters:

eventOutcome - status code of the event to be audited (success or failure to access patient(s) information)

initiatingUser - the id of the entity that triggered the transaction concering the patient(s) information, thus triggering the audit event

transactionPayload - transactional data used to obtain information about the patient(s) or containing information about the patient(s)

See Also:

ATNAAuditClient.audit(int, java.lang.String, java.lang.String)

auditQueryEvent

public void auditQueryEvent(int eventOutcome,
                            java.lang.String initiatingUser,
                            java.lang.String registryID,
                            java.lang.String queryText)
                     throws ATNAAuditClientException

Method to call that will send a Query Audit Event to the Audit Repository. For use by the XDS Consumer, PIX Consumer and PDQ Consumer.

Specified by:

auditQueryEvent in interface ATNAAuditClient

Parameters:

eventOutcome - event outcome from AtnaAuditClient

initatingUser - User Id passed along to the Consumer

registryID - Id of the entity that is responsible for answering the query (ie. XDS Registry or the PIX/PDQ Server)

queryText - complete text of the query issued.

Throws:

ATNAException

javax.xml.parsers.FactoryConfigurationError

javax.xml.parsers.ParserConfigurationException

ATNAAuditClientException

auditPHIImportEvent

public void auditPHIImportEvent(int eventOutcome,
                                java.lang.String initatingUser,
                                java.lang.String dataSourceId,
                                java.lang.String[] patientId,
                                java.lang.String importedData)
                         throws ATNAAuditClientException

Method to call that will send a PHI Import Audit Event to the Audit Repository. For use by the XDS Consumer, PIX Consumer and PDQ Consumer.

Specified by:

auditPHIImportEvent in interface ATNAAuditClient

Parameters:

eventOutcome - event outcome from AtnaAuditClient

initatingUser - User Id passed along to the IHE Actor

dataSourceId - where the imported data came from (ie. the XDS Registry or the PIX/PDQ server)

patientId - Patient Id from within imported data

importedData - exact data or UUID/uniqueId of data imported as a String

Throws:

ATNAAuditClientException

auditPHIExportEvent

public void auditPHIExportEvent(int eventOutcome,
                                java.lang.String initatingUser,
                                java.lang.String dataRecipientId,
                                java.lang.String exportedDataId,
                                java.lang.String patientId)
                         throws ATNAAuditClientException

Method to call that will send a PHI Export Audit Event to the Audit Repository. For use by the XDS Source and PIX Source

Specified by:

auditPHIExportEvent in interface ATNAAuditClient

Parameters:

eventOutcome - event outcome from AtnaAuditClient

initatingUser - User Id passed along to the IHE Actor

dataRecipientId - where the exported data is going (ie. the XDS Repository or the PIX/PDQ server)

exportedDataId - UUID/uniqueId of data exported as a String

patientId - the id of the patient this data pertains to

Throws:

ATNAAuditClientException

auditActorStartEvent

public void auditActorStartEvent(int eventOutcome,
                                 java.lang.String applicationName,
                                 java.lang.String userName)
                          throws ATNAAuditClientException

Transaction ITI-20: Record Audit Event
Method to call that will send a Application Start Audit Event to the Audit Repository. For use by all actors.

Specified by:

auditActorStartEvent in interface ATNAAuditClient

Parameters:

eventOutcome - event outcome from AtnaAuditClient

applicationName - actor/application started

userName - user or process that did the start

Throws:

ATNAAuditClientException

auditActorStopEvent

public void auditActorStopEvent(int eventOutcome,
                                java.lang.String applicationName,
                                java.lang.String userName)
                         throws ATNAAuditClientException

Transaction ITI-20: Record Audit Event
Method to call that will send a Application Stop Audit Event to the Audit Repository. For use by all actors.

Specified by:

auditActorStopEvent in interface ATNAAuditClient

Parameters:

eventOutcome - event outcome from AtnaAuditClient

applicationName - name of the actor/application stopping

userName - userName user or process that did the start

Throws:

ATNAAuditClientException

auditPatientRecordReadEvent

public void auditPatientRecordReadEvent(int eventOutcome,
                                        java.lang.String initiatingUser,
                                        java.lang.String patientId)
                                 throws ATNAAuditClientException

Transaction ITI-20: Record Audit Event
Method to call that will send a Patient Record Audit Event, which indicates that a READING of a patient record took place, to the Audit Repository.

Specified by:

auditPatientRecordReadEvent in interface ATNAAuditClient

Parameters:

eventOutcome - event outcome from AtnaAuditClient

initatingUser - User Id passed along to the IHE Actor

patientId - the id of the patient the record pertains to

Throws:

ATNAAuditClientException

auditPatientRecordCreateEvent

public void auditPatientRecordCreateEvent(int eventOutcome,
                                          java.lang.String initiatingUser,
                                          java.lang.String patientId)
                                   throws ATNAAuditClientException

Transaction ITI-20: Record Audit Event
Method to call that will send a Patient Record Audit Event, which indicates that a CREATING of a patient record took place, to the Audit Repository.

Specified by:

auditPatientRecordCreateEvent in interface ATNAAuditClient

Parameters:

eventOutcome - event outcome from AtnaAuditClient

initatingUser - User Id passed along to the IHE Actor

patientId - the id of the patient the record pertains to

Throws:

ATNAAuditClientException

auditPatientRecordUpdateEvent

public void auditPatientRecordUpdateEvent(int eventOutcome,
                                          java.lang.String initiatingUser,
                                          java.lang.String patientId)
                                   throws ATNAAuditClientException

Transaction ITI-20: Record Audit Event
Method to call that will send a Patient Record Audit Event, which indicates that a UPDATING of a patient record took place, to the Audit Repository.

Specified by:

auditPatientRecordUpdateEvent in interface ATNAAuditClient

Parameters:

eventOutcome - event outcome from AtnaAuditClient

initatingUser - User Id passed along to the IHE Actor

patientId - the id of the patient the record pertains to

Throws:

ATNAAuditClientException

auditPatientRecordDeleteEvent

public void auditPatientRecordDeleteEvent(int eventOutcome,
                                          java.lang.String initiatingUser,
                                          java.lang.String patientId)
                                   throws ATNAAuditClientException

Transaction ITI-20: Record Audit Event
Method to call that will send a Patient Record Audit Event, which indicates that a DELETING of a patient record took place, to the Audit Repository.

Specified by:

auditPatientRecordDeleteEvent in interface ATNAAuditClient

Parameters:

eventOutcome - event outcome from AtnaAuditClient

initatingUser - User Id passed along to the IHE Actor

patientId - the id of the patient the record pertains to

Throws:

ATNAAuditClientException

auditUserAuthenticationLoginEvent

public void auditUserAuthenticationLoginEvent(int eventOutcome,
                                              java.lang.String initiatingUser,
                                              java.lang.String initiatingUserName,
                                              java.lang.String initiatingUserNodeIP,
                                              java.lang.String authenticatingNodeIP)
                                       throws ATNAAuditClientException

Transaction ITI-20: Record Audit Event
Method to call that will send a User Authentication Event, which indicates that a LOGIN took place, to the Audit Repository.

Specified by:

auditUserAuthenticationLoginEvent in interface ATNAAuditClient

Parameters:

eventOutcome - event outcome from AtnaAuditClient

initatingUser - User Id passed along to the IHE Actor

initiatingUserName - the name of the user logging in

initiatingUserNodeIP - the IP Address of the node the user is logging into

authenticatingNodeIP - the IP Address of the node that is authenticating the user

Throws:

ATNAAuditClientException

auditUserAuthenticationLogoutEvent

public void auditUserAuthenticationLogoutEvent(int eventOutcome,
                                               java.lang.String initiatingUser,
                                               java.lang.String initiatingUserName,
                                               java.lang.String initiatingUserNodeIP,
                                               java.lang.String authenticatingNodeIP)
                                        throws ATNAAuditClientException

Transaction ITI-20: Record Audit Event
Method to call that will send a User Authentication Event, which indicates that a LOGIN took place, to the Audit Repository.

Specified by:

auditUserAuthenticationLogoutEvent in interface ATNAAuditClient

Parameters:

eventOutcome - event outcome from AtnaAuditClient

initatingUser - User Id passed along to the IHE Actor

initiatingUserName - the name of the user logging in

initiatingUserNodeIP - the IP Address of the node the user is logging into

authenticatingNodeIP - the IP Address of the node that is authenticating the user

Throws:

ATNAAuditClientException