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

Enum AuthorizationFlagsEnum

java.lang.Object

java.lang.Enum<AuthorizationFlagsEnum>

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

All Implemented Interfaces:

Serializable, Comparable<AuthorizationFlagsEnum>

public enum AuthorizationFlagsEnum
extends Enum<AuthorizationFlagsEnum>

See Also:

AuthorizationInterceptor.setFlags(Collection)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOW_PATCH_REQUEST_UNCHALLENGED
NO_NOT_PROACTIVELY_BLOCK_COMPARTMENT_READ_ACCESS If this flag is set, attempts to perform read operations (read/search/history) will be matched by the interceptor before the method handler is called.

Method Summary

Modifier and Type	Method and Description
static AuthorizationFlagsEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthorizationFlagsEnum[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_NOT_PROACTIVELY_BLOCK_COMPARTMENT_READ_ACCESS

public static final AuthorizationFlagsEnum NO_NOT_PROACTIVELY_BLOCK_COMPARTMENT_READ_ACCESS

If this flag is set, attempts to perform read operations (read/search/history) will be matched by the interceptor before the method handler is called.

For example, suppose a rule set is in place that only allows read access to compartment Patient/123. With this flag set, any attempts to perform a FHIR read/search/history operation will be permitted to proceed to the method handler, and responses will be blocked by the AuthorizationInterceptor if the response contains a resource that is not in the given compartment.

Setting this flag is less secure, since the interceptor can potentially leak information about the existence of data, but it is useful in some scenarios.

Since:

This flag has existed since HAPI FHIR 3.5.0. Prior to this version, this flag was the default and there was no ability to proactively block compartment read access.

ALLOW_PATCH_REQUEST_UNCHALLENGED

public static final AuthorizationFlagsEnum ALLOW_PATCH_REQUEST_UNCHALLENGED

Method Detail

values

public static AuthorizationFlagsEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AuthorizationFlagsEnum c : AuthorizationFlagsEnum.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AuthorizationFlagsEnum valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null