+/*
+ * 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 <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
package jalview.ext.ensembl;
import jalview.io.DataSourceType;
*/
abstract class EnsemblRestClient extends EnsemblSequenceFetcher
{
+ private static final int DEFAULT_READ_TIMEOUT = 5 * 60 * 1000; // 5 minutes
+
+ private static final int CONNECT_TIMEOUT_MS = 10 * 1000; // 10 seconds
+
/*
* update these constants when Jalview has been checked / updated for
* changes to Ensembl REST API
* @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 = "4.6";
- private static final String LATEST_ENSEMBL_REST_VERSION = "4.6";
+ private static final String LATEST_ENSEMBL_REST_VERSION = "4.7";
private static final String REST_CHANGE_LOG = "https://github.com/Ensembl/ensembl-rest/wiki/Change-log";
private final static long VERSION_RETEST_INTERVAL = 1000L * 3600; // 1 hr
private static final Regex TRANSCRIPT_REGEX = new Regex(
- "(ENS)([A-Z]{3}|)T[0-9]{11}$");
+ "(ENS)([A-Z]{3}|)T[0-9]{11}$");
private static final Regex GENE_REGEX = new Regex(
- "(ENS)([A-Z]{3}|)G[0-9]{11}$");
+ "(ENS)([A-Z]{3}|)G[0-9]{11}$");
static
{
*/
private boolean checkEnsembl()
{
- HttpURLConnection conn = null;
+ BufferedReader br = null;
try
{
// note this format works for both ensembl and ensemblgenomes
/*
* expect {"ping":1} if ok
+ * if ping takes more than 2 seconds to respond, treat as if unavailable
*/
- BufferedReader br = getHttpResponse(ping, null);
+ br = getHttpResponse(ping, null, 2 * 1000);
JSONParser jp = new JSONParser();
JSONObject val = (JSONObject) jp.parse(br);
String pingString = val.get("ping").toString();
+ t.getMessage());
} finally
{
- if (conn != null)
+ if (br != null)
{
- conn.disconnect();
+ try
+ {
+ br.close();
+ } catch (IOException e)
+ {
+ // ignore
+ }
}
}
return false;
throws IOException
{
URL url = getUrl(ids);
-
+
BufferedReader reader = getHttpResponse(url, ids);
+ if (reader == null)
+ {
+ // request failed
+ return null;
+ }
FileParse fp = new FileParse(reader, url.toString(), DataSourceType.URL);
return fp;
}
/**
+ * 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<String> ids)
+ throws IOException
+ {
+ return getHttpResponse(url, ids, DEFAULT_READ_TIMEOUT);
+ }
+
+ /**
* Writes the HTTP request and gets the response as a reader.
*
* @param url
* @param ids
* written as Json POST body if more than one
+ * @param readTimeout
+ * in milliseconds
* @return
* @throws IOException
* if response code was not 200, or other I/O error
*/
- protected BufferedReader getHttpResponse(URL url, List<String> ids)
- throws IOException
+ protected BufferedReader getHttpResponse(URL url, List<String> ids,
+ int readTimeout) throws IOException
{
// long now = System.currentTimeMillis();
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
-
+
/*
* POST method allows multiple queries in one request; it is supported for
* sequence queries, but not for overlap
connection.setDoInput(true);
connection.setDoOutput(multipleIds);
+ connection.setConnectTimeout(CONNECT_TIMEOUT_MS);
+ connection.setReadTimeout(readTimeout);
+
if (multipleIds)
{
writePostBody(connection, ids);
}
-
- InputStream response = connection.getInputStream();
+
int responseCode = connection.getResponseCode();
-
+
if (responseCode != 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
*/
- throw new IOException(
- "Response code was not 200. Detected response was "
- + responseCode);
+ System.err.println("Response code " + responseCode + " for " + url);
+ return null;
}
+ // get content
+ InputStream response = connection.getInputStream();
+
// System.out.println(getClass().getName() + " took "
// + (System.currentTimeMillis() - now) + "ms to fetch");
checkRateLimits(connection);
-
+
BufferedReader reader = null;
reader = new BufferedReader(new InputStreamReader(response, "UTF-8"));
return reader;
// remaining, limit, reset));
}
}
-
+
/**
* 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,
git://source.jalview.org / jalview.git / blobdiff