Unmarshal

Table of Contents

Usage
Properties
Related topics

Converts the message data received from the wire into a format that Apache Camel processors can consume

Usage

The Unmarshal pattern uses Apache Camel’s pluggable data format mechanism to convert messages into a format appropriate for processing by Apache Camel.

The Unmarshal pattern can be placed anywhere in the body of a route. However, it is typically placed after endpoints that receive the message.

Properties

Table 116, “Unmarshal Properties” describes the properties you can specify using the properties editor.

Table 116. Unmarshal Properties

Name	Description
`Data Format Type`	Specifies the data type to which the data will be unmarshalled. For data formats that require configuration, the format’s tab provides the property fields to configure the marshaller. Because the GZip, Serialization, String, and Zip data formats are part of the Camel core, you need not add dependencies for them in your Maven`pom.xml` file to use them. However, to use any of the other supported data formats, you must add a dependency on the component that implements the data format (for example, `camel-protobuf`, `camel-xmlbeans`, `camel-flatpack`, `camel-base64`, `camel-xmlrpc`, `camel-zipfile`, and so on) in your Maven`pom.xml` file. avro — Unmarshals Apache Avro binary data, formatted using a user-supplied schema, into Java Objects base64 — Decodes messages in base64 data format into Java Objects beanio — Unmarshals flat data structures, formatted according to user-defined mappings, into Java Objects bindy — Unmarshals flat data structures to Java Objects castor — Unmarshals XML to Java Objects crypto — Unmarshals encrypted cyphertext to Java Objects csv — Unmarshals csv data to Java Objects custom — Unmarshals a custom data format implemented using the DataFormat interface to Java Objects flatpack — Unmarshals fixed-width or delimited text messages to Java Objects gzip — Unmarshals gzipped compressed messages to uncompressed messages hl7 — Unmarshals byte streams to HL7 HAPI message objects ical — Unmarshals ICalendar message objects to Java Objects jaxb — Unmarshals XML to Java Objects jibx — Unmarshals XML to Java Objects using the JiBX library json — Unmarshals JSON to Java Objects pgp — Unmarshals encrypted cyphertext to Java Objects protobuf — Unmarshals Protocol Buffers format (Google’s data exchange format) to Java Objects rss — Unmarshals ROME `SyndFeed` messages to XML `String` messages secureXML — Unmarshals encrypted XML to plain XML. This data format works at the document, element, and element content levels (including simultaneous, multinode encryption using XPath). serialization — Unmarshals a binary blob to Java Objects using the standard Java serialization mechanism soapjaxb — Unmarshals a SOAP message to a tree of Java Objects using JAXB and JAX-WS annotations string — Unmarshals XML or text-based messages to String Objects syslog — Unmarshals Java String Objects to RFC3164 message format tidyMarkup — Unmarshals untidy HTML to well-formed HTML univocity-csv — Unmarshals csv formatted data to Java String Objects univocity-fixed — Unmarshalsfixed-width formatted data to Java String Objects univocity-tsv — Unmarshals tabular formatted data to Java String Objects xmlbeans — Unmarshals Java objects to XML using the XmlBeans library xmljson — Unmarshals json directly to XML xmlrpc — Unmarshals rpc request/response messages from Apache XmlRpc bindary format to xml xstream — Unmarshals Java objects to XML using the XStream library zip — Unmarshals zip compressed messages to uncompressed messages zipFile — Unmarshals compressed messages in a zip file to their original file format. Supports ZIP64 format when Java 7 or later is used
`Description`	Specifies a text description for the node. This description is included in the generated XML file, but it is informational only. It is not used by Apache Camel.
`Id`	Specifies a unique identifier for the endpoint. The tooling automatically generates an id for a node when it is created, but you can remove that id or replace it with your own. The Camel debugger requires all nodes with a breakpoint set to have a unique id. You can use the id to refer to endpoints in your Camel XML file.
`Ref`	Specifies a reference to a Spring bean configuring the Apache Camel data format to which the message body is unmarshalled.

avro Table 117, “avro Properties” describes the properties needed to configure the avro unmarshaller.

Table 117. avro Properties

Name	Description
`Instance Class Name`	Specifies the name of the instance class to use for unmarshalling. This is the class defined by your schema `.apache.camel.dataformat.avro.<nameOfInstanceClass>`.

base64 Table 118, “base64 Properties” describes the properties needed to configure the base64 unmarshaller.

Table 118. base64 Properties

Name	Default	Description
`Line Length`	76	Specifies the maximum line length.
`Line Separator`	\r\n	Specifies the line separator to use.
`Url Safe`	Disabled	When disabled, decodes `-` and `_`. When enabled, decodes `+` (not `-`) and `/` (not `_`).

beanio Table 119, “beanio Properties” describes the properties needed to configure the beanio unmarshaller.

