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.partition;
021
022import ca.uhn.fhir.jpa.entity.PartitionEntity;
023import ca.uhn.fhir.rest.api.server.RequestDetails;
024import ca.uhn.fhir.rest.server.exceptions.ResourceNotFoundException;
025import jakarta.annotation.Nullable;
026
027import java.util.List;
028
029public interface IPartitionLookupSvc {
030
031        /**
032         * This is mostly here for unit test purposes. Regular code is not expected to call this method directly.
033         */
034        void start();
035
036        /**
037         * @throws ResourceNotFoundException If the name is not known
038         */
039        @Nullable
040        PartitionEntity getPartitionByName(String theName) throws ResourceNotFoundException;
041
042        /**
043         * @throws ResourceNotFoundException If the ID is not known
044         */
045        PartitionEntity getPartitionById(Integer theId) throws ResourceNotFoundException;
046
047        void invalidateCaches();
048
049        /**
050         * Will generate a random unused partition ID. Validates that no partition with that ID exists before returning.
051         *
052         * @return an integer, representing a random unused partition ID.
053         */
054        int generateRandomUnusedPartitionId();
055
056        PartitionEntity createPartition(PartitionEntity thePartition, RequestDetails theRequestDetails);
057
058        PartitionEntity updatePartition(PartitionEntity thePartition);
059
060        void deletePartition(Integer thePartitionId);
061
062        List<PartitionEntity> listPartitions();
063}