001package ca.uhn.fhir.jpa.search.reindex;
002
003/*-
004 * #%L
005 * HAPI FHIR JPA Server
006 * %%
007 * Copyright (C) 2014 - 2021 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
023public interface IResourceReindexingSvc {
024
025        /**
026         * Marks all indexes as needing fresh indexing
027         *
028         * @return Returns the job ID
029         */
030        Long markAllResourcesForReindexing();
031
032        /**
033         * Marks all indexes of the given type as needing fresh indexing
034         *
035         * @return Returns the job ID
036         */
037        Long markAllResourcesForReindexing(String theType);
038
039        /**
040         * @return Returns null if the system did not attempt to perform a pass because one was
041         * already proceeding. Otherwise, returns the number of resources affected.
042         */
043        Integer runReindexingPass();
044
045        /**
046         * Does the same thing as {@link #runReindexingPass()} but makes sure to perform at
047         * least one pass even if one is half finished
048         */
049        int forceReindexingPass();
050
051        /**
052         * Cancels all running and future reindexing jobs. This is mainly intended
053         * to be used by unit tests.
054         */
055        void cancelAndPurgeAllJobs();
056
057        int countReindexJobs();
058}