This sample project helps you get started with the PDF Tools Java SDK.
The sample classes illustrate how to perform PDF-related actions (such as converting to and from the PDF format) using the SDK. Please note that the PDF Tools Java SDK supports only server side use cases.
The sample application has the following requirements:
- Java JDK : Version 8 or above.
- Build Tool: The application requires Maven to be installed. Maven installation instructions can be found here.
The credentials file and corresponding private key file for the samples is pdftools-api-credentials.json and private.key
respectively. Before the samples can be run, replace both the files with the ones present in the downloaded zip file at
the end of creation of credentials via Get Started workflow.
The SDK also supports providing the authentication credentials at runtime, without storing them in a config file. Please refer this section to know more.
If you receive ServiceUsageException during the Samples run, it means that trial credentials have exhausted their usage quota. Please contact us to get paid credentials.
Run the following command to build the project:
mvn clean install
Note that the PDF Tools SDK is listed as a dependency in the pom.xml and will be downloaded automatically.
For logging, this SDK uses the slf4j API with a log4j2-slf4j binding. The logging configurations
are provided in src/main/resources/log4j2.properties. Alternate bindings, if required, can be specified in pom.xml.
The following sub-sections describe how to run the samples. Prior to running the samples, check that the configuration file is set up as described above and that the project has been built.
The code itself is in the com.adobe.platform.operation.samples package under the src/main/java/ folder. Test
files used by the samples can be found in src/main/resources/. When executed, all samples create an output
child folder under the working directory to store their results.
These samples illustrate how to convert files of some formats to PDF. Refer the documentation of CreatePDFOperation.java to see the list of all supported media types which can be converted to PDF.
The sample class CreatePDFFromDOCX creates a PDF file from a DOCX file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.createpdf.CreatePDFFromDOCX
The sample class CreatePDFFromDOCXWithOptions creates a PDF file from a DOCX file by setting documentLanguage as the language of input file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.createpdf.CreatePDFFromDOCXWithOptions
The sample class CreatePDFFromDOCXInputStream creates a PDF file from a DOCX input stream.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.createpdf.CreatePDFFromDOCXInputStream
The sample class CreatePDFFromDOCXToOutputStream creates a PDF file from a DOCX file. Instead of saving the result to a local file, it writes the result to an output stream.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.createpdf.CreatePDFFromDOCXToOutputStream
The sample class CreatePDFFromPPTX creates a PDF file from a PPTX file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.createpdf.CreatePDFFromPPTX
The sample class CreatePDFFromStaticHTML creates a PDF file from a zip file containing the input HTML file and its resources. Please refer the documentation of CreatePDFOperation.java to see instructions on the structure of the zip file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.createpdf.CreatePDFFromStaticHTML
The sample class CreatePDFFromDynamicHTML converts a zip file, containing the input HTML file and its resources, along with the input data to a PDF file. The input data is used by the javascript in the HTML file to manipulate the HTML DOM, thus effectively updating the source HTML file. This mechanism can be used to provide data to the template HTML dynamically and then, convert it into a PDF file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.createpdf.CreatePDFFromDynamicHTML
The sample class CreatePDFWithInMemoryAuthCredentials highlights how to provide in-memory auth credentials
for performing an operation. This enables the clients to fetch the credentials from a secret server during runtime,
instead of storing them in a file.
Before running the sample, authentication credentials need to be updated as per the instructions in the class.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.createpdf.CreatePDFWithInMemoryAuthCredentials
The sample project CreatePDFWithCustomTimeouts highlights how to provide the custom value for connection timeout and socket timeout.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.createpdf.CreatePDFWithCustomTimeouts
These samples illustrate how to export PDF files to other formats. Refer to the documentation of ExportPDFOperation.java to see the list of supported export formats.
The sample class ExportPDFToDOCX converts a PDF file to a DOCX file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.exportpdf.ExportPDFToDOCX
The sample class ExportPDFToJPEG converts a PDF file's pages to JPEG images. Note that the output is a zip archive containing the individual images.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.exportpdf.ExportPDFToJPEG
These samples illustrate how to combine multiple PDF files into a single PDF file.
The sample class CombinePDF combines multiple PDF files into a single PDF file. The combined PDF file contains all pages of the source files.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.combinepdf.CombinePDF
The sample class CombinePDFWithPageRanges combines specific pages of multiple PDF files into into a single PDF file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.combinepdf.CombinePDFWithPageRanges
These samples illustrate how to apply OCR(Optical Character Recognition) to a PDF file and convert it to a searchable copy of your PDF. The supported input format is application/pdf.
The sample class OcrPDF converts a PDF file into a searchable PDF file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.ocrpdf.OcrPDF
The sample class OcrPDFWithOptions converts a PDF file to a searchable PDF file with maximum fidelity to the original image and default en-us locale. Refer to the documentation of OCRSupportedLocale and OCRSupportedType to see the list of supported OCR locales and OCR types.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.ocrpdf.OcrPDFWithOptions
These samples illustrate how to reduce the size of a PDF file.
The sample class CompressPDF reduces the size of a PDF file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.compresspdf.CompressPDF
The sample class CompressPDFWithOptions reduces the size of a PDF file on the basis of provided compression level. Refer to the documentation of CompressionLevel to see the list of supported compression levels.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.compresspdf.CompressPDFWithOptions
The sample illustrates how to convert a PDF file into a Linearized (also known as "web optimized") PDF file. Such PDF files are optimized for incremental access in network environments.
The sample class LinearizePDF optimizes the PDF file for a faster Web View.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.linearizepdf.LinearizePDF
These samples illustrate how to secure a PDF file with a password.
The sample class ProtectPDF converts a PDF file into a password protected PDF file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.protectpdf.ProtectPDF
The sample class ProtectPDFWithOwnerPassword secures an input PDF file with owner password and allows certain access permissions such as copying and editing the contents, and printing of the document at low resolution.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.protectpdf.ProtectPDFWithOwnerPassword
The sample illustrates how to remove a password security from a PDF document.
The sample class RemoveProtection removes a password security from a secured PDF document.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.removeprotection.RemoveProtection
The sample illustrates how to rotate pages in a PDF file.
The sample class RotatePDFPages rotates specific pages in a PDF file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.rotatepages.RotatePDFPages
The sample illustrates how to delete pages in a PDF file.
The sample class DeletePDFPages removes specific pages from a PDF file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.deletepages.DeletePDFPages
The sample illustrates how to reorder the pages in a PDF file.
The sample class ReorderPDFPages rearranges the pages of a PDF file according to the specified order.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.reorderpages.ReorderPDFPages
The sample illustrates how to insert pages in a PDF file.
The sample class InsertPDFPages inserts pages of multiple PDF files into a base PDF file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.insertpages.InsertPDFPages
The sample illustrates how to replace pages of a PDF file.
The sample class ReplacePDFPages replaces specific pages in a PDF file with pages from multiple PDF files.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.replacepages.ReplacePDFPages
These samples illustrate how to split PDF file into multiple PDF files.
The sample class SplitPDFByNumberOfPages splits input PDF into multiple PDF files on the basis of the maximum number of pages each of the output files can have.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.splitpdf.SplitPDFByNumberOfPages
The sample class SplitPDFIntoNumberOfFiles splits input PDF into multiple PDF files on the basis of the number of documents.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.splitpdf.SplitPDFIntoNumberOfFiles
The sample class SplitPDFByPageRanges splits input PDF into multiple PDF files on the basis of page ranges. Each page range corresponds to a single output file having the pages specified in the page range.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.splitpdf.SplitPDFByPageRanges
Adobe Document Merge Operation allows you to produce high fidelity PDF and Word documents with dynamic data inputs. Using this operation, you can merge your JSON data with Word templates to create dynamic documents for contracts and agreements, invoices, proposals, reports, forms, branded marketing documents and more. To know more about document generation and document templates, please checkout the documentation
The sample class MergeDocumentToDOCX merges the Word based document template with the input JSON data to generate the output document in the DOCX format.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.documentmerge.MergeDocumentToDOCX
The sample class MergeDocumentToPDF merges the Word based document template with the input JSON data to generate the output document in the PDF format.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.platform.operation.samples.documentmerge.MergeDocumentToPDF
This project is licensed under the MIT License. See LICENSE for more information.