Interface IAuthRule

All Known Implementing Classes:
RuleBulkExportImpl, RuleImplConditional

public interface IAuthRule
Note: At this time, this interface is considered internal API to HAPI FHIR, and is subject to change without warning. Create your own implementations at your own risk. If you have use cases that are not met by the current implementation, please consider raising them on the HAPI FHIR Google Group.
  • Method Summary

    Modifier and Type
    Method
    Description
    applyRule(ca.uhn.fhir.rest.api.RestOperationTypeEnum theOperation, RequestDetails theRequestDetails, org.hl7.fhir.instance.model.api.IBaseResource theInputResource, org.hl7.fhir.instance.model.api.IIdType theInputResourceId, org.hl7.fhir.instance.model.api.IBaseResource theOutputResource, IRuleApplier theRuleApplier, Set<AuthorizationFlagsEnum> theFlags, ca.uhn.fhir.interceptor.api.Pointcut thePointcut)
    Applies the rule and returns a policy decision, or null if the rule does not apply
    Returns a name for this rule, to be used in logs and error messages
  • Method Details

    • applyRule

      AuthorizationInterceptor.Verdict applyRule(ca.uhn.fhir.rest.api.RestOperationTypeEnum theOperation, RequestDetails theRequestDetails, org.hl7.fhir.instance.model.api.IBaseResource theInputResource, org.hl7.fhir.instance.model.api.IIdType theInputResourceId, org.hl7.fhir.instance.model.api.IBaseResource theOutputResource, IRuleApplier theRuleApplier, Set<AuthorizationFlagsEnum> theFlags, ca.uhn.fhir.interceptor.api.Pointcut thePointcut)
      Applies the rule and returns a policy decision, or null if the rule does not apply
      Parameters:
      theOperation - The operation type
      theRequestDetails - The request
      theInputResource - The resource being input by the client, or null
      theInputResourceId - TODO
      theOutputResource - The resource being returned by the server, or null
      theRuleApplier - The rule applying module (this can be used by rules to apply the rule set to nested objects in the request, such as nested requests in a transaction)
      theFlags - The flags configured in the authorization interceptor
      thePointcut - The pointcut hook that triggered this call
      Returns:
      Returns a policy decision, or null if the rule does not apply
    • getName

      Returns a name for this rule, to be used in logs and error messages