Package ca.uhn.fhir.interceptor.auth

Class CompartmentSearchParameterModifications

java.lang.Object

ca.uhn.fhir.interceptor.auth.CompartmentSearchParameterModifications

public class CompartmentSearchParameterModifications
extends Object

This class is used in RuleBuilder, as a way to allow adding or removing certain Search Parameters to the compartment. For example, if you were to add as additional SPs [device -> ["patient", "subject"] and apply it to compartment Patient/123, then any device with Patient/123 as its patient would be considered "in" the compartment, despite the fact that device is technically not part of the compartment definition for patient.

Constructor Summary

Constructors

Constructor	Description
CompartmentSearchParameterModifications()

Method Summary

Modifier and Type	Method	Description
void	addSPToIncludeInCompartment(String theResourceType, String theSPName)	Add an SP, not in the compartment, that will now be included hereafter
void	addSPToOmitFromCompartment(String theResourceType, String theSPName)	Add an SP, normally included in the compartment, that will be omitted hereafter.
static CompartmentSearchParameterModifications	fromAdditionalAndOmittedSPNames(String theResourceType, Set<String> theAdditionalSPs, Set<String> theOmittedSps)	Construct compartment modifications from resource type and sets of SP names to add or omit respectively.
static CompartmentSearchParameterModifications	fromAdditionalCompartmentParamNames(String theResourceType, Set<String> theAdditionalCompartmentParamNames)
Set<String>	getAdditionalSearchParamNamesForResourceType(String theResourceType)
Set<String>	getOmittedSPNamesForResourceType(String theResourceType)

Methods inherited from class java.lang.Object

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

Constructor Details

CompartmentSearchParameterModifications

public CompartmentSearchParameterModifications()

Method Details

fromAdditionalAndOmittedSPNames

public static CompartmentSearchParameterModifications fromAdditionalAndOmittedSPNames(@Nonnull
 String theResourceType,
 @Nonnull
 Set<String> theAdditionalSPs,
 @Nonnull
 Set<String> theOmittedSps)

Construct compartment modifications from resource type and sets of SP names to add or omit respectively.

Parameters:

theResourceType - the resource type the SPs are based on

theAdditionalSPs - the additional SP names

theOmittedSps - the omitted SP names

Returns:

fromAdditionalCompartmentParamNames

public static CompartmentSearchParameterModifications fromAdditionalCompartmentParamNames(String theResourceType,
 @Nonnull
 Set<String> theAdditionalCompartmentParamNames)

addSPToOmitFromCompartment

public void addSPToOmitFromCompartment(String theResourceType,
 String theSPName)

Add an SP, normally included in the compartment, that will be omitted hereafter.

Parameters:

theResourceType - the resource type on which the SP exists

theSPName - the name of the search parameter

addSPToIncludeInCompartment

public void addSPToIncludeInCompartment(String theResourceType,
 String theSPName)

Add an SP, not in the compartment, that will now be included hereafter

Parameters:

theResourceType - the resource type on which the SP exists

theSPName - the name of the search parameter

getAdditionalSearchParamNamesForResourceType

public Set<String> getAdditionalSearchParamNamesForResourceType(@Nonnull
 String theResourceType)

getOmittedSPNamesForResourceType

public Set<String> getOmittedSPNamesForResourceType(String theResourceType)