description: The uri of the endpoint to send to. The uri can be dynamic computed using the org.apache.camel.language.simple.SimpleLanguage expression.


key: host-header

description: The header that holds the service host information, default ServiceCallConstants.SERVICE_HOST

type: string

default: CamelServiceCallServiceHost


key: id

description: The id of this node


key: port-header

description: The header that holds the service port information, default ServiceCallConstants.SERVICE_PORT

default: CamelServiceCallServicePort


key: properties

description: Set client properties to use. These properties are specific to what service call implementation are in use. For example if using a different one, then the client properties are defined according to the specific service in use.

type: array


key: servers

description: Sets the server list. Each entry can be a list of servers separated by comma in the format: servicehost:port,servicehost2:port,servicehost3:port


key: base-path

description: Set the base path to store in ZK


key: connection-timeout

description: Connection timeout.


key: namespace

description: As ZooKeeper is a shared space, users of a given cluster should stay within a pre-defined namespace. If a namespace is set here, all paths will get pre-pended with the namespace


key: nodes

description: A comma separate list of servers to connect to in the form host:port


key: reconnect-base-sleep-time

description: Initial amount of time to wait between retries.


key: reconnect-max-retries

description: Max number of times to retry


key: reconnect-max-sleep-time

description: Max time in ms to sleep on each retry


key: session-timeout

description: Session timeout.


description: Configures batch-processing resequence eip.

type: object

type: boolean

type: number


key: allow-duplicates

description: Whether to allow duplicates.


key: batch-size

description: Sets the size of the batch to be re-ordered. The default size is 100.


key: batch-timeout

description: Sets the timeout for collecting elements to be re-ordered. The default timeout is 1000 msec.


key: ignore-invalid-exchanges

description: Whether to ignore invalid exchanges


key: reverse

description: Whether to reverse the ordering.


description: Configures stream-processing resequence eip.


key: capacity

description: Sets the capacity of the resequencer inbound queue.


key: comparator

description: To use a custom comparator as a org.apache.camel.processor.resequencer.ExpressionResultComparator type.


key: delivery-attempt-interval

description: Sets the interval in milliseconds the stream resequencer will at most wait while waiting for condition of being able to deliver.


key: reject-old

description: If true, throws an exception when messages older than the last delivered message are processed


key: timeout

description: Sets minimum time (milliseconds) to wait for missing elements (messages).


description: Encode and decode data structures using Abstract Syntax Notation One (ASN.1).


key: id

description: The id of this node


key: unmarshal-type

description: Class to use when unmarshalling.


key: using-iterator

description: If the asn1 file has more than one entry, the setting this option to true, allows working with the splitter EIP, to split the data using an iterator in a streaming mode.


description: Serialize and deserialize messages using Apache Avro binary data format.

default: ApacheAvro

enum: ApacheAvro Jackson


key: allow-jms-type

description: Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to.


key: allow-unmarshall-type

description: If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used.


key: auto-discover-object-mapper

description: If set to true then Jackson will lookup for an objectMapper into the registry


key: auto-discover-schema-resolver

description: When not disabled, the SchemaResolver will be looked up into the registry


key: collection-type

description: Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default.


key: content-type-header

description: Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON


key: disable-features

description: Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma


key: enable-features

description: Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma


key: include

description: If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL


key: instance-class-name

description: Class name to use for marshal and unmarshalling


key: json-view

description: When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations


key: library

description: Which Avro library to use.


key: module-class-names

description: To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma.


key: module-refs

description: To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma.


key: object-mapper

description: Lookup and use the existing ObjectMapper with the given id when using Jackson.


key: schema-resolver

description: Optional schema resolver used to lookup schemas for the data in transit.


key: timezone

description: If set then Jackson will use the Timezone when marshalling/unmarshalling.


key: unmarshal-type

description: Class name of the java type to use when unmarshalling


key: use-default-object-mapper

description: Whether to lookup and use default Jackson ObjectMapper from the registry.


key: use-list

description: To unmarshal to a List of Map or a List of Pojo.


description: Transform strings to various 1D/2D barcode bitmap formats and back.


key: barcode-format

description: Barcode format such as QR-Code


key: height

description: Height of the barcode


key: id

description: The id of this node


key: image-type

description: Image type of the barcode such as png


key: width

description: Width of the barcode


description: Encode and decode data using Base64.


key: line-length

description: To specific a maximum line length for the encoded data. By default 76 is used.


key: line-separator

description: The line separators to use. Uses new line characters (CRLF) by default.


key: url-safe

description: Instead of emitting '' and '/' we emit '-' and '_' respectively. urlSafe is only applied to encode operations. Decoding seamlessly handles both modes. Is by default false.


description: Marshal and unmarshal Java beans from and to flat payloads (such as CSV, delimited, fixed length formats, or FIX messages).

enum: Csv Fixed KeyValue


key: allow-empty-stream

description: Whether to allow empty streams in the unmarshal process. If true, no exception will be thrown when a body without records is provided.


key: class-type

description: Name of model class to use.


key: locale

description: To configure a default locale to use, such as us for united states. To use the JVM platform default locale then use the name default


key: type

description: Whether to use Csv, Fixed, or KeyValue.


key: unwrap-single-instance

description: When unmarshalling should a single instance be unwrapped and returned instead of wrapped in a java.util.List.


description: Unmarshal a CBOR payload to POJO and back.


key: allow-jms-type

description: Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to.


key: allow-unmarshall-type

description: If enabled then Jackson CBOR is allowed to attempt to use the CamelCBORUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used.


key: collection-type

description: Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default.


key: disable-features

description: Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma


key: enable-features

description: Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma


description: The id of this node


key: object-mapper

description: Lookup and use the existing CBOR ObjectMapper with the given id when using Jackson.


key: pretty-print

description: To enable pretty printing output nicely formatted. Is by default false.


key: unmarshal-type

description: Class name of the java type to use when unmarshalling


key: use-default-object-mapper

description: Whether to lookup and use default Jackson CBOR ObjectMapper from the registry.


key: use-list

description: To unmarshal to a List of Map or a List of Pojo.


description: Encrypt and decrypt messages using Java Cryptography Extension (JCE).


key: algorithm

description: The JCE algorithm name indicating the cryptographic algorithm that will be used.


key: algorithm-parameter-ref

description: A JCE AlgorithmParameterSpec used to initialize the Cipher. Will lookup the type using the given name as a java.security.spec.AlgorithmParameterSpec type.


key: buffer-size

description: The size of the buffer used in the signature process.


key: crypto-provider

description: The name of the JCE Security Provider that should be used.


key: init-vector-ref

description: Refers to a byte array containing the Initialization Vector that will be used to initialize the Cipher.


key: inline

description: Flag indicating that the configured IV should be inlined into the encrypted data stream. Is by default false.


key: key-ref

description: Refers to the secret key to lookup from the register to use.


key: mac-algorithm

description: The JCE algorithm name indicating the Message Authentication algorithm.


description: Handle CSV (Comma Separated Values) payloads.

default: DEFAULT


key: allow-missing-column-names

description: Whether to allow missing column names.


key: capture-header-record

description: Whether the unmarshalling should capture the header record and store it in the message header


key: comment-marker

description: Sets the comment marker of the reference format.


key: comment-marker-disabled

description: Disables the comment marker of the reference format.


key: delimiter

description: Sets the delimiter to use. The default value is , (comma)


key: escape

description: Sets the escape character to use


key: escape-disabled

description: Use for disabling using escape character


key: format-name

description: The name of the format to use, the default value is CSVFormat.DEFAULT


key: format-ref

description: The reference format to use, it will be updated with the other format options, the default value is CSVFormat.DEFAULT


key: header

description: To configure the CSV headers


key: header-disabled

description: Use for disabling headers


key: id

description: The id of this node


key: ignore-empty-lines

description: Whether to ignore empty lines.


key: ignore-header-case

description: Sets whether or not to ignore case when accessing header names.


key: ignore-surrounding-spaces

description: Whether to ignore surrounding spaces


key: lazy-load

description: Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one.


key: marshaller-factory-ref

description: Sets the implementation of the CsvMarshallerFactory interface which is able to customize marshalling/unmarshalling behavior by extending CsvMarshaller or creating it from scratch.


key: null-string

description: Sets the null string


