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

Interface IAuthRuleBuilder

All Known Implementing Classes:
RuleBuilder
public interface IAuthRuleBuilder
Used by AuthorizationInterceptor in order to allow user code to define authorization rules.
See Also:

  • Method Details

    • allow

      IAuthRuleBuilderRule allow()
      Start a new rule to allow a given operation

    • allow

      IAuthRuleBuilderRule allow(String theRuleName)
      Start a new rule to allow a given operation
      Parameters:
      theRuleName - The name of this rule. The rule name is used for logging and error messages, and could be shown to the client, but has no semantic meaning within HAPI FHIR.

    • allowAll

      IAuthRuleBuilderRuleOpClassifierFinished allowAll()
      This rule allows any invocation to proceed. It is intended to be used at the end of a chain that contains deny() rules in order to specify a blacklist chain.

      This call completes the rule and adds the rule to the chain.

    • allowAll

      IAuthRuleBuilderRuleOpClassifierFinished allowAll(String theRuleName)
      This rule allows any invocation to proceed. It is intended to be used at the end of a chain that contains deny() rules in order to specify a blacklist chain.

      This call completes the rule and adds the rule to the chain.

      Parameters:
      theRuleName - The name of this rule. The rule name is used for logging and error messages, and could be shown to the client, but has no semantic meaning within HAPI FHIR.

    • build

      List<IAuthRule> build()
      Build the rule list

    • deny

      IAuthRuleBuilderRule deny()
      Start a new rule to deny a given operation

    • deny

      IAuthRuleBuilderRule deny(String theRuleName)
      Start a new rule to deny a given operation
      Parameters:
      theRuleName - The name of this rule. The rule name is used for logging and error messages, and could be shown to the client, but has no semantic meaning within HAPI FHIR.

    • denyAll

      IAuthRuleBuilderRuleOpClassifierFinished denyAll()
      This rule allows any invocation to proceed. It is intended to be used at the end of a chain that contains allow() rules in order to specify a whitelist chain.

      This call completes the rule and adds the rule to the chain.

    • denyAll

      IAuthRuleBuilderRuleOpClassifierFinished denyAll(String theRuleName)
      This rule allows any invocation to proceed. It is intended to be used at the end of a chain that contains allow() rules in order to specify a whitelist chain.

      This call completes the rule and adds the rule to the chain.

      Parameters:
      theRuleName - The name of this rule. The rule name is used for logging and error messages, and could be shown to the client, but has no semantic meaning within HAPI FHIR.