001/*-
002 * #%L
003 * HAPI FHIR JPA Server
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.jpa.esr;
021
022import org.hl7.fhir.instance.model.api.IBaseResource;
023
024public interface IExternallyStoredResourceService {
025
026        /**
027         * Returns the ID of this provider. No two providers may return the same
028         * ID, and this provider should always return the same ID.
029         */
030        String getId();
031
032        /**
033         * Fetches the given resource using the given address string
034         *
035         * @param theAddress The address string is a format that is entirely up to the individual provider. HAPI FHIR
036         *                   doesn't try to understand it.
037         * @return HAPI FHIR may modify the returned object, so it is important to always return a new object for every call here (careful with caching!)
038         */
039        IBaseResource fetchResource(String theAddress);
040}