org.dcm4chee.xds2.common.audit

Class XDSAudit

java.lang.Object

org.dcm4chee.xds2.common.audit.XDSAudit

public class XDSAudit
extends Object

Audit logger for XDS. A configured AuditLogger must be set via setAuditLogger. AuditLogger can be configured via LDAP: InputStream ldapConf = new URL(ldapPropertiesURL).openStream(); Properties p = new Properties(); p.load(ldapConf); ExtendedLdapDicomConfiguration config = new ExtendedLdapDicomConfiguration(p); config.addDicomConfigurationExtension(new LdapAuditLoggerConfiguration()); config.addDicomConfigurationExtension(new LdapAuditRecordRepositoryConfiguration()); Device device = config.findDevice("XDSAuditLogger"); AuditLogger logger = device.getDeviceExtension(AuditLogger.class); LDAP properties example (openDs): java.naming.factory.initial=com.sun.jndi.ldap.LdapCtxFactory java.naming.ldap.attributes.binary=dicomVendorData java.naming.provider.url=ldap://localhost:1389/dc=example,dc=com java.naming.security.principal=cn=Directory Manager java.naming.security.credentials=secret or Java Preferences: PreferencesDicomConfiguration prefConfig = new PreferencesDicomConfiguration(); prefConfig.addDicomConfigurationExtension(new PreferencesAuditLoggerConfiguration()); prefConfig.addDicomConfigurationExtension(new PreferencesAuditRecordRepositoryConfiguration()); Device device = prefConfig.findDevice("XDSAuditLogger"); AuditLogger logger = device.getDeviceExtension(AuditLogger.class); or by using AuditLogger directly: .. AuditLogger logger = createLoggerDevice("XDSLoggerDevice").getDeviceExtension(AuditLogger.class); .. private Device createLoggerDevice(String name) { Device device = new Device(name); Connection udp = new Connection("audit-udp", "host.dcm4che.org"); udp.setProtocol(Connection.Protocol.SYSLOG_UDP); Connection tls = new Connection("audit-tls", "host.dcm4che.org"); tls.setProtocol(Connection.Protocol.SYSLOG_TLS); tls.setTlsCipherSuites("TLS_RSA_WITH_AES_128_CBC_SHA"); device.addConnection(udp); device.addConnection(tls); udp.setPort(514); tls.setPort(6514); addAuditRecordRepository(device, udp, tls); arrDevice = device; addAuditLogger(device, udp, tls, arrDevice); return device ; } private void addAuditRecordRepository(Device device, Connection udp, Connection tls) { AuditRecordRepository arr = new AuditRecordRepository(); device.addDeviceExtension(arr); arr.addConnection(udp); arr.addConnection(tls); } private void addAuditLogger(Device device, Connection udp, Connection tls, Device arrDevice) { AuditLogger logger = new AuditLogger(); device.addDeviceExtension(logger); logger.addConnection(udp); logger.addConnection(tls); logger.setAuditRecordRepositoryDevice(arrDevice); logger.setSchemaURI(AuditMessages.SCHEMA_URI); }

Author:

franz.willer@gmail.com

Constructor Summary

Constructors

Constructor and Description
XDSAudit()

Method Summary

Methods