key: null-string-disabled

description: Used to disable null strings


key: quote

description: Sets the quote which by default is


key: quote-disabled

description: Used to disable quotes


key: quote-mode

description: Sets the quote mode


key: record-converter-ref

description: Refers to a custom CsvRecordConverter to lookup from the registry to use.


key: record-separator

description: Sets the record separator (aka new line) which by default is new line characters (CRLF)


key: record-separator-disabled

description: Used for disabling record separator


key: skip-header-record

description: Whether to skip the header record in the output


key: trailing-delimiter

description: Sets whether or not to add a trailing delimiter.


key: trim

description: Sets whether or not to trim leading and trailing blanks.


key: use-maps

description: Whether the unmarshalling should produce maps (HashMap)for the lines values instead of lists. It requires to have header (either defined or collected).


key: use-ordered-maps

description: Whether the unmarshalling should produce ordered maps (LinkedHashMap) for the lines values instead of lists. It requires to have header (either defined or collected).


description: Delegate to a custom org.apache.camel.spi.DataFormat implementation via Camel registry.


key: id

description: The id of this node


key: ref

description: Reference to the custom org.apache.camel.spi.DataFormat to lookup from the Camel registry.


description: Configure data formats.


description: Marshall and unmarshall FHIR objects to/from JSON.


key: content-type-header

description: Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON


key: dont-encode-elements

description: If provided, specifies the elements which should NOT be encoded. Multiple elements can be separated by comma when using String parameter. Valid values for this field would include: Patient - Don't encode patient and all its children Patient.name - Don't encode the patient's name Patient.name.family - Don't encode the patient's family name .text - Don't encode the text element on any resource (only the very first position may contain a wildcard) DSTU2 note: Note that values including meta, such as Patient.meta will work for DSTU2 parsers, but values with subelements on meta such as Patient.meta.lastUpdated will only work in DSTU3 mode.


description: If supplied value(s), any resource references at the specified paths will have their resource versions encoded instead of being automatically stripped during the encoding process. This setting has no effect on the parsing process. Multiple elements can be separated by comma when using String parameter. This method provides a finer-grained level of control than setStripVersionsFromReferences(String) and any paths specified by this method will be encoded even if setStripVersionsFromReferences(String) has been set to true (which is the default)


key: encode-elements

description: If provided, specifies the elements which should be encoded, to the exclusion of all others. Multiple elements can be separated by comma when using String parameter. Valid values for this field would include: Patient - Encode patient and all its children Patient.name - Encode only the patient's name Patient.name.family - Encode only the patient's family name .text - Encode the text element on any resource (only the very first position may contain a wildcard) .(mandatory) - This is a special case which causes any mandatory fields (min 0) to be encoded


description: If set to true (default is false), the values supplied to setEncodeElements(Set) will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e. search result resources in that bundle)


key: fhir-context

description: To use a custom fhir context. Reference to object of type ca.uhn.fhir.context.FhirContext


key: fhir-version

description: The version of FHIR to use. Possible values are: DSTU2,DSTU2_HL7ORG,DSTU2_1,DSTU3,R4,R5


key: force-resource-id

description: When encoding, force this resource ID to be encoded as the resource ID. Reference to object of type org.hl7.fhir.instance.model.api.IIdType


key: omit-resource-id

description: If set to true (default is false) the ID of any resources being encoded will not be included in the output. Note that this does not apply to contained resources, only to root resources. In other words, if this is set to true, contained resources will still have local IDs but the outer/containing ID will not have an ID.


description: If set to true (which is the default), the Bundle.entry.fullUrl will override the Bundle.entry.resource's resource id if the fullUrl is defined. This behavior happens when parsing the source data into a Bundle object. Set this to false if this is not the desired behavior (e.g. the client code wishes to perform additional validation checks between the fullUrl and the resource id).


key: parser-error-handler

description: Registers an error handler which will be invoked when any parse errors are found. Reference to object of type ca.uhn.fhir.parser.IParserErrorHandler


key: parser-options

description: Sets the parser options object which will be used to supply default options to newly created parsers. Reference to object of type ca.uhn.fhir.context.ParserOptions.


key: prefer-types

description: If set (FQN class names), when parsing resources the parser will try to use the given types when possible, in the order that they are provided (from highest to lowest priority). For example, if a custom type which declares to implement the Patient resource is passed in here, and the parser is parsing a Bundle containing a Patient resource, the parser will use the given custom type. Multiple class names can be separated by comma.


key: pretty-print

description: Sets the pretty print flag, meaning that the parser will encode resources with human-readable spacing and newlines between elements instead of condensing output as much as possible.


key: server-base-url

description: Sets the server's base URL used by this parser. If a value is set, resource references will be turned into relative references if they are provided as absolute URLs but have a base matching the given base.


key: strip-versions-from-references

description: If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded. This is generally good behaviour because in most situations, references from one resource to another should be to the resource by ID, not by ID and version. In some cases though, it may be desirable to preserve the version in resource links. In that case, this value should be set to false. This method provides the ability to globally disable reference encoding. If finer-grained control is needed, use setDontStripVersionsFromReferencesAtPaths(List)


key: summary-mode

description: If set to true (default is false) only elements marked by the FHIR specification as being summary elements will be included.


key: suppress-narratives

description: If set to true (default is false), narratives will not be included in the encoded values.


description: Marshall and unmarshall FHIR objects to/from XML.


description: Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON


description: If provided, specifies the elements which should NOT be encoded. Multiple elements can be separated by comma when using String parameter. Valid values for this field would include: Patient - Don't encode patient and all its children Patient.name - Don't encode the patient's name Patient.name.family - Don't encode the patient's family name .text - Don't encode the text element on any resource (only the very first position may contain a wildcard) DSTU2 note: Note that values including meta, such as Patient.meta will work for DSTU2 parsers, but values with subelements on meta such as Patient.meta.lastUpdated will only work in DSTU3 mode.


description: If supplied value(s), any resource references at the specified paths will have their resource versions encoded instead of being automatically stripped during the encoding process. This setting has no effect on the parsing process. Multiple elements can be separated by comma when using String parameter. This method provides a finer-grained level of control than setStripVersionsFromReferences(String) and any paths specified by this method will be encoded even if setStripVersionsFromReferences(String) has been set to true (which is the default)


description: If provided, specifies the elements which should be encoded, to the exclusion of all others. Multiple elements can be separated by comma when using String parameter. Valid values for this field would include: Patient - Encode patient and all its children Patient.name - Encode only the patient's name Patient.name.family - Encode only the patient's family name .text - Encode the text element on any resource (only the very first position may contain a wildcard) .(mandatory) - This is a special case which causes any mandatory fields (min 0) to be encoded


description: If set to true (default is false), the values supplied to setEncodeElements(Set) will not be applied to the root resource (typically a Bundle), but will be applied to any sub-resources contained within it (i.e. search result resources in that bundle)


description: To use a custom fhir context. Reference to object of type ca.uhn.fhir.context.FhirContext


description: The version of FHIR to use. Possible values are: DSTU2,DSTU2_HL7ORG,DSTU2_1,DSTU3,R4,R5


description: When encoding, force this resource ID to be encoded as the resource ID. Reference to object of type org.hl7.fhir.instance.model.api.IIdType


key: id

description: The id of this node


description: If set to true (default is false) the ID of any resources being encoded will not be included in the output. Note that this does not apply to contained resources, only to root resources. In other words, if this is set to true, contained resources will still have local IDs but the outer/containing ID will not have an ID.


description: If set to true (which is the default), the Bundle.entry.fullUrl will override the Bundle.entry.resource's resource id if the fullUrl is defined. This behavior happens when parsing the source data into a Bundle object. Set this to false if this is not the desired behavior (e.g. the client code wishes to perform additional validation checks between the fullUrl and the resource id).


description: Registers an error handler which will be invoked when any parse errors are found. Reference to object of type ca.uhn.fhir.parser.IParserErrorHandler


description: Sets the parser options object which will be used to supply default options to newly created parsers. Reference to object of type ca.uhn.fhir.context.ParserOptions.


description: If set (FQN class names), when parsing resources the parser will try to use the given types when possible, in the order that they are provided (from highest to lowest priority). For example, if a custom type which declares to implement the Patient resource is passed in here, and the parser is parsing a Bundle containing a Patient resource, the parser will use the given custom type. Multiple class names can be separated by comma.