Table 119. beanio Properties

Name	Description
`Encoding`	Specifies the charset to use. The default is platform-specific.
`Ignore Invalid Records`	Species whether to ignore invalid records. The default is false.
`Ignore Unexpected Records`	Species whether to ignore invalid records. The default is false.
`Ignore Unidentified Records`	Species whether to ignore invalid records. The default is false.
`Mapping`	Specifies the BeanIO mapping.xml file to use. By default, this file is loaded from the classpath, but you can add one of the prefixes — `file:`, `http:`, or `classpath:` — to specify the location from which to load this file.
`Stream Name`	Specifies the name of the stream to use.

bindy Table 120, “bindy Properties” describes the properties needed to configure the bindy unmarshaller.

Table 120. bindy Properties

Name	Description
`Class Type`	Specifies a fully qualified class name that explicitly defines the type to use for unmarshalling. For example, you might enter com.mycompany.MyOrder You must use either this property or `Packages`, but not both.
`Locale`	Species the language name of the locale whose date and number format will be used. If not specified, the unmarshaller determines and uses the formatting of a default language name. Valid values are the two-letter abbreviation of the language name, in lower case. For example, `ar` — Arabic `es` — Castilian Spanish `da` — Danish `en` — English `fr` — French `jp` — Japanese For an exhaustive list of language names, see Codes for the Representation of Names of Languages
`Packages`	Specifies the packages to use for unmarshalling. A package contains a defined model with required annotations properly associated for each class in the model. For example, you might enter com.mycompany. When specifying multiple packages, separate them with a comma (`,`). You must use either this property or `Class Type`, but not both.
`Type`	Specifies the field type. Select `Csv` (comma-separated value fields), `Fixed` (fixed-length records), or `KeyValue` (key/value pair fields).

castor Table 121, “castor Properties” describes the properties needed to configure the castor unmarshaller.

Table 121. castor Properties

Name	Description
`Classes`	Specifies additional classes to add to the Castor XmlContext. Enter the fully qualified path. When specifying multiple classes, separate them with a comma (`,`).
`Encoding`	Specifies the encoding to use when unmarshalling XML to an Object. Default is UTF-8.
`Mapping File`	Specifies the path to the Castor mapping file to load from the classpath.
`Packages`	Specifies any additional packages to add to the Castor XmlContext. Enter the fully qualified path. When specifying multiple packages, separate them with a comma (`,`).
`Validation`	Enables/disables validation. The default is Disabled.

crypto Table 122, “crypto Properties” describes the properties needed to configure the crypto unmarshaller.

Table 122. crypto Properties

Name	Description
`Algorithm`	Specifies the name of the JCE cryptographic algorithm to use. Default is `DES/CBC/PKCS5Padding`.
`Algorithm Parameter Ref`	Reference to the JCE `AlgorithmParameterSpec` to use to initialize the cipher. Some crypto algorithms, particularly block algorithms, require initialization by an initial block of data, known as an Initialization Vector. The JCE passes the Initialization Vector to the cipher as an `AlgorithmParameterSpec`. Select from the list of available options.
`Buffersize`	Specifies the size, in bytes, of the buffer used in the signature process.
`Crypto Provider`	Specifies the name of the JCE Security Provider to use. For options, see Java Cryptography Architecture; Sun Providers Documentation.
`Init Vector Ref`	Reference to a byte array containing the Initialization Vector to use to initialize the cipher. Select from the list of available options.
`Inline`	Enables inlining the configured Initialization Vector into the encrypted data stream.
`Key Ref`	Specifies the value of the keyref attribute within the <dataFormats> element in a Spring configuration. For example, `<crypto id="basic" algorithm="DES" keyref="desKey" />`. Select from the list of available options.
`Mac Algorithm`	Specifies the algorithm to use to create the Hash-based Message Authentication. Default is `HmacSHA1`. For more options, see Java Standard Names Reference.
`Should Append HMAC`	Enables calculating and appending a Message Authentication Code to the decrypted data.

csv Table 123, “csv Properties” describes the properties needed to configure the csv unmarshaller.

Table 123. csv Properties

