Skip to main content
Version: Version 1.5

Get started with Java

This guide walks you through the steps to use a code example, and then explains how to integrate the Toolbox add-on into your application with the Java programming language.

Request trial or full license​

The Toolbox add-on requires a license key for both evaluation and full use. To request a license key, follow these steps:

  1. Contact the sales team through the Contact page and mark the Toolbox add-on as the product of your interest for a trial license.

If you already have a license key and you need to copy it, review Find the license key.

Prerequisites​

The Toolbox add-on for Java requires Java version 8 or higher.

Getting started with a sample project​

Learn how to use the Toolbox add-on using a Java code example. The ImageExtraction example extracts all images and image masks from a PDF document. Use similar steps to run any other code example from the toolbox-examples-java repository.

Compile and run the sample​

To compile and run the sample, follow these steps:

  1. Clone the toolbox-examples-java repository:

    git clone https://github.com/pdf-tools/toolbox-examples-java.git

  2. Find your license key. For more information, review Find the license key.

  3. In the ToolboxImageExtraction.java file, replace the string "YOUR_LICENSE_KEY" with your license key:

    Sdk.initialize("YOUR_LICENSE_KEY", null);

    Use the license key in the same format you copied it. Include the less-than (<) and greater-than (>) signs.

  4. Navigate to the ImageExtraction code example:

    cd toolbox-examples-java/ImageExtraction

  5. Create an output directory:

    mkdir output_images

  6. Compile the Java source file:

    javac -cp jar/com.pdftools.toolbox.jar:. ToolboxImageExtraction.java

  7. To extract all images and image masks from the sample PDF file ImageCollection.pdf to the output directory /output_images, run the following command:

    java -cp jar/com.pdftools.toolbox.jar:bin:. ToolboxImageExtraction ImageCollection.pdf /output_images

The code example takes:

  • The input and output files represented as a file name, a file path with the file name, or the output directory.
  • Both file paths (input and output) can be relative or absolute.

Review the following snippet with a placeholder and compare it to the last step of the previous procedure:

java -cp jar/com.pdftools.toolbox.jar:bin:. ToolboxImageExtraction INPUT_FILE OUTPUT_DIRECTORY
note

You can apply a similar procedure described in this tutorial for other code examples. For more information, see Code samples page.

Integrate the SDK into your application​

Integrate and initialize the Toolbox add-on into your application by following the instructions in the following sections.

Add the SDK to your project​

The Toolbox add-on for Java is available on Maven. To add the Toolbox add-on for Java to your project, select your operating system and system architecture and add the following to your pom.xml:

<dependency>
    <groupId>com.pdftools</groupId>
    <artifactId>toolbox</artifactId>
    <version>1.5.0</version>
</dependency>
<dependency>
    <groupId>com.pdftools</groupId>
    <artifactId>toolbox</artifactId>
    <version>1.5.0</version>
    <classifier>linux-x64</classifier>
    <type>so</type>
</dependency>

Load the Toolbox add-on​

The Toolbox add-on for Java requires you to load the underlying native binary files suitable for your operating system and system architecture at runtime.

There are two ways how to load the Toolbox add-on for Java with Maven:

  1. If you are consuming Java libraries directly from the local Maven repository, load the native binary files using the following code:

    System.load(System.getProperty("user.home") + "/.m2/repository/com/pdftools/toolbox/1.5.0/toolbox-1.5.0-linux-x64.so");

  2. Alternatively, use the system library path:

    1. Add the Toolbox add-on lib directory to the system library path.

      • Windows: Environment variable PATH
      • Linux and macOS: Defined by LD_LIBRARY_PATH
      • Or specify the path using the VM arg -Djava.library.path=.

    2. Load the library using:

      System.loadLibrary("toolbox-1.5.0-linux-x64");
note

Note the difference between:

  • System.load(..): Loads the library from an absolute file path.
  • System.loadLibrary(..): Load the library from the system’s library path.
info

If you are shipping your application, ensure to ship it with the native binary files. Note that you must load the native binary files from the file system and cannot load them from within a jar file or other bundle.

Initialize the SDK​

The Toolbox add-on always requires a license key to operate (unlike the Pdftools SDK). Without a valid license, every Toolbox add-on function call fails with LicenseError: No license key was set.

Getting a license key

Contact the Pdftools sales team through the Contact page to get a full license.

To initialize the Toolbox add-on with your license key, follow these steps:

  1. Find your license key. For more information, review Find the license key.

  2. Call Sdk.initialize once at application startup, before any other Toolbox add-on method call:

    Sdk.initialize("YOUR_LICENSE_KEY", null);

    Replace YOUR_LICENSE_KEY with your license key. Use the license key in the same format you copied it. Include the less-than (<) and greater-than (>) signs.

To get a working reference with the Sdk.initialize method, follow these steps:

  1. On the Code samples page, clone a sample repository. For example, clone toolbox-examples-java and navigate to toolbox-examples-java/ImageExtraction.
  2. Find the Sdk.initialize method in the main Java file of the sample. For example: Extract all images and image masks from a PDF sample includes Sdk.initialize method in the ToolboxImageExtraction.java file.
  3. Replace the "insert-license-key-here" placeholder in the sample with your license key. Include the less-than (<) and greater-than (>) signs.

Implement your use case​

  • Find more use cases and code examples on the Code samples page.
  • For more technical information about the Toolbox add-on for Java, consult the Java technical notes.