src/jalview/ext/ensembl/EnsemblData.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ext.ensembl;
  22
  23 /**
  24  * A data class to model the data and rest version of one Ensembl domain,
  25  * currently for rest.ensembl.org and rest.ensemblgenomes.org.
  26  * <p>
  27  * April 2019 reduced to rest.ensembl.org only
  28  *
  29  * @author gmcarstairs
  30  */
  31 class EnsemblData
  32 {
  33   /*
  34    * The http domain this object is holding data values for
  35    */
  36   String domain;
  37
  38   /*
  39    * The latest version Jalview has tested for, e.g. "4.5"; a minor version change should be
  40    * ok, a major version change may break stuff
  41    */
  42   String expectedRestVersion;
  43
  44   /*
  45    * Major / minor / point version e.g. "4.5.1"
  46    * @see http://rest.ensembl.org/info/rest/?content-type=application/json
  47    */
  48   String restVersion;
  49
  50   /*
  51    * data version
  52    * @see http://rest.ensembl.org/info/data/?content-type=application/json
  53    */
  54   String dataVersion;
  55
  56   /*
  57    * true when http://rest.ensembl.org/info/ping/?content-type=application/json
  58    * returns response code 200 and not {"error":"Database is unavailable"}
  59    */
  60   boolean restAvailable;
  61
  62   /*
  63    * absolute time when availability was last checked
  64    */
  65   long lastAvailableCheckTime;
  66
  67   /*
  68    * absolute time when version numbers were last checked
  69    */
  70   long lastVersionCheckTime;
  71
  72   // flag set to true if REST major version is not the one expected
  73   boolean restMajorVersionMismatch;
  74
  75   /*
  76    * absolute time to wait till if we overloaded the REST service
  77    */
  78   long retryAfter;
  79
  80   /**
  81    * Constructor given expected REST version number e.g 4.5 or 3.4.3
  82    *
  83    * @param restExpected
  84    */
  85   EnsemblData(String theDomain, String restExpected)
  86   {
  87     domain = theDomain;
  88     expectedRestVersion = restExpected;
  89     lastAvailableCheckTime = -1;
  90     lastVersionCheckTime = -1;
  91   }
  92
  93 }