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 org.hl7.fhir.instance.model.api.IBaseResource;
023import org.hl7.fhir.instance.model.api.IIdType;
024
025import java.util.Collection;
026
027public interface IAuthRuleBuilderOperationNamed {
028
029        /**
030         * Rule applies to invocations of this operation at the <code>server</code> level
031         */
032        IAuthRuleBuilderOperationNamedAndScoped onServer();
033
034        /**
035         * Rule applies to invocations of this operation at the <code>type</code> level
036         */
037        IAuthRuleBuilderOperationNamedAndScoped onType(Class<? extends IBaseResource> theType);
038
039        /**
040         * Rule applies to invocations of this operation at the <code>type</code> level on any type
041         */
042        IAuthRuleBuilderOperationNamedAndScoped onAnyType();
043
044        /**
045         * Rule applies to invocations of this operation at the <code>instance</code> level
046         */
047        IAuthRuleBuilderOperationNamedAndScoped onInstance(IIdType theInstanceId);
048
049        IAuthRuleBuilderOperationNamedAndScoped onInstances(Collection<IIdType> theInstanceIds);
050
051        /**
052         * Rule applies to invocations of this operation at the <code>instance</code> level on any instance of the given type
053         */
054        IAuthRuleBuilderOperationNamedAndScoped onInstancesOfType(Class<? extends IBaseResource> theType);
055
056        /**
057         * Rule applies to invocations of this operation at the <code>instance</code> level on any instance
058         */
059        IAuthRuleBuilderOperationNamedAndScoped onAnyInstance();
060
061        /**
062         * Rule applies to invocations of this operation at any level (server, type or instance)
063         */
064        IAuthRuleBuilderOperationNamedAndScoped atAnyLevel();
065}