org.dcm4che3.net.audit

Class AuditLogger

java.lang.Object

org.dcm4che3.net.DeviceExtension

org.dcm4che3.net.audit.AuditLogger

All Implemented Interfaces:

Serializable

public class AuditLogger
extends DeviceExtension

Author:

Gunter Zeilinger , Michael Backhaus

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuditLogger.Facility
static class	AuditLogger.SendStatus
static class	AuditLogger.Severity

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_ID

Fields inherited from class org.dcm4che3.net.DeviceExtension

device

Constructor Summary

Constructors

Constructor and Description
AuditLogger()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAuditSuppressCriteria(AuditSuppressCriteria criteria)
void	addConnection(Connection conn)
void	clearAllAuditSuppressCriteria()
void	closeActiveConnection()
ActiveParticipant	createActiveParticipant(boolean requestor, AuditMessages.RoleIDCode... roleIDs)
ActiveParticipant	createActiveParticipant(boolean requestor, String userID, String alternativeUserID, String userName, String hostName, AuditMessages.RoleIDCode... roleIDs)
AuditSourceIdentification	createAuditSourceIdentification()
AuditSuppressCriteria	findAuditSuppressCriteriaByCommonName(String cn)
String	getApplicationName()
String	getAuditEnterpriseSiteID()
Device	getAuditRecordRepositoryDevice()
String	getAuditRecordRepositoryDeviceName()
String	getAuditSourceID()
String[]	getAuditSourceTypeCodes()
List<AuditSuppressCriteria>	getAuditSuppressCriteriaList()
List<Connection>	getConnections()
static AuditLogger	getDefaultLogger()
String	getEncoding()
AuditLogger.Facility	getFacility()
Boolean	getInstalled()
Exception	getLastException()
long	getLastSentTimeInMillis()
AuditLogger.Severity	getMajorFailureSeverity()
String	getMessageID()
AuditLogger.Severity	getMinorFailureSeverity()
int	getNumberOfQueuedMessages()
File[]	getQueuedMessages()
int	getRetryInterval() Get interval in seconds to retry to sent messages which could not be sent to the record repository or 0 if messages failed to sent are not spooled for later re-send.
String	getSchemaURI()
AuditLogger.Severity	getSeriousFailureSeverity()
File	getSpoolDirectory() Get spool directory into which messages failed to sent to the record repository are stored for later re-send.
String	getSpoolDirectoryURI()
String	getSpoolFileNameSuffix()
String	getSpoolNameFilePrefix()
AuditLogger.Severity	getSuccessSeverity()
boolean	isAuditMessageSuppressed(AuditMessage msg) Test if the Event Identification and the Active ActiveParticipant of an Audit Message matches one of the AuditSuppressCriteria
boolean	isFormatXML()
boolean	isIncludeBOM()
Boolean	isIncludeInstanceUID()
boolean	isInstalled()
boolean	isTimestampInUTC()
static InetAddress	localHost()
static String	processID()
void	reconfigure(DeviceExtension from)
boolean	removeConnection(Connection conn)
void	sendQueuedMessages()
void	setApplicationName(String applicationName)
void	setAuditEnterpriseSiteID(String auditEnterpriseSiteID)
void	setAuditRecordRepositoryDevice(Device arrDevice)
void	setAuditSourceID(String auditSourceID)
void	setAuditSourceTypeCodes(String... auditSourceTypeCode)
void	setAuditSuppressCriteriaList(List<AuditSuppressCriteria> filters)
static void	setDefaultLogger(AuditLogger defaultLogger)
void	setEncoding(String encoding)
void	setFacility(AuditLogger.Facility facility)
void	setFormatXML(boolean formatXML)
void	setIncludeBOM(boolean includeBOM)
void	setIncludeInstanceUID(Boolean includeInstanceUID)
void	setInstalled(Boolean installed)
void	setMajorFailureSeverity(AuditLogger.Severity severity)
void	setMessageID(String messageID)
void	setMinorFailureSeverity(AuditLogger.Severity severity)
void	setRetryInterval(int interval) Set interval in seconds to retry to sent messages which could not be sent to the record repository or 0 if messages failed to sent are not spooled for later re-send.
void	setSchemaURI(String schemaURI)
void	setSeriousFailureSeverity(AuditLogger.Severity severity)
void	setSpoolDirectory(File directory) Set spool directory into which messages failed sent to the record repository are stored for later re-send.
void	setSpoolDirectoryURI(String uri)
void	setSpoolFileNamePrefix(String prefix)
void	setSpoolFileNameSuffix(String suffix)
void	setSuccessSeverity(AuditLogger.Severity severity)
void	setTimestampInUTC(boolean timestampInUTC)
Calendar	timeStamp()
void	verifyNotUsed(Connection conn)
void	waitForNoQueuedMessages(long timeout)
AuditLogger.SendStatus	write(Calendar timeStamp, AuditLogger.Severity severity, byte[] data, int off, int len)
AuditLogger.SendStatus	write(Calendar timeStamp, AuditMessage msg) Send Audit Message by Syslog Protocol to Audit Record Repository, if the message does not match any configured AuditSuppressCriteria.