Name	Description
`Allow Missing Column Names`	Specifies whether to allow missing column names in the header line. The default is Disabled for formats `DEFAULT`, `RFC4180`, `MYSQL`, and `TDF`, but True for `EXCEL`. (See [unmarshalCSVFormatName] for available reference formats.)
`Comment Marker`	Specifies the character to use to mark the start of a comment line. The default is null.
`Comment Marker Disabled`	Disables the comment marker of the reference format. The default is False.
`Delimiter`	Specifies the character to use for the value delimiter, typically `,`, `;`, or `\t`. The line break character causes an IllegalArguementException. The default is `,` for formats `DEFAULT`, `RFC4180`, and `EXCEL`, but `\t` for `MYSQL` and `TDF`. (See [unmarshalCSVFormatName] for available reference formats.)
`Escape`	Specifies the character to use as the escape character. The default is null, except for `MYSQL`, for which the default is `\\`. (See [unmarshalCSVFormatName] for available reference formats.)
`Escape Disabled`	Disables the processing of escape characters.
`Format Name`	Specifies the name of the reference format to use for parsing input. Predefined reference format options are: `CSVFormat.DEFAULT` — [Default] Standard comma-separated format, but allows empty lines `CSVFormat.EXCEL` — Excel file format, which typically uses the comma (`,`) as the value delimiter. Note that the value of the value delimiter is locale-dependent and depends on the system’s regional settings. `CSVFormat.MYSQL` — Default MySQL format used by the `SELECT INTO OUTFILE` and `LOAD DATA INFILE` operations `CSVFormat.RFC4180` — Comma-separated format as defined by RFC 4180, which does allow empty lines `CSVFormat.TDF` — Tab-delimited format, which uses the LF character as line separator
`Format Ref`	Reference to a custom reference format.
`Header`	Specifies the column names to use to address values in the CSV records. If your CSV source contains a first record that also defines column names, enable the `Skip Header Record` property. The default is null.
`Header Disabled`	Disables processing of the column names specified in the `Header` property.
`Ignore Empty Lines`	Specifies whether empty lines between records are ignored or turned into empty records. The default is False for formats `RFC4180`, `EXCEL`, `MYSQL` and `TDF`, which results in empty lines becoming empty records, but True for `DEFAULT`, which results in empty lines being ignored. (See [unmarshalCSVFormatName] for available reference formats.)
`Ignore Surrounding Spaces`	Specifies whether spaces surrounding values are trimmed or included as part of the value. The default is False for formats `DEFAULT`, `RFC4180`, `EXCEL`, and `MYSQL`, which results in including empty spaces with values, but True for `TDF`, which results in empty lines being ignored/trimmed. (See [unmarshalCSVFormatName] for available reference formats.)
`Lazy Load`	Specifies whether the unmarshaller should use an iterator to read lines on-the-fly as needed. The default is False, which specifies eager loading/reading all lines at once.
`Null String`	Specifies the string to use to convert to and from `null` on input and output. If left unspecified, the null string representation of the reference format is used.
`Null String Disabled`	Disables null string processing. The default is False.
`Quote`	Specifies the character to use to encapsulate values containing special characters. If not specified, uses the default character of the reference format, which is double quotes (`"`) for all reference formats, except `MYSQL`, for which it is `null`. (See [unmarshalCSVFormatName] for available reference formats.)
`Quote Disabled`	Disables quote processing. The default is False.
`Record Converter Ref`	Specifies a reference to the record converter to use for unmarshalling when `Use Maps` is Disabled. The default is null.
`Record Separator`	Specifies the character or characters to use for the record separator. If not specified, uses the default of the reference format. The default is `\r\n` for formats `DEFAULT`, `RFC4180`, `EXCEL`, and `TDF`, but `\n` for `MYSQL`. (See [unmarshalCSVFormatName] for available reference formats.)
`Record Separator Disabled`	Disables processing of the record separator. The default is False.
`Skip Header Record`	Specifies whether to skip the header record in the input file. Enable this property if you define your own column headers using the `Header` property. The default is False.
`Use Maps`	Specifies whether the unmarshaller produces maps, instead of lists, for line values. When enabled, the input must have a header line (either defined or collected). The default is False.

custom Table 124, “custom Properties” describes the properties needed to configure the custom unmarshaller.

Table 124. custom Properties

Name	Description
`Ref`	Reference to the file that implements your custom data format using the DataFormat interface.

flatpack Table 125, “flatpack Properties” describes the properties needed to configure the jaxb marshaller.

Table 125. flatpack Properties

Name	Description
`Allow Short Lines`	Specifies whether to allow lines to be shorter than expected and to ignore the extra characters. The default is Disabled.
`Definition`	Specifies the flatpack pzmap configuration file to use to configure the structure of the input. If not specified, the configuration of the input defaults to Delimited.
`Delimiter`	Specifies the character to use to delimit values in the input for delimited input. The default is ,.
`Fixed`	Specifies whether the input format is delimited or fixed-length. The default is Delimited.
`Ignore Extra Columns`	Specifies whether to allow lines to be longer than expected and to ignore the extra characters. The default is Disabled.
`Ignore First Record`	Specifies whether to ignore the first line (containing headers) for delimited input. The default is Disabled.
`Parse Factory Ref`	Specifies the parser factory to use. If not specified, the default Flatpack parser factory is used.
`Text Qualifier`	Specifies the character to use to encapsulate text. The default is double quotes (`"`).

