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

Class AuditLogUsedBuilder

java.lang.Object

org.openehealth.ipf.commons.audit.event.BaseAuditMessageBuilder<AuditLogUsedBuilder>

org.openehealth.ipf.commons.audit.event.AuditLogUsedBuilder

All Implemented Interfaces:

AuditMessageBuilder<AuditLogUsedBuilder>, Validateable

public class AuditLogUsedBuilder
extends BaseAuditMessageBuilder<AuditLogUsedBuilder>

Builds an Audit Event representing a Audit Log Used event as specified in http://dicom.nema.org/medical/dicom/current/output/html/part15.html#sect_A.5.3.2

This message describes the event of a person or process reading a log of audit trail information.

Since:

3.5

Author:

Christian Ohr

Constructor Summary

Constructors

Constructor	Description
AuditLogUsedBuilder(EventOutcomeIndicator outcome)
AuditLogUsedBuilder(EventOutcomeIndicator outcome, String eventOutcomeDescription)

Method Summary

Modifier and Type	Method	Description
AuditLogUsedBuilder	addAccessingParticipant(String userId, String altUserId, String userName, boolean userIsRequestor, String networkId)	Deprecated. use addAccessingParticipant(String, String, String, boolean, List, String)
AuditLogUsedBuilder	addAccessingParticipant(String userId, String altUserId, String userName, boolean userIsRequestor, List<ActiveParticipantRoleId> roleIds, String networkId)	Adds the Active Participant of the User or System that accessed the log
AuditLogUsedBuilder	addAuditLogIdentity(String auditLogUri)	Adds the Participant Object representing the audit log accessed
void	validate()	Validates the constructed audit message against the specification, because API does not completely prevent constructing incomplete or inconsistent messages.

Methods inherited from class org.openehealth.ipf.commons.audit.event.BaseAuditMessageBuilder

addActiveParticipant, addActiveParticipant, addActiveParticipant, addDestinationActiveParticipant, addParticipantObjectIdentification, addParticipantObjectIdentification, addParticipantObjectIdentification, addPatientParticipantObject, addSourceActiveParticipant, addStudyParticipantObject, getMessage, getNetworkAccessPointCodeFromAddress, setAuditSource, setAuditSource, setAuditSource, setAuditSource, setAuditSourceIdentification, setAuditSourceIdentification, setAuditSourceIdentification, setEventIdentification, setEventIdentification

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openehealth.ipf.commons.audit.event.AuditMessageBuilder

getMessages, getTypeValuePair, getTypeValuePair, getTypeValuePair, getTypeValuePair, self

Constructor Detail

AuditLogUsedBuilder

public AuditLogUsedBuilder(EventOutcomeIndicator outcome)

AuditLogUsedBuilder

public AuditLogUsedBuilder(EventOutcomeIndicator outcome,
                           String eventOutcomeDescription)

Method Detail

addAccessingParticipant

@Deprecated
public AuditLogUsedBuilder addAccessingParticipant(String userId,
                                                   String altUserId,
                                                   String userName,
                                                   boolean userIsRequestor,
                                                   String networkId)

Deprecated.

use addAccessingParticipant(String, String, String, boolean, List, String)

Adds the Active Participant of the User or System that accessed the log

Parameters:

userId - The person or process accessing the audit trail. If both are known, then two active participants shall be included (both the person and the process).

altUserId - The Active Participant's Alternate UserID

userName - The Active Participant's UserName

networkId - The Active Participant's Network Access Point ID

addAccessingParticipant

public AuditLogUsedBuilder addAccessingParticipant(String userId,
                                                   String altUserId,
                                                   String userName,
                                                   boolean userIsRequestor,
                                                   List<ActiveParticipantRoleId> roleIds,
                                                   String networkId)

Adds the Active Participant of the User or System that accessed the log

Parameters:

userId - The person or process accessing the audit trail. If both are known, then two active participants shall be included (both the person and the process).

altUserId - The Active Participant's Alternate UserID

userName - The Active Participant's UserName

networkId - The Active Participant's Network Access Point ID

addAuditLogIdentity

public AuditLogUsedBuilder addAuditLogIdentity(String auditLogUri)

Adds the Participant Object representing the audit log accessed

Parameters:

auditLogUri - The URI of the audit log that was accessed

validate

public void validate()

Description copied from interface: Validateable

Validates the constructed audit message against the specification, because API does not completely prevent constructing incomplete or inconsistent messages.

Specified by:

validate in interface Validateable

Overrides:

validate in class BaseAuditMessageBuilder<AuditLogUsedBuilder>