Package ca.uhn.fhir.rest.server.interceptor.consent

Class ConsentInterceptor

java.lang.Object

ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

public class ConsentInterceptor
extends Object

The ConsentInterceptor can be used to apply arbitrary consent rules and data access policies on responses from a FHIR server.

See Consent Interceptor for more information on this interceptor.

Constructor Summary

Constructors

Constructor	Description
ConsentInterceptor()	Constructor
ConsentInterceptor(IConsentService theConsentService)	Constructor
ConsentInterceptor(IConsentService theConsentService, IConsentContextServices theContextConsentServices)	Constructor

Method Summary

Modifier and Type	Method	Description
protected void	authorizeRequest(RequestDetails theRequestDetails)
List<IConsentService>	getConsentServices()
protected RequestDetails	getRequestDetailsForCurrentExportOperation(BulkExportJobParameters theParameters, org.hl7.fhir.instance.model.api.IBaseResource theBaseResource)
void	interceptOutgoingResponse(RequestDetails theRequestDetails, ResponseDetails theResponseDetails)
void	interceptPreAccess(RequestDetails theRequestDetails, IPreResourceAccessDetails thePreResourceAccessDetails)
boolean	interceptPreCheckForCachedSearch(RequestDetails theRequestDetails)	Check if this request is eligible for cached search results.
void	interceptPreHandled(RequestDetails theRequestDetails)
void	interceptPreSearchRegistered(RequestDetails theRequestDetails, ICachedSearchDetails theCachedSearchDetails)	Check if the search results from this request might be reused by later searches.
void	interceptPreShow(RequestDetails theRequestDetails, IPreResourceShowDetails thePreResourceShowDetails)
ConsentInterceptor	registerConsentService(IConsentService theConsentService)	Adds a consent service to the chain.
void	requestFailed(RequestDetails theRequest, ca.uhn.fhir.rest.server.exceptions.BaseServerResponseException theException)
void	requestSucceeded(RequestDetails theRequest)
void	setConsentService(IConsentService theConsentService)	Deprecated. Use registerConsentService(IConsentService) instead
void	setContextConsentServices(IConsentContextServices theContextConsentServices)
boolean	shouldBulkExportIncludeResource(BulkExportJobParameters theParameters, org.hl7.fhir.instance.model.api.IBaseResource theResource)
ConsentInterceptor	unregisterConsentService(IConsentService theConsentService)	Removes a consent service from the chain.

Methods inherited from class java.lang.Object

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

Constructor Details

ConsentInterceptor

public ConsentInterceptor()

Constructor

ConsentInterceptor

public ConsentInterceptor(IConsentService theConsentService)

Constructor

Parameters:

theConsentService - Must not be null

ConsentInterceptor

public ConsentInterceptor(IConsentService theConsentService,
 IConsentContextServices theContextConsentServices)

Constructor

Parameters:

theConsentService - Must not be null

theContextConsentServices - Must not be null

Method Details

setContextConsentServices

public void setContextConsentServices(IConsentContextServices theContextConsentServices)

setConsentService

@Deprecated
public void setConsentService(IConsentService theConsentService)

Deprecated.

Use registerConsentService(IConsentService) instead

registerConsentService

public ConsentInterceptor registerConsentService(IConsentService theConsentService)

Adds a consent service to the chain.

Thread safety note: This method can be called while the service is actively processing requestes

Parameters:

theConsentService - The service to register. Must not be null.

Since:

6.0.0

unregisterConsentService

public ConsentInterceptor unregisterConsentService(IConsentService theConsentService)

Removes a consent service from the chain.

Thread safety note: This method can be called while the service is actively processing requestes

Parameters:

theConsentService - The service to unregister. Must not be null.

Since:

6.0.0

getConsentServices

public List<IConsentService> getConsentServices()

interceptPreHandled

public void interceptPreHandled(RequestDetails theRequestDetails)

authorizeRequest

protected void authorizeRequest(RequestDetails theRequestDetails)

interceptPreCheckForCachedSearch

public boolean interceptPreCheckForCachedSearch(@Nonnull
 RequestDetails theRequestDetails)

Check if this request is eligible for cached search results. We can't use a cached result if consent may use canSeeResource. This checks for AUTHORIZED requests, and the responses from shouldProcessCanSeeResource() to see if this holds.

Returns:

may the request be satisfied from cache.

interceptPreSearchRegistered

public void interceptPreSearchRegistered(RequestDetails theRequestDetails,
 ICachedSearchDetails theCachedSearchDetails)

Check if the search results from this request might be reused by later searches. We can't use a cached result if consent may use canSeeResource. This checks for AUTHORIZED requests, and the responses from shouldProcessCanSeeResource() to see if this holds. If not, marks the result as single-use.

interceptPreAccess

public void interceptPreAccess(RequestDetails theRequestDetails,
 IPreResourceAccessDetails thePreResourceAccessDetails)

interceptPreShow

public void interceptPreShow(RequestDetails theRequestDetails,
 IPreResourceShowDetails thePreResourceShowDetails)

interceptOutgoingResponse

public void interceptOutgoingResponse(RequestDetails theRequestDetails,
 ResponseDetails theResponseDetails)

requestFailed

public void requestFailed(RequestDetails theRequest,
 ca.uhn.fhir.rest.server.exceptions.BaseServerResponseException theException)

requestSucceeded

public void requestSucceeded(RequestDetails theRequest)

getRequestDetailsForCurrentExportOperation

protected RequestDetails getRequestDetailsForCurrentExportOperation(BulkExportJobParameters theParameters,
 org.hl7.fhir.instance.model.api.IBaseResource theBaseResource)

shouldBulkExportIncludeResource

public boolean shouldBulkExportIncludeResource(BulkExportJobParameters theParameters,
 org.hl7.fhir.instance.model.api.IBaseResource theResource)