Methods inherited from class org.dcm4che3.net.DeviceExtension

getDevice

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_ID

public static final String MESSAGE_ID

See Also:

Constant Field Values

Constructor Detail

AuditLogger

public AuditLogger()

Method Detail

getAuditRecordRepositoryDevice

public final Device getAuditRecordRepositoryDevice()

getAuditRecordRepositoryDeviceName

public String getAuditRecordRepositoryDeviceName()

setAuditRecordRepositoryDevice

public void setAuditRecordRepositoryDevice(Device arrDevice)

getFacility

public final AuditLogger.Facility getFacility()

setFacility

public final void setFacility(AuditLogger.Facility facility)

getSuccessSeverity

public final AuditLogger.Severity getSuccessSeverity()

setSuccessSeverity

public final void setSuccessSeverity(AuditLogger.Severity severity)

getMinorFailureSeverity

public final AuditLogger.Severity getMinorFailureSeverity()

setMinorFailureSeverity

public final void setMinorFailureSeverity(AuditLogger.Severity severity)

getSeriousFailureSeverity

public final AuditLogger.Severity getSeriousFailureSeverity()

setSeriousFailureSeverity

public final void setSeriousFailureSeverity(AuditLogger.Severity severity)

getMajorFailureSeverity

public final AuditLogger.Severity getMajorFailureSeverity()

setMajorFailureSeverity

public final void setMajorFailureSeverity(AuditLogger.Severity severity)

getApplicationName

public final String getApplicationName()

setApplicationName

public final void setApplicationName(String applicationName)

getAuditSourceID

public final String getAuditSourceID()

setAuditSourceID

public final void setAuditSourceID(String auditSourceID)

getAuditEnterpriseSiteID

public final String getAuditEnterpriseSiteID()

setAuditEnterpriseSiteID

public final void setAuditEnterpriseSiteID(String auditEnterpriseSiteID)

getAuditSourceTypeCodes

public String[] getAuditSourceTypeCodes()

setAuditSourceTypeCodes

public void setAuditSourceTypeCodes(String... auditSourceTypeCode)

createActiveParticipant

public ActiveParticipant createActiveParticipant(boolean requestor,
                                        AuditMessages.RoleIDCode... roleIDs)

createActiveParticipant

public ActiveParticipant createActiveParticipant(boolean requestor,
                                        String userID,
                                        String alternativeUserID,
                                        String userName,
                                        String hostName,
                                        AuditMessages.RoleIDCode... roleIDs)

createAuditSourceIdentification

public AuditSourceIdentification createAuditSourceIdentification()

getMessageID

public final String getMessageID()

setMessageID

public final void setMessageID(String messageID)

getEncoding

public final String getEncoding()

setEncoding

public final void setEncoding(String encoding)

getSchemaURI

public final String getSchemaURI()

setSchemaURI

public final void setSchemaURI(String schemaURI)

isTimestampInUTC

public final boolean isTimestampInUTC()

setTimestampInUTC

public final void setTimestampInUTC(boolean timestampInUTC)

isIncludeBOM

public final boolean isIncludeBOM()

setIncludeBOM

public final void setIncludeBOM(boolean includeBOM)

isFormatXML

public final boolean isFormatXML()

setFormatXML

public final void setFormatXML(boolean formatXML)

isInstalled

public boolean isInstalled()

getInstalled

public final Boolean getInstalled()

setInstalled

public void setInstalled(Boolean installed)

isIncludeInstanceUID

public Boolean isIncludeInstanceUID()

setIncludeInstanceUID

public void setIncludeInstanceUID(Boolean includeInstanceUID)

getSpoolDirectory

public File getSpoolDirectory()

Get spool directory into which messages failed to sent to the record repository are stored for later re-send.

Returns:

The directory in which the messages failed to sent are stored, or null if the default temporary-file directory is to be used

setSpoolDirectory

public void setSpoolDirectory(File directory)

Set spool directory into which messages failed sent to the record repository are stored for later re-send.

Parameters:

directory - The directory in which the messages failed to sent are stored, or null if the default temporary-file directory is to be used

getSpoolDirectoryURI

public String getSpoolDirectoryURI()

setSpoolDirectoryURI

public void setSpoolDirectoryURI(String uri)

