PDF Component

Table of Contents

URI format
Options
Headers
See Also

Available as of Camel 2.16.0

The PDF: components provides the ability to create, modify or extract content from PDF documents. This component uses Apache PDFBox as underlying library to work with PDF documents.

In order to use the PDF component, Maven users will need to add the following dependency to their pom.xml:

pom.xml

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-pdf</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

URI format

The PDF component only supports producer endpoints.

pdf:operation[?options]

Options

The PDF component has no options.

The PDF component supports 10 endpoint options which are listed below:

{% raw %}

NameGroupDefaultJava TypeDescription

operation

producer

 

PdfOperation

Required Operation type

font

producer

Helvetica

PDFont

Font

fontSize

producer

14

float

Font size in pixels

marginBottom

producer

20

int

Margin bottom in pixels

marginLeft

producer

20

int

Margin left in pixels

marginRight

producer

40

int

Margin right in pixels

marginTop

producer

20

int

Margin top in pixels

pageSize

producer

PAGE_SIZE_A4

PDRectangle

Page size

textProcessingFactory

producer

lineTermination

TextProcessingFactory

Text processing to use. autoFormatting: Text is getting sliced by words then max amount of words that fits in the line will be written into pdf document. With this strategy all words that doesn’t fit in the line will be moved to the new line. lineTermination: Builds set of classes for line-termination writing strategy. Text getting sliced by line termination symbol and then it will be written regardless it fits in the line or not.

synchronous

advanced

false

boolean

Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).

{% endraw %}

Headers

HeaderDescription

pdf-document

Mandatory header for append operation and ignored in all other operations. Expected type is PDDocument. Stores PDF document which will be used for append operation.

protection-policy

Expected type ishttps://pdfbox.apache.org/docs/1.8.9/javadocs/org/apache/pdfbox/pdmodel/encryption/ProtectionPolicy.html[ProtectionPolicy]. If specified then PDF document will be encrypted with it.

decryption-material

Expected type ishttps://pdfbox.apache.org/docs/1.8.9/javadocs/org/apache/pdfbox/pdmodel/encryption/DecryptionMaterial.html[DecryptionMaterial]. Mandatory header if PDF document is encrypted.

See Also

-   -