ical Table 126, “ical Properties” describes the properties needed to configure the ical marshaller.

Table 126. ical Properties

Name	Description
`Validating`	Specifies whether to enable validation checking. The default is Disabled.

jaxb Table 127, “jaxb Properties” describes the properties needed to configure the jaxb unmarshaller.

Table 127. jaxb Properties

Name	Description
`Context Path`	Specifies the context path for the jaxb data format. For example, `org.apache.camel.example`
`Encoding`	Specifies the encoding to use when unmarshalling data. Valid values include: ISO-8859-1 US-ASCII UTF-8 With no value specified, Red Hat JBoss Fuse Tooling for Eclipse defaults to the encoding used by JAXB.
`Filter Non XML Chars`	Not applicable. Enables the filtering of non XML characters during marshalling such that the marshaller replaces any non XML characters it encounters with the string `" "`. Otherwise, when it encounters a non XML character, the marshaller throws an exception.
`Fragment`	Not applicable. Enables the marshaller’s `FRAGMENT` encoding property, which prevents the marshaller from generating the XML declaration. Enable this property in conjunction with setting `Part Class` and `Part Namespace` to perform partial marshalling on only a fragment of the XML tree.
`Ignore JAXBElement`	Disables the `ignoreJAXBElement` property so that the unmarshaller returns the JAXBElement object from the body of the unmarshalled message, instead of the value of the element instance (default behavior).
`Must Be JAXBElement`	Not applicable. Specifies whether the Marshaller relaxes message checking for JAXB compatibility to marshal XML messages as is. To enable relaxed message checking, disable this property. The default is Enabled..
`Namespace Prefix Ref`	Not applicable. Specifies the `id` of the `<util:map>` that contains custom namespace mapping specifications. The JAXB implementation auto assigns namespace prefixes (such as n1,n2, n3,…) to namespaces when marshalling JAXB or SOAP. To use your own custom prefixes or to eliminate prefixes, you need to create and reference a `<util:map>` in your `camelContext`. For example: <util:map id="myMap"> <!-- Assign the prefix soap to the soap namespace --> <entry key="http://www.w3.org/2003/05/soap-envelope" value="soap" /> <!-- Eliminate any prefix from our own namespace --> <entry key="http://www.mycompny.com/foo/2" value="" /> </util:map>
`Part Class`	Specifies the uri of the class within the XML tree that you want to marshal, leaving all other classes in the tree as is. Set this property in conjunction with `Fragment` and `Part Namespace` to perform partial marshalling on only a fragment of the XML tree.
`Part Namespace`	Specifies the `Qname` of the destination namespace.
`Pretty Print`	Not applicable. Enables pretty printing, which adds white space as needed to tidy up the resulting XML for easy reading.
`Schema`	Specifies the schema to use for validation. To use multiple schemas, separate them using commas (`,`). Use the `classpath:`, `file:`, or `http:` prefix to specify how to resolve a specific resource.
`Schema Location`	Specifies the location of the schema to use for validation when unmarshalling XML (for example, `schema/person.xsd`).
`Xml Stream Writer Wrapper`	Not applicable. Specifies the name of XMLStreamWriterWrapper to use to marshal the stream to XML. Using the XMLStreamWriterWrapper to customize the XMLStreamWriter, you can remove, escape, or replace non-XML characters.

json Table 128, “json Properties” describes the properties needed to configure the json unmarshaller.

Table 128. json Properties

Name	Description
`Allow Jms Type`	For JMS destinations. Specifies whether to allow unmarshalling from Json to POJO using dynamic class names. To implement, you use the JMS message header `JMSType` to specify the class name to which to unmarshal. Requires the Jackson library. The default is Disabled.
`Collection Type Name`	Specifies a reference to the name of a custom collection type in the Camel registry to use, instead of the default, which is based on java.util.Collection.
`Disable Features`	Specifies the name or names of features to disable on the `com.fasterxml.jackson.databind.ObjectMapper`. Names must match an `enum` from `com.fasterxml.jackson.databind.SerializationFeature`, `com.fasterxml.jackson.databind.DeserializationFeature`, or `com.fasterxml.jackson.databind.MapperFeature`. When specifying multiple features, separate them with a comma. Requires the Jackson library.
`Enable Features`	Specifies the name or names of features to enable on the `com.fasterxml.jackson.databind.ObjectMapper`. Names must match an `enum` from `com.fasterxml.jackson.databind.SerializationFeature`, `com.fasterxml.jackson.databind.DeserializationFeature`, or `com.fasterxml.jackson.databind.MapperFeature`. When specifying multiple features, separate them with a comma. Requires the Jackson library.
`Enable Jaxb Annotation Module`	Enables the JAXB annotation module, allowing Jackson to use JAXB annotations. Requires the Jackson library.
`Include`	Not applicable. Specifies the fields to exclude from the Json output when marshalling a POJO to Json, when using Gson or Xstream.
`Json View`	Specifies the marker class to use for including/excluding specific fields in the POJO output. You must select the Jackson library from the Library drop-down list.
`Library`	Specifies the library to use for unmarshalling. Select either XStream or Jackson from the drop-down list. Default is XStream.
`Module Class Names`	Specifies the name or names of custom Jackson modules to use from `com.fasterxml.jackson.databind.Module`. Names are specified as a string of FNQ classnames. When specifying multiple modules, separate them with a comma.
`Module Refs`	Specifies a reference to the name or names of custom Jackson modules to use from the Camel registry. Names are specified as a string of FNQ classnames. When referencing multiple modules, separate them with a comma.
`Pretty Print`	Enables pretty printing, which adds white space as needed to tidy up the resulting XML for easy reading.
`Unmarshal Type Name`	Specifies the class type to use when unmarshalling; for example `org.apache.camel.component.jackson.<typeName>`. Defaults to using a map-based type. You can define a custom type to use with `org.codehaus.jackson.map.OblectMapper`.
`Use List`	Specifies to use list for unmarshalling Json to a list of map POJO. Requires the Jackson library.