description: Sets the pretty print flag, meaning that the parser will encode resources with human-readable spacing and newlines between elements instead of condensing output as much as possible.


description: Sets the server's base URL used by this parser. If a value is set, resource references will be turned into relative references if they are provided as absolute URLs but have a base matching the given base.


description: If set to true (which is the default), resource references containing a version will have the version removed when the resource is encoded. This is generally good behaviour because in most situations, references from one resource to another should be to the resource by ID, not by ID and version. In some cases though, it may be desirable to preserve the version in resource links. In that case, this value should be set to false. This method provides the ability to globally disable reference encoding. If finer-grained control is needed, use setDontStripVersionsFromReferencesAtPaths(List)


description: If set to true (default is false) only elements marked by the FHIR specification as being summary elements will be included.


description: If set to true (default is false), narratives will not be included in the encoded values.


description: Marshal and unmarshal Java lists and maps to/from flat files (such as CSV, delimited, or fixed length formats) using Flatpack library.


key: allow-short-lines

description: Allows for lines to be shorter than expected and ignores the extra characters


key: definition

description: The flatpack pzmap configuration file. Can be omitted in simpler situations, but its preferred to use the pzmap.


key: delimiter

description: The delimiter char (could be ; , or similar)


key: fixed

description: Delimited or fixed. Is by default false = delimited


key: ignore-extra-columns

description: Allows for lines to be longer than expected and ignores the extra characters.


key: ignore-first-record

description: Whether the first line is ignored for delimited files (for the column headers). Is by default true.


key: parser-factory-ref

description: References to a custom parser factory to lookup in the registry


key: text-qualifier

description: If the text is qualified with a character. Uses quote character by default.


description: Unmarshal unstructured data to objects using Logstash based Grok patterns.


key: allow-multiple-matches-per-line

description: If false, every line of input is matched for pattern only once. Otherwise the line can be scanned multiple times when non-terminal pattern is used.


key: flattened

description: Turns on flattened mode. In flattened mode the exception is thrown when there are multiple pattern matches with same key.


description: The id of this node


key: named-only

description: Whether to capture named expressions only or not (i.e. %{IP:ip} but not ${IP})


key: pattern

description: The grok pattern to match lines of input


description: Compress and decompress messages using java.util.zip.GZIPStream.


description: Marshal and unmarshal HL7 (Health Care) model objects using the HL7 MLLP codec.


key: validate

description: Whether to validate the HL7 message Is by default true.


description: Marshal and unmarshal iCal (.ics) documents to/from model objects.


key: validating

description: Whether to validate.


description: Unmarshal an XML payloads to POJOs and back using XMLMapper extension of Jackson.


key: allow-jms-type

description: Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to.


key: allow-unmarshall-type

description: If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used.


key: collection-type

description: Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default.


key: content-type-header

description: Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON


key: disable-features

description: Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma


key: enable-features

description: Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma


key: enable-jaxb-annotation-module

description: Whether to enable the JAXB annotations module when using jackson. When enabled then JAXB annotations can be used by Jackson.


key: include

description: If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL


key: json-view

description: When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations


key: module-class-names

description: To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma.


key: module-refs

description: To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma.


key: pretty-print

description: To enable pretty printing output nicely formatted. Is by default false.


key: timezone

description: If set then Jackson will use the Timezone when marshalling/unmarshalling.


key: unmarshal-type

description: Class name of the java type to use when unmarshalling


key: use-list

description: To unmarshal to a List of Map or a List of Pojo.


key: xml-mapper

description: Lookup and use the existing XmlMapper with the given id.


description: Unmarshal XML payloads to POJOs and back using JAXB2 XML marshalling standard.

default: false


key: access-external-schema-protocols

description: Only in use if schema validation has been enabled. Restrict access to the protocols specified for external reference set by the schemaLocation attribute, Import and Include element. Examples of protocols are file, http, jar:file. false or none to deny all access to external references; a specific protocol, such as file, to give permission to only the protocol; the keyword all to grant permission to all protocols.


key: context-path

description: Package name where your JAXB classes are located.


key: context-path-is-class-name

description: This can be set to true to mark that the contextPath is referring to a classname and not a package name.


key: encoding

description: To overrule and use a specific encoding


key: filter-non-xml-chars

description: To ignore non xml characheters and replace them with an empty space.


key: fragment

description: To turn on marshalling XML fragment trees. By default JAXB looks for XmlRootElement annotation on given class to operate on whole XML tree. This is useful but not always - sometimes generated code does not have XmlRootElement annotation, sometimes you need unmarshall only part of tree. In that case you can use partial unmarshalling. To enable this behaviours you need set property partClass. Camel will pass this class to JAXB's unmarshaler.


key: id

description: The id of this node


key: jaxb-provider-properties

description: Refers to a custom java.util.Map to lookup in the registry containing custom JAXB provider properties to be used with the JAXB marshaller.


key: namespace-prefix-ref

description: When marshalling using JAXB or SOAP then the JAXB implementation will automatic assign namespace prefixes, such as ns2, ns3, ns4 etc. To control this mapping, Camel allows you to refer to a map which contains the desired mapping.


key: no-namespace-schema-location

description: To define the location of the namespaceless schema


key: object-factory

description: Whether to allow using ObjectFactory classes to create the POJO classes during marshalling. This only applies to POJO classes that has not been annotated with JAXB and providing jaxb.index descriptor files.


key: part-class

description: Name of class used for fragment parsing. See more details at the fragment option.


key: part-namespace

description: XML namespace to use for fragment parsing. See more details at the fragment option.


key: pretty-print

description: To enable pretty printing output nicely formatted. Is by default false.


key: schema

description: To validate against an existing schema. Your can use the prefix classpath:, file: or http: to specify how the resource should be resolved. You can separate multiple schema files by using the ',' character.


key: schema-location

description: To define the location of the schema


key: schema-severity-level

description: Sets the schema severity level to use when validating against a schema. This level determines the minimum severity error that triggers JAXB to stop continue parsing. The default value of 0 (warning) means that any error (warning, error or fatal error) will trigger JAXB to stop. There are the following three levels: 0=warning, 1=error, 2=fatal error.


key: xml-stream-writer-wrapper

description: To use a custom xml stream writer.


description: Marshal and unmarshal JSON:API resources using JSONAPI-Converter library.


key: data-format-types

description: The classes to take into account for the marshalling. Multiple classes can be separated by comma.


key: main-format-type

description: The class to take into account while unmarshalling.


description: Marshal POJOs to JSON and back.

default: Jackson

enum: Fastjson Gson Jackson Johnzon Jsonb


key: allow-jms-type

description: Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to.


key: allow-unmarshall-type

description: If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used.


key: auto-discover-object-mapper

description: If set to true then Jackson will look for an objectMapper to use from the registry


key: auto-discover-schema-resolver

description: When not disabled, the SchemaResolver will be looked up into the registry


key: collection-type

description: Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows using different collection types than java.util.Collection based as default.


key: content-type-header

description: Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON


key: date-format-pattern

description: To configure the date format while marshall or unmarshall Date fields in JSON using Gson


key: disable-features

description: Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma


key: enable-features

description: Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma


key: id

description: The id of this node


key: include

description: If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL


key: json-view

description: When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations


key: library

description: Which json library to use.


key: module-class-names

description: To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma.


key: module-refs

description: To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma.


key: naming-strategy

description: If set then Jackson will use the the defined Property Naming Strategy.Possible values are: LOWER_CAMEL_CASE, LOWER_DOT_CASE, LOWER_CASE, KEBAB_CASE, SNAKE_CASE and UPPER_CAMEL_CASE


key: object-mapper

description: Lookup and use the existing ObjectMapper with the given id when using Jackson.


key: pretty-print

description: To enable pretty printing output nicely formatted. Is by default false.


key: schema-resolver

description: Optional schema resolver used to lookup schemas for the data in transit.


key: timezone

description: If set then Jackson will use the Timezone when marshalling/unmarshalling. This option will have no effect on the others Json DataFormat, like gson and fastjson.


key: unmarshal-type

description: Class name of the java type to use when unmarshalling


key: use-default-object-mapper

