Product:

Get started

Overview

Platforms

Frameworks

Languages

Download

Get a trial key

Release notes

Viewer

Basic operations

Learn more

Annotation

MS Office

Generate via template

Conversion

Smart Data Extraction

Augmenting LLMs with Smart Data Extraction

PDF/A

Accessibility

Forms

Create

Page manipulation

PDF Editing

OCR

Digital signature

Comparison

Bookmark

Optimization

Layer (OCG)

Redaction

Security

Portfolio

Low-level PDF API

Changelogs

Java PDF library integration

Welcome to Apryse. Java for the Apryse SDK is cross-platform and supported on Windows, macOS and Linux. To get started, choose your preferred platform from the tabs below.

Windows Java PDF library integration

This guide will help you run Apryse samples and integrate a free trial of the Apryse SDK into Java applications on Windows. Your free trial includes unlimited trial usage and support from solution engineers.

Prerequisites

JDK >= 5.Make sure that the JDK has been added to your path environment variable.Please visit the Java FAQ section for more information about some of the common Java installation issues.
Apryse's Java PDF library for Windows:

Download the SDK

For 32-bit binary packages and slimmer binaries (including java libraries), visit the C++ docs for Server SDK.

Run Apryse SDK in production

A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.

Keep your commercial license key confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Initial setup

Extract the folder from the .zip file.
Get your Apryse trial key.

License Key

Apryse collects some data regarding your usage of the SDK for product improvement.

If you wish to continue without data collection, contact us and we will email you a no-tracking trial key for you to get started.

Run the samples

Navigate to the location of extracted contents. Find and enter the Samples folder. Here you can find sample code for a large number of features supported by the Apryse SDK.

Run a specific sample

Find the sample you want to run and navigate into the JAVA folder inside.
Find RunTest.bat and run it. This can be done using either CLI or with a double-click. The results should appear on a cmd window.

Run all samples

Find runall_java.bat in the samples folder and double click it to run it. The results should appear on a cmd window.

Integrate into your application

This is called the "Apryse Hello World" application. It is easy to integrate the rest of Apryse SDK if you are able to open, save and close a PDFDoc.

Create a new folder in Samples by the name HelloWorld.
In the HelloWorld folder, create a new file called HelloWorld.java, open and edit it using your favorite text editor.
Insert the following to your file:

Java

1import java.io.File;
2import java.io.IOException;
3// These are the most important packages to import
4// for basic document manipulation.
5import com.pdftron.common.PDFNetException;
6import com.pdftron.pdf.*;
7import com.pdftron.sdf.SDFDoc;
8import java.io.*;
9public class HelloWorld
10{
11    // Just a simple setup for the application
12    public static void main(String[] args)
13    {
14        // PDFNet must always be initialized before any Apryse
15        // classes and methods can be used
16        PDFNet.initialize("YOUR_APRYSE_LICENSE_KEY");
17        System.out.println("Hello World!");
18        // Most Apryse operations are required to be wrapped in
19        // a try-catch block for PDFNetException, or in a method/class that
20        // throws PDFNetException
21        try {
22            // Creates a new PDFDoc object
23            PDFDoc doc = new PDFDoc();
24            // Creating a new page and adding it
25            // to document's sequence of pages
26            Page page1 = doc.pageCreate();
27            doc.pagePushBack(page1);
28            // Files can be saved with various options
29            // Linearized files are the most effective
30            // for opening and viewing quickly on various platforms
31            doc.save(("linearized_ouput.pdf"), SDFDoc.SaveMode.LINEARIZED, null);
32            doc.close();
33        } catch (PDFNetException e) {
34            System.out.println(e);
35            e.getStackTrace();
36        }
37        PDFNet.terminate();
38    }
39}

To test that your code works, compile and run the code using a shell in the HelloWorld folder using:

Java

1javac -cp .;../../Lib/PDFNet.jar HelloWorld.java
2java.exe -Djava.library.path=../../Lib -classpath .;../../Lib/PDFNet.jar HelloWorld

Once you have successfully run this, you should see an output file in the working directory of this program.

Add the PDFNet Maven repository in your top-level pom.xml.

XML

1<repositories>
2    <repository>
3        <id>pdftron</id>
4        <name>PDFNet Maven</name>
5        <url>https://pdftron.com/maven/release</url>
6    </repository>
7</repositories>

2. Add the PDFNet Maven dependency in your pom.xml.

XML

1<dependencies>
2    <dependency>
3        <groupId>com.pdftron</groupId>
4        <artifactId>PDFNet</artifactId>
5        <version>10.10.0</version>
6    </dependency>
7</dependencies>

Integrate into your application

Add PDFNet Maven repository and dependency in your pom.xml.
In your src\main\java\your\java\folder\, add the following code to your java files. We use src\main\java\com\mycompany\app\App.java as an example:

