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

Class UserAuthenticationBuilder

java.lang.Object

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

org.openehealth.ipf.commons.audit.event.UserAuthenticationBuilder

All Implemented Interfaces:

AuditMessageBuilder<UserAuthenticationBuilder>, Validateable

Direct Known Subclasses:

UserAuthenticationBuilder.Login, UserAuthenticationBuilder.Logout

public class UserAuthenticationBuilder
extends BaseAuditMessageBuilder<UserAuthenticationBuilder>

Builds an User Authentication representing a Network Entry event as specified in http://dicom.nema.org/medical/dicom/current/output/html/part15.html#sect_A.5.3.12

This message describes the event that a user has attempted to log on or log off. This report can be made regardless of whether the attempt was successful or not. No Participant Objects are needed for this message.

The user usually has UserIsRequestor TRUE, but in the case of a logout timer, the Node might be the UserIsRequestor.

Since:

3.5

Author:

Christian Ohr

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserAuthenticationBuilder.Login
static class	UserAuthenticationBuilder.Logout

Constructor Summary

Constructors

Constructor	Description
UserAuthenticationBuilder(EventOutcomeIndicator outcome, String eventOutcomeDescription, EventTypeCode eventTypeCode, PurposeOfUse... purposesOfUse)

Method Summary

Modifier and Type	Method	Description
UserAuthenticationBuilder	setAuthenticatedParticipant(String userId, String networkId)
UserAuthenticationBuilder	setAuthenticatedParticipant(String userId, String altUserId, String userName, boolean userIsRequestor, ActiveParticipantRoleIdCode roleId, String networkId)	Sets the Active Participant of the Node or System entering or leaving the network
UserAuthenticationBuilder	setAuthenticatingSystemParticipant(String userId, String networkId)
UserAuthenticationBuilder	setAuthenticatingSystemParticipant(String userId, String altUserId, String userName, boolean userIsRequestor, ActiveParticipantRoleIdCode roleId, String networkId)	Node or System performing authentication
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

UserAuthenticationBuilder

public UserAuthenticationBuilder(EventOutcomeIndicator outcome,
                                 String eventOutcomeDescription,
                                 EventTypeCode eventTypeCode,
                                 PurposeOfUse... purposesOfUse)

Method Detail

setAuthenticatedParticipant

public UserAuthenticationBuilder setAuthenticatedParticipant(String userId,
                                                             String networkId)

setAuthenticatedParticipant

public UserAuthenticationBuilder setAuthenticatedParticipant(String userId,
                                                             String altUserId,
                                                             String userName,
                                                             boolean userIsRequestor,
                                                             ActiveParticipantRoleIdCode roleId,
                                                             String networkId)

Sets the Active Participant of the Node or System entering or leaving the network

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

setAuthenticatingSystemParticipant

public UserAuthenticationBuilder setAuthenticatingSystemParticipant(String userId,
                                                                    String networkId)

setAuthenticatingSystemParticipant

public UserAuthenticationBuilder setAuthenticatingSystemParticipant(String userId,
                                                                    String altUserId,
                                                                    String userName,
                                                                    boolean userIsRequestor,
                                                                    ActiveParticipantRoleIdCode roleId,
                                                                    String networkId)

Node or System performing authentication

Parameters:

userId - The Active Participant's UserID

altUserId - The Active Participant's Alternate UserID

userName - The Active Participant's UserName

networkId - The Active Participant's Network Access Point ID

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<UserAuthenticationBuilder>