org.dcm4che2.audit.message
Class UserAuthenticationMessage

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

public class UserAuthenticationMessage
extends AuditMessage

This message describes the event of a user has attempting to log on or log off, whether successful or not. No Participant Objects are needed for this message.

Since:

Nov 23, 2006

Version:

$Revision: 5516 $ $Date: 2007-11-23 12:42:30 +0100 (Fri, 23 Nov 2007) $

Author:

Gunter Zeilinger

See Also:

DICOM Supp 95: Audit Trail Messages, A.1.3.15 User Authentication

Field Summary

static AuditEvent.TypeCode	LOGIN Action Type code for UserAuthenticationMessage(org.dcm4che2.audit.message.AuditEvent.TypeCode).
static AuditEvent.TypeCode	LOGOUT Action Type code for UserAuthenticationMessage(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

UserAuthenticationMessage(AuditEvent.TypeCode typeCode)
Constructs an User Authentication message.

Method Summary

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	addNode(java.lang.String hostname)
ActiveParticipant	addUserPerson(java.lang.String userID, java.lang.String altUserID, java.lang.String userName, 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

LOGIN

public static final AuditEvent.TypeCode LOGIN

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

LOGOUT

public static final AuditEvent.TypeCode LOGOUT

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

name

protected final java.lang.String name

Constructor Detail

UserAuthenticationMessage

public UserAuthenticationMessage(AuditEvent.TypeCode typeCode)

Constructs an User Authentication message. Use AuditMessage.setOutcomeIndicator(org.dcm4che2.audit.message.AuditEvent.OutcomeIndicator) to modify default success indicator to describe a failed user login.

Parameters:

typeCode - indicator for type of action, LOGIN or LOGOUT

Throws:

java.lang.NullPointerException - If typeCode=null

java.lang.IllegalArgumentException - If typeCode is neither LOGIN nor LOGOUT

Method Detail

addUserPerson

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

addNode

public ActiveParticipant addNode(java.lang.String hostname)

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