pgp Table 129, “pgp Properties” describes the properties needed to configure the pgp unmarshaller.

Table 129. pgp Properties

Name	Description
`Algorithm`	Not applicable. Specifies the symmetric key encryption algorithm to use for encryption. Valid values are defined in `org.bouncycastle.bcpg.SymmetricKeyAlgorithmTags`. The default is 3 (SymmetricKeyAlgorithmTags.CAST5). Some example values are: `2` (TRIPLE DES) `4` (BLOWFISH) `6` (DES) `7` (AES_128)
`Armored`	Specifies whether the encrypted file was encoded using base64. The default is Disabled.
`Compression Algorithm`	Not applicable. Specifies the compression algorithm used for encryption. Valid values are defined in `org.bouncycastle.bcpg.CompressionAlgorithmTags`. The default is 1 (CompressionAlgorithmTags.ZIP). Some example values are: `0` (UNCOMPRESSED) `2` (ZLIB) `3` (BZIP2)
`Hash Algorithm`	Not applicable. Specifies the hash algorithm used for signing during encryption. Valid values are defined in `org.bouncycastle.bcpg.HashAlgorithmTags`. The default is 2 (HashAlgorithmTags.SHA10). Some example values are: `8` (SHA256) `9` (SHA384) `10` (SHA512) `11` (SHA224)
`Integrity`	Specifies whether the encrypted file contains an integrity check sign. The default is Enabled.
`Key File Name`	Specifies the name of the keyring file that contains the private keys to use to decrypt the data. This file must be accessible as a classpath resource; for example, `org/apache/camel/component/crypto/secring.gpg`.
`Key User Id`	Specifies the user id of the key in the pgp keyring that was used for encryption.
`Password`	Specifies the password to use for opening the private key. This password is not used for encryption.
`Provider`	Specifies the Java Cryptography Extension (JCE) provider to use. The default is BC (Bouncy Castle).
`Signature Key File Name`	Specifies an optional name of the keyring file to use for signing during encryption or for signature verification during decryption. This file must be accessible as a classpath resource, but you can specify its location in the file system using the `file:` prefix. Do not set this option when `Signature Key Ring` is set.
`Signature Key Ring`	Specifies the keyring to use for signing during encryption or during signature verification. Do not set this option when `Signature Key File Name` is set.
`Signature Key Userid`	Specifies an optional user ID for the key in the PGP keyring used for signing during encryption or for signature verification during decryption. During the signature verification process, the specified `Signature Key Userid` prevents public keys in the public keyring being used for verification. If not specified, any public key in the public keyring can be used for verification. You can also specify a portion of the user ID. For example, for user ID "TEST USER <test@camel.com>", you can specify the "Test User" part or the "test@camel.com" part.
`Signature Password`	Specifies an optional password to use when opening the private key used for signing during encryption.
`Signature Verification Option`	Controls the behavior of signature verification during decryption. Valid values are: `optional` — The PGP message may or may not contain signatures. If it contains signatures, signature verification is executed. `required` — The PGP message must contain at least one signature. If so, signature verification is executed. If not, a PGPException is thrown. `ignore` — Signatures contained in the PGP message are ignored, and no signature verification is performed. `no_signature_allowed` — The PGP message must not contain a signature. If it does, a PGPException is thrown. The default is optional.

protobuf Table 130, “protobuf Properties” describes the properties needed to configure the protobuf unmarshaller.

Table 130. protobuf Properties

Name	Description
`Instance Class`	Specifies the name of the instance class to use. This is one of the classes generated when you compiled your `.proto` file. Include the builder `generated` in the uri; for example, `org.apache.camel.dataformat.protobuf.generated.<nameOfInstanceClass>`.

