001package ca.uhn.fhir.rest.server.tenant;
002
003/*-
004 * #%L
005 * HAPI FHIR - Server Framework
006 * %%
007 * Copyright (C) 2014 - 2023 Smile CDR, Inc.
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import ca.uhn.fhir.rest.api.server.RequestDetails;
024import ca.uhn.fhir.util.UrlPathTokenizer;
025
026public interface ITenantIdentificationStrategy {
027
028        /**
029         * Implementations should use this method to determine the tenant ID
030         * based on the incoming request andand populate it in the
031         * {@link RequestDetails#setTenantId(String)}.
032         *
033         * @param theUrlPathTokenizer The tokenizer which is used to parse the request path
034         * @param theRequestDetails   The request details object which can be used to access headers and to populate the tenant ID to
035         */
036        void extractTenant(UrlPathTokenizer theUrlPathTokenizer, RequestDetails theRequestDetails);
037
038        /**
039         * Implementations may use this method to tweak the server base URL
040         * if necessary based on the tenant ID
041         */
042        String massageServerBaseUrl(String theFhirServerBase, RequestDetails theRequestDetails);
043}