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

Interface IAuthRuleTester

All Known Implementing Classes:
FhirQueryRuleTester
public interface IAuthRuleTester
Allows user-supplied logic for authorization rules.

THIS IS AN EXPERIMENTAL API! Feedback is welcome, and this API may change.

Since:
3.4.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    IAuthRuleTester.RuleTestRequest
    A request object to make this easier to extend.

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    matches(ca.uhn.fhir.rest.api.RestOperationTypeEnum theOperation, RequestDetails theRequestDetails, org.hl7.fhir.instance.model.api.IIdType theInputResourceId, org.hl7.fhir.instance.model.api.IBaseResource theInputResource)
    Deprecated. 
    default boolean
    matches(IAuthRuleTester.RuleTestRequest theRequest)
    User supplied logic called just before the parent rule renders a verdict on the operation or input resource.
    default boolean
    matchesOutput(ca.uhn.fhir.rest.api.RestOperationTypeEnum theOperation, RequestDetails theRequestDetails, org.hl7.fhir.instance.model.api.IBaseResource theOutputResource)
    Deprecated. 
    default boolean
    matchesOutput(IAuthRuleTester.RuleTestRequest theRequest)
    User supplied logic called just before the parent rule renders a verdict on an output resource.

  • Method Details

    • matches

      default boolean matches(IAuthRuleTester.RuleTestRequest theRequest)
      User supplied logic called just before the parent rule renders a verdict on the operation or input resource. Returning true will allow the verdict continue. Returning false will block the verdict and cause the rule to abstain (i.e. return null).

      THIS IS AN EXPERIMENTAL API! Feedback is welcome, and this API may change.

      Parameters:
      theRequest - The details of the operation or an INPUT resource to evaluate
      Returns:
      true if the verdict should continue
      Since:
      6.1.0

    • matches

      @Deprecated(since="6.1.0") default boolean matches(ca.uhn.fhir.rest.api.RestOperationTypeEnum theOperation, RequestDetails theRequestDetails, org.hl7.fhir.instance.model.api.IIdType theInputResourceId, org.hl7.fhir.instance.model.api.IBaseResource theInputResource)
      Deprecated.
      DO NOT IMPLEMENT - Old api. matches(RuleTestRequest) instead.

    • matchesOutput

      default boolean matchesOutput(IAuthRuleTester.RuleTestRequest theRequest)
      User supplied logic called just before the parent rule renders a verdict on an output resource. Returning true will allow the verdict continue. Returning false will block the verdict and cause the rule to abstain (i.e. return null).

      THIS IS AN EXPERIMENTAL API! Feedback is welcome, and this API may change.

      Parameters:
      theRequest - The details of the operation or an INPUT resource to evaluate
      Returns:
      true if the verdict should continue
      Since:
      6.1.0

    • matchesOutput

      @Deprecated(since="6.1.0") default boolean matchesOutput(ca.uhn.fhir.rest.api.RestOperationTypeEnum theOperation, RequestDetails theRequestDetails, org.hl7.fhir.instance.model.api.IBaseResource theOutputResource)
      Deprecated.
      DO NOT IMPLEMENT - Old api. matches(RuleTestRequest) instead.