secureXML Table 131, “secureXML Properties” describes the properties needed to configure the secureXML unmarshaller.

Table 131. secureXML Properties

Name	Description
`Add Key Value For Encrypted Key`	Enables/Disables adding the public key used to encrypt the session key as a key value in the EncryptedKey structure, when performing asymmetric key encryption. The default is Enabled.
`Digest Algorithm`	Species the digest algorithm to use with the RSA OAEP algorithm. Default is XMLCipher.SHA1. Valid values are: `XMLCipher.SHA1` `XMLCipher.SHA256` `XMLCipher.SHA512`
`Key Cipher Algorithm` ^[a]	Specifies the cipher algorithm to use to encrypt the asymmetric key. The default is XMLCipher.RSA_OAEP [Camel 2.12]. Valid values are: `XMLCipher.RSA_v1dot5` — NOTE: Use of this algorithm is discouraged due to attacks `XMLCipher.RSA_OAEP` `XMLCipher.RSA_OAEP_11` Asymmetric key encryption is enabled when either this property or the `Recipient Key Alias` property is set.
`Key Or Trust Store Parameters Id`	Specifies the ID of the configuration options to use to create and load a keyStore instance that represents the recipient’s keyStore, when performing asymmetric key decryption.
`Key Password`	Specifies the password to use for retrieving the private key from the keyStore, when performing asymmetric decryption.
`Mgf Algorithm`	Specifies the MFG algorithm to use with the RSA OAEP algorithm, when performing asymmetric key encryption. The default is EncryptionConstants.MFG1_SHA1. Valid values are: `EncryptionConstants.MFG1_SHA1` `EncryptionConstants.MFG1_SHA256` `EncryptionConstants.MFG1_SHA512`
`Pass Phrase`	Specifies a string of alphanumeric characters to use as the passphrase for unmarshalling the message into regular text. The passphrase must be appropriate for the selected decryption algorithm. if not, the unmarshaller throws an exception. When no phrase is specified, the unmarshaller generates and uses a default passphrase.
`Recipient Key Alias`	Specifies the key alias to use for retrieving the recipient’s public or private key from a KeyStore when performing asymmetric key encryption.
`Secure Tag`	Specifies the XPath reference to the XML element to decrypt. If left blank, the entire XML message is decrypted.
`Secure Tag Contents`	Enables/disables encryption of the contents of the XML element. The default is Disabled, which encrypts the XML element.
`XML Cipher Algorithm`	Specifies the cipher algorithm to use for encrypting message content. Valid values a:re: `XMLCipher.TRIPLIDES` `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`
^[a]Used for asymmetric key encryption

soapjaxb Table 132, “soapjaxb Properties” describes the properties needed to configure the soapjaxb unmarshaller.

Table 132. soapjaxb Properties

Name	Description
`Context Path`	Specifies the path of the package to use for initializing the JAXB context.
`Element Name Strategy Ref`	Selects the bean reference to the element name and its namespace within the body of the soap message.
`Encoding`	Specifies the encoding to use when unmarshalling data. Valid values include: `ISO-8859-1` `US-ASCII` `UTF-8` With no value specified, Red Hat JBoss Fuse Tooling for Eclipse defaults to the encoding used by JAXB.
`Namespace Prefix Ref`	Specifies a reference to a map containing the namespace mapping to use when unmarshalling using JAXB or SOAP. This option enables you to override the default behavior of the JAXB implementation, which automatically assigns its own prefixes to namespaces. First you define the map with mappings made up of key/value pair entries, each of which specifies a namespace (key) and prefix (value) to use for it, and assign the map an id to use as the `Namespace Prefix Ref`. NOTE: This option requires that JAXB-RI 2.1 or higher (from SUN) be on the classpath.
`Schema`	Specifies an existing schema to use for XML validation. You can use the prefix `classpath:`, `file:`, or `http:` to specify how to resolve the resource. Separate multiple schema files using commas (`,`).
`Version`	Specifies the version of soap to use. Options are 1.1 or 1.2; the default is 1.1.

string Table 133, “string Properties” describes the properties needed to configure the string unmarshaller.

Table 133. string Properties

Name Description

Name	Description
`Charset`	Specifies the character set to use for encoding. Valid values include: `ISO-8859-1` `US-ASCII` `UTF-8` With no value specified, Red Hat JBoss Fuse Tooling for Eclipse defaults to the encoding used by the platform.

Charset

Specifies the character set to use for encoding. Valid values include:

ISO-8859-1
US-ASCII
UTF-8

With no value specified, Red Hat JBoss Fuse Tooling for Eclipse defaults to the encoding used by the platform.

tidyMarkup Table 134, “tidyMarkup Properties” describes the properties needed to configure the tidyMarkup unmarshaller.

