org.dcm4che2.audit.message
Class ApplicationActivityMessage

java.lang.Object
  org.dcm4che2.audit.message.AuditMessage
      org.dcm4che2.audit.message.ApplicationActivityMessage

public class ApplicationActivityMessage
extends AuditMessage

This audit message describes the event of an Application Entity starting or stopping.

Message Structure

• Event
• ID of the Application started/stopped (1)
• ID of person or process that started/stopped the Application (0..1)

Since:

Nov 21, 2006

Version:

$Revision: 5685 $ $Date: 2008-01-15 21:05:18 +0100 (Tue, 15 Jan 2008) $

Author:

Gunter Zeilinger

See Also:

DICOM Supp 95: Audit Trail Messages, A.1.3.1 Application Activity

Field Summary

static AuditEvent.TypeCode	APPLICATION_START Action Type code for ApplicationActivityMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	APPLICATION_STOP Action Type code for ApplicationActivityMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
protected java.lang.String	name

Fields inherited from class org.dcm4che2.audit.message.AuditMessage

activeParticipants, auditSources, event, participantObjects

Constructor Summary

ApplicationActivityMessage(AuditEvent.TypeCode typeCode)
Constructs an Application Entity message.

Method Summary

ActiveParticipant	addApplication(java.lang.String processID, java.lang.String[] aets, java.lang.String processName, java.lang.String nodeID) Adds ActiveParticipant identifying the Application.
ActiveParticipant	addApplicationLauncher(java.lang.String userID, java.lang.String altUserID, java.lang.String userName, java.lang.String napID) Adds ActiveParticipant identifying the person or process that started/stopped the Application.
protected void	addAttribute(java.lang.String name, byte[] val, boolean optional)
protected void	addAttribute(java.lang.String name, java.util.Date val, boolean optional)
protected void	addAttribute(java.lang.String name, java.lang.Object val, boolean optional)
protected java.lang.Object	getAttribute(java.lang.String name)
protected void	outputChilds(java.io.Writer out, java.util.List<? extends org.dcm4che2.audit.message.BaseElement> childs)
java.lang.String	toString(int initialSize)
void	validate()

Methods inherited from class org.dcm4che2.audit.message.AuditMessage

addActiveParticipant, addAuditSource, addParticipantObject, aetsToAltUserID, aetToAltUserID, altUserIDToAETs, getActiveParticipants, getAuditEvent, getAuditSources, getLocalAETitles, getLocalHost, getLocalHostName, getLocalNodeID, getParticipantObjects, getProcessID, getProcessName, getRequestingActiveParticipants, hostNameOf, isAllowMultipleRequestors, isEmpty, isEnableDNSLookups, isIncludeXMLDeclaration, isQualifyHostname, isTimezonedDateTime, isUtcDateTime, nodeIDOf, output, outputContent, setAllowMultipleRequestors, setEnableDNSLookups, setEventDateTime, setIncludeXMLDeclaration, setLocalAETitles, setOutcomeIndicator, setProcessName, setQualifyHostname, setTimezonedDateTime, setUtcDateTime, toDateTimeStr, toString

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATION_START

public static final AuditEvent.TypeCode APPLICATION_START

Action Type code for ApplicationActivityMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).

APPLICATION_STOP

public static final AuditEvent.TypeCode APPLICATION_STOP

Action Type code for ApplicationActivityMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).

name

protected final java.lang.String name

Constructor Detail

ApplicationActivityMessage

public ApplicationActivityMessage(AuditEvent.TypeCode typeCode)

Constructs an Application Entity message.

Parameters:

typeCode - indicator for type of action, typically APPLICATION_START or APPLICATION_STOP

Throws:

java.lang.NullPointerException - If typeCode=null

Method Detail

addApplication

public ActiveParticipant addApplication(java.lang.String processID,
                                        java.lang.String[] aets,
                                        java.lang.String processName,
                                        java.lang.String nodeID)

Adds ActiveParticipant identifying the Application.

Parameters:

processID - the identity of the process started or stopped. Use AuditMessageUtils#getProcessID() for this Java VM.

aets - if the process supports DICOM, then the AE Titles supported, otherwise null

processName - process name

nodeID - DNS name or IP address of the node. Use AuditMessageUtils#getLocalHostName() for this node.

Returns:

added ActiveParticipant identifying the Application.

addApplicationLauncher

public ActiveParticipant addApplicationLauncher(java.lang.String userID,
                                                java.lang.String altUserID,
                                                java.lang.String userName,
                                                java.lang.String napID)

Adds ActiveParticipant identifying the person or process that started/stopped the Application.

Parameters:

userID - unique identifier for the person used by the application

altUserID - Alternative User ID, used for authentication (e.g. SSO), - if available, otherwise null.

userName - person's name - if available, otherwise null

napID - identifier for the user's network access point (Machine Name, DNS name, IP Address or Telephone Number) - if available, otherwise null.

Returns:

ActiveParticipant identifying the person or process.

validate

public void validate()

Overrides:

validate in class AuditMessage

addAttribute

protected void addAttribute(java.lang.String name,
                            java.lang.Object val,
                            boolean optional)

addAttribute

protected void addAttribute(java.lang.String name,
                            java.util.Date val,
                            boolean optional)

addAttribute

protected void addAttribute(java.lang.String name,
                            byte[] val,
                            boolean optional)

getAttribute

protected java.lang.Object getAttribute(java.lang.String name)

toString

public java.lang.String toString(int initialSize)

outputChilds

protected void outputChilds(java.io.Writer out,
                            java.util.List<? extends org.dcm4che2.audit.message.BaseElement> childs)
                     throws java.io.IOException

Throws:

java.io.IOException