DatabaseServices.java

/* 
 * Licensed under the Apache License, Version 2.0 (the "License");
 *
 * You may not use this file except in compliance with the License.
 *
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Contributions from 2013-2017 where performed either by US government 
 * employees, or under US Veterans Health Administration contracts. 
 *
 * US Veterans Health Administration contributions by government employees
 * are work of the U.S. Government and are not subject to copyright
 * protection in the United States. Portions contributed by government 
 * employees are USGovWork (17USC §105). Not subject to copyright. 
 * 
 * Contribution by contractors to the US Veterans Health Administration
 * during this period are contractually contributed under the
 * Apache License, Version 2.0.
 *
 * See: https://www.usa.gov/government-works
 * 
 * Contributions prior to 2013:
 *
 * Copyright (C) International Health Terminology Standards Development Organisation.
 * Licensed under the Apache License, Version 2.0.
 *
 */



package sh.isaac.api;

//~--- JDK imports ------------------------------------------------------------

import java.nio.file.Path;

//~--- non-JDK imports --------------------------------------------------------

import org.jvnet.hk2.annotations.Contract;

//~--- interfaces -------------------------------------------------------------

/**
 * Contract used to validate that databases & lucene directories uniformly exist and are uniformly populated during startup. If fails, signals that
 * database is corrupted and force a pull of new database. Launched via {@link LookupService}
 *
 * @author Jesse Efron
 */
@Contract
public interface DatabaseServices {
   /**
    * The Enum DatabaseValidity.
    */
   public enum DatabaseValidity {
      /** The not set. */
      NOT_SET,

      /** The missing directory. */
      MISSING_DIRECTORY,

      /** The empty directory. */
      EMPTY_DIRECTORY,

      /** The populated directory. */
      POPULATED_DIRECTORY
   }

   ;

   //~--- methods -------------------------------------------------------------

   /**
    * Clear database validity value.
    */

   /*
    * Clear flag indicating that database has had its validity calculated. Will force a real-time investigation second time through
    */
   void clearDatabaseValidityValue();

   //~--- get methods ---------------------------------------------------------

   /**
    * Gets the database folder.
    *
    * @return the database folder
    */

   /*
    * Flag indicating that folder path of the database.
    */
   public Path getDatabaseFolder();

   /**
    * Gets the database validity status.
    *
    * @return the database validity status
    */

   /*
    * get database validity status
    */
   public DatabaseValidity getDatabaseValidityStatus();
}