description: Whether to lookup and use default Jackson ObjectMapper from the registry.


key: use-list

description: To unmarshal to a List of Map or a List of Pojo.


description: Compress and decompress streams using LZF deflate algorithm.


key: using-parallel-compression

description: Enable encoding (compress) using multiple processing cores.


description: Marshal Camel messages with attachments into MIME-Multipart messages and back.

default: mixed


key: binary-content

description: Defines whether the content of binary parts in the MIME multipart is binary (true) or Base-64 encoded (false) Default is false.


key: headers-inline

description: Defines whether the MIME-Multipart headers are part of the message body (true) or are set as Camel headers (false). Default is false.


key: id

description: The id of this node


key: include-headers

description: A regex that defines which Camel headers are also included as MIME headers into the MIME multipart. This will only work if headersInline is set to true. Default is to include no headers


key: multipart-sub-type

description: Specify the subtype of the MIME Multipart. Default is mixed.


key: multipart-without-attachment

description: Defines whether a message without attachment is also marshaled into a MIME Multipart (with only one body part). Default is false.


description: Encrypt and decrypt messages using Java Cryptographic Extension (JCE) and PGP.


key: algorithm

description: Symmetric key encryption algorithm; possible values are defined in org.bouncycastle.bcpg.SymmetricKeyAlgorithmTags; for example 2 (= TRIPLE DES), 3 (= CAST5), 4 (= BLOWFISH), 6 (= DES), 7 (= AES_128). Only relevant for encrypting.


key: armored

description: This option will cause PGP to base64 encode the encrypted text, making it available for copy/paste, etc.


key: compression-algorithm

description: Compression algorithm; possible values are defined in org.bouncycastle.bcpg.CompressionAlgorithmTags; for example 0 (= UNCOMPRESSED), 1 (= ZIP), 2 (= ZLIB), 3 (= BZIP2). Only relevant for encrypting.


key: hash-algorithm

description: Signature hash algorithm; possible values are defined in org.bouncycastle.bcpg.HashAlgorithmTags; for example 2 (= SHA1), 8 (= SHA256), 9 (= SHA384), 10 (= SHA512), 11 (=SHA224). Only relevant for signing.


key: integrity

description: Adds an integrity check/sign into the encryption file. The default value is true.


key: key-file-name

description: Filename of the keyring; must be accessible as a classpath resource (but you can specify a location in the file system by using the file: prefix).


key: key-userid

description: The user ID of the key in the PGP keyring used during encryption. Can also be only a part of a user ID. For example, if the user ID is Test User then you can use the part Test User or to address the user ID.


key: password

description: Password used when opening the private key (not used for encryption).


key: provider

description: Java Cryptography Extension (JCE) provider, default is Bouncy Castle (BC). Alternatively you can use, for example, the IAIK JCE provider; in this case the provider must be registered beforehand and the Bouncy Castle provider must not be registered beforehand. The Sun JCE provider does not work.


key: signature-key-file-name

description: Filename of the keyring to use for signing (during encryption) or for signature verification (during decryption); must be accessible as a classpath resource (but you can specify a location in the file system by using the file: prefix).


key: signature-key-ring

description: Keyring used for signing/verifying as byte array. You can not set the signatureKeyFileName and signatureKeyRing at the same time.


key: signature-key-userid

description: User ID of the key in the PGP keyring used for signing (during encryption) or signature verification (during decryption). During the signature verification process the specified User ID restricts the public keys from the public keyring which can be used for the verification. If no User ID is specified for the signature verficiation then any public key in the public keyring can be used for the verification. Can also be only a part of a user ID. For example, if the user ID is Test User then you can use the part Test User or to address the User ID.


key: signature-password

description: Password used when opening the private key used for signing (during encryption).


key: signature-verification-option

description: Controls the behavior for verifying the signature during unmarshaling. There are 4 values possible: optional: The PGP message may or may not contain signatures; if it does contain signatures, then a signature verification is executed. required: The PGP message must contain at least one signature; if this is not the case an exception (PGPException) is thrown. A signature verification is executed. ignore: Contained signatures in the PGP message are ignored; no signature verification is executed. no_signature_allowed: The PGP message must not contain a signature; otherwise an exception (PGPException) is thrown.


description: Parquet Avro serialization and de-serialization.

default: GZIP


key: compression-codec-name

description: Compression codec to use when marshalling.


key: id

description: The id of this node


key: unmarshal-type

description: Class to use when (un)marshalling. If omitted, parquet files are converted into Avro's GenericRecords for unmarshalling and input objects are assumed as GenericRecords for marshalling.


description: Serialize and deserialize Java objects using Google's Protocol buffers.

default: native

enum: native json

default: GoogleProtobuf

enum: GoogleProtobuf Jackson


key: allow-jms-type

description: Used for JMS users to allow the JMSType header from the JMS spec to specify a FQN classname to use to unmarshal to.


key: allow-unmarshall-type

description: If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used.


key: auto-discover-object-mapper

description: If set to true then Jackson will lookup for an objectMapper into the registry


key: auto-discover-schema-resolver

description: When not disabled, the SchemaResolver will be looked up into the registry


key: collection-type

description: Refers to a custom collection type to lookup in the registry to use. This option should rarely be used, but allows to use different collection types than java.util.Collection based as default.


key: content-type-format

description: Defines a content type format in which protobuf message will be serialized/deserialized from(to) the Java been. The format can either be native or json for either native protobuf or json fields representation. The default value is native.


key: content-type-header

description: Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON


key: disable-features

description: Set of features to disable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma


key: enable-features

description: Set of features to enable on the Jackson com.fasterxml.jackson.databind.ObjectMapper. The features should be a name that matches a enum from com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature, or com.fasterxml.jackson.databind.MapperFeature Multiple features can be separated by comma


key: include

description: If you want to marshal a pojo to JSON, and the pojo has some fields with null values. And you want to skip these null values, you can set this option to NON_NULL


key: instance-class

description: Name of class to use when unmarshalling


key: json-view

description: When marshalling a POJO to JSON you might want to exclude certain fields from the JSON output. With Jackson you can use JSON views to accomplish this. This option is to refer to the class which has JsonView annotations


key: library

description: Which Protobuf library to use.


key: module-class-names

description: To use custom Jackson modules com.fasterxml.jackson.databind.Module specified as a String with FQN class names. Multiple classes can be separated by comma.


key: module-refs

description: To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma.


key: object-mapper

description: Lookup and use the existing ObjectMapper with the given id when using Jackson.


key: schema-resolver

description: Optional schema resolver used to lookup schemas for the data in transit.


key: timezone

description: If set then Jackson will use the Timezone when marshalling/unmarshalling.


key: unmarshal-type

description: Class name of the java type to use when unmarshalling


key: use-default-object-mapper

description: Whether to lookup and use default Jackson ObjectMapper from the registry.


key: use-list

description: To unmarshal to a List of Map or a List of Pojo.


description: Transform from ROME SyndFeed Java Objects to XML and vice-versa.


key: id

description: The id of this node


description: Marshal Java objects to SOAP messages and back.


key: context-path

description: Package name where your JAXB classes are located.


key: element-name-strategy-ref

description: Refers to an element strategy to lookup from the registry. An element name strategy is used for two purposes. The first is to find a xml element name for a given object and soap action when marshaling the object into a SOAP message. The second is to find an Exception class for a given soap fault name. The following three element strategy class name is provided out of the box. QNameStrategy - Uses a fixed qName that is configured on instantiation. Exception lookup is not supported TypeNameStrategy - Uses the name and namespace from the XMLType annotation of the given type. If no namespace is set then package-info is used. Exception lookup is not supported ServiceInterfaceStrategy - Uses information from a webservice interface to determine the type name and to find the exception class for a SOAP fault All three classes is located in the package name org.apache.camel.dataformat.soap.name If you have generated the web service stub code with cxf-codegen or a similar tool then you probably will want to use the ServiceInterfaceStrategy. In the case you have no annotated service interface you should use QNameStrategy or TypeNameStrategy.


key: encoding

description: To overrule and use a specific encoding


key: namespace-prefix-ref

description: When marshalling using JAXB or SOAP then the JAXB implementation will automatic assign namespace prefixes, such as ns2, ns3, ns4 etc. To control this mapping, Camel allows you to refer to a map which contains the desired mapping.


