org.docx4j.services.client.ConverterHttp Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of docx4j-core Show documentation
Show all versions of docx4j-core Show documentation
docx4j is a library which helps you to work with the Office Open
XML file format as used in docx
documents, pptx presentations, and xlsx spreadsheets.
/*
* Copyright 2015-2016, Plutext Pty Ltd.
*
* This file is part of docx4j.
docx4j is 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.
*/
package org.docx4j.services.client;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import org.apache.http.HttpEntity;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.BasicHttpEntity;
import org.apache.http.entity.ByteArrayEntity;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.FileEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Java client library for Plutext PDF Converter
*
* @since 3.3.0
*/
public class ConverterHttp implements Converter {
private static Logger log = LoggerFactory.getLogger(ConverterHttp.class);
private String URL = null;
public ConverterHttp() {
}
public ConverterHttp(String endpointURL) {
log.debug("starting, with endpointURL: " + endpointURL);
if (endpointURL!=null) {
this.URL = endpointURL;
}
}
/**
* Convert File fromFormat to toFormat, streaming result to OutputStream os.
*
* fromFormat supported: DOC, DOCX
*
* toFormat supported: PDF
*
* @param f
* @param fromFormat
* @param toFormat
* @param os
* @throws IOException
* @throws ConversionException
*/
public void convert(File f, Format fromFormat, Format toFormat, OutputStream os) throws IOException, ConversionException {
checkParameters(fromFormat, toFormat);
// CloseableHttpClient httpclient = HttpClients.createDefault();
CloseableHttpClient httpclient = HttpClients.custom()
.setRetryHandler(new MyRetryHandler() )
.build();
try {
HttpPost httppost = getUrlForFormat(toFormat);
HttpEntity reqEntity = new FileEntity(f, map(fromFormat) );
httppost.setEntity(reqEntity);
execute(httpclient, httppost, os);
log.debug("..done");
} finally {
httpclient.close();
}
}
private HttpPost getUrlForFormat(Format toFormat) {
if (Format.TOC.equals(toFormat)) {
//httppost = new HttpPost(URL+"/?bookmarks");
// System.out.println(URL+"?format=application/json");
return new HttpPost(URL+"?format=application/json");
} else if (Format.DOCX.equals(toFormat)) {
return new HttpPost(URL+"?format=application/vnd.openxmlformats-officedocument.wordprocessingml.document");
} else {
return new HttpPost(URL);
}
}
/**
* Convert InputStream fromFormat to toFormat, streaming result to OutputStream os.
*
* fromFormat supported: DOC, DOCX
*
* toFormat supported: PDF
*
* Note this uses a non-repeatable request entity, so it may not be suitable
* (depending on the endpoint config).
*
* @param instream
* @param fromFormat
* @param toFormat
* @param os
* @throws IOException
* @throws ConversionException
*/
public void convert(InputStream instream, Format fromFormat, Format toFormat, OutputStream os) throws IOException, ConversionException {
checkParameters(fromFormat, toFormat);
CloseableHttpClient httpclient = HttpClients.createDefault();
try {
HttpPost httppost = getUrlForFormat(toFormat);
BasicHttpEntity reqEntity = new BasicHttpEntity();
reqEntity.setContentType( map(fromFormat).getMimeType() ); // messy that API is different to FileEntity
reqEntity.setContent(instream);
httppost.setEntity(reqEntity);
execute(httpclient, httppost, os);
} finally {
httpclient.close();
}
}
/**
* Convert byte array fromFormat to toFormat, streaming result to OutputStream os.
*
* fromFormat supported: DOC, DOCX
*
* toFormat supported: PDF
*
* @param bytesIn
* @param fromFormat
* @param toFormat
* @param os
* @throws IOException
* @throws ConversionException
*/
public void convert(byte[] bytesIn, Format fromFormat, Format toFormat, OutputStream os) throws IOException, ConversionException {
checkParameters(fromFormat, toFormat);
CloseableHttpClient httpclient = HttpClients.createDefault();
try {
HttpPost httppost = getUrlForFormat(toFormat);
HttpEntity reqEntity = new ByteArrayEntity(bytesIn, map(fromFormat) ); // messy that API is different to FileEntity
httppost.setEntity(reqEntity);
execute(httpclient, httppost, os);
} finally {
httpclient.close();
}
}
/**
* @param httpclient
* @param httppost
* @param os
* @throws IOException
* @throws ClientProtocolException
* @throws ConversionException
*/
protected void execute(CloseableHttpClient httpclient, HttpPost httppost,
OutputStream os) throws ClientProtocolException, ConversionException {
CloseableHttpResponse response = null;
try {
response = httpclient.execute(httppost);
int statusCode = response.getStatusLine().getStatusCode();
if (statusCode==403) {
throw new ConversionException("403 license expired?", response);
} else if (statusCode==429) {
// Possible if you send too many requests to converter-eval.plutext.com
// or a commercial SAAS endpoint. Install your own instance?
// eg Kong: {"message":"API rate limit exceeded"}
throw new ConversionRateLimitException("API rate limit exceeded", response);
} else if (statusCode!=200) {
throw new ConversionException(response.getStatusLine().getStatusCode() + "\n"
+ response);
}
// we got a 200, so write the result
HttpEntity resEntity = response.getEntity();
resEntity.writeTo(os);
} catch (java.net.UnknownHostException uhe) {
throw new ConversionException("\nLooks like you have the wrong host in your endpoint URL '" + URL + "'\n", uhe);
} catch (java.net.SocketException se) {
String errorMessage="";
if (System.getProperty("os.name").toUpperCase().indexOf("WINDOWS") > -1) {
// In some circumstances, the converter will return an error before waiting for
// the request to complete.
// On Windows, you get "java.net.SocketException: Connection reset",
// whereas on Linux and OSX, the SocketException still occurs, but the response is read
// (though possibly only sometimes/partially, since the socket exception occurs
// in BasicHttpEntity.writeTo)
errorMessage="This behaviour may be Windows client OS specific; please look in the server logs or try a Linux client";
}
// TODO: What happens on Android?
throw new ConversionException(errorMessage, se);
} catch (IOException ioe) {
throw new ConversionException(ioe.getMessage(), ioe);
} finally {
try {
if (response==null) {
log.error("\nLooks like your endpoint URL '" + URL + "' is wrong\n");
} else {
response.close();
}
} catch (IOException e) {}
}
}
private ContentType map(Format f) {
if (Format.DOCX.equals(f)) {
return ContentType.create("application/vnd.openxmlformats-officedocument.wordprocessingml.document");
} else if (Format.DOC.equals(f)) {
return ContentType.create("application/msword");
}
return null;
}
private void checkParameters(Format fromFormat, Format toFormat) throws ConversionException {
if (URL==null) {
throw new ConversionException("Endpoint URL not configured.");
}
if ( Format.DOCX.equals(fromFormat) || Format.DOC.equals(fromFormat) ) {
// OK
} else {
throw new ConversionException("Conversion from format " + fromFormat + " not supported");
}
if (Format.PDF.equals(toFormat) || Format.TOC.equals(toFormat)
|| Format.DOCX.equals(toFormat)) {
// OK
} else {
throw new ConversionException("Conversion to format " + toFormat + " not supported");
}
}
}