This sample project helps you get started with the PDF Services 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 Services Java SDK supports only server side use cases.
The sample application has the following requirements:
- Java JDK : Version 11 or above.
- Build Tool: The application requires Maven to be installed. Maven installation instructions can be found here.
The credentials file for the samples is pdfservices-api-credentials.json.
Before the samples can be run, set the environment variables PDF_SERVICES_CLIENT_ID and PDF_SERVICES_CLIENT_SECRET from the pdfservices-api-credentials.json file downloaded at the end of creation of credentials via Get Started workflow by running the following commands :
- For MacOS/Linux Users :
export PDF_SERVICES_CLIENT_ID=<YOUR CLIENT ID>
export PDF_SERVICES_CLIENT_SECRET=<YOUR CLIENT SECRET>
- For Windows Users :
set PDF_SERVICES_CLIENT_ID=<YOUR CLIENT ID>
set PDF_SERVICES_CLIENT_SECRET=<YOUR CLIENT SECRET>
The SDK supports setting up custom socket timeout or connect timeout for the API calls. Please refer this section to know more.
The SDK also supports setting up Proxy Server configurations which helps in successful API calls for network where all outgoing calls have to go through a proxy else, they are blocked. Please refer this section to know more.
Additionally, SDK can be configured to process the documents in the specified region. 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 Services 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.pdfservices.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 supported formats to PDF. Refer the Create PDF API documentation 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.pdfservices.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.pdfservices.operation.samples.createpdf.CreatePDFFromDOCXWithOptions
The sample class CreatePDFFromPPTX creates a PDF file from a PPTX file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.createpdf.CreatePDFFromPPTX
These samples illustrate how to convert HTML to PDF. Refer the HTML to PDF API documentation to see instructions on the structure of the zip file.
The sample class HTMLWithInlineCSSToPDF creates a PDF file from an input HTML file with inline CSS.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.htmltopdf.HTMLWithInlineCSSToPDF
The sample class HTMLToPDFFromURL creates a PDF file from an HTML specified via URL.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.htmltopdf.HTMLToPDFFromURL
The sample class StaticHTMLToPDF creates a PDF file from a zip file containing the input HTML file and its resources.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.htmltopdf.StaticHTMLToPDF
The sample class DynamicHTMLToPDF 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.pdfservices.operation.samples.htmltopdf.DynamicHTMLToPDF
These samples illustrate how to export PDF files to other formats. Refer Export PDF API documentation and Export PDF To Images API documentation for 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.pdfservices.operation.samples.exportpdf.ExportPDFToDOCX
The sample class ExportPDFToDOCXWithOCROption converts a PDF file to a DOCX file. OCR processing is also performed on the input PDF file to extract text from images in the document.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.exportpdf.ExportPDFToDOCXWithOCROption
The sample class ExportPDFToJPEG converts a PDF file's pages to a list of JPEG images.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.exportpdftoimages.ExportPDFToJPEG
The sample class ExportPDFToJPEGZip converts a PDF file's pages to JPEG images. The resulting file is a ZIP archive containing one image per page of the source PDF file
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.exportpdftoimages.ExportPDFToJPEGZip
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.pdfservices.operation.samples.combinepdf.CombinePDF
The sample class CombinePDFWithPageRanges combines specific pages of multiple PDF files into a single PDF file.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.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.pdfservices.operation.samples.documentmerge.MergeDocumentToDOCX
The sample class MergeDocumentToDOCX merges the Word based document template with the input JSON data and fragments JSON to generate the output document in the DOCX format.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.documentmerge.MergeDocumentToDOCXWithFragments
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.pdfservices.operation.samples.documentmerge.MergeDocumentToPDF
These samples illustrate how to perform electronic seal over PDF documents like agreements, invoices, proposals, reports, forms, branded marketing documents and more. To know more about PDF Electronic Seal, please see the documentation. The following details needs to updated while executing these samples: PROVIDER_NAME, ACCESS_TOKEN, CREDENTIAL_ID and PIN.
The sample class ElectronicSeal uses the sealing options with default appearance options to apply electronic seal over the PDF document.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.electronicseal.ElectronicSeal
The sample class ElectronicSealWithAppearanceOptions uses the sealing options with custom appearance options to apply electronic seal over the PDF document.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.electronicseal.ElectronicSealWithAppearanceOptions
The sample class ElectronicSealWithTimeStampAuthority uses a time stamp authority to apply electronic seal with trusted timestamp over the PDF document.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.electronicseal.ElectronicSealWithTimeStampAuthority
These samples illustrate extracting content of PDF in a structured JSON format along with the renditions inside PDF. The output of SDK extract operation is Zip package. The Zip package consists of following:
- The structuredData.json file with the extracted content & PDF element structure. See the JSON schema. Please refer the Styling JSON schema for a description of the output when the styling option is enabled.
- A renditions' folder(s) containing renditions for each element type selected as input. The folder name is either “tables” or “figures” depending on your specified element type. Each folder contains renditions with filenames that correspond to the element information in the JSON file.
The sample class ExtractTextInfoFromPDF extracts text elements from PDF document.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.extractpdf.ExtractTextInfoFromPDF
The sample class ExtractTextTableInfoFromPDF extracts text, table elements from PDF document.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.extractpdf.ExtractTextTableInfoFromPDF
The sample class ExtractTextTableInfoWithRenditionsFromPDF extracts text, table elements along with table renditions from PDF document. Note that the output is a zip containing the structured information along with renditions as described in section.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.extractpdf.ExtractTextTableInfoWithRenditionsFromPDF
The sample class ExtractTextTableInfoWithFiguresTablesRenditionsFromPDF extracts text, table elements along with figure and table element's renditions from PDF document. Note that the output is a zip containing the structured information along with renditions as described in section.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.extractpdf.ExtractTextTableInfoWithFiguresTablesRenditionsFromPDF
The sample class ExtractTextInfoWithCharBoundsFromPDF extracts text elements and bounding boxes for characters present in text blocks. Note that the output is a zip containing the structured information along with renditions as described in section.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.extractpdf.ExtractTextInfoWithCharBoundsFromPDF
Extract Text, Table Elements and bounding boxes for Characters present in text blocks with Renditions of Table Elements
The sample class ExtractTextTableInfoWithCharBoundsFromPDF extracts text, table elements, bounding boxes for characters present in text blocks and table element's renditions from PDF document. Note that the output is a zip containing the structured information along with renditions as described in section.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.extractpdf.ExtractTextTableInfoWithCharBoundsFromPDF
The sample class ExtractTextTableInfoWithTableStructureFromPDF extracts text, table elements, table structures as CSV and table element's renditions from PDF document. Note that the output is a zip containing the structured information along with renditions as described in section.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.extractpdf.ExtractTextTableInfoWithTableStructureFromPDF
The sample class ExtractTextTableInfoWithStylingFromPDF extracts text and table elements along with the styling information of the text blocks. Note that the output is a zip containing the structured information along with renditions as described in section.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.extractpdf.ExtractTextTableInfoWithStylingFromPDF
This sample illustrates how to fetch properties of a PDF file
The sample class GetPDFProperties fetches the properties of an input PDF.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.pdfproperties.GetPDFProperties
These samples illustrate how to provide a custom client configurations(timeouts, proxy etc.).
The sample class CreatePDFWithCustomTimeouts highlights how to provide the custom value for connection timeout and socket timeout.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.customconfigurations.CreatePDFWithCustomTimeouts
The sample class CreatePDFWithProxyServer highlights how to provide Proxy Server configurations to allow all API calls via that proxy Server.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.customconfigurations.CreatePDFWithProxyServer
The sample class CreatePDFWithAuthenticatedProxyServer highlights how to provide Proxy Server configurations to allow all API calls via that proxy Server that requires authentication.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.customconfigurations.CreatePDFWithAuthenticatedProxyServer
The sample class ExportPDFWithSpecifiedRegion highlights how to configure the SDK to process the documents in the specified region.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.customconfigurations.ExportPDFWithSpecifiedRegion
These samples illustrate how to create a PDF document with enhanced readability from existing PDF document. All tags from the input file will be removed except for existing alt-text images and a new tagged PDF will be created as output. However, the generated PDF is not guaranteed to comply with accessibility standards such as WCAG and PDF/UA as you may need to perform further downstream remediation to meet those standards.
The sample project AutotagPDF highlights how to add tags to PDF document to make the PDF more accessible.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.autotagpdf.AutotagPDF
The sample project AutotagPDFWithOptions highlights how to add tags to PDF documents to make the PDF more accessible and also shift the headings in the output PDF file. Also, it generates a tagging report which contains the information about the tags that the tagged output PDF document contains.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.autotagpdf.AutotagPDFWithOptions
The sample project AutotagPDFParameterised highlights how to add tags to PDF documents to make the PDF more accessible by setting options through command line arguments.
Here is a sample list of command line arguments and their description:
--input < input file path >
--output < output file path >
--report { If this argument is present then the output will be generated with the tagging report }
--shift_headings { If this argument is present then the headings will be shifted in the output PDF document }
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.autotagpdf.AutotagPDFParameterised -Dexec.args="--report --shift_headings --input src/main/resources/autotagPDFInput.pdf --output output/AutotagPDFParamaterised/"
These samples illustrate how to use external input and output storage for the supported operations.
The sample class ExternalInputCreatePDFFromDOCX creates a PDF file from a DOCX file stored at external storage.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.externalstorage.ExternalInputCreatePDFFromDOCX
Create a PDF File From a DOCX File Using External Input Storage and Store the Result in External Output Storage
The sample class ExternalInputAndOutputCreatePDFFromDOCX creates a PDF file from a DOCX file stored at external storage and stores the result in external output storage.
mvn -f pom.xml exec:java -Dexec.mainClass=com.adobe.pdfservices.operation.samples.externalstorage.ExternalInputAndOutputCreatePDFFromDOCX
This project is licensed under the MIT License. See LICENSE for more information.