| [[rss-dataformat]] |
| = RSS DataFormat |
| //THIS FILE IS COPIED: EDIT THE SOURCE FILE: |
| :page-source: components/camel-rss/src/main/docs/rss-dataformat.adoc |
| :docTitle: RSS |
| :artifactId: camel-rss |
| :description: Transform from ROME SyndFeed Java Objects to XML and vice-versa. |
| :since: 2.1 |
| :supportLevel: Stable |
| |
| *Since Camel {since}* |
| |
| The RSS component ships with an RSS dataformat that can be used to |
| convert between String (as XML) and ROME RSS model objects. |
| |
| * marshal = from ROME `SyndFeed` to XML `String` |
| * unmarshal = from XML `String` to ROME `SyndFeed` |
| |
| A route using this would look something like this: |
| |
| The purpose of this feature is to make it possible to use Camel's lovely |
| built-in expressions for manipulating RSS messages. As shown below, an |
| XPath expression can be used to filter the RSS message: |
| |
| [TIP] |
| ==== |
| *Query parameters* |
| |
| If the URL for the RSS feed uses query parameters, this component will |
| understand them as well, for example if the feed uses `alt=rss`, then |
| you can for example do |
| `from("rss:http://someserver.com/feeds/posts/default?alt=rss&splitEntries=false&delay=1000").to("bean:rss");` |
| ==== |
| |
| == Options |
| |
| // dataformat options: START |
| The RSS dataformat supports 1 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2s,1m,1m,6",options="header"] |
| |=== |
| | Name | Default | Java Type | Description |
| | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON etc. |
| |=== |
| // dataformat options: END |
| ND |
| |
| include::camel-spring-boot::page$rss-starter.adoc[] |
