Document Conversion Library for JAVA

File conversion example using Java

The ConvertAPI Java library empowers developers to seamlessly integrate advanced document conversion and manipulation capabilities into their Java applications. Supporting hundreds of file formats—including PDFs, Office documents, images, and more—it streamlines complex tasks like merging files, compressing large documents, extracting valuable data, and securely redacting sensitive information.

With intuitive methods and flexible parameters, the library reduces development overhead and speeds up integration, allowing you to focus on delivering reliable, high-quality document processing solutions within a familiar Java environment.

Install the ConvertAPI library into your JAVA project

To get started, install the ConvertAPI Java package using Maven:

<dependency>

   <groupId>com.convertapi.client</groupId>

   <artifactId>convertapi</artifactId>

   <version>2.10</version>

</dependency>

Convert PPTX to PDF example

The ConvertAPI Java library makes it effortless to convert PPTX presentations into PDFs while offering a wide range of customizable parameters to meet your specific requirements. Whether you need to adjust page size, define conversion quality, embed fonts, or include speaker notes, the library provides intuitive options right out of the box.

With straightforward integration into your Java application, converting PPTX files to PDF is not only reliable and efficient, but also easily adaptable to suit the exact presentation standards and design elements your project demands.

Convert a Remote File

This example demonstrates how to execute a document conversion directly from a remote URL. This illustrates how to convert a file hosted on a remote server by providing its direct URL.

Key Features:

• Accepts a publicly accessible file URL as input.
• Processes the file conversion without downloading it locally first.
• Stores the converted file on the local machine.

It is useful for automating the conversion of files available online without manual intervention.

/**
 * Example of conversion remote file. Converting file must be accessible from
 * the internet.
 */
public class ConvertRemoteFile {

    public static void main(String[] args) throws ExecutionException, InterruptedException {
        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a

        System.out.println("Converting remote PPTX to PDF");
        CompletableFuture<ConversionResult> result = ConvertApi.convert("pptx", "pdf",
            new Param("file", "https://cdn.convertapi.com/cara/testfiles/presentation.pptx")
        );

        Path pdfFile = Paths.get(System.getProperty("java.io.tmpdir") + "/myfile.pdf");
        result.get().saveFile(pdfFile).get();

        System.out.println("PDF file saved to: " + pdfFile.toString());
    }
}

Convert File Stream

Shows how to perform file conversions entirely in memory using streams, eliminating the need for temporary file downloads and uploads.

Key Features

• Reads the input file into an InputStream.
• Processes the conversion directly from the stream.
• Writes the output to an OutputStream, avoiding disk I/O.

/**
 * Example of the file conversion when data is passed as a stream.
 */
public class ConvertStream {

    public static void main(String[] args) throws ExecutionException, InterruptedException, IOException {
        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a

        // Creating file data stream
        InputStream stream = Files.newInputStream(new File("src/main/resources/test.docx").toPath());

        System.out.println("Converting stream of DOCX data to PDF");
        CompletableFuture<ConversionResult> result = ConvertApi.convert("docx", "pdf",
                new Param("file", stream, "test.docx")
        );

        Path pdfFile = Paths.get(System.getProperty("java.io.tmpdir") + "/myfile.pdf");
        result.get().saveFile(pdfFile).get();

        System.out.println("PDF file saved to: " + pdfFile.toString());
    }
}

Convert Web To PDF

This example demonstrates converting a live web page into a PDF document by providing its URL.

Key Features:

• Fetches web content directly from the provided URL.
• Generates a PDF representation of the web page.
• Saves the resulting PDF to the local file system.

It is ideal for archiving web pages or generating PDF versions of online content for offline access or record-keeping.

/**
 * Example of converting Web Page URL to PDF file
 * https://www.convertapi.com/web-to-pdf
 */
public class ConvertWebToPdf {

    public static void main(String[] args) throws ExecutionException, InterruptedException {
        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a

        System.out.println("Converting WEB to PDF");
        CompletableFuture<ConversionResult> result = ConvertApi.convert("web", "pdf",
            new Param("url", "https://en.wikipedia.org/wiki/Data_conversion"),
            new Param("filename", "web-example")
        );

        Path tmpDir = Paths.get(System.getProperty("java.io.tmpdir"));
        CompletableFuture<Path> pdfFile = result.get().saveFile(tmpDir);

        System.out.println("PDF file saved to: " + pdfFile.get().toString());
    }
}

Conversion Chaining

Demonstrates chaining multiple conversions in a single workflow, such as converting a PDF to JPG and compressing result files into a ZIP archive.

Key Features:

