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
022import jakarta.annotation.Nullable;
023
024import java.util.List;
025
026public interface IAuthRuleFinished {
027
028        /**
029         * Start another rule
030         */
031        IAuthRuleBuilder andThen();
032
033        /**
034         * Build the rule list
035         */
036        List<IAuthRule> build();
037
038        /**
039         * Add an additional tester that will be queried if all other conditions
040         * of this rule already match. For example, given the following rule
041         * <pre>
042         * return new RuleBuilder()
043         *   .allow("Rule 1").operation().named("everything").onInstancesOfType(Patient.class).withTester(myTester)
044         *   .build();
045         * </pre>
046         * ..the tester will be invoked on any $everything operations on Patient
047         * resources as a final check as to whether the rule applies or not. In this
048         * example, the tester is not invoked for other operations.
049         *
050         * @param theTester The tester to add, or <code>null</code>
051         */
052        IAuthRuleFinished withTester(@Nullable IAuthRuleTester theTester);
053
054        /**
055         * Narrow this rule to resources matching the given FHIR query.
056         * @param theQueryParameters a FHIR query parameter string.  E.g. category=laboratory&date=ge2021
057         */
058        IAuthRuleFinished withFilterTester(String theQueryParameters);
059}