X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fext%2Fensembl%2FEnsemblRestClient.java;h=771980c11b600495fbc6aa6443477362bb745f1a;hb=refs%2Fheads%2FJAL-3253-applet-SwingJS-omnibus;hp=02b13ef6f3f8a85d05ee18a2528bb2d62a7f195d;hpb=f9b80711054b61e8c2257488a1637e15616cb9c9;p=jalview.git
diff --git a/src/jalview/ext/ensembl/EnsemblRestClient.java b/src/jalview/ext/ensembl/EnsemblRestClient.java
index 02b13ef..771980c 100644
--- a/src/jalview/ext/ensembl/EnsemblRestClient.java
+++ b/src/jalview/ext/ensembl/EnsemblRestClient.java
@@ -1,19 +1,44 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
package jalview.ext.ensembl;
-import jalview.io.FileParse;
-
import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStream;
-import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
+import java.net.ProtocolException;
import java.net.URL;
+import java.util.HashMap;
import java.util.List;
+import java.util.Map;
import javax.ws.rs.HttpMethod;
+import org.json.simple.parser.ParseException;
+
+import jalview.util.Platform;
+import jalview.util.StringUtils;
+
/**
* Base class for Ensembl REST service clients
*
@@ -21,22 +46,87 @@ import javax.ws.rs.HttpMethod;
*/
abstract class EnsemblRestClient extends EnsemblSequenceFetcher
{
- protected final static String ENSEMBL_REST = "http://rest.ensembl.org";
- protected static final String SEQUENCE_ID_URL = ENSEMBL_REST
- + "/sequence/id";
+ static
+ {
+ Platform.addJ2SDirectDatabaseCall("http://rest.ensembl");
+ Platform.addJ2SDirectDatabaseCall("https://rest.ensembl");
+ }
+
+ private static final int DEFAULT_READ_TIMEOUT = 5 * 60 * 1000; // 5 minutes
+
+ private static final int CONNECT_TIMEOUT_MS = 10 * 1000; // 10 seconds
- // @see https://github.com/Ensembl/ensembl-rest/wiki/Output-formats
- private static final String PING_URL = "http://rest.ensembl.org/info/ping.json";
+ private static final int MAX_RETRIES = 3;
- private final static long RETEST_INTERVAL = 10000L; // 10 seconds
+ private static final int HTTP_OK = 200;
- private static boolean ensemblRestAvailable = false;
+ private static final int HTTP_OVERLOAD = 429;
- private static long lastCheck = -1;
+ /*
+ * update these constants when Jalview has been checked / updated for
+ * changes to Ensembl REST API, and updated JAL-3018
+ * @see https://github.com/Ensembl/ensembl-rest/wiki/Change-log
+ * @see http://rest.ensembl.org/info/rest?content-type=application/json
+ */
+ private static final String LATEST_ENSEMBLGENOMES_REST_VERSION = "10.0";
+
+ private static final String LATEST_ENSEMBL_REST_VERSION = "10.0";
+
+ private static final String REST_CHANGE_LOG = "https://github.com/Ensembl/ensembl-rest/wiki/Change-log";
+
+ private static Map domainData;
+
+ private final static long AVAILABILITY_RETEST_INTERVAL = 10000L; // 10 seconds
+
+ private final static long VERSION_RETEST_INTERVAL = 1000L * 3600; // 1 hr
+
+ protected static final String CONTENT_TYPE_JSON = "?content-type=application/json";
+
+ static
+ {
+ domainData = new HashMap<>();
+ domainData.put(DEFAULT_ENSEMBL_BASEURL, new EnsemblData(
+ DEFAULT_ENSEMBL_BASEURL, LATEST_ENSEMBL_REST_VERSION));
+ domainData.put(DEFAULT_ENSEMBL_GENOMES_BASEURL,
+ new EnsemblData(DEFAULT_ENSEMBL_GENOMES_BASEURL,
+ LATEST_ENSEMBLGENOMES_REST_VERSION));
+ }
protected volatile boolean inProgress = false;
+ /**
+ * Default constructor to use rest.ensembl.org
+ */
+ public EnsemblRestClient()
+ {
+ super();
+
+ /*
+ * initialise domain info lazily
+ */
+ if (!domainData.containsKey(ensemblDomain))
+ {
+ domainData.put(ensemblDomain,
+ new EnsemblData(ensemblDomain, LATEST_ENSEMBL_REST_VERSION));
+ }
+ if (!domainData.containsKey(ensemblGenomesDomain))
+ {
+ domainData.put(ensemblGenomesDomain, new EnsemblData(
+ ensemblGenomesDomain, LATEST_ENSEMBLGENOMES_REST_VERSION));
+ }
+ }
+
+ /**
+ * Constructor given the target domain to fetch data from
+ *
+ * @param d
+ */
+ public EnsemblRestClient(String d)
+ {
+ setDomain(d);
+ }
+
@Override
public boolean queryInProgress()
{
@@ -67,113 +157,286 @@ abstract class EnsemblRestClient extends EnsemblSequenceFetcher
protected abstract boolean useGetRequest();
/**
- * Return the desired value for the Content-Type request header
+ * Returns the desired value for the Content-Type request header. Default is
+ * application/json, override if required to vary this.
*
* @return
* @see https://github.com/Ensembl/ensembl-rest/wiki/HTTP-Headers
*/
- protected abstract String getRequestMimeType();
+ protected String getRequestMimeType()
+ {
+ return "application/json";
+ }
/**
- * Return the desired value for the Accept request header
+ * Return the desired value for the Accept request header. Default is
+ * application/json, override if required to vary this.
*
* @return
* @see https://github.com/Ensembl/ensembl-rest/wiki/HTTP-Headers
*/
- protected abstract String getResponseMimeType();
+ protected String getResponseMimeType()
+ {
+ return "application/json";
+ }
/**
- * Tries to connect to Ensembl's REST 'ping' endpoint, and returns true if
- * successful, else false
+ * Checks Ensembl's REST 'ping' endpoint, and returns true if response
+ * indicates available, else false
*
+ * @see http://rest.ensembl.org/documentation/info/ping
* @return
*/
- private boolean checkEnsembl()
+ @SuppressWarnings("unchecked")
+ boolean checkEnsembl()
{
+ BufferedReader br = null;
+ String pingUrl = getDomain() + "/info/ping" + CONTENT_TYPE_JSON;
try
{
- URL ping = new URL(PING_URL);
- HttpURLConnection conn = (HttpURLConnection) ping.openConnection();
- int rc = conn.getResponseCode();
- conn.disconnect();
- if (rc >= 200 && rc < 300)
+ // note this format works for both ensembl and ensemblgenomes
+ // info/ping.json works for ensembl only (March 2016)
+
+ /*
+ * expect {"ping":1} if ok
+ * if ping takes more than 2 seconds to respond, treat as if unavailable
+ */
+ Map val = (Map) getJSON(
+ new URL(pingUrl), null, 2 * 1000, MODE_MAP, null);
+ if (val == null)
{
- return true;
+ return false;
}
+ String pingString = val.get("ping").toString();
+ return pingString != null;
} catch (Throwable t)
{
- System.err.println("Error connecting to " + PING_URL + ": "
- + t.getMessage());
+ System.err.println(
+ "Error connecting to " + pingUrl + ": " + t.getMessage());
+ } finally
+ {
+ if (br != null)
+ {
+ try
+ {
+ br.close();
+ } catch (IOException e)
+ {
+ // ignore
+ }
+ }
}
return false;
}
+ protected final static int MODE_ARRAY = 0;
+
+ protected final static int MODE_MAP = 1;
+
+ protected final static int MODE_ITERATOR = 2;
+
+ // /**
+ // * Returns a reader to a (Json) response from the Ensembl sequence endpoint.
+ // * If the request failed the return value may be null.
+ // *
+ // * @param ids
+ // * @return
+ // * @throws IOException
+ // * @throws ParseException
+ // */
+ // protected Object getSequenceJSON(List ids, int mode)
+ // throws IOException, ParseException
+ // {
+ // URL url = getUrl(ids);
+ // return getJSON(url, ids, -1, mode);
+ // }
+ //
+ // /**
+ // * Gets a reader to the HTTP response, using the default read timeout of 5
+ // * minutes
+ // *
+ // * @param url
+ // * @param ids
+ // * @return
+ // * @throws IOException
+ // */
+ // protected BufferedReader getHttpResponse(URL url, List ids)
+ // throws IOException
+ // {
+ // return getHttpResponse(url, ids, DEFAULT_READ_TIMEOUT);
+ // }
+
/**
- * returns a reader to a Fasta response from the Ensembl sequence endpoint
+ * Sends the HTTP request and gets the response as a reader. Returns null if
+ * the HTTP response code was not 200.
*
+ * @param url
* @param ids
+ * written as Json POST body if more than one
+ * @param readTimeout
+ * in milliseconds
* @return
* @throws IOException
+ * @throws ParseException
*/
- protected FileParse getSequenceReader(List ids)
- throws IOException
+ private Object getJSON(URL url, List ids, int readTimeout)
+ throws IOException, ParseException
{
- URL url = getUrl(ids);
-
+
+ if (readTimeout < 0)
+ {
+ readTimeout = DEFAULT_READ_TIMEOUT;
+ }
+ int retriesLeft = MAX_RETRIES;
+ HttpURLConnection connection = null;
+ int responseCode = 0;
+
+ Platform.setAjaxJSON(url);
+
+ while (retriesLeft > 0)
+ {
+ connection = tryConnection(url, ids, readTimeout);
+ responseCode = connection.getResponseCode();
+ if (responseCode == HTTP_OVERLOAD) // 429
+ {
+ retriesLeft--;
+ checkRetryAfter(connection);
+ }
+ else
+ {
+ retriesLeft = 0;
+ }
+ }
+ if (responseCode != HTTP_OK) // 200
+ {
+ /*
+ * note: a GET request for an invalid id returns an error code e.g. 415
+ * but POST request returns 200 and an empty Fasta response
+ */
+ System.err.println("Response code " + responseCode);// + " for " + url);
+ return null;
+ }
+
+ InputStream response = connection.getInputStream();
+
+ // Platform.timeCheck(null, Platform.TIME_MARK);
+ Object ret = Platform.parseJSON(response);
+ // Platform.timeCheck("EnsemblRestClient.getJSON " + url,
+ // Platform.TIME_MARK);
+
+ return ret;
+ }
+
+ /**
+ * @param url
+ * @param ids
+ * @param readTimeout
+ * @return
+ * @throws IOException
+ * @throws ProtocolException
+ */
+ protected HttpURLConnection tryConnection(URL url, List ids,
+ int readTimeout) throws IOException, ProtocolException
+ {
+ // System.out.println(System.currentTimeMillis() + " " + url);
+
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
-
+
/*
* POST method allows multiple queries in one request; it is supported for
* sequence queries, but not for overlap
*/
- connection.setRequestMethod(useGetRequest() ? HttpMethod.GET
- : HttpMethod.POST);
+ boolean multipleIds = ids != null && ids.size() > 1;
+ connection.setRequestMethod(
+ multipleIds ? HttpMethod.POST : HttpMethod.GET);
connection.setRequestProperty("Content-Type", getRequestMimeType());
connection.setRequestProperty("Accept", getResponseMimeType());
- connection.setUseCaches(false);
connection.setDoInput(true);
- connection.setDoOutput(true);
+ connection.setDoOutput(multipleIds);
+
+ connection.setUseCaches(false);
+ connection.setConnectTimeout(CONNECT_TIMEOUT_MS);
+ connection.setReadTimeout(readTimeout);
- if (!useGetRequest())
+ if (multipleIds)
{
writePostBody(connection, ids);
}
-
- InputStream response = connection.getInputStream();
- int responseCode = connection.getResponseCode();
-
- if (responseCode != 200)
+ return connection;
+ }
+
+ /**
+ * Inspects response headers for a 'retry-after' directive, and waits for the
+ * directed period (if less than 10 seconds)
+ *
+ * @see https://github.com/Ensembl/ensembl-rest/wiki/Rate-Limits
+ * @param connection
+ */
+ void checkRetryAfter(HttpURLConnection connection)
+ {
+ String retryDelay = connection.getHeaderField("Retry-After");
+
+ // to test:
+ // retryDelay = "5";
+
+ if (retryDelay != null)
{
- throw new RuntimeException(
- "Response code was not 200. Detected response was "
- + responseCode);
+ try
+ {
+ int retrySecs = Integer.valueOf(retryDelay);
+ if (retrySecs > 0 && retrySecs < 10)
+ {
+ System.err.println(
+ "Ensembl REST service rate limit exceeded, waiting "
+ + retryDelay + " seconds before retrying");
+ Thread.sleep(1000 * retrySecs);
+ }
+ } catch (NumberFormatException | InterruptedException e)
+ {
+ System.err.println("Error handling Retry-After: " + e.getMessage());
+ }
}
-
- BufferedReader reader = null;
- reader = new BufferedReader(new InputStreamReader(response, "UTF-8"));
- FileParse fp = new FileParse(reader, url.toString(), "HTTP_POST");
- return fp;
}
/**
* Rechecks if Ensembl is responding, unless the last check was successful and
* the retest interval has not yet elapsed. Returns true if Ensembl is up,
- * else false.
+ * else false. Also retrieves and saves the current version of Ensembl data
+ * and REST services at intervals.
*
* @return
*/
protected boolean isEnsemblAvailable()
{
+ EnsemblData info = domainData.get(getDomain());
+
long now = System.currentTimeMillis();
- boolean retest = now - lastCheck > RETEST_INTERVAL;
- if (ensemblRestAvailable && !retest)
+
+ /*
+ * recheck if Ensembl is up if it was down, or the recheck period has elapsed
+ */
+ boolean retestAvailability = (now
+ - info.lastAvailableCheckTime) > AVAILABILITY_RETEST_INTERVAL;
+ if (!info.restAvailable || retestAvailability)
+ {
+ info.restAvailable = checkEnsembl();
+ info.lastAvailableCheckTime = now;
+ }
+
+ /*
+ * refetch Ensembl versions if the recheck period has elapsed
+ */
+ boolean refetchVersion = (now
+ - info.lastVersionCheckTime) > VERSION_RETEST_INTERVAL;
+ if (refetchVersion)
{
- return true;
+ checkEnsemblRestVersion();
+ checkEnsemblDataVersion();
+ info.lastVersionCheckTime = now;
}
- ensemblRestAvailable = checkEnsembl();
- lastCheck = now;
- return ensemblRestAvailable;
+
+ return info.restAvailable;
}
/**
@@ -191,8 +454,9 @@ abstract class EnsemblRestClient extends EnsemblSequenceFetcher
StringBuilder postBody = new StringBuilder(64);
postBody.append("{\"ids\":[");
first = true;
- for (String id : ids)
+ for (int i = 0, n = ids.size(); i < n; i++)
{
+ String id = ids.get(i);
if (!first)
{
postBody.append(",");
@@ -206,10 +470,167 @@ abstract class EnsemblRestClient extends EnsemblSequenceFetcher
byte[] thepostbody = postBody.toString().getBytes();
connection.setRequestProperty("Content-Length",
Integer.toString(thepostbody.length));
- DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
+ DataOutputStream wr = new DataOutputStream(
+ connection.getOutputStream());
wr.write(thepostbody);
wr.flush();
wr.close();
}
+ /**
+ * Primary access point to parsed JSON data, including the call to retrieve
+ * and parsing.
+ *
+ * @param url
+ * request url; if null, getUrl(ids) will be used
+ * @param ids
+ * optional; may be null
+ * @param msDelay
+ * -1 for default delay
+ * @param mode
+ * map, array, or array iterator
+ * @param mapKey
+ * an optional key for an outer map
+ * @return a Map, List, Iterator, or null
+ * @throws IOException
+ * @throws ParseException
+ *
+ * @author Bob Hanson 2019
+ */
+ @SuppressWarnings("unchecked")
+ protected Object getJSON(URL url, List ids, int msDelay, int mode,
+ String mapKey) throws IOException, ParseException
+ {
+ if (url == null)
+ {
+ url = getUrl(ids);
+ }
+
+ Object json = (url == null ? null : getJSON(url, ids, msDelay));
+
+ if (json != null && mapKey != null)
+ {
+ json = ((Map) json).get(mapKey);
+ }
+ if (json == null)
+ {
+ return null;
+ }
+ switch (mode)
+ {
+ case MODE_ARRAY:
+ case MODE_MAP:
+ break;
+ case MODE_ITERATOR:
+ json = ((List