Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 261. PDF Component

Available as of Camel version 2.16

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>
Copy to Clipboard Toggle word wrap

261.1. URI format
Copy link

The PDF component only supports producer endpoints. 

pdf:operation[?options]
Copy to Clipboard Toggle word wrap

261.2. Options
Copy link

The PDF component has no options.

The PDF endpoint is configured using URI syntax: 

pdf:operation
Copy to Clipboard Toggle word wrap

with the following path and query parameters:

261.2.1. Path Parameters (1 parameters):
Copy link

Expand
NameDescriptionDefaultType

operation

Required Operation type

 

PdfOperation

261.2.2. Query Parameters (9 parameters):
Copy link

Expand
NameDescriptionDefaultType

font (producer)

Font

Helvetica

PDFont

fontSize (producer)

Font size in pixels

14

float

marginBottom (producer)

Margin bottom in pixels

20

int

marginLeft (producer)

Margin left in pixels

20

int

marginRight (producer)

Margin right in pixels

40

int

marginTop (producer)

Margin top in pixels

20

int

pageSize (producer)

Page size

A4

PDRectangle

textProcessingFactory (producer)

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.

lineTermination

TextProcessingFactory

synchronous (advanced)

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

false

boolean

261.3. Spring Boot Auto-Configuration
Copy link

The component supports 2 options, which are listed below.

Expand
NameDescriptionDefaultType

camel.component.pdf.enabled

Enable pdf component

true

Boolean

camel.component.pdf.resolve-property-placeholders

Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.

true

Boolean

261.4. Headers
Copy link

Expand
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.10/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.10/javadocs/org/apache/pdfbox/pdmodel/encryption/DecryptionMaterial.html[DecryptionMaterial]. Mandatory header if PDF document is encrypted.

261.5. See Also
Copy link

  • Configuring Camel
  • Component
  • Endpoint
  • Getting Started

-   -

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat