New releases of Open HTML to PDF will be distributed through Maven. Search maven for com.openhtmltopdf.
Current maven release is 0.0.1-RC11. If you would like to be notified of new releases, please subscribe to the Maven issue.
Add these to your maven dependencies section as needed:
<properties>
<!-- Define the version of OPEN HTML TO PDF in the properties section of your POM. -->
<openhtml.version>0.0.1-RC11</openhtml.version>
</properties>
<dependency>
<!-- ALWAYS required. -->
<groupId>com.openhtmltopdf</groupId>
<artifactId>openhtmltopdf-core</artifactId>
<version>${openhtml.version}</version>
</dependency>
<dependency>
<!-- Required for PDF output. -->
<groupId>com.openhtmltopdf</groupId>
<artifactId>openhtmltopdf-pdfbox</artifactId>
<version>${openhtml.version}</version>
</dependency>
<dependency>
<!-- Required for image output only. -->
<groupId>com.openhtmltopdf</groupId>
<artifactId>openhtmltopdf-java2d</artifactId>
<version>${openhtml.version}</version>
</dependency>
<dependency>
<!-- Optional, leave out if you do not need right-to-left or bi-directional text support. -->
<groupId>com.openhtmltopdf</groupId>
<artifactId>openhtmltopdf-rtl-support</artifactId>
<version>${openhtml.version}</version>
</dependency>
<dependency>
<!-- Optional, leave out if you do not need HTML5 parsing support. -->
<groupId>com.openhtmltopdf</groupId>
<artifactId>openhtmltopdf-jsoup-dom-converter</artifactId>
<version>${openhtml.version}</version>
</dependency>
<dependency>
<!-- Optional, leave out if you do not need logging via slf4j. -->
<groupId>com.openhtmltopdf</groupId>
<artifactId>openhtmltopdf-slf4j</artifactId>
<version>${openhtml.version}</version>
</dependency>
<dependency>
<!-- Optional, leave out if you do not need logging via log4j. -->
<groupId>com.openhtmltopdf</groupId>
<artifactId>openhtmltopdf-log4j</artifactId>
<version>${openhtml.version}</version>
</dependency>
<dependency>
<!-- Optional, leave out if you do not SVG support. -->
<groupId>com.openhtmltopdf</groupId>
<artifactId>openhtmltopdf-svg-support</artifactId>
<version>${openhtml.version}</version>
</dependency>Most of the options avaiable for PDF output are settable on the PdfRendererBuilder builder class. This shows the minimal possible configuration to output a PDF from an XHTML document.
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import com.openhtmltopdf.pdfboxout.PdfRendererBuilder;
import com.openhtmltopdf.pdfboxout.PdfRendererBuilder.TextDirection;
public class SimpleUsage
{
public static void main(String[] args)
{
new SimpleUsage().exportToPdfBox("file:///Users/user/path-to/document.xhtml", "/Users/user/path-to/output.pdf");
}
public void exportToPdfBox(String url, String out)
{
OutputStream os = null;
try {
os = new FileOutputStream(out);
try {
// There are more options on the builder than shown below.
PdfRendererBuilder builder = new PdfRendererBuilder();
builder.withUri(url);
builder.toStream(os);
builder.run();
} catch (Exception e) {
e.printStackTrace();
// LOG exception
} finally {
try {
os.close();
} catch (IOException e) {
// swallow
}
}
}
catch (IOException e1) {
e.printStackTrace();
// LOG exception.
}
}
}// Add these imports (and remember the rtl-support maven module).
import com.openhtmltopdf.bidi.support.ICUBidiReorderer;
import com.openhtmltopdf.bidi.support.ICUBidiSplitter;
// Then call on the builder.
builder.useUnicodeBidiSplitter(new ICUBidiSplitter.ICUBidiSplitterFactory());
builder.useUnicodeBidiReorderer(new ICUBidiReorderer());
builder.defaultTextDirection(TextDirection.LTR); // OR RTLWhile Open HTML to PDF works with a standard w3c DOM, the project provides a converter from the Jsoup HTML5 parser provided Document to a w3c DOM Document. This allows you to parse and use HTML5, rather than the default strict XML required by the project.
Then you can use one of the Jsoup.parse methods to parse HTML5 and DOMBuilder.jsoup2DOM to convert the Jsoup document to a w3c DOM one.
public org.w3c.dom.Document html5ParseDocument(String urlStr, int timeoutMs) throws IOException
{
URL url = new URL(urlStr);
org.jsoup.nodes.Document doc;
if (url.getProtocol().equalsIgnoreCase("file")) {
doc = Jsoup.parse(new File(url.getPath()), "UTF-8");
}
else {
doc = Jsoup.parse(url, timeoutMs);
}
return DOMBuilder.jsoup2DOM(doc);
}Then you can set the renderer document with builder.withW3cDocument(doc, url) in place of builder.withUri(url).
Open HTML to PDF makes it simple to plugin an external client for HTTP and HTTPS requests. In fact this is recommended if you are using HTTP/HTTPS resources, as the built-in Java client is showing its age. For example, to use the excellent OkHttp library is as simple as adding the following code:
public static class OkHttpStreamFactory implements HttpStreamFactory {
private final OkHttpClient client = new OkHttpClient();
@Override
public HttpStream getUrl(String url) {
Request request = new Request.Builder()
.url(url)
.build();
try {
final Response response = client.newCall(request).execute();
return new HttpStream() {
@Override
public InputStream getStream() {
return response.body().byteStream();
}
@Override
public Reader getReader() {
return response.body().charStream();
}
};
}
catch (IOException e) {
e.printStackTrace();
}
return null;
}
}Then use builder.useHttpStreamImplementation(new OkHttpStreamFactory()).
The library should close the reader or stream when it is finished with it.
By default, Open HTML to PDF should not cache anything between runs. However, it allows the user to plugin an external cache. It should be noted that the URI received by the cache is already resolved (see below). Here is a simple external cache:
public static class SimpleCache implements FSCache {
private final Map<FSCacheKey, Object> cache = new HashMap<>();
@Override
public Object get(FSCacheKey cacheKey) {
Object obj = cache.get(cacheKey);
System.out.println("Requesting: " + cacheKey.getUri() + " of type: " + cacheKey.getClazz().getName() + ", got it: " + (obj != null));
return obj;
}
@Override
public void put(FSCacheKey cacheKey, Object obj) {
System.out.println("Putting: " + cacheKey.getUri() + " of type: " + cacheKey.getClazz().getName());
cache.put(cacheKey, obj);
}
}Of course, you may want to customize your cache by inspecting the URI or class name contained by cache key. Once you have a cache, you can set it
on the builder with builder.useCache(cache).
By default, the code attempts to resolve relative URIs by using the document URI or CSS stylesheet URI as a base URI.
Absolute URIs are returned unchanged. If you wish to plugin your own resolver, you can.
This can not only resolve relative URIs but also resolve URIs in a private address space or even reject a URI. To use an external resolver
implement FSUriResolver and use it with builder.useUriResolver(new MyResolver()). The following example requires resources to be loaded through
SSL.
final NaiveUserAgent.DefaultUriResolver defaultUriResolver = new NaiveUserAgent.DefaultUriResolver();
builder.useUriResolver(new FSUriResolver() {
@Override
public String resolveURI(String baseUri, String uri) {
// First get an absolute version.
String supResolved = defaultUriResolver.resolveURI(baseUri, uri);
if (supResolved == null || supResolved.isEmpty())
return null;
try {
URI uriObj = new URI(supResolved);
// Only let through resources that are loaded through ssl.
if (uriObj.getScheme().equalsIgnoreCase("https"))
return uriObj.toString();
} catch (URISyntaxException e) {
e.printStackTrace();
}
return null;
}
});Three options are provided by Open HTML to PDF. The default is to use java.util.logging. If you prefer to output using log4j or slf4j, adapters are provided. Add the appropriate maven module, then at the start of your code, before calling any Open HTML to PDF methods, use this code:
XRLog.setLoggingEnabled(true);
// For slf4j:
XRLog.setLoggerImpl(new Slf4jLogger());
// or for log4j 1.2.17:
XRLog.setLoggerImpl(new Log4JXRLogger()); Add the appropriate maven module and include this line in your builder code:
builder.useSVGDrawer(new BatikSVGDrawer());For an example of outputting to images see issue #73
- Loads more (stay tuned).
Thanks for using openhtmltopdf and please feel free to file any issues you are having trouble with.