• Executes sequential conversions using intermediate results.
• Manages multiple steps within a single process.
• Outputs the final converted file after all transformations.

It is extremely useful for complex workflows requiring multiple file transformations in a specific sequence.

/**
 * Short example of conversions chaining, the PDF pages extracted and saved as
 * separated JPGs and then ZIP'ed
 * https://www.convertapi.com/doc/chaining
 */
public class ConversionChaining {

    public static void main(String[] args) throws IOException, ExecutionException, InterruptedException {
        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a

        System.out.println("Converting PDF to JPG and compressing result files with ZIP");
        CompletableFuture<ConversionResult> jpgResult = ConvertApi.convert("docx", "jpg", new Param("file", Paths.get("files/test.docx")));
        System.out.println("ConvertApi.convert is not blocking method, proceeding to ZIP conversion");

        CompletableFuture<ConversionResult> zipResult = ConvertApi.convert("jpg", "zip", new Param("files", jpgResult));

        System.out.println("Saving result file (blocking operation)");
        Path tempDir = Paths.get(System.getProperty("java.io.tmpdir"));
        CompletableFuture<Path> path = zipResult.get().saveFile(tempDir);

        System.out.println("DOCX -> JPG conversion cost: " + jpgResult.get().conversionCost());
        System.out.println("DOCX -> JPG conversion result file count: " + jpgResult.get().fileCount());
        System.out.println("JPG -> ZIP conversion cost: " + zipResult.get().conversionCost());
        System.out.println("ZIP file saved to: " + path.get().toString());
    }
}

Advanced techniques

Below you will find some examples of advanced usage scenarios, including setting custom timeout and deleting the files from ConvertAPI servers manually.

Key Features:

• Demonstrates setting custom conversion timeout.
• Handles file deletion manually.
• Showcases setting a proxy server.

/**
 * Example of HTTP client setup to use HTTP proxy server.
 */
public class Advanced {

    public static void main(String[] args) throws ExecutionException, InterruptedException {
        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a

        // Advanced HTTP client setup
        Config.setDefaultHttpBuilder(builder -> {
            return builder
            //  .proxy(new Proxy(Proxy.Type.HTTP, new InetSocketAddress("10.0.0.1", 8888))) // Setting Proxy server
                .connectTimeout(3, TimeUnit.SECONDS);    // Setting connect timeout
            // More settings can be tuned here
        });

        // Conversion
        Param fileParam = new Param("file", "https://cdn.convertapi.com/cara/testfiles/presentation.pptx");
        System.out.println("Converting remote PPTX to PDF");
        CompletableFuture<ConversionResult> result = ConvertApi.convert("pptx", "pdf", fileParam);
        Path pdfFile = Paths.get(System.getProperty("java.io.tmpdir") + "/myfile.pdf");
        result.get().saveFile(pdfFile).get();

        // Leaving no files on convertapi.com server
        System.out.println("Deleting source file from convertapi.com server");
        fileParam.delete().get();
        System.out.println("Deleting result files from convertapi.com server");
        result.get().deleteSync();

        System.out.println("PDF file saved to: " + pdfFile.toString());
    }
}

Retrieve Account Information

The final example illustrates how to retrieve account information, such as usage statistics and remaining conversion credits, using the ConvertAPI Java SDK. It is important for monitoring account usage and managing conversion quotas programmatically.

Key Features:

• Authenticates using API credentials.
• Fetches user account details.
• Displays information like conversion usage and balance.

/**
 * Retrieve user information
 * https://www.convertapi.com/doc/user
 */
public class UserInformation {

    public static void main(String[] args) {
        Config.setDefaultApiCredentials(getenv("CONVERTAPI_CREDENTIALS"));   //Get your api credentials at https://www.convertapi.com/a
        User user = ConvertApi.getUser();

        System.out.println("API Key: " + user.ApiKey);
        System.out.println("Email: " + user.Email);
        System.out.println("Name: " + user.FullName);
        System.out.println("Status: " + user.Status);
        System.out.println("Active: " + user.Active);
        System.out.println("Total Conversions: " + user.ConversionsTotal);
        System.out.println("Conversions Consumed: " + user.ConversionsConsumed);
    }
}
}

With our Java SDK, you’ll unlock a wide range of over 500+ converters and document management capabilities—conveniently accessible from a single, unified platform.

You can provide documents via URLs, use file streams, or reference local file paths, ensuring that file handling fits seamlessly into your existing environment. To further enhance efficiency, consider employing conversion workflows to manage multiple tasks concurrently.

For in-depth examples and expert tips, be sure to explore our GitHub repository.