getSpoolNameFilePrefix

public String getSpoolNameFilePrefix()

setSpoolFileNamePrefix

public void setSpoolFileNamePrefix(String prefix)

getSpoolFileNameSuffix

public String getSpoolFileNameSuffix()

setSpoolFileNameSuffix

public void setSpoolFileNameSuffix(String suffix)

getRetryInterval

public int getRetryInterval()

Get interval in seconds to retry to sent messages which could not be sent to the record repository or 0 if messages failed to sent are not spooled for later re-send.

Returns:

interval retry interval in seconds or 0

See Also:

write(Calendar, AuditMessage)

setRetryInterval

public void setRetryInterval(int interval)

Set interval in seconds to retry to sent messages which could not be sent to the record repository or 0 if messages failed to sent are not spooled for later re-send.

Parameters:

interval - retry interval in seconds or 0

See Also:

write(Calendar, AuditMessage)

addConnection

public void addConnection(Connection conn)

verifyNotUsed

public void verifyNotUsed(Connection conn)

Overrides:

verifyNotUsed in class DeviceExtension

removeConnection

public boolean removeConnection(Connection conn)

getConnections

public List<Connection> getConnections()

getAuditSuppressCriteriaList

public List<AuditSuppressCriteria> getAuditSuppressCriteriaList()

findAuditSuppressCriteriaByCommonName

public AuditSuppressCriteria findAuditSuppressCriteriaByCommonName(String cn)

setAuditSuppressCriteriaList

public void setAuditSuppressCriteriaList(List<AuditSuppressCriteria> filters)

addAuditSuppressCriteria

public void addAuditSuppressCriteria(AuditSuppressCriteria criteria)

clearAllAuditSuppressCriteria

public void clearAllAuditSuppressCriteria()

isAuditMessageSuppressed

public boolean isAuditMessageSuppressed(AuditMessage msg)

Test if the Event Identification and the Active ActiveParticipant of an Audit Message matches one of the AuditSuppressCriteria

Parameters:

msg - Audit Message to test

Returns:

true the specified audit message will be suppressed; otherwise false

reconfigure

public void reconfigure(DeviceExtension from)

Overrides:

reconfigure in class DeviceExtension

timeStamp

public Calendar timeStamp()

write

public AuditLogger.SendStatus write(Calendar timeStamp,
                           AuditMessage msg)
                             throws IncompatibleConnectionException,
                                    GeneralSecurityException,
                                    IOException

Send Audit Message by Syslog Protocol to Audit Record Repository, if the message does not match any configured AuditSuppressCriteria. If an I/O error occurs sending the message to the AuditRecordRepository and if a RetryInterval) is configured, the message will be spooled into the configured {@code SpoolDirectory} for later re-send and the method returns {@code false}. If no {@code RetryInterval} is configured, the method throws an {@code IOException) if an I/O error occurs sending the message. Attention: sending via UDP without getting an I/O error does not ensure that the Audit Record Repository actually received the message!

Parameters:

timeStamp - included in Syslog Header

msg - Audit Message

Returns:

SendStatus.SUPPRESSED if the message was suppressed; SendStatus.SENT if the message was successfully emitted; SendStatus.QUEUED if the message was spooled for later re-send

Throws:

IllegalStateException - if there is no AuditRecordRepository associated with this AuditLogger

IncompatibleConnectionException - if no Connection) of this {@code AuditLogger} is compatible with any {@code Connection) of the associated {@code AuditRecordRepository}

GeneralSecurityException - if the SSLContext could not get intialized from configured private key and public certificates

IOException - if an I/O error occurs sending the message to the AuditRecordRepository or on spooling the message to the file system

write

public AuditLogger.SendStatus write(Calendar timeStamp,
                           AuditLogger.Severity severity,
                           byte[] data,
                           int off,
                           int len)
                             throws IncompatibleConnectionException,
                                    GeneralSecurityException,
                                    IOException

Throws:

IncompatibleConnectionException

GeneralSecurityException

IOException

sendQueuedMessages

public void sendQueuedMessages()

getLastException

public Exception getLastException()

getLastSentTimeInMillis

public long getLastSentTimeInMillis()

getNumberOfQueuedMessages

public int getNumberOfQueuedMessages()

getQueuedMessages

public File[] getQueuedMessages()

waitForNoQueuedMessages

public void waitForNoQueuedMessages(long timeout)
                             throws InterruptedException

Throws:

InterruptedException

closeActiveConnection

public void closeActiveConnection()

processID

public static String processID()

localHost

public static InetAddress localHost()

getDefaultLogger

public static AuditLogger getDefaultLogger()

setDefaultLogger

public static void setDefaultLogger(AuditLogger defaultLogger)