Skip to content

Added handling of request timeouts #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
drallgood merged 1 commit into from
Aug 21, 2013
Merged

Added handling of request timeouts #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 132 additions & 11 deletions src/main/java/de/bitzeche/video/transcoding/zencoder/ZencoderClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
import java.util.Map;

import javax.ws.rs.core.MediaType;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.OutputKeys;
import javax.xml.transform.Transformer;
Expand Down Expand Up @@ -62,6 +64,9 @@ public class ZencoderClient implements IZencoderClient {
private final String zencoderAPIKey;
private final ZencoderAPIVersion zencoderAPIVersion;
private XPath xPath;

private final int MAX_CONNECTION_ATTEMPTS = 5;
private int currentConnectionAttempt = 0;

public ZencoderClient(String zencoderApiKey) {
this(zencoderApiKey, ZencoderAPIVersion.API_V1);
Expand All @@ -77,6 +82,11 @@ public ZencoderClient(String zencoderApiKey, ZencoderAPIVersion apiVersion) {

httpClient = ApacheHttpClient.create();
httpClient.setFollowRedirects(true);

// set a 20 second timeout on the client
httpClient.setConnectTimeout(20000);
httpClient.setReadTimeout(20000);

xPath = XPathFactory.newInstance().newXPath();
zencoderAPIBaseUrl = zencoderAPIVersion.getBaseUrl();
}
Expand Down Expand Up @@ -138,35 +148,77 @@ private void completeJobInfo(ZencoderJob job, Document response) {
LOGGER.error("XPath threw Exception", e);
}
}

private void resetConnectionCount() {
// reset to 0 for use in tracking connections next time
currentConnectionAttempt = 0;
}

private Document createDocumentForException(String message) {
try {
DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder();
Document errorDocument = documentBuilder.newDocument();
Element root = errorDocument.createElemet("error");
errorDocument.appendChild(root);
Node input = errorDocument.createElement("reason");
input.setTextContent(message);
root.appendChild(input);
return errorDocument;
} catch (ParserConfigurationException e) {
LOGGER.error("Exception creating document for exception '" + message + "'", e);
return null;
}
}

@Override
public Document createJob(ZencoderJob job)
throws ZencoderErrorResponseException {
if(currentConnectionAttempt > MAX_CONNECTION_ATTEMPTS) {
resetConnectionCount();
String message = "Reached maximum number of connection attempts for Zencoder, aborting creation of job";
Document errorDocument = createDocumentForException(message);
throw new ZencoderErrorResponseException(errorDocument);
}
Document data;
try {
data = job.createXML();
if (data == null) {
LOGGER.error("Got no XML from Job");
String message = "Got no XML from Job";
LOGGER.error(message);
resetConnectionCount();
Document errorDocument = createDocumentForException(message);
throw new ZencoderErrorResponseException(errorDocument);
}
Element apikey = data.createElement("api_key");
apikey.setTextContent(zencoderAPIKey);
data.getDocumentElement().appendChild(apikey);
Document response = sendPostRequest(zencoderAPIBaseUrl
+ "jobs?format=xml", data);
// a null response means the call did not get through
// we should try again, since the job has not been started
if(response == null) {
currentConnectionAttempt++;
// maybe delay this call by a few seconds?
return createJob(job);
}
String id = (String) xPath.evaluate("/api-response/job/id",
response, XPathConstants.STRING);
if (StringUtils.isNotEmpty(id)) {
job.setJobId(Integer.parseInt(id));
resetConnectionCount();
return response;
}
completeJobInfo(job, response);
LOGGER.error("Error when sending request to Zencoder: ", response);
resetConnectionCount();
throw new ZencoderErrorResponseException(response);
} catch (ParserConfigurationException e) {
LOGGER.error("Parser threw Exception", e);
} catch (XPathExpressionException e) {
LOGGER.error("XPath threw Exception", e);
}
resetConnectionCount();
return null;
}

Expand Down Expand Up @@ -205,23 +257,47 @@ public Document getJobProgress(ZencoderJob job) {
}

public Document getJobProgress(int id) {
if(currentConnectionAttempt > MAX_CONNECTION_ATTEMPTS) {
resetConnectionCount();
LOGGER.error("Reached maximum number of attempts for getting job progress. Aborting and returning null");
return null;
}
if (zencoderAPIVersion != ZencoderAPIVersion.API_V2) {
LOGGER.warn("jobProgress is only available for API v2. Returning null.");
return null;
}
String url = zencoderAPIBaseUrl + "jobs/" + id
+ "/progress.xml?api_key=" + zencoderAPIKey;
return sendGetRequest(url);
Document result = sendGetRequest(url);
if(result == null) {
currentConnectionAttempt++;
// delay this call by a few seconds?
return getJobProgress(id);
}
resetConnectionCount();
return result;
}

public Document getJobDetails(ZencoderJob job) {
return getJobDetails(job.getJobId());
}

public Document getJobDetails(int id) {
if(currentConnectionAttempt > MAX_CONNECTION_ATTEMPTS) {
resetConnectionCount();
LOGGER.error("Reached maximum number of attempts for getting job details. Aborting and returning null");
return null;
}
String url = zencoderAPIBaseUrl + "jobs/" + id + ".xml?api_key="
+ zencoderAPIKey;
return sendGetRequest(url);
Document result = sendGetRequest(url);
if(result == null) {
currentConnectionAttempt++;
// delay this call by a few seconds?
return getJobDetails(id);
}
resetConnectionCount();
return result;
}

public boolean resubmitJob(ZencoderJob job) {
Expand All @@ -233,10 +309,20 @@ public boolean resubmitJob(ZencoderJob job) {
}

public boolean resubmitJob(int id) {
if(currentConnectionAttempt > MAX_CONNECTION_ATTEMPTS) {
resetConnectionCount();
LOGGER.error("Reached maximum number of attempts to resubmit job, aborting");
return false;
}
String url = zencoderAPIBaseUrl + "jobs/" + id + "/resubmit?api_key="
+ zencoderAPIKey;
ClientResponse response = sendPutRequest(url);
if(response == null) {
currentConnectionAtttempt++;
return resubmitJob(id);
}
int responseStatus = response.getStatus();
resetConnectionCount();
if (responseStatus == 200 || responseStatus == 204) {
return true;
} else if (responseStatus == 409) {
Expand All @@ -255,10 +341,20 @@ public boolean cancelJob(ZencoderJob job) {
}

public boolean cancelJob(int id) {
if(currentConnectionAttempt > MAX_CONNECTION_ATTEMPTS) {
resetConnectionCount();
LOGGER.error("Reached maximum number of attempts to cancel job, aborting");
return false;
}
String url = zencoderAPIBaseUrl + "jobs/" + id
+ "/cancel.json?api_key=" + zencoderAPIKey;
ClientResponse res = sendPutRequest(url);
if(res == null) {
currentConnectionAttempt++;
return cancelJob(id);
}
int responseStatus = res.getStatus();
resetConnectionCount();
if (responseStatus == 200 || responseStatus == 204) {
return true;
} else if (responseStatus == 409) {
Expand Down Expand Up @@ -292,20 +388,38 @@ public boolean deleteJob(int id) {

protected Document sendGetRequest(String url) {
LOGGER.debug("calling: {}", url);
WebResource webResource = httpClient.resource(url);
Document response = webResource.get(Document.class);
try {
WebResource webResource = httpClient.resource(url);
Document response = webResource.get(Document.class);

logXmlDocumentToDebug("Got response", response);
return response;
logXmlDocumentToDebug("Got response", response);
return response;
} catch (Exception e) {
if(e instanceof SocketTimeoutException) {
LOGGER.warn("Connection to Zencoder timed out");
} else {
LOGGER.warn(e.getMessage());
}
}
return null;
}

protected ClientResponse sendPutRequest(String url) {
LOGGER.debug("calling: {}", url);
WebResource webResource = httpClient.resource(url);
ClientResponse response = webResource.put(ClientResponse.class);
try {
WebResource webResource = httpClient.resource(url);
ClientResponse response = webResource.put(ClientResponse.class);

LOGGER.debug("Got response: {}", response);
return response;
LOGGER.debug("Got response: {}", response);
return response;
} catch (Exception e) {
if(e instanceof SocketTimeoutException) {
LOGGER.warn("Connection to Zencoder timed out");
} else {
LOGGER.warn(e.getMessage());
}
}
return null;

}

Expand All @@ -331,7 +445,14 @@ protected Document sendPostRequest(String url, Document xml) {
}
LOGGER.error("couldn't submit job: {}", errormessage);
return errorXml;
} catch (Exception e) {
if(e instanceof SocketTimeoutException) {
LOGGER.warn("Connection to Zencoder timed out");
} else {
LOGGER.warn(e.getMessage());
}
}
return null;

}

Expand Down