001/*
002 * #%L
003 * HAPI FHIR - Server Framework
004 * %%
005 * Copyright (C) 2014 - 2023 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;
021
022import ca.uhn.fhir.rest.annotation.IdParam;
023import ca.uhn.fhir.rest.annotation.Read;
024import ca.uhn.fhir.rest.api.server.RequestDetails;
025import org.hl7.fhir.instance.model.api.IBaseResource;
026import org.hl7.fhir.instance.model.api.IIdType;
027
028import javax.servlet.http.HttpServletRequest;
029
030public interface IServerConformanceProvider<T extends IBaseResource> {
031
032        /**
033         * Actually create and return the conformance statement
034         *
035         * See the class documentation for an important note if you are extending this class
036         */
037        T getServerConformance(HttpServletRequest theRequest, RequestDetails theRequestDetails);
038
039        @Read(typeName = "OperationDefinition")
040        default IBaseResource readOperationDefinition(@IdParam IIdType theId, RequestDetails theRequestDetails) {
041                return null;
042        }
043
044        /**
045         * This setter is needed in implementation classes (along with
046         * a no-arg constructor) to avoid reference cycles in the
047         * Spring wiring of a RestfulServer instance.
048         *
049         * @param theRestfulServer
050         */
051        void setRestfulServer(RestfulServer theRestfulServer);
052}