001/*-
002 * #%L
003 * HAPI FHIR - Server Framework
004 * %%
005 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.rest.server.interceptor.auth;
021
022public interface IAuthRuleBuilderOperationNamedAndScoped {
023
024        /**
025         * Responses for this operation will not be checked
026         */
027        IAuthRuleBuilderRuleOpClassifierFinished andAllowAllResponses();
028
029        /**
030         * Responses for this operation will not be checked and access to all resources is allowed. This
031         * is intended for operations which are known to fetch a graph of resources that is known to be
032         * safe, such as `$everything` which may access and fetch resources outside the patient's compartment
033         * but enforces safety in what it fetches via strict SQL queries.
034         */
035        IAuthRuleBuilderRuleOpClassifierFinished andAllowAllResponsesWithAllResourcesAccess();
036
037        /**
038         * Responses for this operation must be authorized by other rules. For example, if this
039         * rule is authorizing the Patient $everything operation, there must be a separate
040         * rule (or rules) that actually authorize the user to read the
041         * resources being returned
042         */
043        IAuthRuleBuilderRuleOpClassifierFinished andRequireExplicitResponseAuthorization();
044}