Table 134. tidyMarkup Properties

Name	Description
`Data Object Type Name`	Specifies the type of Object the unmarshaller outputs. Valid values are `String` and `org.w3c.dom.Node`.

uniVocity-csv Table 135, “uniVocity-csv Properties” describes the properties needed to configure the uniVocity-csv unmarshaller.

Table 135. uniVocity-csv Properties

Name	Description
`As Map`	Enables/disables the production of maps, instead of lists, for line values. The default is Disabled, which causes the unmarshaller to produce lists instead of maps. When enabling this option to produce maps instead of lists, headers must be enabled and either defined or collected.
`Comment`	Specifies the character to use to identify a comment. The default is #.
`Delimiter`	Specifies the character to use to delimit values. The default is ,.
`Empty Value`	Specifies the string representation of an empty value. The default is " ".
`Header Extraction Enabled`	Enables/disables reading in the first line of the test document as the header line. The default is Disabled.
`Headers Disabled`	Enables/disables headers. The default is Disabled. When enabled, this option sets the headers as `null`, which indicates there is no header.
`Id`	Specifies a unique identifier for the endpoint. The Id can be used to refer to the endpoint in the Camel XML file.
`Ignore Leading Whitespaces`	Enables/disables ignoring leading white spaces in a line. The default is Enabled.
`Ignore Trailing Whitespaces`	Enables/disables ignoring trailing white spaces in a line. The default is Enabled.
`Lazy Load`	Enables/disables unmarshaller reading lines on-the-fly. The default is Disabled, which instructs the unmarshaller to read all lines in batch.
`Line Separator`	Specifies the character to use to separate lines in a file. The default is the platform’s line separator.
`Normalized Line Separator`	Specifies the character to use as the normalized line separator for files. The default is \n.
`Null Value`	Specifies the string representation of a `null` value. The default is null.
`Number Of Records To Read`	Specifies the maximum number of records to read. The default is -1 (no records).
`Quote`	Specifies the character to use to mark the beginning of a quoted value. The default is ".
`Quote All Fields`	Specifies whether to enclose all values in quotes when writing them. The default is Disabled.
`Quote Escape`	Specifies the character to use to mark the end of a quoted value. The default is ".
`Skip Empty Lines`	Enables/disables ignoring empty lines. The default is Enabled.

uniVocity-fixed Table 136, “uniVocity-fixed Properties” describes the properties needed to configure the uniVocity-fixed unmarshaller.

Table 136. uniVocity-fixed Properties

Name	Description
`As Map`	Enables/disables the production of maps, instead of lists, for line values. The default is Disabled, which causes the unmarshaller to produce lists instead of maps. When enabling this option to produce maps instead of lists, headers must be enabled and either defined or collected.
`Comment`	Specifies the character to use to identify a comment. The default is #.
`Empty Value`	Specifies the string representation of an empty value. The default is " ".
`Header Extraction Enabled`	Enables/disables reading in the first line of the test document as the header line. The default is Disabled.
`Headers Disabled`	Enables/disables headers. The default is Disabled. When enabled, this option sets the headers as `null`, which indicates there is no header.
`Id`	Specifies a unique identifier for the endpoint. The Id can be used to refer to the endpoint in the Camel XML file.
`Ignore Leading Whitespaces`	Enables/disables ignoring leading white spaces in a line. The default is Enabled.
`Ignore Trailing Whitespaces`	Enables/disables ignoring trailing white spaces in a line. The default is Enabled.
`Lazy Load`	Enables/disables unmarshaller reading lines on-the-fly. The default is Disabled, which instructs the unmarshaller to read all lines in batch.
`Line Separator`	Specifies the character to use to separate lines in a file. The default is the platform’s line separator.
`Normalized Line Separator`	Specifies the character to use as the normalized line separator for files. The default is \n.
`Null Value`	Specifies the string representation of a `null` value. The default is null.
`Number Of Records To Read`	Specifies the maximum number of records to read. The default is -1 (no records).
`Padding`	Specifies the character to use for padding. The default is ' ' (white space).
`Record Ends On Newline`	Specifies whether records end at a new line. The default is Disabled.
`Skip Empty Lines`	Enables/disables ignoring empty lines. The default is Enabled.
`Skip trailing Chars Until Newline`	Specifies whether to skip trailing spaces up to a new line. The default is Disabled.

uniVocity-tsv Table 137, “uniVocity-tsv Properties” describes the properties needed to configure the uniVocity-tsv unmarshaller.

Table 137. uniVocity-tsv Properties