Modifier and Type	Method and Description
static org.dcm4che3.audit.AuditMessage	createExport(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode, String submissionSetUID, String patID, String srcUserID, String altSrcUserID, String srcHostName, String destUserID, String altDestUserID, String destHostName, org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq, List<String> docUIDs, Calendar timeStamp, String outcomeIndicator)
static org.dcm4che3.audit.AuditMessage	createImport(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode, String submissionSetUID, String patID, String srcUserID, String altSrcUserID, String srcHostName, String destUserID, String altDestUserID, String destHostName, org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq, Calendar timeStamp, String outcomeIndicator)
static org.dcm4che3.audit.ParticipantObjectIdentification	createPatient(String patID)
static org.dcm4che3.audit.AuditMessage	createPatientFeed(String patID, String eventActionCode, byte[] msh10, String srcUserID, String altSrcUserID, String srcHostName, String destUserID, Calendar timeStamp, String outcomeIndicator)
static org.dcm4che3.audit.AuditMessage	createQuery(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode, String queryUID, String patID, String homeCommunityID, byte[] adhocQuery, String srcUserID, String altSrcUserID, String srcHostName, String destUserID, String altDestUserID, String destHostName, Calendar timeStamp, String outcomeIndicator)
static org.dcm4che3.audit.ParticipantObjectIdentification	createQueryParticipantObjectIdentification(String queryUID, String homeCommunityID, byte[] adhocQuery)
static org.dcm4che3.audit.AuditMessage	createRetrieveImgLogMessage(org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetResponseType rsp, String remoteHost, String user, Calendar timeStamp)
static org.dcm4che3.audit.AuditMessage	createStudyUsedLogMessage(org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetResponseType rsp, String remoteHost, String user, Calendar timeStamp)
static org.dcm4che3.audit.ParticipantObjectIdentification	createSubmissionSet(String submissionSetUID)
static org.dcm4che3.net.audit.AuditLogger	getAuditLogger()
static String	info()
static void	logApplicationActivity(String appName, org.dcm4che3.audit.AuditMessages.EventTypeCode eventType, boolean success)
static void	logClientQuery(org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req, String srcUserID, String srcHostName, URL registryURL, boolean success) Send a ITI-18 Stored Query Audit message.
static void	logClientXCAQuery(org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req, String srcUserID, String srcHostName, URL registryURL, boolean success)
static void	logConsumerImport(String patID, URL repositoryURL, org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq, boolean success) Send a ITI-43 Import Audit message.
static void	logConsumerXCAImport(String patID, URL repositoryURL, org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq, boolean success)
static void	logExport(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode, org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType req, org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetResponseType rsp, AuditRequestInfo info)
static void	logExport(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode, String submissionSetUID, String patID, String srcUserID, String altSrcUserID, String srcHostName, String destUserID, String altDestUserID, String destHostName, org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq, List<String> docUIDs, boolean success)
static void	logImgRetrieve(org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetResponseType rsp, AuditRequestInfo info)
static void	logImport(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode, String submissionSetUID, String patID, String srcUserID, String altSrcUserID, String srcHostName, String destUserID, String altDestUserID, String destHostName, org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq, boolean success)
static void	logImport(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode, String patID, URL repositoryURL, org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq, boolean success)
static void	logPatientFeed(String patID, String eventActionCode, byte[] msh10, String srcUserID, String remoteHost, String destUserID, boolean success)
static void	logPixQuery(String patID, String sendingApp, String sendingFacility, String receivingApp, String receivingFacility, String remoteHost, byte[] query, byte[] msh10, boolean success)
static void	logQuery(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode, org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req, String srcUserID, String altSrcUserID, String srcHostName, String destUserID, String altDestUserID, String destHostName, boolean success)
static void	logRegistryImport(String submissionSetUID, String patID, AuditRequestInfo info, boolean success) Send a ITI-42 Import Audit message.
static void	logRegistryQuery(org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req, AuditRequestInfo info, boolean success) Send a ITI-18 Stored Query Audit message.
static void	logRegistryQuery(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode, org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req, AuditRequestInfo info, boolean success)
static void	logRepositoryImport(String submissionSetUID, String patID, AuditRequestInfo info, boolean success) Send a ITI-41 Import Audit message.
static void	logRepositoryPnRExport(String submissionSetUID, String patID, AuditRequestInfo info, URL registryURL, boolean success) Send a ITI-42 Export Audit message.
static void	logRepositoryRetrieveExport(AuditRequestInfo info, org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq, List<String> docUIDs, boolean success) Send a ITI-43 Export Audit message.
static void	logRepositoryRetrieveExport(org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType req, org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetResponseType rsp, AuditRequestInfo info)
static void	logSourceExport(String submissionSetUID, String patID, String srcUserID, String altSrcUserID, String srcHostName, String destUserID, String destHostName, boolean success) Send a ITI-41 Export Audit message.
static void	logStudyUsed(org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetResponseType rsp, AuditRequestInfo info)
static void	logXCAQuery(org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req, AuditRequestInfo info, boolean success)
static void	logXCARetrieveExport(org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType req, org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetResponseType rsp, AuditRequestInfo info)
static void	sendAuditMessage(Calendar timeStamp, org.dcm4che3.audit.AuditMessage msg)
static void	setAuditLogger(org.dcm4che3.net.audit.AuditLogger logger)