key: schema

description: To validate against an existing schema. Your can use the prefix classpath:, file: or http: to specify how the resource should be resolved. You can separate multiple schema files by using the ',' character.


key: version

description: SOAP version should either be 1.1 or 1.2. Is by default 1.1


description: Encode and decode SWIFT MT messages.


key: write-in-json

description: The flag indicating that messages must be marshalled in a JSON format.


description: Encode and decode SWIFT MX messages.


key: read-config-ref

description: Refers to a specific configuration to use when unmarshalling an input stream to lookup from the registry.


key: read-message-id

description: The type of MX message to produce when unmarshalling an input stream. If not set, it will be automatically detected from the namespace used.


key: write-config-ref

description: Refers to a specific configuration to use when marshalling a message to lookup from the registry.


description: Marshall SyslogMessages to RFC3164 and RFC5424 messages and back.


description: Archive files into tarballs or extract files from tarballs.


key: allow-empty-directory

description: If the tar file has more than one entry, setting this option to true, allows to get the iterator even if the directory is empty


description: The id of this node


key: max-decompressed-size

description: Set the maximum decompressed size of a tar file (in bytes). The default value if not specified corresponds to 1 gigabyte. An IOException will be thrown if the decompressed size exceeds this amount. Set to -1 to disable setting a maximum decompressed size.


key: preserve-path-elements

description: If the file name contains path elements, setting this option to true, allows the path to be maintained in the tar file.


key: using-iterator

description: If the tar file has more than one entry, the setting this option to true, allows working with the splitter EIP, to split the data using an iterator in a streaming mode.


description: Serialize and deserialize messages using Apache Thrift binary data format.

default: binary

enum: binary json sjson


key: content-type-format

description: Defines a content type format in which thrift message will be serialized/deserialized from(to) the Java been. The format can either be native or json for either native binary thrift, json or simple json fields representation. The default value is binary.


key: content-type-header

description: Whether the data format should set the Content-Type header with the type from the data format. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON


key: instance-class

description: Name of class to use when unmarshalling


description: Parse (potentially invalid) HTML into valid HTML or DOM.


key: data-object-type

description: What data type to unmarshal as, can either be org.w3c.dom.Node or java.lang.String. Is by default org.w3c.dom.Node


key: omit-xml-declaration

description: When returning a String, do we omit the XML declaration in the top.


description: Marshal and unmarshal Java objects from and to CSV (Comma Separated Values) using UniVocity Parsers.

default: \n


key: as-map

description: Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected). The default value is false


key: comment

description: The comment symbol. The default value is #


key: delimiter

description: The delimiter of values


key: empty-value

description: The String representation of an empty value


key: header-extraction-enabled

description: Whether or not the header must be read in the first line of the test document The default value is false


key: headers-disabled

description: Whether or not the headers are disabled. When defined, this option explicitly sets the headers as null which indicates that there is no header. The default value is false


key: id

description: The id of this node


key: ignore-leading-whitespaces

description: Whether or not the leading white spaces must be ignored. The default value is true


key: ignore-trailing-whitespaces

description: Whether or not the trailing white spaces must be ignored. The default value is true


key: lazy-load

description: Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one. The default value is false


key: line-separator

description: The line separator of the files The default value is to use the JVM platform line separator


key: normalized-line-separator

description: The normalized line separator of the files The default value is a new line character.


key: null-value

description: The string representation of a null value. The default value is null


key: number-of-records-to-read

description: The maximum number of record to read.


key: quote

description: The quote symbol.


key: quote-all-fields

description: Whether or not all values must be quoted when writing them.


key: quote-escape

description: The quote escape symbol


key: skip-empty-lines

description: Whether or not the empty lines must be ignored. The default value is true


description: Marshal and unmarshal Java objects from and to fixed length records using UniVocity Parsers.


key: as-map


key: comment


key: empty-value


key: header-extraction-enabled


key: headers-disabled


key: id

description: The id of this node


key: ignore-leading-whitespaces


key: ignore-trailing-whitespaces


key: lazy-load


key: line-separator


key: normalized-line-separator


key: null-value


key: number-of-records-to-read

description: The maximum number of record to read.


key: padding

description: The padding character. The default value is a space


key: record-ends-on-newline

description: Whether or not the record ends on new line. The default value is false


key: skip-trailing-chars-until-newline

description: Whether or not the trailing characters until new line must be ignored. The default value is false


description: To configure headers for UniVocity data formats.


key: length

description: Header length


key: name

description: Header name


description: Marshal and unmarshal Java objects from and to TSV (Tab-Separated Values) records using UniVocity Parsers.


key: as-map

description: Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected). The default value is false


key: comment

description: The comment symbol. The default value is #


key: empty-value

description: The String representation of an empty value


key: escape-char

description: The escape character.


key: header-extraction-enabled

description: Whether or not the header must be read in the first line of the test document The default value is false


key: headers-disabled

description: Whether or not the headers are disabled. When defined, this option explicitly sets the headers as null which indicates that there is no header. The default value is false


key: id

description: The id of this node


key: ignore-leading-whitespaces

description: Whether or not the leading white spaces must be ignored. The default value is true


key: ignore-trailing-whitespaces

description: Whether or not the trailing white spaces must be ignored. The default value is true


key: lazy-load

description: Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one. The default value is false


key: line-separator

description: The line separator of the files The default value is to use the JVM platform line separator


key: normalized-line-separator

description: The normalized line separator of the files The default value is a new line character.


key: null-value

description: The string representation of a null value. The default value is null


key: number-of-records-to-read

description: The maximum number of record to read.


key: skip-empty-lines

description: Whether or not the empty lines must be ignored. The default value is true


description: Encrypt and decrypt XML payloads using Apache Santuario.

format: binary


key: add-key-value-for-encrypted-key

description: Whether to add the public key used to encrypt the session key as a KeyValue in the EncryptedKey structure or not.


key: digest-algorithm

description: The digest algorithm to use with the RSA OAEP algorithm. The available choices are: XMLCipher.SHA1 XMLCipher.SHA256 XMLCipher.SHA512 The default value is XMLCipher.SHA1


key: key-cipher-algorithm

description: The cipher algorithm to be used for encryption/decryption of the asymmetric key. The available choices are: XMLCipher.RSA_v1dot5 XMLCipher.RSA_OAEP XMLCipher.RSA_OAEP_11 The default value is XMLCipher.RSA_OAEP


key: key-or-trust-store-parameters-ref

description: Refers to a KeyStore instance to lookup in the registry, which is used for configuration options for creating and loading a KeyStore instance that represents the sender's trustStore or recipient's keyStore.


key: key-password

description: The password to be used for retrieving the private key from the KeyStore. This key is used for asymmetric decryption.


key: mgf-algorithm

description: The MGF Algorithm to use with the RSA OAEP algorithm. The available choices are: EncryptionConstants.MGF1_SHA1 EncryptionConstants.MGF1_SHA256 EncryptionConstants.MGF1_SHA512 The default value is EncryptionConstants.MGF1_SHA1


key: pass-phrase

description: A String used as passPhrase to encrypt/decrypt content. The passPhrase has to be provided. The passPhrase needs to be put together in conjunction with the appropriate encryption algorithm. For example using TRIPLEDES the passPhase can be a Only another 24 Byte key


key: pass-phrase-byte

description: A byte used as passPhrase to encrypt/decrypt content. The passPhrase has to be provided. The passPhrase needs to be put together in conjunction with the appropriate encryption algorithm. For example using TRIPLEDES the passPhase can be a Only another 24 Byte key


key: recipient-key-alias

description: The key alias to be used when retrieving the recipient's public or private key from a KeyStore when performing asymmetric key encryption or decryption.


key: secure-tag

description: The XPath reference to the XML Element selected for encryption/decryption. If no tag is specified, the entire payload is encrypted/decrypted.


key: secure-tag-contents

description: A boolean value to specify whether the XML Element is to be encrypted or the contents of the XML Element. false = Element Level. true = Element Content Level.


key: xml-cipher-algorithm

