Access the BuildVu Microservice using Java

Table of contents

  1. Introduction
  2. Prerequisites
  3. Code Example
  4. Configuration Options
  5. Upload by URL
  6. Using Authentication
  7. Further details


The following tutorial shows you how to convert PDF files to HTML or SVG using a hosted BuildVu cloud API, such as:

Whilst all the above services can be accessed with plain old HTTP requests, this tutorial uses our open source Java IDRCloudClient which provides a simple Java wrapper around the REST API.


Before you begin you will need to ensure you have an up-to-date version of the JDK(version 8 or above) installed. You can find more on this on Java’s website.

Code Example

Here is a basic code example to convert PDF files to HTML or SVG. Configuration options and advanced features can be found below.

import java.util.Map;

public final class ExampleUsage {

    public static void main(final String[] args) {

        final IDRCloudClient client = new IDRCloudClient("https://example/" + IDRCloudClient.BUILDVU);

        final HashMap<String, String> params = new HashMap<>();
        params.put("token", "token"); //Required only when connecting to the IDRsolutions trial or cloud subscription servers
        params.put("input", IDRCloudClient.UPLOAD);
        params.put("file", "path/to/file.pdf");
        try {
            final Map<String, String> results = client.convert(params);

            System.out.println("   ---------   ");

            IDRCloudClient.downloadResults(results, "path/to/outputDir", "example");
        } catch (final ClientException | InterruptedException e) {

Configuration Options

The BuildVu API accepts a stringified JSON object containing key value pair configuration options to customise your conversion. The settings should be added to the parameters array. A full list of the configuration options to convert PDF files to HTML or SVG can be found here.

params.put("settings", "{\"key\":\"value\",\"key\":\"value\"}");

Upload by URL

As well as uploading a local file you can also provide a URL which the BuildVu Microservice will download and then perform the conversion. To do this you should replace the input and file values in the parameters variable with the following.

params.put("input", IDRCloudClient.DOWNLOAD);
params.put("url", "http://exampleURL/exampleFile.pdf");

Using Authentication

If the BuildVu Microservice requires authentication, you will need to provide a username and password. These are provided by passing two variables named username and password to the convert method as shown below.


Further details

IDRCloudClient on GitHub BuildVu Microservice API
BuildVu Microservice Use

Still need help? Send us your questions.