Some test text!

Search
Hamburger Icon

Windows / Guides / Java

Java & Windows 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++ page here.
Run Apryse SDK in production
A commercial license key is required for use in a production environment. Please fill out our licensing form if you do not have a valid license key.
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

  1. Extract the folder from the .zip file.

  2. Get your Apryse trial 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

  1. Find the sample you want to run and navigate into the JAVA folder inside.

  2. 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

  1. 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

Manual Integration

Maven Integration

Gradle Integration

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.

  1. Create a new folder in Samples by the name HelloWorld.

  2. In the HelloWorld folder, create a new file called HelloWorld.java, open and edit it using your favorite text editor.

  3. Insert the following to your file:

    import java.io.File;
    import java.io.IOException;
    
    // These are the most important packages to import
    // for basic document manipulation. 
    import com.pdftron.common.PDFNetException;
    import com.pdftron.pdf.*;
    import com.pdftron.sdf.SDFDoc;
    
    import java.io.*;
    
    public class HelloWorld
    {
        // Just a simple setup for the application
        public static void main(String[] args)
        {
            // PDFNet must always be initialized before any Apryse
            // classes and methods can be used
            PDFNet.initialize("YOUR_APRYSE_LICENSE_KEY");
            System.out.println("Hello World!");
    
            // Most Apryse operations are required to be wrapped in
            // a try-catch block for PDFNetException, or in a method/class that
            // throws PDFNetException
            try {
                // Creates a new PDFDoc object
                PDFDoc doc = new PDFDoc();
    
                // Creating a new page and adding it
                // to document's sequence of pages
                Page page1 = doc.pageCreate();
                doc.pagePushBack(page1);
    
                // Files can be saved with various options
                // Linearized files are the most effective
                // for opening and viewing quickly on various platforms
                doc.save(("linearized_ouput.pdf"), SDFDoc.SaveMode.LINEARIZED, null);
    
                doc.close();
            } catch (PDFNetException e) {
                System.out.println(e);
                e.getStackTrace();
            }
            PDFNet.terminate();
        }
    }

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

    javac -cp .;../../Lib/PDFNet.jar HelloWorld.java
    
    java.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.

Next step

Guides API docsSamples

Troubleshooting

Java installation issues
More information about JDK installation, possible issues and their respective fixes.

Get the answers you need: Chat with us