Name	Description
`As Map`	Enables/disables the production of maps, instead of lists, for line values. The default is Disabled, which causes the unmarshaller to produce lists instead of maps. When enabling this option to produce maps instead of lists, headers must be enabled and either defined or collected.
`Comment`	Specifies the character to use to identify a comment. The default is #.
`Empty Value`	Specifies the string representation of an empty value. The default is " ".
`Escape Char`	Specifies the character to use for escape. The default is \.
`Header Extraction Enabled`	Enables/disables reading in the first line of the test document as the header line. The default is Disabled.
`Headers Disabled`	Enables/disables headers. The default is Disabled. When enabled, this option sets the headers as `null`, which indicates there is no header.
`Id`	Specifies a unique identifier for the endpoint. The Id can be used to refer to the endpoint in the Camel XML file.
`Ignore Leading Whitespaces`	Enables/disables ignoring leading white spaces in a line. The default is Enabled.
`Ignore Trailing Whitespaces`	Enables/disables ignoring trailing white spaces in a line. The default is Enabled.
`Lazy Load`	Enables/disables unmarshaller reading lines on-the-fly. The default is Disabled, which instructs the unmarshaller to read all lines in batch.
`Line Separator`	Specifies the character to use to separate lines in a file. The default is the platform’s line separator.
`Normalized Line Separator`	Specifies the character to use as the normalized line separator for files. The default is \n.
`Null Value`	Specifies the string representation of a `null` value. The default is null.
`Number Of Records To Read`	Specifies the maximum number of records to read. The default is -1 (no records).
`Skip Empty Lines`	Enables/disables ignoring empty lines. The default is Enabled.

XmlBeans Table 138, “XmlBeans Properties” describes the properties needed to configure the XmlBeans unmarshaller.

Table 138. XmlBeans Properties

Name	Description
`Pretty Print`	Enables pretty printing, which adds white space as needed to tidy up the input XML for easy reading.

Xmljson Table 139, “xmljson Properties” describes the properties needed to configure the xmljson unmarshaller.

	Note
	An asterisk (*) to the right of a property name (unmarshaller properties only) indicates that the default value for that property is set by `json-lib`, not by the code of the data format.

Table 139. xmljson Properties

Name	Description
`Array Name` ^*	Specifies the name of the top-level XML element. The default is `'a'` For example, `[1,2,3]` is converted to `<a><e>1</e><e>2</e><e>3</e><a>` by default. By setting this property or `Root Name`, you can change the name of element `'a'`.
`Element Name` ^*	Specifies the name of the XML element that represents each array element. The default is `'e'`.
`Encoding` ^*	Specifies the encoding for the call to the `XMLSerializer.write()`method, so it’s used only when generating XML.
`Expandable Properties`	Specifies expandable properties that alter the way JSON array elements are converted to XML. Using expandable properties, json array elements are converted to XML as a sequence of repetitive XML elements with the local name equal to the json key. For example, if number is set as an expandable property, the array `{number:1,2,3}`, normally converted to `<number>:<e>1</e><e>2</e><e>3</e></number>`, will instead be converted to `<number>1</number><number>2</number><number>3</number>`.
`Force Top Level Object`	Applies to marshalling only.
`Namespace Lenient` ^*	Specifies whether to tolerate incomplete namespace prefixes. The default is false. In most cases, `json-lib` automatically changes this property at runtime to match the processing.
`Remove Namespace Prefixes`	Applies to marshalling only.
`Root Name` ^*	Specifies the name of the top-level element when converting any JSON construct (object, array, null) to XML. If not set, `json-lib` uses arrayName or objectName (default value of`'o'`). If set to `'root'`, the JSON string `{'x':'value1','y':'value2'}` is converted to `<root><x>value1</x><y>value2</y></root>`; otherwise, the `'root'` element would be named `'o'`.
`Skip Namespaces`	Applies to marshalling only.
`Skip Whitespace`	Applies to marshalling only.
`Trim Spaces`	Applies to marshalling only.
`Type Hints`	Specifies whether to add type hints to the resulting XML to aid conversion back to JSON. The default is YES. Valid values are: `YES` — enable type hints, prefixed with `json_` `NO` — disable type hints `WITH_PREFIX` — enable type hints, with no prefix

Xmlrpc Table 140, “Xmlrpc Properties” describes the properties needed to configure the Xmlrpc unmarshaller.

Table 140. Xmlrpc Properties

Name	Description
`Request`	When enabled, specifies the message is a request. When disabled, specifies the message is a response. The default is Disabled.

zip Table 141, “zip Properties” describes the properties needed to configure the zip unmarshaller.

Table 141. zip Properties

Name	Description
`Compression Level`	Not Applicable.

zipFile Table 142, “zipFile Properties” describes the properties needed to configure the zipFile unmarshaller.

Table 142. zipFile Properties

Name	Description
`Using Iterator`	When enabled, iteratively unmarshals multiple entries in a zip file to their original file format. The default is `Disabled`.

Unmarshal

Usage

Properties

Related topics