Methods inherited from class java.lang.Object

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

Constructor Detail

XDSAudit

public XDSAudit()

Method Detail

getAuditLogger

public static org.dcm4che3.net.audit.AuditLogger getAuditLogger()

setAuditLogger

public static void setAuditLogger(org.dcm4che3.net.audit.AuditLogger logger)

logApplicationActivity

public static void logApplicationActivity(String appName,
                          org.dcm4che3.audit.AuditMessages.EventTypeCode eventType,
                          boolean success)

logRepositoryImport

public static void logRepositoryImport(String submissionSetUID,
                       String patID,
                       AuditRequestInfo info,
                       boolean success)

Send a ITI-41 Import Audit message. (Document Repository: PnR) patID(1) srcUserID content of wsa:ReplyTo. ('http://www.w3.org/2005/08/addressing/anonymous' if null). altSrcUserID not specialized destUserID SOAP endpoint URI. altDestUserID Process ID (consumer) SubmissionSet(1) Document(0)

Parameters:

submissionSetUID -

patID -

info -

success -

logRegistryImport

public static void logRegistryImport(String submissionSetUID,
                     String patID,
                     AuditRequestInfo info,
                     boolean success)

Send a ITI-42 Import Audit message. (Document Registry: register document set) patID(1) srcUserID content of wsa:ReplyTo. ('http://www.w3.org/2005/08/addressing/anonymous' if null). altSrcUserID not specialized destUserID SOAP endpoint URI. altDestUserID Process ID (consumer) SubmissionSet(1) Document(0)

Parameters:

submissionSetUID -

patID -

info -

success -

logConsumerImport

public static void logConsumerImport(String patID,
                     URL repositoryURL,
                     org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq,
                     boolean success)

Send a ITI-43 Import Audit message. (document consumer: Retrieve document set) patID(0..1) srcUserID SOAP Endpoint URI of repository altSrcUserID not specialized destUserID content of wsa:ReplyTo. ('http://www.w3.org/2005/08/addressing/anonymous' if null). altDestUserID Process ID (consumer) SubmissionSet(0) Document(1..n)

Parameters:

patID -

repositoryURL -

docReq -

success -

logConsumerXCAImport

public static void logConsumerXCAImport(String patID,
                        URL repositoryURL,
                        org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq,
                        boolean success)

logImport

public static void logImport(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode,
             String patID,
             URL repositoryURL,
             org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq,
             boolean success)

logImport

public static void logImport(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode,
             String submissionSetUID,
             String patID,
             String srcUserID,
             String altSrcUserID,
             String srcHostName,
             String destUserID,
             String altDestUserID,
             String destHostName,
             org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq,
             boolean success)

logSourceExport

public static void logSourceExport(String submissionSetUID,
                   String patID,
                   String srcUserID,
                   String altSrcUserID,
                   String srcHostName,
                   String destUserID,
                   String destHostName,
                   boolean success)