description: The cipher algorithm to be used for encryption/decryption of the XML message content. The available choices are: XMLCipher.TRIPLEDES XMLCipher.AES_128 XMLCipher.AES_128_GCM XMLCipher.AES_192 XMLCipher.AES_192_GCM XMLCipher.AES_256 XMLCipher.AES_256_GCM XMLCipher.SEED_128 XMLCipher.CAMELLIA_128 XMLCipher.CAMELLIA_192 XMLCipher.CAMELLIA_256 The default value is XMLCipher.AES_256_GCM


description: Marshal and unmarshal Java objects to and from YAML.

default: SnakeYAML


key: allow-any-type

description: Allow any class to be un-marshaled


key: allow-recursive-keys

description: Set whether recursive keys are allowed.


key: constructor

description: BaseConstructor to construct incoming documents.


key: dumper-options

description: DumperOptions to configure outgoing objects.


key: id

description: The id of this node


key: library

description: Which yaml library to use. By default it is SnakeYAML


key: max-aliases-for-collections

description: Set the maximum amount of aliases allowed for collections.


key: pretty-flow

description: Force the emitter to produce a pretty YAML document when using the flow style.


key: representer

description: Representer to emit outgoing objects.


key: resolver

description: Resolver to detect implicit type


key: type-filter

description: Set the types SnakeYAML is allowed to un-marshall


key: unmarshal-type

description: Class name of the java type to use when unmarshalling


key: use-application-context-class-loader

description: Use ApplicationContextClassLoader as custom ClassLoader


key: type

description: Whether to filter by class type or regular expression


key: value

description: Value of type such as class name or regular expression


description: Compress and decompress streams using java.util.zip.Deflater and java.util.zip.Inflater.


key: compression-level

description: To specify a specific compression between 0-9. -1 is default compression, 0 is no compression, and 9 is the best compression.


description: Compression and decompress streams using java.util.zip.ZipStream.


key: allow-empty-directory

description: If the zip file has more than one entry, setting this option to true, allows to get the iterator even if the directory is empty


key: max-decompressed-size

description: Set the maximum decompressed size of a zip file (in bytes). The default value if not specified corresponds to 1 gigabyte. An IOException will be thrown if the decompressed size exceeds this amount. Set to -1 to disable setting a maximum decompressed size.


key: preserve-path-elements

description: If the file name contains path elements, setting this option to true, allows the path to be maintained in the zip file.


key: using-iterator

description: If the zip file has more than one entry, the setting this option to true, allows working with the splitter EIP, to split the data using an iterator in a streaming mode.


description: Error handler with dead letter queue.

default: ERROR

enum: TRACE DEBUG INFO WARN ERROR OFF


key: dead-letter-handle-new-exception

description: Whether the dead letter channel should handle (and ignore) any new exception that may been thrown during sending the message to the dead letter endpoint. The default value is true which means any such kind of exception is handled and ignored. Set this to false to let the exception be propagated back on the org.apache.camel.Exchange . This can be used in situations where you use transactions, and want to use Camel's dead letter channel to deal with exceptions during routing, but if the dead letter channel itself fails because of a new exception being thrown, then by setting this to false the new exceptions is propagated back and set on the org.apache.camel.Exchange , which allows the transaction to detect the exception, and rollback.


key: dead-letter-uri

description: The dead letter endpoint uri for the Dead Letter error handler.


key: executor-service-ref

description: Sets a reference to a thread pool to be used by the error handler


key: id

description: The id of this node


key: level

description: Logging level to use when using the logging error handler type.


key: log-name

description: Name of the logger to use for the logging error handler


key: logger-ref

description: References to a logger to use as logger for the error handler


key: on-exception-occurred-ref

description: Sets a reference to a processor that should be processed just after an exception occurred. Can be used to perform custom logging about the occurred exception at the exact time it happened. Important: Any exception thrown from this processor will be ignored.


key: on-prepare-failure-ref

description: Sets a reference to a processor to prepare the org.apache.camel.Exchange before handled by the failure processor / dead letter channel. This allows for example to enrich the message before sending to a dead letter queue.


key: on-redelivery-ref

description: Sets a reference to a processor that should be processed before a redelivery attempt. Can be used to change the org.apache.camel.Exchange before its being redelivered.


key: redelivery-policy

description: Sets the redelivery settings


key: redelivery-policy-ref

description: Sets a reference to a RedeliveryPolicy to be used for redelivery settings.


key: retry-while-ref

description: Sets a retry while predicate. Will continue retrying until the predicate evaluates to false.


key: use-original-body

description: Will use the original input org.apache.camel.Message body (original body only) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the splitted message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off.


key: use-original-message

description: Will use the original input org.apache.camel.Message (original body and headers) when an org.apache.camel.Exchange is moved to the dead letter queue. Notice: this only applies when all redeliveries attempt have failed and the org.apache.camel.Exchange is doomed for failure. Instead of using the current inprogress org.apache.camel.Exchange IN message we use the original IN message instead. This allows you to store the original input in the dead letter queue instead of the inprogress snapshot of the IN message. For instance if you route transform the IN body during routing and then failed. With the original exchange store in the dead letter queue it might be easier to manually re submit the org.apache.camel.Exchange again as the IN message is the same as when Camel received it. So you should be able to send the org.apache.camel.Exchange to the same input. The difference between useOriginalMessage and useOriginalBody is that the former includes both the original body and headers, where as the latter only includes the original body. You can use the latter to enrich the message with custom headers and include the original message body. The former wont let you do this, as its using the original message body and headers as they are. You cannot enable both useOriginalMessage and useOriginalBody. The original input message is defensively copied, and the copied message body is converted to org.apache.camel.StreamCache if possible (stream caching is enabled, can be disabled globally or on the original route), to ensure the body can be read when the original message is being used later. If the body is converted to org.apache.camel.StreamCache then the message body on the current org.apache.camel.Exchange is replaced with the org.apache.camel.StreamCache body. If the body is not converted to org.apache.camel.StreamCache then the body will not be able to re-read when accessed later. Important: The original input means the input message that are bounded by the current org.apache.camel.spi.UnitOfWork . An unit of work typically spans one route, or multiple routes if they are connected using internal endpoints such as direct or seda. When messages is passed via external endpoints such as JMS or HTTP then the consumer will create a new unit of work, with the message it received as input as the original input. Also some EIP patterns such as splitter, multicast, will create a new unit of work boundary for the messages in their sub-route (eg the splitted message); however these EIPs have an option named shareUnitOfWork which allows to combine with the parent unit of work in regard to error handling and therefore use the parent original message. By default this feature is off.


description: The default error handler.


description: JTA based transactional error handler (requires camel-jta).

default: WARN


key: rollback-logging-level

description: Sets the logging level to use for logging transactional rollback. This option is default WARN.


key: transacted-policy-ref

description: The transacted policy to use that is configured for either Spring or JTA based transactions. If no policy has been configured then Camel will attempt to auto-discover.


description: To not use an error handler.


description: The id of this node


description: References to an existing or custom error handler.


key: ref


description: Spring based transactional error handler (requires camel-spring).


description: Evaluate a compiled simple expression.


key: expression

description: The expression value in your chosen language syntax


description: Sets the id of this node


key: result-type

description: Sets the class of the result type (type from output)


key: trim

description: Whether to trim the value to remove leading and trailing whitespaces and line breaks


description: A fixed value set only once during the route startup.


description: To use DataSonnet scripts for message transformations.


key: body-media-type

description: The String representation of the message's body MediaType


key: output-media-type

description: The String representation of the MediaType to output


description: Gets a property from the Exchange.


description: Evaluates a Groovy script.


description: Gets a header from the Exchange.


description: Get the value of a HL7 message field specified by terse location specification syntax.


key: header-name

description: Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set.


key: property-name

description: Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set.


description: Evaluates a JavaScript expression.


description: Evaluates a jOOR (Java compiled once at runtime) expression.


key: pre-compile

description: Whether the expression should be pre compiled once during initialization phase. If this is turned off, then the expression is reloaded and compiled on each evaluation.


key: single-quotes

description: Whether single quotes can be used as replacement for double quotes. This is convenient when you need to work with strings inside strings.


description: Evaluates a JQ expression against a JSON message body.


key: id

description: Sets the id of this node


description: Evaluates a JSONPath expression against a JSON message body.


key: allow-easy-predicate

description: Whether to allow using the easy predicate parser to pre-parse predicates.


key: allow-simple

