FOP
Since Camel 2.10
Only producer is supported
The FOP component allows you to render a message into different output formats using Apache FOP.
Maven users will need to add the following dependency to their pom.xml
for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-fop</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
Output Formats
The primary output format is PDF but other output formats are also supported:
name | outputFormat | description |
---|---|---|
application/pdf |
Portable Document Format |
|
PS |
application/postscript |
Adobe Postscript |
PCL |
application/x-pcl |
Printer Control Language |
PNG |
image/png |
PNG images |
JPEG |
image/jpeg |
JPEG images |
SVG |
image/svg+xml |
Scalable Vector Graphics |
XML |
application/X-fop-areatree |
Area tree representation |
MIF |
application/mif |
FrameMaker’s MIF |
RTF |
application/rtf |
Rich Text Format |
TXT |
text/plain |
Text |
The complete list of valid output formats can be found in the MimeConstants.java
source file.
Configuring Options
Camel components are configured on two separate levels:
-
component level
-
endpoint level
Configuring Component Options
The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.
Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.
Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.
Configuring Endpoint Options
Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.
Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.
A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.
The following two sections lists all the options, firstly for the component followed by the endpoint.
Component Options
The FOP component supports 2 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
boolean |
|
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. |
true |
boolean |
Endpoint Options
The FOP endpoint is configured using URI syntax:
fop:outputType
with the following path and query parameters:
Query Parameters (3 parameters)
Name | Description | Default | Type |
---|---|---|---|
Allows to use a custom configured or implementation of org.apache.fop.apps.FopFactory. |
FopFactory |
||
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
boolean |
|
The location of a configuration file which can be loaded from classpath or file system. |
String |
Configuration file
The location of a configuration file with the following
structure.
The file is loaded from the classpath by
default. You can use file:
, or classpath:
as prefix to load the
resource from file or classpath. In previous releases the file is always
loaded from file system.
Message Operations
name | default value | description |
---|---|---|
CamelFop.Output.Format |
Overrides the output format for that message |
|
CamelFop.Encrypt.userPassword |
PDF user password |
|
CamelFop.Encrypt.ownerPassword |
PDF owner passoword |
|
CamelFop.Encrypt.allowPrint |
true |
Allows printing the PDF |
CamelFop.Encrypt.allowCopyContent |
true |
Allows copying content of the PDF |
CamelFop.Encrypt.allowEditContent |
true |
Allows editing content of the PDF |
CamelFop.Encrypt.allowEditAnnotations |
true |
Allows editing annotation of the PDF |
CamelFop.Render.producer |
Apache FOP |
Metadata element for the system/software that produces the document |
CamelFop.Render.creator |
Metadata element for the user that created the document |
|
CamelFop.Render.creationDate |
Creation Date |
|
CamelFop.Render.author |
Author of the content of the document |
|
CamelFop.Render.title |
Title of the document |
|
CamelFop.Render.subject |
Subject of the document |
|
CamelFop.Render.keywords |
Set of keywords applicable to this document |
Example
Below is an example route that renders PDFs from xml data and xslt template and saves the PDF files in target folder:
from("file:source/data/xml")
.to("xslt:xslt/template.xsl")
.to("fop:application/pdf")
.to("file:target/data");
Spring Boot Auto-Configuration
When using fop with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-fop-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
The component supports 3 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. |
true |
Boolean |
|
Whether to enable auto configuration of the fop component. This is enabled by default. |
Boolean |
||
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
Boolean |