Java

1package com.mycompany.app;
2import com.pdftron.pdf.*;
3public class App
4{
5    public static void main(String[] args)
6    {
7        PDFNet.initialize("YOUR_APRYSE_LICENSE_KEY");
8        try {
9             // YOUR CODE GOES HERE
10        } catch (Exception e) {
11        }
12        PDFNet.terminate();
13    }
14}

To test your code, you can navigate to the root of your project and run the following commands:

Java

1mvn compile
2mvn exec:java -Dexec.mainClass=com.mycompany.app.App

If the program runs successfully, you should see no error in the terminal.

We have demonstrated how to integrate Apryse's Java SDK into your Maven project. If your have any questions, please don't hesitate to contact us!

Add the PDFNet Maven repository in your top-level build.gradle.

Groovy

1repositories {
2    maven {
3       url 'https://pdftron.com/maven/release/'
4   }
5}

2. Add the PDFNet dependency in your build.gradle.

Groovy

1dependencies {
2    implementation 'com.pdftron:PDFNet:10.10.0'
3}

Integrate into your application

Here we use a demo Gradle app as an example:

Add PDFNet Maven repository and dependency in your build.gradle.

Groovy

1repositories {
2    maven {
3       url 'https://pdftron.com/maven/release/'
4   }
5}
6dependencies {
7    implementation 'com.pdftron:PDFNet:10.10.0'
8}
9application {
10    mainClass = 'demo.App'
11}

2. In your app\src\main\java\your\java\folder\, add the following code to your java files. In this example, it's app\src\main\java\demo\App.java.

Java

1package demo;
2import com.pdftron.pdf.*;
3public class App
4{
5    public static void main(String[] args)
6    {
7        PDFNet.initialize("YOUR_APRYSE_LICENSE_KEY");
8        try {
9         // YOUR CODE GOES HERE
10        } catch (Exception e) {
11        }
12        PDFNet.terminate();
13    }
14}

To test your code, you can navigate to the root of your project and run the following commands:

Groovy

1.\gradlew run

If the program builds successfully, you should see Apryse is running ... and BUILD SUCCESSFUL in the terminal.

We have demonstrated how to integrate Apryse's Java SDK into your Gradle project. Read more on building with Java on Gradle. If your have any questions, please don't hesitate to contact us!

Linux Java PDF library integration

This guide will help you run Apryse samples and integrate a free trial of the Apryse SDK into Java applications on Linux. Your free trial includes unlimited trial usage and support from solution engineers.

Prerequisites

JDK version ≥ 5
Apryse SDK for Linux:

Download the SDK

Run Apryse SDK in production

A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.

Keep your commercial license key confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Initial setup

Extract the folder from the .zip file.
Get your Apryse trial key.

License Key

Apryse collects some data regarding your usage of the SDK for product improvement.

If you wish to continue without data collection, contact us and we will email you a no-tracking trial key for you to get started.

Run the samples

Run a specific sample

Navigate to the JAVA folder in a sample project, for example /Samples/AddImageTest/JAVA and run the sample with

sh

1./RunTest.sh

Run all samples

Navigate to /Samples and run

sh

1./runall_java.sh

The tests will run one by one.

Output files will be in /Samples/TestFiles/Output

Integrate into your application

This section will show you how to use our SDK to create a simple Apryse "Hello World!" application. It will create a document with one blank page and save it as a linearized PDF in its running directory.

Navigate to the /Samples directory of the Apryse SDK and create a directory called myApp if it does not exist already. This guide will assume your project is named myApp.
Enter your myApp directory and create a JAVA directory for organization. Then create a myApp.java file in the JAVA directory. Open this file in your favorite text editor and paste:

Java

1import java.io.File;
2import java.io.IOException;
3import com.pdftron.common.PDFNetException;
4import com.pdftron.pdf.*;
5import com.pdftron.sdf.SDFDoc;
6import com.pdftron.sdf.ObjSet;
7import com.pdftron.sdf.Obj;
8public class myApp
9{
10    public static void main(String[] args)
11    {
12        PDFNet.initialize("YOUR_APRYSE_LICENSE_KEY");  // PDFNet must be initialized before accessing any Apryse API
13        try
14        {
15            PDFDoc doc = new PDFDoc();
16            Page page = doc.pageCreate();  // Start a new page
17            doc.pagePushBack(page);  // Add the page to the document
18            doc.save("output.pdf", SDFDoc.SaveMode.LINEARIZED, null);  // Save the document as a linearized PDF
19        }
20        catch(PDFNetException e)
21        {
22            e.printStackTrace();
23            System.out.println(e);
24        }
25        System.out.println("Hello World!");
26    }
27}

3. Navigate back to your myApp project folder and compile your application using our PDFNet library:

Bash

1javac -cp .:../../../Lib/PDFNet.jar myApp.java

4. Run the project by executing:

Bash

1java -Djava.library.path=../../../Lib -classpath .:../../../Lib/PDFNet.jar myApp

If all goes well, your terminal should output:

txt

1PDFNet is running in demo mode.
2Permission: write
3Hello World!

Check the output.pdf that the program output in the same directory. It should be a PDF with one blank page.

Next step

Troubleshooting

Check the troubleshooting page if you run into any issues going through this document.

1. Add the PDFNet Maven repository in your top-level pom.xml.

XML

1<repositories>
2    <repository>
3        <id>pdftron</id>
4        <name>PDFNet Maven</name>
5        <url>https://pdftron.com/maven/release</url>
6    </repository>
7</repositories>

2. Add the PDFNet Maven dependency in your pom.xml.

XML

1<dependencies>
2    <dependency>
3        <groupId>com.pdftron</groupId>
4        <artifactId>PDFNet</artifactId>
5        <version>11.1.0</version>
6    </dependency>
7</dependencies>

Integrate into your application

Add PDFNet Maven repository and dependency in your pom.xml.
In your src\main\java\your\java\folder\, add the following code to your java files. We use src\main\java\com\mycompany\app\App.java as an example:

Java

1package com.mycompany.app;
2import com.pdftron.pdf.*;
3public class App
4{
5    public static void main(String[] args)
6    {
7        PDFNet.initialize("YOUR_APRYSE_LICENSE_KEY");
8        try {
9             // YOUR CODE GOES HERE
10        } catch (Exception e) {
11        }
12        PDFNet.terminate();
13    }
14}

To test your code, you can navigate to the root of your project and run the following commands:

Bash

1mvn compile
2mvn exec:java -Dexec.mainClass=com.mycompany.app.App

If the program runs successfully, you should see no error in the terminal.

We have demonstrated how to integrate Apryse's Java SDK into your Maven project. If your have any questions, please don't hesitate to contact us!

1. Add the PDFNet Maven repository in your top-level build.gradle.

Groovy

1repositories {
2    maven {
3       url 'https://pdftron.com/maven/release/'
4   }
5}

2. Add the PDFNet dependency in your build.gradle.

Groovy

1dependencies {
2    implementation 'com.pdftron:PDFNet:11.1.0'
3}

Integrate into your application

Here we use a demo Gradle app as an example:

1. Add PDFNet Maven repository and dependency in your build.gradle.

Groovy

1repositories {
2    maven {
3       url 'https://pdftron.com/maven/release/'
4   }
5}
6dependencies {
7    implementation 'com.pdftron:PDFNet:11.1.0'
8}
9application {
10    mainClass = 'demo.App'
11}

2. In your app\src\main\java\your\java\folder\, add the following code to your java files. In this example, it's app\src\main\java\demo\App.java.

Java

1package demo;
2import com.pdftron.pdf.*;
3public class App
4{
5    public static void main(String[] args)
6    {
7        PDFNet.initialize("YOUR_APRYSE_LICENSE_KEY");
8        try {
9         // YOUR CODE GOES HERE
10        } catch (Exception e) {
11        }
12        PDFNet.terminate();
13    }
14}

To test your code, you can navigate to the root of your project and run the following commands:

Bash

1./gradlew run

If the program builds successfully, you should see Apryse is running ... and BUILD SUCCESSFUL in the terminal.

We have demonstrated how to integrate Apryse's Java SDK into your Gradle project. You can find more information about building with Java on Gradle. If your have any questions, please don't hesitate to contact us!

macOS Java PDF library integration

This guide will help you run Apryse samples and integrate a free trial of the Apryse SDK into Java applications on macOS. Your free trial includes unlimited trial usage and support from solution engineers.

Prerequisites

JDK version ≥ 5
Apryse's Java PDF library for macOS:

Download the SDK

Run Apryse SDK in production

A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.

Keep your commercial license key confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Initial setup

Extract the folder from the .zip file.
Get your Apryse trial key.

License Key

Apryse collects some data regarding your usage of the SDK for product improvement.

If you wish to continue without data collection, contact us and we will email you a no-tracking trial key for you to get started.

Run the samples

Run a specific sample

Navigate to the JAVA folder in a sample project, for example /Samples/AddImageTest/JAVA and run the sample with

sh

1./RunTest.sh

Run all samples

Navigate to /Samples and run

sh

1./runall_java.sh

The tests will run one by one.

Output files will be in /Samples/TestFiles/Output

Integrate into your application

Navigate to the /Samples directory of the Apryse SDK and create a directory called myApp if it does not exist already. This guide will assume your project is named myApp.
Enter your myApp directory and create a JAVA directory for organization. Then create a myApp.java file in the JAVA directory. Open this file in your favorite text editor and paste:

