ca.uhn.fhir.rest.server.interceptor.auth.IAuthRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hapi-fhir-android Show documentation

There is a newer version: 7.6.1

package ca.uhn.fhir.rest.server.interceptor.auth;

/*
 * #%L
 * HAPI FHIR - Core Library
 * %%
 * Copyright (C) 2014 - 2016 University Health Network
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import org.hl7.fhir.instance.model.api.IBaseResource;
import org.hl7.fhir.instance.model.api.IIdType;

import ca.uhn.fhir.rest.api.RestOperationTypeEnum;
import ca.uhn.fhir.rest.method.RequestDetails;
import ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor.Verdict;

public interface IAuthRule {

	/**
	 * Applies the rule and returns a policy decision, or null if the rule does not apply
	 * 
	 * @param theOperation
	 *           The operation type
	 * @param theRequestDetails
	 *           The request
	 * @param theInputResource
	 *           The resource being input by the client, or null
	 * @param theInputResourceId TODO
	 * @param theOutputResource
	 *           The resource being returned by the server, or null
	 * @param 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)
	 * @return Returns a policy decision, or null if the rule does not apply
	 */
	Verdict applyRule(RestOperationTypeEnum theOperation, RequestDetails theRequestDetails, IBaseResource theInputResource, IIdType theInputResourceId, IBaseResource theOutputResource, IRuleApplier theRuleApplier);

	/**
	 * Returns a name for this rule, to be used in logs and error messages
	 */
	String getName();

}