Package org.openehealth.ipf.commons.audit.event

Interface AuditMessageBuilder<T extends AuditMessageBuilder<T>>

All Superinterfaces:

Validateable

All Known Implementing Classes:

ApplicationActivityBuilder, ApplicationActivityBuilder.ApplicationStart, ApplicationActivityBuilder.ApplicationStop, AuditLogUsedBuilder, BaseAuditMessageBuilder, BeginTransferringDicomInstancesBuilder, CustomAuditMessageBuilder, DataExportBuilder, DataImportBuilder, DelegatingAuditMessageBuilder, DicomInstancesAccessedAuditBuilder, DicomInstancesAccessedBuilder, DicomInstancesAccessedEventBuilder, DicomInstancesTransferredAuditBuilder, DicomInstancesTransferredBuilder, DicomInstancesTransferredEventBuilder, DicomStudyDeletedBuilder, GenericFhirAuditMessageBuilder, IHEAuditLogUsedBuilder, IHEAuditMessageBuilder, NetworkEntryBuilder, NetworkEntryBuilder.EnteringNetwork, NetworkEntryBuilder.LeavingNetwork, OrderRecordBuilder, PatientRecordBuilder, PatientRecordEventBuilder, PHIExportBuilder, PHIImportBuilder, ProcedureRecordBuilder, QueryBuilder, QueryInformationBuilder, SecurityAlertBuilder, UserAuthenticationBuilder, UserAuthenticationBuilder.Login, UserAuthenticationBuilder.Logout, XdsPatientRecordEventBuilder, XdsPHIExportBuilder, XdsPHIImportBuilder, XdsQueryInformationBuilder

public interface AuditMessageBuilder<T extends AuditMessageBuilder<T>>
extends Validateable

Base interface for building DICOM audit messages

Since:

3.5

Author:

Christian Ohr

Method Summary

Modifier and Type	Method	Description
AuditMessage	getMessage()
default AuditMessage[]	getMessages()
default TypeValuePairType	getTypeValuePair(String type, byte[] value)	Create and set a Type Value Pair instance for a given type and value
default TypeValuePairType	getTypeValuePair(String type, byte[] value, byte[] defaultValue)	Create and set a Type Value Pair instance for a given type and value
default TypeValuePairType	getTypeValuePair(String type, Object value)	Create and set a Type Value Pair instance for a given type and value
default TypeValuePairType	getTypeValuePair(String type, Object value, String defaultValue)	Create and set a Type Value Pair instance for a given type and value
default T	self()

Methods inherited from interface org.openehealth.ipf.commons.audit.model.Validateable

validate

Method Detail

getMessage

AuditMessage getMessage()

Returns:

the audit message being built

getMessages

default AuditMessage[] getMessages()

Returns:

the audit message being built as only element in an array

getTypeValuePair

default TypeValuePairType getTypeValuePair(String type,
                                           Object value)

Create and set a Type Value Pair instance for a given type and value

Parameters:

type - the type to set

value - the value to set

Returns:

the Type Value Pair instance

getTypeValuePair

default TypeValuePairType getTypeValuePair(String type,
                                           byte[] value)

Create and set a Type Value Pair instance for a given type and value

Parameters:

type - the type to set

value - the value to set

Returns:

the Type Value Pair instance

getTypeValuePair

default TypeValuePairType getTypeValuePair(String type,
                                           Object value,
                                           String defaultValue)

Create and set a Type Value Pair instance for a given type and value

Parameters:

type - the type to set

value - the value to set

defaultValue - the value to set if value is null

Returns:

the Type Value Pair instance

getTypeValuePair

default TypeValuePairType getTypeValuePair(String type,
                                           byte[] value,
                                           byte[] defaultValue)

Create and set a Type Value Pair instance for a given type and value

Parameters:

type - the type to set

value - the value to set

defaultValue - the value to set if value is null

Returns:

the Type Value Pair instance

self

default T self()

Returns:

this builder