Java

1import java.io.File;
2import java.io.IOException;
3import com.pdftron.common.PDFNetException;
4import com.pdftron.pdf.*;
5import com.pdftron.sdf.SDFDoc;
6import com.pdftron.sdf.ObjSet;
7import com.pdftron.sdf.Obj;
8public class myApp
9{
10    public static void main(String[] args)
11    {
12        PDFNet.initialize("YOUR_APRYSE_LICENSE_KEY");  // PDFNet must be initialized before accessing any Apryse API
13        try
14        {
15            PDFDoc doc = new PDFDoc();
16            Page page = doc.pageCreate();  // Start a new page
17            doc.pagePushBack(page);  // Add the page to the document
18            doc.save("output.pdf", SDFDoc.SaveMode.LINEARIZED, null);  // Save the document as a linearized PDF
19        }
20        catch(PDFNetException e)
21        {
22            e.printStackTrace();
23            System.out.println(e);
24        }
25        System.out.println("Hello World!");
26    }
27}

3. In that same JAVA directory inside your myApp project folder and compile your application using our PDFNet library:

Bash

1javac -cp .:../../../Lib/PDFNet.jar myApp.java

4. Run the project by executing:

Bash

1java -Djava.library.path=../../../Lib -classpath .:../../../Lib/PDFNet.jar myApp

If all goes well, your terminal should output:

txt

1PDFNet is running in demo mode.
2Permission: write
3Hello World!

Check the output.pdf that the program output in the same directory. It should be a PDF with one blank page.

Next step

Troubleshooting

Check the troubleshooting page if you run into any issues going through this document.

1. Add the PDFNet Maven repository in your top-level pom.xml.

XML

1<repositories>
2    <repository>
3        <id>pdftron</id>
4        <name>PDFNet Maven</name>
5        <url>https://pdftron.com/maven/release</url>
6    </repository>
7</repositories>

2. Add the PDFNet Maven dependency in your pom.xml.

XML

1<dependencies>
2    <dependency>
3        <groupId>com.pdftron</groupId>
4        <artifactId>PDFNet</artifactId>
5        <version>10.10.0</version>
6    </dependency>
7</dependencies>

Integrate into your application

Add PDFNet Maven repository and dependency in your pom.xml.
In your src\main\java\your\java\folder\, add the following code to your java files. We use src\main\java\com\mycompany\app\App.java as an example:

Java

1package com.mycompany.app;
2import com.pdftron.pdf.*;
3public class App
4{
5    public static void main(String[] args)
6    {
7        PDFNet.initialize("YOUR_APRYSE_LICENSE_KEY");
8        try {
9             // YOUR CODE GOES HERE
10        } catch (Exception e) {
11        }
12        PDFNet.terminate();
13    }
14}

To test your code, you can navigate to the root of your project and run the following commands:

Bash

1mvn compile
2mvn exec:java -Dexec.mainClass=com.mycompany.app.App

If the program runs successfully, you should see no error in the terminal.

We have demonstrated how to integrate Apryse's Java SDK into your Maven project. If your have any questions, please don't hesitate to contact us!

1. Add the PDFNet Maven repository in your top-level build.gradle.

Groovy

1repositories {
2    maven {
3       url 'https://pdftron.com/maven/release/'
4   }
5}

2. Add the PDFNet dependency in your build.gradle.

Groovy

1dependencies {
2    implementation 'com.pdftron:PDFNet:10.10.0'
3}

Integrate into your application

Here we use a demo Gradle app as an example:

1. Add PDFNet Maven repository and dependency in your build.gradle.

Groovy

1repositories {
2    maven {
3       url 'https://pdftron.com/maven/release/'
4   }
5}
6dependencies {
7    implementation 'com.pdftron:PDFNet:10.10.0'
8}
9application {
10    mainClass = 'demo.App'
11}

2. In your app\src\main\java\your\java\folder\, add the following code to your java files. In this example, it's app\src\main\java\demo\App.java.

Java

1package demo;
2import com.pdftron.pdf.*;
3public class App
4{
5    public static void main(String[] args)
6    {
7        PDFNet.initialize("YOUR_APRYSE_LICENSE_KEY");
8        try {
9         // YOUR CODE GOES HERE
10        } catch (Exception e) {
11        }
12        PDFNet.terminate();
13    }
14}

To test your code, you can navigate to the root of your project and run the following commands:

Bash

1./gradlew run

If the program builds successfully, you should see Apryse is running ... and BUILD SUCCESSFUL in the terminal.

We have demonstrated how to integrate Apryse's Java SDK into your Gradle project. Read more on building with Java on Gradle. If your have any questions, please don't hesitate to contact us!

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales