Red Hat Summit이 콘텐츠는 선택한 언어로 제공되지 않습니다.
Chapter 105. FOP Component
Available as of Camel version 2.10
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:
105.1. URI format
fop://outputFormat?[options]
fop://outputFormat?[options]105.2. 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 here
105.3. Endpoint Options
The FOP component has no options.
The FOP endpoint is configured using URI syntax:
fop:outputType
fop:outputTypewith the following path and query parameters:
105.3.1. Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| outputType | Required The primary output format is PDF but other output formats are also supported. | FopOutputType |
105.3.2. Query Parameters (3 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| fopFactory (producer) | Allows to use a custom configured or implementation of org.apache.fop.apps.FopFactory. | FopFactory | |
| userConfigURL (producer) | The location of a configuration file which can be loaded from classpath or file system. | String | |
| synchronous (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
The location of a configuration file with the following structure. From Camel 2.12 onwards 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.
fopFactory
Allows to use a custom configured or implementation of org.apache.fop.apps.FopFactory.
105.4. 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 |
105.5. 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");
from("file:source/data/xml")
.to("xslt:xslt/template.xsl")
.to("fop:application/pdf")
.to("file:target/data");For more information, see these resources…
105.6. See Also
- Configuring Camel
- Component
- Endpoint
- Getting Started
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}