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

Class AuthorizedList

java.lang.Object

ca.uhn.fhir.rest.server.interceptor.auth.AuthorizedList

public class AuthorizedList
extends Object

Return type for SearchNarrowingInterceptor.buildAuthorizedList(RequestDetails)

Constructor Summary

Constructors

Constructor	Description
AuthorizedList()

Method Summary

Modifier and Type	Method	Description
AuthorizedList	addCodeInValueSet(String theResourceName, String theSearchParameterName, String theValueSetUrl)	If specified, any search for theResourceName will automatically include a parameter indicating that the token search parameter theSearchParameterName must have a value in the ValueSet with URL theValueSetUrl.
AuthorizedList	addCodeNotInValueSet(String theResourceName, String theSearchParameterName, String theValueSetUrl)	If specified, any search for theResourceName will automatically include a parameter indicating that the token search parameter theSearchParameterName must have a value not in the ValueSet with URL theValueSetUrl.
AuthorizedList	addCompartment(String theCompartment)	Adds a compartment that the user should be allowed to access
AuthorizedList	addCompartments(String... theCompartments)	Adds a compartment that the user should be allowed to access
AuthorizedList	addResource(String theResource)	Adds a resource that the user should be allowed to access
AuthorizedList	addResources(String... theResources)	Adds a resource that the user should be allowed to access

Methods inherited from class java.lang.Object

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

Constructor Details

AuthorizedList

public AuthorizedList()

Method Details

addCompartment

public AuthorizedList addCompartment(String theCompartment)

Adds a compartment that the user should be allowed to access

Parameters:

theCompartment - The compartment name, e.g. "Patient/123" (in this example the user would be allowed to access Patient/123 as well as Observations where Observation.subject="Patient/123"m, etc.

Returns:

Returns this for easy method chaining

addCompartments

public AuthorizedList addCompartments(String... theCompartments)

Adds a compartment that the user should be allowed to access

Parameters:

theCompartments - The compartment names, e.g. "Patient/123" (in this example the user would be allowed to access Patient/123 as well as Observations where Observation.subject="Patient/123"m, etc.

Returns:

Returns this for easy method chaining

addResource

public AuthorizedList addResource(String theResource)

Adds a resource that the user should be allowed to access

Parameters:

theResource - The resource name, e.g. "Patient/123" (in this example the user would be allowed to access Patient/123 but not Observations where Observation.subject="Patient/123"m, etc.

Returns:

Returns this for easy method chaining

addResources

public AuthorizedList addResources(String... theResources)

Adds a resource that the user should be allowed to access

Parameters:

theResources - The resource names, e.g. "Patient/123" (in this example the user would be allowed to access Patient/123 but not Observations where Observation.subject="Patient/123"m, etc.

Returns:

Returns this for easy method chaining

addCodeInValueSet

public AuthorizedList addCodeInValueSet(@Nonnull
 String theResourceName,
 @Nonnull
 String theSearchParameterName,
 @Nonnull
 String theValueSetUrl)

If specified, any search for theResourceName will automatically include a parameter indicating that the token search parameter theSearchParameterName must have a value in the ValueSet with URL theValueSetUrl.

Parameters:

theResourceName - The resource name, e.g. Observation

theSearchParameterName - The search parameter name, e.g. code

theValueSetUrl - The valueset URL, e.g. http://my-value-set

Returns:

Returns a reference to this for easy chaining

Since:

6.0.0

See Also:

• If search narrowing by code is being used for security reasons, consider also using AuthorizationInterceptor as a failsafe to ensure that no inapproproiate resources are returned

addCodeNotInValueSet

public AuthorizedList addCodeNotInValueSet(@Nonnull
 String theResourceName,
 @Nonnull
 String theSearchParameterName,
 @Nonnull
 String theValueSetUrl)

If specified, any search for theResourceName will automatically include a parameter indicating that the token search parameter theSearchParameterName must have a value not in the ValueSet with URL theValueSetUrl.

Parameters:

theResourceName - The resource name, e.g. Observation

theSearchParameterName - The search parameter name, e.g. code

theValueSetUrl - The valueset URL, e.g. http://my-value-set

Returns:

Returns a reference to this for easy chaining

Since:

6.0.0

See Also:

• If search narrowing by code is being used for security reasons, consider also using AuthorizationInterceptor as a failsafe to ensure that no inapproproiate resources are returned