description: Whether to allow in inlined Simple exceptions in the JSONPath expression


description: The expression value in your chosen language syntax


key: option

description: To configure additional options on JSONPath. Multiple values can be separated by comma.


description: Sets the class of the result type (type from output)


key: suppress-exceptions

description: Whether to suppress exceptions such as PathNotFoundException.


description: Whether to trim the value to remove leading and trailing whitespaces and line breaks


key: unpack-array

description: Whether to unpack a single element json-array into an object.


key: write-as-string

description: Whether to write the output of each row/element as a JSON String value instead of a Map/POJO value.


description: Evaluates a custom language.

required: expression language


key: language

description: The name of the language to use


description: Calls a Java bean method.

default: Singleton

enum: Singleton Request Prototype


key: bean-type

description: Class name (fully qualified) of the bean to use Will lookup in registry and if there is a single instance of the same type, then the existing bean is used, otherwise a new bean is created (requires a default no-arg constructor).


key: method

description: Name of method to call


key: ref

description: Reference to an existing bean (bean id) to lookup in the registry


key: scope

description: Scope of bean. When using singleton scope (default) the bean is created or looked up only once and reused for the lifetime of the endpoint. The bean should be thread-safe in case concurrent threads is calling the bean at the same time. When using request scope the bean is created or looked up once per request (exchange). This can be used if you want to store state on a bean while processing a request and you want to call the same bean instance multiple times while processing the request. The bean does not have to be thread-safe as the instance is only called from the same request. When using prototype scope, then the bean will be looked up or created per call. However in case of lookup then this is delegated to the bean registry such as Spring or CDI (if in use), which depends on their configuration can act as either singleton or prototype scope. So when using prototype scope then this depends on the bean registry implementation.


description: Evaluates a MVEL template.


description: Sets the id of this node


description: Evaluates an OGNL expression (Apache Commons OGNL).


key: expression


description: Evaluates a Python expression.


key: result-type


description: Uses an existing expression from the registry.


key: trim


description: Evaluates a Camel simple expression.


description: Evaluates a Spring expression (SpEL).


description: Tokenize text payloads using delimiter patterns.


key: end-token

description: The end token to use as tokenizer if using start/end token pairs. You can use simple language as the token to support dynamic tokens.


key: group

description: To group N parts together, for example to split big files into chunks of 1000 lines. You can use simple language as the group to support dynamic group sizes.


key: group-delimiter

description: Sets the delimiter to use when grouping. If this has not been set then token will be used as the delimiter.


key: header-name

description: Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set.


key: include-tokens

description: Whether to include the tokens in the parts when using pairs. When including tokens then the endToken property must also be configured (to use pair mode). The default value is false


key: inherit-namespace-tag-name

description: To inherit namespaces from a root/parent tag name when using XML You can use simple language as the tag name to support dynamic names.


key: property-name

description: Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set.


key: regex

description: If the token is a regular expression pattern. The default value is false


key: skip-first

description: To skip the very first element


key: token

description: The (start) token to use as tokenizer, for example you can use the new line token. You can use simple language as the token to support dynamic tokens.


key: xml

description: Whether the input is XML messages. This option must be set to true if working with XML payloads.


description: Tokenize XML payloads.

default: i

enum: i w u t


description: The expression value in your chosen language syntax


description: To group N parts together


key: id

description: Sets the id of this node


key: mode

description: The extraction mode. The available extraction modes are: i - injecting the contextual namespace bindings into the extracted token (default) w - wrapping the extracted token in its ancestor context u - unwrapping the extracted token to its child content t - extracting the text content of the specified element


key: namespace

description: Injects the XML Namespaces of prefix - uri mappings


description: Whether to trim the value to remove leading and trailing whitespaces and line breaks


description: Evaluates an XPath expression against an XML payload.

default: NODESET

enum: NUMBER STRING BOOLEAN NODESET NODE


key: document-type

description: Name of class for document type The default value is org.w3c.dom.Document


key: factory-ref

description: References to a custom XPathFactory to lookup in the registry


key: log-namespaces

description: Whether to log namespaces which can assist during troubleshooting


key: object-model

description: The XPath object model to use


key: pre-compile

description: Whether to enable pre-compiling the xpath expression during initialization phase. pre-compile is enabled by default. This can be used to turn off, for example in cases the compilation phase is desired at the starting phase, such as if the application is ahead of time compiled (for example with camel-quarkus) which would then load the xpath factory of the built operating system, and not a JVM runtime.


key: result-type

description: Sets the class name of the result type (type from output) The default result type is NodeSet


key: saxon

description: Whether to use Saxon.


key: thread-safety

description: Whether to enable thread-safety for the returned result of the xpath expression. This applies to when using NODESET as the result type, and the returned set has multiple elements. In this situation there can be thread-safety issues if you process the NODESET concurrently such as from a Camel Splitter EIP in parallel processing mode. This option prevents concurrency issues by doing defensive copies of the nodes. It is recommended to turn this option on if you are using camel-saxon or Saxon in your application. Saxon has thread-safety issues which can be prevented by turning this option on.


description: Evaluates an XQuery expressions against an XML payload.


key: configuration-ref

description: Reference to a saxon configuration instance in the registry to use for xquery (requires camel-saxon). This may be needed to add custom functions to a saxon configuration, so these custom functions can be used in xquery expressions.


key: expression


key: header-name

description: Name of header to use as input, instead of the message body It has as higher precedent than the propertyName if both are set.


description: Sets the id of this node


key: property-name

description: Name of property to use as input, instead of the message body. It has a lower precedent than the headerName if both are set.


description: Sets the class of the result type (type from output)


key: trim


key: type


description: To use a custom load balancer implementation.


key: id

description: The id of this node


key: ref

description: Refers to the custom load balancer to lookup from the registry


description: In case of failures the exchange will be tried on the next endpoint.


key: exception

description: A list of class names for specific exceptions to monitor. If no exceptions are configured then all exceptions are monitored


key: maximum-failover-attempts

description: A value to indicate after X failover attempts we should exhaust (give up). Use -1 to indicate never give up and continuously try to failover. Use 0 to never failover. And use e.g. 3 to failover at most 3 times before giving up. his option can be used whether or not roundRobin is enabled or not.


key: round-robin

description: Whether or not the failover load balancer should operate in round robin mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If round robin is enabled, then it keeps state and will continue with the next endpoint in a round robin fashion. You can also enable sticky mode together with round robin, if so then it will pick the last known good endpoint to use when starting the load balancing (instead of using the next when starting).


key: sticky

description: Whether or not the failover load balancer should operate in sticky mode or not. If not, then it will always start from the first endpoint when a new message is to be processed. In other words it restart from the top for every message. If sticky is enabled, then it keeps state and will continue with the last known good endpoint. You can also enable sticky mode together with round robin, if so then it will pick the last known good endpoint to use when starting the load balancing (instead of using the next when starting).


description: The destination endpoints are selected by random.


description: The destination endpoints are selected in a round-robin fashion. This is a well known and classic policy, which spreads the load evenly.


description: Sticky load balancing using an expression to calculate a correlation key to perform the sticky load balancing.


key: correlation-expression

description: The correlation expression to use to calculate the correlation key


description: Topic which sends to all destinations.


description: Uses a weighted load distribution ratio for each server with respect to others.


key: distribution-ratio

description: The distribution ratio is a delimited String consisting on integer weights separated by delimiters for example 2,3,5. The distributionRatio must match the number of endpoints and/or processors specified in the load balancer list.


key: distribution-ratio-delimiter

description: Delimiter used to specify the distribution ratio. The default value is , (comma)


description: To enable round robin mode. By default the weighted distribution mode is used. The default value is false.


description: Rest security basic auth definition

required: key name


key: description

description: A short description for security scheme.


key: in-cookie

description: To use a cookie as the location of the API key.


key: in-header

description: To use header as the location of the API key.


key: in-query

description: To use query parameter as the location of the API key.


key: key

description: Key used to refer to this security definition


key: name

description: The name of the header or query parameter to be used.


description: Rest security basic auth definition


description: Rest security bearer token authentication definition


key: format

description: A hint to the client to identify how the bearer token is formatted.


description: Rest DELETE command

default: off

enum: off auto json xml json_xml


key: api-docs

description: Whether to include or exclude this rest operation in API documentation. The default value is true.