Send a ITI-41 Export Audit message. (document source) patID(1) srcUserID wsa:ReplyTo. ('http://www.w3.org/2005/08/addressing/anonymous' if null altSrcUserID Process ID (consumer) destUserID SOAP endpoint URI altDestUserID not spezialized SubmissionSet(1) Document(0)

Parameters:

submissionSetUID -

patID -

srcUserID -

altSrcUserID -

srcHostName -

destUserID -

destHostName -

success -

logRepositoryPnRExport

public static void logRepositoryPnRExport(String submissionSetUID,
                          String patID,
                          AuditRequestInfo info,
                          URL registryURL,
                          boolean success)

Send a ITI-42 Export Audit message. (document repository: register document set) patID(1) srcUserID wsa:ReplyTo. ('http://www.w3.org/2005/08/addressing/anonymous' if null). altSrcUserID Process ID destUserID SOAP endpoint URI. altDestUserID not spezialized SubmissionSet(1) Document(0)

Parameters:

submissionSetUID -

patID -

info -

registryURL -

success -

logRepositoryRetrieveExport

public static void logRepositoryRetrieveExport(AuditRequestInfo info,
                               org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq,
                               List<String> docUIDs,
                               boolean success)

Send a ITI-43 Export Audit message. (document repository: Retrieve document set) patID(0) srcUserID SOAP Endpoint URI of repository altSrcUserID Process ID destUserID content of wsa:ReplyTo. ('http://www.w3.org/2005/08/addressing/anonymous' if null). altDestUserID not spezialized SubmissionSet(0) Document(1..n)

Parameters:

info -

docReq -

docUIDs -

success -

logRepositoryRetrieveExport

public static void logRepositoryRetrieveExport(org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType req,
                               org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetResponseType rsp,
                               AuditRequestInfo info)

logXCARetrieveExport

public static void logXCARetrieveExport(org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType req,
                        org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetResponseType rsp,
                        AuditRequestInfo info)

logExport

public static void logExport(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode,
             org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType req,
             org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetResponseType rsp,
             AuditRequestInfo info)

logExport

public static void logExport(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode,
             String submissionSetUID,
             String patID,
             String srcUserID,
             String altSrcUserID,
             String srcHostName,
             String destUserID,
             String altDestUserID,
             String destHostName,
             org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq,
             List<String> docUIDs,
             boolean success)

logClientQuery

public static void logClientQuery(org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req,
                  String srcUserID,
                  String srcHostName,
                  URL registryURL,
                  boolean success)

Send a ITI-18 Stored Query Audit message. (Document Source/Consumer) srcUserID wsa:ReplyTo altSrcUserID process ID destUserID SOAP Endpoint URI (registry) altDestUserID not specialized Patient (0..1) Query Parameters(1)

Parameters:

queryUID -

patID -

homeCommunityID -

adhocQuery -

srcUserID -

srcHostName -

registryURL -

success -

logClientXCAQuery

public static void logClientXCAQuery(org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req,
                     String srcUserID,
                     String srcHostName,
                     URL registryURL,
                     boolean success)

logRegistryQuery

public static void logRegistryQuery(org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req,
                    AuditRequestInfo info,
                    boolean success)

Send a ITI-18 Stored Query Audit message. (Document Registry) srcUserID wsa:ReplyTo altSrcUserID not spezialized destUserID SOAP Endpoint URI (registry) altDestUserID process ID Patient (0..1) Query Parameters(1)

Parameters:

queryUID -

patID -

homeCommunityID -

adhocQuery -

info -

success -

logXCAQuery

public static void logXCAQuery(org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req,
               AuditRequestInfo info,
               boolean success)

logRegistryQuery

public static void logRegistryQuery(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode,
                    org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req,
                    AuditRequestInfo info,
                    boolean success)

logQuery

public static void logQuery(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode,
            org.dcm4chee.xds2.infoset.rim.AdhocQueryRequest req,
            String srcUserID,
            String altSrcUserID,
            String srcHostName,
            String destUserID,
            String altDestUserID,
            String destHostName,
            boolean success)

logPatientFeed

public static void logPatientFeed(String patID,
                  String eventActionCode,
                  byte[] msh10,
                  String srcUserID,
                  String remoteHost,
                  String destUserID,
                  boolean success)

logPixQuery

public static void logPixQuery(String patID,
               String sendingApp,
               String sendingFacility,
               String receivingApp,
               String receivingFacility,
               String remoteHost,
               byte[] query,
               byte[] msh10,
               boolean success)

logImgRetrieve

public static void logImgRetrieve(org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetResponseType rsp,
                  AuditRequestInfo info)

logStudyUsed

public static void logStudyUsed(org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetResponseType rsp,
                AuditRequestInfo info)

createRetrieveImgLogMessage

public static org.dcm4che3.audit.AuditMessage createRetrieveImgLogMessage(org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetResponseType rsp,
                                                          String remoteHost,
                                                          String user,
                                                          Calendar timeStamp)

createStudyUsedLogMessage

public static org.dcm4che3.audit.AuditMessage createStudyUsedLogMessage(org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetResponseType rsp,
                                                        String remoteHost,
                                                        String user,
                                                        Calendar timeStamp)

createImport

public static org.dcm4che3.audit.AuditMessage createImport(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode,
                                           String submissionSetUID,
                                           String patID,
                                           String srcUserID,
                                           String altSrcUserID,
                                           String srcHostName,
                                           String destUserID,
                                           String altDestUserID,
                                           String destHostName,
                                           org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq,
                                           Calendar timeStamp,
                                           String outcomeIndicator)

createExport

public static org.dcm4che3.audit.AuditMessage createExport(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode,
                                           String submissionSetUID,
                                           String patID,
                                           String srcUserID,
                                           String altSrcUserID,
                                           String srcHostName,
                                           String destUserID,
                                           String altDestUserID,
                                           String destHostName,
                                           org.dcm4chee.xds2.infoset.ihe.RetrieveDocumentSetRequestType docReq,
                                           List<String> docUIDs,
                                           Calendar timeStamp,
                                           String outcomeIndicator)

Parameters:

eventTypeCode -

submissionSetUID -

patID -

srcUserID -

srcHostName -

destUserID -

altDestUserID -

docReq - The RetrieveDocumentRequest with list of requested documents (null if no documents are involved)

docUIDs - List of retrieved Document UIDs. Used to filter docUIDs for ParticipantObjectIdentification 'Document' according outcomeIndicator. null means no filtering.

timeStamp -

outcomeIndicator -

Returns:

createQuery

public static org.dcm4che3.audit.AuditMessage createQuery(org.dcm4che3.audit.AuditMessages.EventTypeCode eventTypeCode,
                                          String queryUID,
                                          String patID,
                                          String homeCommunityID,
                                          byte[] adhocQuery,
                                          String srcUserID,
                                          String altSrcUserID,
                                          String srcHostName,
                                          String destUserID,
                                          String altDestUserID,
                                          String destHostName,
                                          Calendar timeStamp,
                                          String outcomeIndicator)

createPatientFeed

public static org.dcm4che3.audit.AuditMessage createPatientFeed(String patID,
                                                String eventActionCode,
                                                byte[] msh10,
                                                String srcUserID,
                                                String altSrcUserID,
                                                String srcHostName,
                                                String destUserID,
                                                Calendar timeStamp,
                                                String outcomeIndicator)

sendAuditMessage

public static void sendAuditMessage(Calendar timeStamp,
                    org.dcm4che3.audit.AuditMessage msg)
                             throws org.dcm4che3.net.IncompatibleConnectionException,
                                    GeneralSecurityException,
                                    IOException

Throws:

org.dcm4che3.net.IncompatibleConnectionException

GeneralSecurityException

IOException

createPatient

public static org.dcm4che3.audit.ParticipantObjectIdentification createPatient(String patID)

createSubmissionSet

public static org.dcm4che3.audit.ParticipantObjectIdentification createSubmissionSet(String submissionSetUID)

createQueryParticipantObjectIdentification

public static org.dcm4che3.audit.ParticipantObjectIdentification createQueryParticipantObjectIdentification(String queryUID,
                                                                                            String homeCommunityID,
                                                                                            byte[] adhocQuery)

info

public static String info()