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

Class AuditDataset

java.lang.Object
org.openehealth.ipf.commons.ihe.core.atna.AuditDataset
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
FhirAuditDataset, MllpAuditDataset, WsAuditDataset
public abstract class AuditDataset extends Object implements Serializable
A generic data structure used to store information pieces needed for auditing.
Author:
Dmytro Rud
See Also:

  • Constructor Details

    • AuditDataset

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

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getSourceUserId

      public abstract String getSourceUserId()
      Returns:
      the user ID of the transaction source

    • getDestinationUserId

      public abstract String getDestinationUserId()
      Returns:
      the user ID of the transaction destination

    • getLocalAddress

      public abstract String getLocalAddress()
      Returns the local address. May fall back to AuditUtils.getLocalIPAddress() if not explicitly set
      Returns:
      the local address

    • getRemoteAddress

      public abstract String getRemoteAddress()
      Returns:
      the remote address of the transaction

    • getHumanUsers

      public abstract List<AuditDataset.HumanUser> getHumanUsers()
      Returns:
      information about human user(s) participating in the transaction

    • isSourceUserIsRequestor

      public boolean isSourceUserIsRequestor()
      Returns:
      true if the source user is the requestor of the event

    • isDestinationUserIsRequestor

      public boolean isDestinationUserIsRequestor()
      Returns:
      true if the destination user is the requestor of the event

    • isServerSide

      public boolean isServerSide()
      whether we audit on server (true) or on client (false)

    • getEventOutcomeIndicator

      public EventOutcomeIndicator getEventOutcomeIndicator()
      Overall outcome of the transaction that causes this audit event

    • setEventOutcomeIndicator

      public void setEventOutcomeIndicator(EventOutcomeIndicator eventOutcomeIndicator)
      Overall outcome of the transaction that causes this audit event

    • getEventOutcomeDescription

      public String getEventOutcomeDescription()
      Description of the overall outcome of the transaction that causes this audit event

    • setEventOutcomeDescription

      public void setEventOutcomeDescription(String eventOutcomeDescription)
      Description of the overall outcome of the transaction that causes this audit event

    • getSourceUserName

      public String getSourceUserName()
      Source User Name, e.g. extracted from a client certificate

    • setSourceUserName

      public void setSourceUserName(String sourceUserName)
      Source User Name, e.g. extracted from a client certificate

    • getW3cTraceContextId

      public String getW3cTraceContextId()
      Contents of the HTTP header "traceparent:" as defined in the W3C Trace Context specification.

    • setW3cTraceContextId

      public void setW3cTraceContextId(String w3cTraceContextId)
      Contents of the HTTP header "traceparent:" as defined in the W3C Trace Context specification.