T
- public abstract class BaseAuditMessageBuilder<T extends BaseAuditMessageBuilder<T>> extends Object implements AuditMessageBuilder<T>
Constructor and Description |
---|
BaseAuditMessageBuilder() |
Modifier and Type | Method and Description |
---|---|
T |
addActiveParticipant(ActiveParticipantType activeParticipantType) |
T |
addActiveParticipant(String userID,
String altUserID,
String userName,
Boolean userIsRequestor,
List<ActiveParticipantRoleId> roleIdCodes,
String networkAccessPointID)
Create and add an Active Participant to this audit event message but automatically
determine the Network Access Point ID Type Code
|
T |
addActiveParticipant(String userID,
String altUserID,
String userName,
Boolean userIsRequestor,
List<ActiveParticipantRoleId> roleIdCodes,
String networkAccessPointID,
NetworkAccessPointTypeCode networkAccessPointTypeCode,
String mediaIdentifier,
MediaType mediaType)
Create and add an Active Participant block to this audit event message
|
T |
addDestinationActiveParticipant(String userId,
String altUserId,
String userName,
String networkAccessPointId,
boolean userIsRequestor)
Adds an Active Participant representing destination participant
|
T |
addParticipantObjectIdentification(ParticipantObjectIdentificationType poit) |
T |
addParticipantObjectIdentification(ParticipantObjectIdType objectIDTypeCode,
String objectName,
byte[] objectQuery,
List<TypeValuePairType> objectDetails,
String objectID,
ParticipantObjectTypeCode objectTypeCode,
ParticipantObjectTypeCodeRole objectTypeCodeRole,
ParticipantObjectDataLifeCycle objectDataLifeCycle,
String objectSensitivity)
Create and add an Participant Object Identification block to this audit event message
|
T |
addPatientParticipantObject(String patientId,
String patientName,
List<TypeValuePairType> details,
ParticipantObjectDataLifeCycle lifecycle)
Adds a Participant Object representing a patient involved in the event
|
T |
addSourceActiveParticipant(String userId,
String altUserId,
String userName,
String networkId,
boolean isRequestor)
Adds an Active Participant representing the source participant
|
T |
addStudyParticipantObject(String studyId,
List<TypeValuePairType> objectDetails)
Adds a Participant Object representing a studies involved in the event
|
AuditMessage |
getMessage() |
protected NetworkAccessPointTypeCode |
getNetworkAccessPointCodeFromAddress(String address) |
TypeValuePairType |
getTypeValuePair(String type,
Object value)
Create and set a Type Value Pair instance for a given type and value
|
T |
setAuditSource(AuditContext auditContext)
Sets the audit source from the audit context
|
T |
setAuditSource(String sourceId)
Sets a
AuditSourceIdentificationType for a given Audit Source ID |
T |
setAuditSource(String sourceId,
String enterpriseSiteId)
Sets a
AuditSourceIdentificationType for a given Audit Source ID
and Audit Source Enterprise Site ID |
T |
setAuditSource(String sourceId,
String enterpriseSiteId,
AuditSource... typeCodes)
Sets a
AuditSourceIdentificationType for a given Audit Source ID,
Audit Source Enterprise Site ID, and a list of audit source type codes |
T |
setAuditSourceIdentification(AuditSourceIdentificationType auditSourceIdentificationType) |
T |
setAuditSourceIdentification(String sourceID,
String enterpriseSiteID,
AuditSource... typeCodes)
Create and add an Audit Source Identification to this audit event message
|
T |
setAuditSourceIdentification(String sourceID,
String enterpriseSiteID,
Collection<AuditSource> typeCodes)
Create and add an Audit Source Identification to this audit event message
|
T |
setEventIdentification(EventOutcomeIndicator outcome,
String eventOutcomeDescription,
EventActionCode action,
EventId id,
EventType type,
Collection<PurposeOfUse> purposesOfUse)
Create and set an Event Identification block for this audit event message
|
T |
setEventIdentification(EventOutcomeIndicator outcome,
String eventOutcomeDescription,
EventActionCode action,
EventId id,
EventType type,
PurposeOfUse... purposesOfUse)
Create and set an Event Identification block for this audit event message
|
void |
validate()
Validates the constructed audit message against the specification, because API does not completely
prevent constructing incomplete or inconsistent messages.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getMessages, self
public void validate()
Validateable
validate
in interface Validateable
public AuditMessage getMessage()
getMessage
in interface AuditMessageBuilder<T extends BaseAuditMessageBuilder<T>>
public T setAuditSource(String sourceId)
AuditSourceIdentificationType
for a given Audit Source IDsourceId
- The Audit Source ID to usepublic T setAuditSource(String sourceId, String enterpriseSiteId)
AuditSourceIdentificationType
for a given Audit Source ID
and Audit Source Enterprise Site IDsourceId
- The Audit Source ID to useenterpriseSiteId
- The Audit Enterprise Site ID to usepublic T setAuditSource(String sourceId, String enterpriseSiteId, AuditSource... typeCodes)
AuditSourceIdentificationType
for a given Audit Source ID,
Audit Source Enterprise Site ID, and a list of audit source type codessourceId
- The Audit Source ID to useenterpriseSiteId
- The Audit Enterprise Site ID to usetypeCodes
- The RFC 3881 Audit Source Type codes to usepublic T setAuditSource(AuditContext auditContext)
auditContext
- audit contextpublic T setEventIdentification(EventOutcomeIndicator outcome, String eventOutcomeDescription, EventActionCode action, EventId id, EventType type, PurposeOfUse... purposesOfUse)
outcome
- The Event Outcome Indicatoraction
- The Event Action Codeid
- The Event IDtype
- The Event Type Codepublic T setEventIdentification(EventOutcomeIndicator outcome, String eventOutcomeDescription, EventActionCode action, EventId id, EventType type, Collection<PurposeOfUse> purposesOfUse)
outcome
- The Event Outcome Indicatoraction
- The Event Action Codeid
- The Event IDtype
- The Event Type Codepublic T setAuditSourceIdentification(String sourceID, String enterpriseSiteID, AuditSource... typeCodes)
sourceID
- The Audit Source IDenterpriseSiteID
- The Audit Enterprise Site IDtypeCodes
- The Audit Source Type Codespublic T setAuditSourceIdentification(String sourceID, String enterpriseSiteID, Collection<AuditSource> typeCodes)
sourceID
- The Audit Source IDenterpriseSiteID
- The Audit Enterprise Site IDtypeCodes
- The Audit Source Type Codespublic T setAuditSourceIdentification(AuditSourceIdentificationType auditSourceIdentificationType)
public T addSourceActiveParticipant(String userId, String altUserId, String userName, String networkId, boolean isRequestor)
userId
- The identity of the local user or process exporting the data. 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 IDisRequestor
- Whether the participant represents the requestor (i.e. push request)public T addDestinationActiveParticipant(String userId, String altUserId, String userName, String networkAccessPointId, boolean userIsRequestor)
userId
- The identity of the remote user or process receiving the dataaltUserId
- The Active Participant's Alternate UserIDuserName
- The Active Participant's UserNamenetworkAccessPointId
- The Active Participant's Network Access Point IDuserIsRequestor
- Whether the destination participant represents the requestor (i.e. pull request)public T addActiveParticipant(String userID, String altUserID, String userName, Boolean userIsRequestor, List<ActiveParticipantRoleId> roleIdCodes, String networkAccessPointID)
userID
- The Active Participant's UserIDaltUserID
- The Active Participant's Alternate UserIDuserName
- The Active Participant's UserNameuserIsRequestor
- Whether this Active Participant is a requestorroleIdCodes
- The Active Participant's Role CodesnetworkAccessPointID
- The Active Participant's Network Access Point ID (IP / Hostname)public T addActiveParticipant(String userID, String altUserID, String userName, Boolean userIsRequestor, List<ActiveParticipantRoleId> roleIdCodes, String networkAccessPointID, NetworkAccessPointTypeCode networkAccessPointTypeCode, String mediaIdentifier, MediaType mediaType)
userID
- The Active Participant's UserIDaltUserID
- The Active Participant's Alternate UserIDuserName
- The Active Participant's UserNameuserIsRequestor
- Whether this Active Participant is a requestorroleIdCodes
- The Active Participant's Role CodesnetworkAccessPointID
- The Active Participant's Network Access Point ID (IP / Hostname)networkAccessPointTypeCode
- The type code for the Network Access Point IDpublic T addActiveParticipant(ActiveParticipantType activeParticipantType)
public T addPatientParticipantObject(String patientId, String patientName, List<TypeValuePairType> details, ParticipantObjectDataLifeCycle lifecycle)
patientId
- Identifier of the involved patientpatientName
- name of the involved patientpublic T addStudyParticipantObject(String studyId, List<TypeValuePairType> objectDetails)
studyId
- Identifier of the involved studyobjectDetails
- objectDetailspublic T addParticipantObjectIdentification(ParticipantObjectIdType objectIDTypeCode, String objectName, byte[] objectQuery, List<TypeValuePairType> objectDetails, String objectID, ParticipantObjectTypeCode objectTypeCode, ParticipantObjectTypeCodeRole objectTypeCodeRole, ParticipantObjectDataLifeCycle objectDataLifeCycle, String objectSensitivity)
objectIDTypeCode
- The Participant Object ID Type codeobjectName
- The Participant Object NameobjectQuery
- The Participant Object Query dataobjectDetails
- The Participant Object detailobjectID
- The Participant Object IDobjectTypeCode
- The Participant Object Type CodeobjectTypeCodeRole
- The Participant Object Type Code's ROleobjectDataLifeCycle
- The Participant Object Data Life CycleobjectSensitivity
- The Participant Object sensitivitypublic T addParticipantObjectIdentification(ParticipantObjectIdentificationType poit)
protected NetworkAccessPointTypeCode getNetworkAccessPointCodeFromAddress(String address)
public TypeValuePairType getTypeValuePair(String type, Object value)
getTypeValuePair
in interface AuditMessageBuilder<T extends BaseAuditMessageBuilder<T>>
type
- The type to setvalue
- The value to setCopyright © 2018 Open eHealth Foundation. All rights reserved.