Data Format Type

Specifies the data type into which the data will be marshalled. 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-ical,camel-xmlrpc, camel-zipfile, and so on) in your Maven pom.xml file.

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 marshalled.

Instance Class Name

Specifies the name of the instance class to use for marshalling. This is the class defined by your schema .apache.camel.dataformat.avro.<nameOfInstanceClass>.

Line Length

76

Specifies the maximum line length.

Line Separator

\r\n

Specifies the line separator to use.

Url Safe

Disabled

When disabled, encodes - and _. When enabled, encodes + (not -) and / (not _).

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.

Class Type

Specifies a fully qualified class name that explicitly defines the type to use for marshalling. 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 marshaller 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,

For an exhaustive list of language names, see Codes for the Representation of Names of Languages

Packages

Specifies the packages to use for marshalling. 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 record type, Select either Csv (comma-separated value fields), Fixed (fixed-length records), or KeyValue (key/value pair fields).

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 marshalling an Object to XML. 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 classes, separate them with a comma (,).

Validation

Enables/disables validation. The default is Disabled.

Algorithm

Specifies the name of the JCE cryptographic algorithm to use. Default is DES/CBC/PKCS5Padding.

Algorithm Parameter Ref

Specifies a 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

Specifies a 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 encrypted data.

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 [marshalCSVFormatName] 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 [marshalCSVFormatName] 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 [marshalCSVFormatName] for available reference formats.)

Escape Disabled

Disables the processing of escape characters. The default is False.

Format Name

Specifies the name of the reference format to use for parsing input. Predefined reference format options are:

Format Ref

Reference to a custom reference format.

Header

Specifies the column 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 [marshalCSVFormatName] 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 [marshalCSVFormatName] for available reference formats.)

Lazy Load

Not applicable. 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 [marshalCSVFormatName] for available reference formats.)

Quote Disabled

Disables quote processing. The default is False.

Record Converter Ref

Not applicable. 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 [marshalCSVFormatName] 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

Not applicable. 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.

Ref

Reference to file that implements your custom data format using the DataFormat interface.

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 Qualier

Specifies the character to use to encapsulate text. The default is double quotes (").

Validating

Specifies whether to enable validation checking. The default is Disabled.

Context Path

Specifies the context path for the jaxb data format. For example, org.apache.camel.example

Encoding

Specifies the encoding to use when marshalling data. Valid values include:

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

Filter Non XML Chars

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. The default is Disabled.

Fragment

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. The default is Disabled.

Ignore JAXBElement

Not applicable. Specifies whether the unmarshalled message body contains the element instance value or the JAXBElement object. Enable this property to get the element instance value. The default is Disabled.

Must Be JAXBElement

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

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

Enables pretty printing, which adds white space as needed to tidy up the resulting XML for easy reading. The default is Disabled.

Schema

Not applicable. Specifies the schema to use for validation when unmarshalling. 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

Not applicable. Specifies the location of the schema to use for validation when unmarshalling XML (for example, schema/person.xsd).

Xml Stream Writer Wrapper

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.

Allow Jms Type

Not applicable. 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

Specifies the fields to exclude from the Json output when marshalling a POJO to Json, when using Gson or Xstream.

Json View

Specifies the fields to exclude from the Json output when marshalling a POJO to Json when using Jackson. Requires the Jackson library. First you create one or more marker classes, then annotate the marker classes with the @JasonView annotation to exclude specific fields, and then use CamelJacksonDataFormatto marshal the POJO to Json. For details, see Json.

Library

Specifies the library to use for marshalling. Select either XStream, Jackson, or Gson 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

Not Applicable.

Use List

Not applicable. Specifies to use list for unmarshalling Json to a list of map POJO. Requires the Jackson library.

Algorithm

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:

Armored

Specifies whether to base64 encode the encrypted text, so it can be copied/pasted, and so on. The default is Disabled.

Compression Algorithm

Specifies the compression algorithm to use for encryption. Valid values are defined in org.bouncycastle.bcpg.CompressionAlgorithmTags. The default is 1 (CompressionAlgorithmTags.ZIP).

Some example values are:

Hash Algorithm

Specifies the hash algorithm to use for signing during encryption. Valid values are defined in org.bouncycastle.bcpg.HashAlgorithmTags. The default is 2 (HashAlgorithmTags.SHA10).

Some example values are:

Integrity

Specifies whether to add an integrity check sign to the encrypted file. The default is Enabled.

Key File Name

Specifies the name of the keyring file that contains the public keys to use to encrypt the data. This file must be accessible as a classpath resource, but you can specify its location in the file system using the file: prefix; for example, org/apache/camel/component/crypto/pubring.gpg.

Key Userid

Specifies the user id of the key in the PGP keyring used during encryption.

You can also specify a portion of a 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.

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

Not applicable. Controls the behavior of signature verification during decryption.

Valid values are:

The default is optional.

Instance Class

Specifies the name of the instance class to use for marshalling. 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>.

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:

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:

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 sender’s trustStore, when performing asymmetric key encryption.

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:

Pass Phrase

Specifies a string of alphanumeric characters to use as the passphrase for marshalling the message into cyphertext. The passphrase must be appropriate for the selected encryption algorithm. If not, the marshaller throws an exception. When no phrase is specified, the marshaller 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 encrypt. If left blank, the entire XML message is encrypted.

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:

Context Path

Specifies the path of the package to use for initializing the JAXB context.

Element Name Strategy Ref

Specifies the bean reference to use to the element name and its namespace within the body of the soap message. Select for the list of available options.

Encoding

Specifies the encoding to use when marshalling data. Valid values include:

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 marshalling 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.

Charset

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

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

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

Not applicable. 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.

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

Not applicable. 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.

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

Not applicable. 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.

Pretty Print

Enables pretty printing, which adds white space as needed to tidy up the resulting XML for easy reading.

Array Name

Applies to unmarshalling only.

Element Name

Applies to unmarshalling only.

Encoding

Applies to unmarshalling only.

For marshalling, encoding is determined by the input String being processed. When converting an input Stream, json-lib uses the platform’s default encoding.

Expandable Properties

Applies to unmarshalling only.

Force Top Level Object ^*

Specifies whether the resulting json conversion starts off with a top-most element whose name matches the XML root element.

When disabled (default), the xml string <a><x>1</x><y>2</y><a> is converted to {'x:'1','y':'2'}; otherwise it’s converted to {'a':'x:'1','y':'2'}}.

Namespace Lenient

Applies to unmarshalling only.

Remove Namespace Prefixes ^*

Specifies whether to remove the namespace prefixes from XML-qualified elements so that the resulting json string does not contain them.

The default is false.

Root Name

Applies to unmarshalling only.

Skip Namespaces ^*

Specifies whether namespaces are ignored. When disabled (default), they are added to the json output using @xmlns elements.

Skip Whitespace ^*

Specifies whether white spaces between XML elements are treated as text values or are ignored. When disabled (default), they are treated as text values.

Trim Spaces ^*

Specifies whether leading and trailing white spaces are omitted in string values. When disabled (default), they are left untouched.

Type Hints

Applies to unmarshalling only.

Request

When enabled, specifies the message is a request. When disabled, specifies the message is a response. The default is Disabled.

Compression Level

Specifies the level of compression for the marshaller to use. When no value is specified, the marshaller uses its default compression algorithm. Valid values are:

Using Iterator

Applies only to Unmarshalling. The default is Disabled.