Package ca.uhn.fhir.storage.interceptor.balp

Interface IBalpAuditContextServices

public interface IBalpAuditContextServices

This interface is intended to be implemented in order to supply implementation strategy details to the BalpAuditCaptureInterceptor.

Since:

6.6.0

Method Summary

Modifier and Type	Method	Description
org.hl7.fhir.r4.model.Reference	getAgentClientWho(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)	Create and return a Reference to the client that was used to perform the action in question.
org.hl7.fhir.r4.model.Reference	getAgentUserWho(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)	Create and return a Reference to the user that was used to perform the action in question.
default String	getNetworkAddress(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)	Provide the requesting network address to include in the AuditEvent.
default org.hl7.fhir.r4.model.AuditEvent.AuditEventAgentNetworkType	getNetworkAddressType(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)	Provides a code representing the appropriate return type for getNetworkAddress(RequestDetails).
default String	massageResourceIdForStorage(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails, org.hl7.fhir.instance.model.api.IBaseResource theResource, org.hl7.fhir.instance.model.api.IIdType theResourceId)	Turns an entity resource ID from an IIdType to a String.

Method Details

getAgentClientWho

@Nonnull
org.hl7.fhir.r4.model.Reference getAgentClientWho(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)

Create and return a Reference to the client that was used to perform the action in question.

Parameters:

theRequestDetails - The request details object

getAgentUserWho

@Nonnull
org.hl7.fhir.r4.model.Reference getAgentUserWho(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)

Create and return a Reference to the user that was used to perform the action in question.

Parameters:

theRequestDetails - The request details object

getNetworkAddress

default String getNetworkAddress(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)

Provide the requesting network address to include in the AuditEvent.

See Also:

• If this method is returning an adress type that is not an IP address, you must also oerride this method and return the correct code.

getNetworkAddressType

default org.hl7.fhir.r4.model.AuditEvent.AuditEventAgentNetworkType getNetworkAddressType(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)

Provides a code representing the appropriate return type for getNetworkAddress(RequestDetails). The default implementation returns BalpConstants.AUDIT_EVENT_AGENT_NETWORK_TYPE_IP_ADDRESS.

Parameters:

theRequestDetails - The request details object

See Also:

• getNetworkAddress(RequestDetails)
• Potential return type for this method
• Potential return type for this method
• Potential return type for this method

massageResourceIdForStorage

@Nonnull
default String massageResourceIdForStorage(@Nonnull
 ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails,
 @Nonnull
 org.hl7.fhir.instance.model.api.IBaseResource theResource,
 @Nonnull
 org.hl7.fhir.instance.model.api.IIdType theResourceId)

Turns an entity resource ID from an IIdType to a String. The default implementation injects the server's base URL into the ID in order to create fully qualified URLs for resource references within BALP events.