key: binding-mode

description: Sets the binding mode to use. This option will override what may be configured on a parent level The default value is off


key: client-request-validation

description: Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error.


key: consumes

description: To define the content type what the REST service consumes (accept as input), such as application/xml or application/json. This option will override what may be configured on a parent level


key: deprecated

description: Marks this rest operation as deprecated in OpenApi documentation.


description: Sets the id of this node


key: disabled

description: Whether to disable this REST service from the route during build time. Once an REST service has been disabled then it cannot be enabled later at runtime.


key: id

description: Sets the id of this node


key: out-type

description: Sets the class name to use for binding from POJO to output for the outgoing data This option will override what may be configured on a parent level The name of the class of the input data. Append a to the end of the name if you want the input to be an array type.


key: path

description: The path mapping URIs of this REST operation such as /{id}.


key: produces

description: To define the content type what the REST service produces (uses for output), such as application/xml or application/json This option will override what may be configured on a parent level


key: route-id

description: Sets the id of the route


key: skip-binding-on-error-code

description: Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do. This option will override what may be configured on a parent level


key: to

description: The Camel endpoint this REST service will call, such as a direct endpoint to link to an existing route that handles this REST call.


key: type

description: Sets the class name to use for binding from input to POJO for the incoming data This option will override what may be configured on a parent level. The name of the class of the input data. Append a to the end of the name if you want the input to be an array type.


description: Rest GET command


description: Rest HEAD command


description: Rest security mutual TLS authentication definition


key: description

description: A short description for security scheme.


key: key

description: Key used to refer to this security definition


description: Rest security OAuth2 definition

enum: implicit password application clientCredentials accessCode authorizationCode


key: authorization-url

description: The authorization URL to be used for this flow. This SHOULD be in the form of a URL. Required for implicit and access code flows


key: flow

description: The flow used by the OAuth2 security scheme. Valid values are implicit, password, application or accessCode.


key: refresh-url

description: The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.


key: scopes

description: The available scopes for an OAuth2 security scheme


key: token-url

description: The token URL to be used for this flow. This SHOULD be in the form of a URL. Required for password, application, and access code flows.


description: Rest security OpenID Connect definition

required: key url


key: url

description: OpenId Connect URL to discover OAuth2 configuration values.


description: To specify the rest operation parameters.

default: string

default: csv

enum: csv multi pipes ssv tsv

default: path

enum: body formData header path query


key: allowable-values

description: Sets the parameter list of allowable values (enum).


key: array-type

description: Sets the parameter array type. Required if data type is array. Describes the type of items in the array.


key: collection-format

description: Sets the parameter collection format.


key: data-format

description: Sets the parameter data format.


key: data-type

description: Sets the parameter data type.


key: default-value

description: Sets the parameter default value.


description: Sets the parameter description.


key: examples

description: Sets the parameter examples.


key: name

description: Sets the parameter name.


key: required

description: Sets the parameter required flag.


key: type

description: Sets the parameter type.


description: Rest PATCH command


key: api-docs

description: Whether to include or exclude this rest operation in API documentation. The default value is true.


key: binding-mode

description: Sets the binding mode to use. This option will override what may be configured on a parent level The default value is off


key: client-request-validation

description: Whether to enable validation of the client request to check: 1) Content-Type header matches what the Rest DSL consumes; returns HTTP Status 415 if validation error. 2) Accept header matches what the Rest DSL produces; returns HTTP Status 406 if validation error. 3) Missing required data (query parameters, HTTP headers, body); returns HTTP Status 400 if validation error. 4) Parsing error of the message body (JSon, XML or Auto binding mode must be enabled); returns HTTP Status 400 if validation error.


key: consumes

description: To define the content type what the REST service consumes (accept as input), such as application/xml or application/json. This option will override what may be configured on a parent level


key: deprecated

description: Marks this rest operation as deprecated in OpenApi documentation.


key: description

description: Sets the id of this node


key: disabled

description: Whether to disable this REST service from the route during build time. Once an REST service has been disabled then it cannot be enabled later at runtime.


key: id

description: Sets the id of this node


key: out-type

description: Sets the class name to use for binding from POJO to output for the outgoing data This option will override what may be configured on a parent level The name of the class of the input data. Append a to the end of the name if you want the input to be an array type.


key: path

description: The path mapping URIs of this REST operation such as /{id}.


key: produces

description: To define the content type what the REST service produces (uses for output), such as application/xml or application/json This option will override what may be configured on a parent level


key: route-id

description: Sets the id of the route


key: skip-binding-on-error-code

description: Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do. This option will override what may be configured on a parent level


key: to

description: The Camel endpoint this REST service will call, such as a direct endpoint to link to an existing route that handles this REST call.


description: Sets the class name to use for binding from input to POJO for the incoming data This option will override what may be configured on a parent level. The name of the class of the input data. Append a to the end of the name if you want the input to be an array type.


description: Rest POST command


description: Rest PUT command


description: To specify the rest operation response headers.


key: allowable-values

description: Sets the parameter list of allowable values.


key: array-type


key: collection-format

description: Sets the parameter collection format.


key: data-format

description: Sets the parameter data format.


key: data-type

description: Sets the header data type.


description: Description of the parameter.


key: example

description: Sets the example


key: name

description: Name of the parameter. This option is mandatory.


description: To specify the rest operation response messages.


key: code

description: The response code such as a HTTP status code


key: examples

description: Examples of response messages


key: header

description: Adds a response header


key: message

description: The response message (description)


key: response-model

description: The response model


description: To configure rest binding


key: binding-mode

description: Sets the binding mode to use. The default value is off


key: client-request-validation


key: component

description: Sets the component name that this definition will apply to


key: consumes

description: To define the content type what the REST service consumes (accept as input), such as application/xml or application/json


key: description

description: Sets the id of this node


key: id

description: Sets the id of this node


key: out-type

description: Sets the class name to use for binding from POJO to output for the outgoing data The name of the class of the input data. Append a to the end of the name if you want the input to be an array type.


key: produces

description: To define the content type what the REST service produces (uses for output), such as application/xml or application/json


key: skip-binding-on-error-code

description: Whether to skip binding on output if there is a custom HTTP error code header. This allows to build custom error messages that do not bind to json / xml etc, as success messages otherwise will do.


key: type

description: Sets the class name to use for binding from input to POJO for the incoming data The name of the class of the input data. Append a to the end of the name if you want the input to be an array type.


description: To configure rest

enum: openapi swagger

enum: auto json json_xml off xml

enum: platform-http servlet jetty undertow netty-http coap

default: allLocalIp

enum: allLocalIp localHostName localIp

enum: vertx-http http undertow netty-http


key: api-component

description: The name of the Camel component to use as the REST API. If no API Component has been explicit configured, then Camel will lookup if there is a Camel component responsible for servicing and generating the REST API documentation, or if a org.apache.camel.spi.RestApiProcessorFactory is registered in the registry. If either one is found, then that is being used.


key: api-context-path

description: Sets a leading API context-path the REST API services will be using. This can be used when using components such as camel-servlet where the deployed web application is deployed using a context-path.


key: api-context-route-id

description: Sets the route id to use for the route that services the REST API. The route will by default use an auto assigned route id.


key: api-host

description: To use a specific hostname for the API documentation (such as swagger or openapi) This can be used to override the generated host with this configured hostname


key: api-property

description: Allows to configure as many additional properties for the api documentation. For example set property api.title to my cool stuff


key: api-vendor-extension

description: Whether vendor extension is enabled in the Rest APIs. If enabled then Camel will include additional information as vendor extension (eg keys starting with x-) such as route ids, class names etc. Not all 3rd party API gateways and tools supports vendor-extensions when importing your API docs.


description: The Camel Rest component to use for the REST transport (consumer), such as netty-http, jetty, servlet, undertow. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found, then that is being used.


key: component-property

description: Allows to configure as many additional properties for the rest component in use.


key: consumer-property

description: Allows to configure as many additional properties for the rest consumer in use.


key: context-path

description: Sets a leading context-path the REST services will be using. This can be used when using components such as camel-servlet where the deployed web application is deployed using a context-path. Or for components such as camel-jetty or camel-netty-http that includes a HTTP server.


key: cors-headers

description: Allows to configure custom CORS headers.