Package org.openehealth.ipf.commons.ihe.ws.cxf.audit

Class WsAuditDataset

java.lang.Object

org.openehealth.ipf.commons.ihe.core.atna.AuditDataset

org.openehealth.ipf.commons.ihe.ws.cxf.audit.WsAuditDataset

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ChPpqAuditDataset, Hl7v3AuditDataset, Iti59AuditDataset, XdsAuditDataset

public class WsAuditDataset
extends AuditDataset

A data structure that contains various ATNA audit information pieces common for all Web Service-based IHE transactions.

These pieces are stored and used by corresponding CXF interceptors and transaction-specific audit strategies.

Author:

Dmytro Rud

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.openehealth.ipf.commons.ihe.core.atna.AuditDataset

AuditDataset.HumanUser

Constructor Summary

Constructors

Constructor	Description
WsAuditDataset(boolean serverSide)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getClientIpAddress()	Client IP address.
String	getDestinationUserId()	Server user ID (SOAP endpoint)
List<AuditDataset.HumanUser>	getHumanUsers()	IDs and real-world names of human users.
String	getLocalAddress()	Returns the local address.
PurposeOfUse[]	getPurposesOfUse()	Purposes of use, see ITI TF-2a section 3.20.7.8 and ITI TF-2b section 3.40.4.1.2.3.
String	getRemoteAddress()	Remote address
String	getRequestPayload()	Request SOAP Body (XML) payload.
String	getSourceUserId()	Client user ID (WS-Addressing <Reply-To> header).
String	getXuaPatientId()	Patient ID from XUA token, see ITI TF-2b Section 3.40.4.1.2.2.1.
boolean	isSourceUserIsRequestor()
void	setClientIpAddress(String clientIpAddress)	Client IP address.
void	setDestinationUserId(String destinationUserId)	Server user ID (SOAP endpoint)
void	setLocalAddress(String localAddress)	Local address
void	setPurposesOfUse(PurposeOfUse[] purposesOfUse)	Purposes of use, see ITI TF-2a section 3.20.7.8 and ITI TF-2b section 3.40.4.1.2.3.
void	setRemoteAddress(String remoteAddress)	Remote address
void	setRequestPayload(String requestPayload)	Sets the request SOAP Body (XML) payload.
void	setRequestPayload(StringPayloadHolder payloadHolder)	Sets the request SOAP Body (XML) payload.
void	setSourceUserId(String sourceUserId)	Client user ID (WS-Addressing <Reply-To> header).
void	setSourceUserIsRequestor(boolean sourceUserIsRequestor)
void	setXuaPatientId(String xuaPatientId)	Patient ID from XUA token, see ITI TF-2b Section 3.40.4.1.2.2.1.

Methods inherited from class org.openehealth.ipf.commons.ihe.core.atna.AuditDataset

getEventOutcomeDescription, getEventOutcomeIndicator, getSourceUserName, isDestinationUserIsRequestor, isServerSide, setEventOutcomeDescription, setEventOutcomeIndicator, setSourceUserName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WsAuditDataset

public WsAuditDataset(boolean serverSide)

Constructor.

Parameters:

serverSide - specifies whether this audit dataset will be used on the server side (true) or on the client side ( false)

Method Detail

setRequestPayload

public void setRequestPayload(String requestPayload)

Sets the request SOAP Body (XML) payload.

Parameters:

requestPayload - SOAP Body (XML) payload.

setRequestPayload

public void setRequestPayload(StringPayloadHolder payloadHolder)

Sets the request SOAP Body (XML) payload.

Parameters:

payloadHolder - POJO containing SOAP Body (XML) payload.

getLocalAddress

public String getLocalAddress()

Description copied from class: AuditDataset

Returns the local address. May fall back to AuditUtils.getLocalIPAddress() if not explicitly set

Specified by:

getLocalAddress in class AuditDataset

Returns:

The machine name or IP address

isSourceUserIsRequestor

public boolean isSourceUserIsRequestor()

Overrides:

isSourceUserIsRequestor in class AuditDataset

Returns:

true if the source user is the requestor of the event

getSourceUserId

public String getSourceUserId()

Client user ID (WS-Addressing <Reply-To> header).

Specified by:

getSourceUserId in class AuditDataset

Returns:

the user ID of the transaction source

setSourceUserId

public void setSourceUserId(String sourceUserId)

Client user ID (WS-Addressing <Reply-To> header).

getDestinationUserId

public String getDestinationUserId()

Server user ID (SOAP endpoint)

Specified by:

getDestinationUserId in class AuditDataset

Returns:

the user ID of the transaction destination

setDestinationUserId

public void setDestinationUserId(String destinationUserId)

Server user ID (SOAP endpoint)

getRequestPayload

public String getRequestPayload()

Request SOAP Body (XML) payload.

getHumanUsers

public List<AuditDataset.HumanUser> getHumanUsers()

IDs and real-world names of human users.

Specified by:

getHumanUsers in class AuditDataset

Returns:

information about human user(s) participating in the transaction

getClientIpAddress

public String getClientIpAddress()

Client IP address.

setClientIpAddress

public void setClientIpAddress(String clientIpAddress)

Client IP address.

getPurposesOfUse

public PurposeOfUse[] getPurposesOfUse()

Purposes of use, see ITI TF-2a section 3.20.7.8 and ITI TF-2b section 3.40.4.1.2.3.

setPurposesOfUse

public void setPurposesOfUse(PurposeOfUse[] purposesOfUse)

Purposes of use, see ITI TF-2a section 3.20.7.8 and ITI TF-2b section 3.40.4.1.2.3.

getXuaPatientId

public String getXuaPatientId()

Patient ID from XUA token, see ITI TF-2b Section 3.40.4.1.2.2.1.

setXuaPatientId

public void setXuaPatientId(String xuaPatientId)

Patient ID from XUA token, see ITI TF-2b Section 3.40.4.1.2.2.1.

setLocalAddress

public void setLocalAddress(String localAddress)

Local address

setRemoteAddress

public void setRemoteAddress(String remoteAddress)

Remote address

getRemoteAddress

public String getRemoteAddress()

Remote address

Specified by:

getRemoteAddress in class AuditDataset

Returns:

the remote address of the transaction

setSourceUserIsRequestor

public void setSourceUserIsRequestor(boolean sourceUserIsRequestor)