org.dcm4che2.audit.message
Class SecurityAlertMessage

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

public class SecurityAlertMessage
extends AuditMessage

This message describes any event for which a node needs to report a security alert, e.g., a node authentication failure when establishing a secure communications channel.

Note: The Node Authentication event can be used to report both successes and failures. If reporting of success is done, this could generate a very large number of audit messages, since every authenticated DICOM association, HL7 transaction, and HTML connection should result in a successful node authentication. It is expected that in most situations only the node authentication failures will be reported.

Since:

Nov 23, 2006

Version:

$Revision: 14557 $ $Date: 2010-12-16 13:10:55 +0100 (Thu, 16 Dec 2010) $

Author:

Gunter Zeilinger

See Also:

DICOM Supp 95: Audit Trail Messages, A.1.3.14 Security Alert

Field Summary

static AuditEvent.TypeCode	AUDIT_RECORDING_STARTED Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	AUDIT_RECORDING_STOPPED Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	EMERGENCY_OVERRIDE_STARTED Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	EMERGENCY_OVERRIDE_STOPPED Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	HARDWARE_CONFIGURATION Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	LOCAL_SERVICE_OPERATION_STARTED Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	LOCAL_SERVICE_OPERATION_STOPPED Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
protected java.lang.String	name
static AuditEvent.TypeCode	NETWORK_CONFIGURATION Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	NODE_AUTHENTICATION Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	OBJECT_SECURITY_ATTRIBUTES_CHANGED Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	REMOTE_SERVICE_OPERATION_STARTED Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	REMOTE_SERVICE_OPERATION_STOPPED Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	SECURITY_CONFIGURATION Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	SECURITY_ROLES_CHANGED Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	SOFTWARE_CONFIGURATION Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	USE_OF_RESTRICTED_FUNCTION Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	USER_SECURITY_ATTRIBUTES_CHANGED Action Type code for SecurityAlertMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).

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

activeParticipants, auditSources, event, participantObjects

Constructor Summary

SecurityAlertMessage(AuditEvent.TypeCode type)
Constructs an Security Alert message.

Method Summary

ParticipantObject	addAlertSubjectWithNodeID(java.lang.String nodeID, java.lang.String desc)
ParticipantObject	addAlertSubjectWithURI(java.lang.String uri, java.lang.String desc)
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)
ActiveParticipant	addPerformingNode(java.lang.String hostname)
ActiveParticipant	addPerformingPerson(java.lang.String userID, java.lang.String altUserID, java.lang.String userName, java.lang.String hostname)
ActiveParticipant	addPerformingProcess(java.lang.String processID, java.lang.String[] aets, java.lang.String processName, java.lang.String hostname)
ActiveParticipant	addReportingPerson(java.lang.String userID, java.lang.String altUserID, java.lang.String userName, java.lang.String hostname)
ActiveParticipant	addReportingProcess(java.lang.String processID, java.lang.String[] aets, java.lang.String processName, java.lang.String hostname)
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

NODE_AUTHENTICATION

public static final AuditEvent.TypeCode NODE_AUTHENTICATION

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

EMERGENCY_OVERRIDE_STARTED

public static final AuditEvent.TypeCode EMERGENCY_OVERRIDE_STARTED

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

NETWORK_CONFIGURATION

public static final AuditEvent.TypeCode NETWORK_CONFIGURATION

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

SECURITY_CONFIGURATION

public static final AuditEvent.TypeCode SECURITY_CONFIGURATION

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

HARDWARE_CONFIGURATION

public static final AuditEvent.TypeCode HARDWARE_CONFIGURATION

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

SOFTWARE_CONFIGURATION

public static final AuditEvent.TypeCode SOFTWARE_CONFIGURATION

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

USE_OF_RESTRICTED_FUNCTION

public static final AuditEvent.TypeCode USE_OF_RESTRICTED_FUNCTION

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

AUDIT_RECORDING_STOPPED

public static final AuditEvent.TypeCode AUDIT_RECORDING_STOPPED

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

AUDIT_RECORDING_STARTED

public static final AuditEvent.TypeCode AUDIT_RECORDING_STARTED

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

OBJECT_SECURITY_ATTRIBUTES_CHANGED

public static final AuditEvent.TypeCode OBJECT_SECURITY_ATTRIBUTES_CHANGED

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

SECURITY_ROLES_CHANGED

public static final AuditEvent.TypeCode SECURITY_ROLES_CHANGED

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

USER_SECURITY_ATTRIBUTES_CHANGED

public static final AuditEvent.TypeCode USER_SECURITY_ATTRIBUTES_CHANGED

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

EMERGENCY_OVERRIDE_STOPPED

public static final AuditEvent.TypeCode EMERGENCY_OVERRIDE_STOPPED

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

REMOTE_SERVICE_OPERATION_STARTED

public static final AuditEvent.TypeCode REMOTE_SERVICE_OPERATION_STARTED

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

REMOTE_SERVICE_OPERATION_STOPPED

public static final AuditEvent.TypeCode REMOTE_SERVICE_OPERATION_STOPPED

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

LOCAL_SERVICE_OPERATION_STARTED

public static final AuditEvent.TypeCode LOCAL_SERVICE_OPERATION_STARTED

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

LOCAL_SERVICE_OPERATION_STOPPED

public static final AuditEvent.TypeCode LOCAL_SERVICE_OPERATION_STOPPED

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

name

protected final java.lang.String name

Constructor Detail

SecurityAlertMessage

public SecurityAlertMessage(AuditEvent.TypeCode type)

Constructs an Security Alert message. Use AuditMessage.setOutcomeIndicator(org.dcm4che2.audit.message.AuditEvent.OutcomeIndicator) to modify default success indicator to describe failures.

Parameters:

typeCode - indicator for type of security alert

Throws:

java.lang.NullPointerException - If typeCode=null

Method Detail

addReportingPerson

public ActiveParticipant addReportingPerson(java.lang.String userID,
                                            java.lang.String altUserID,
                                            java.lang.String userName,
                                            java.lang.String hostname)

addReportingProcess

public ActiveParticipant addReportingProcess(java.lang.String processID,
                                             java.lang.String[] aets,
                                             java.lang.String processName,
                                             java.lang.String hostname)

addPerformingPerson

public ActiveParticipant addPerformingPerson(java.lang.String userID,
                                             java.lang.String altUserID,
                                             java.lang.String userName,
                                             java.lang.String hostname)

addPerformingProcess

public ActiveParticipant addPerformingProcess(java.lang.String processID,
                                              java.lang.String[] aets,
                                              java.lang.String processName,
                                              java.lang.String hostname)

addPerformingNode

public ActiveParticipant addPerformingNode(java.lang.String hostname)

addAlertSubjectWithURI

public ParticipantObject addAlertSubjectWithURI(java.lang.String uri,
                                                java.lang.String desc)

addAlertSubjectWithNodeID

public ParticipantObject addAlertSubjectWithNodeID(java.lang.String nodeID,
                                                   java.lang.String desc)

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