public class UserAuthenticationBuilder extends BaseAuditMessageBuilder<UserAuthenticationBuilder>
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.
Modifier and Type | Class and Description |
---|---|
static class |
UserAuthenticationBuilder.Login |
static class |
UserAuthenticationBuilder.Logout |
Constructor and Description |
---|
UserAuthenticationBuilder(EventOutcomeIndicator outcome,
String eventOutcomeDescription,
EventTypeCode eventTypeCode,
PurposeOfUse... purposesOfUse) |
Modifier and Type | Method and 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.
|
addActiveParticipant, addActiveParticipant, addActiveParticipant, addDestinationActiveParticipant, addParticipantObjectIdentification, addParticipantObjectIdentification, addPatientParticipantObject, addSourceActiveParticipant, addStudyParticipantObject, getMessage, getNetworkAccessPointCodeFromAddress, getTypeValuePair, setAuditSource, setAuditSource, setAuditSource, setAuditSource, setAuditSourceIdentification, setAuditSourceIdentification, setAuditSourceIdentification, setEventIdentification, setEventIdentification
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getMessages, self
public UserAuthenticationBuilder(EventOutcomeIndicator outcome, String eventOutcomeDescription, EventTypeCode eventTypeCode, PurposeOfUse... purposesOfUse)
public UserAuthenticationBuilder setAuthenticatedParticipant(String userId, String networkId)
public UserAuthenticationBuilder setAuthenticatedParticipant(String userId, String altUserId, String userName, boolean userIsRequestor, ActiveParticipantRoleIdCode roleId, String networkId)
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 UserIDuserName
- The Active Participant's UserNamenetworkId
- The Active Participant's Network Access Point IDpublic UserAuthenticationBuilder setAuthenticatingSystemParticipant(String userId, String networkId)
public UserAuthenticationBuilder setAuthenticatingSystemParticipant(String userId, String altUserId, String userName, boolean userIsRequestor, ActiveParticipantRoleIdCode roleId, String networkId)
userId
- The Active Participant's UserIDaltUserId
- The Active Participant's Alternate UserIDuserName
- The Active Participant's UserNamenetworkId
- The Active Participant's Network Access Point IDpublic void validate()
Validateable
validate
in interface Validateable
validate
in class BaseAuditMessageBuilder<UserAuthenticationBuilder>
Copyright © 2018 Open eHealth Foundation. All rights reserved.