Skip to content

Instantly share code, notes, and snippets.

@gnodet

gnodet/metamodel.xml

Created Jul 24, 2019
Embed
What would you like to do?
This file has been truncated, but you can view the full file.
<?xml version='1.0' encoding='UTF-8'?>
<model>
<!--
- Languages
-->
<languages>
<language name="bean" display="Bean method" label="language,core,java" extends="model:expression" maven="org.apache.camel:camel-bean:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.MethodCallExpression" since="1.3.0" description="To use a Java bean (aka method call) in Camel expressions or predicates.">
<property name="beanType" type="class" display="Bean Type" description="Class of the bean to use"/>
<property name="method" type="string" display="Method" description="Name of method to call"/>
<property name="bean" type="object" display="Bean" description="The bean to use"/>
</language>
<language name="constant" display="Constant" label="language,core" extends="model:expression" maven="org.apache.camel:camel-base:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.ConstantExpression" since="1.5.0" description="To use a constant value in Camel expressions or predicates."/>
<language name="exchangeProperty" display="ExchangeProperty" label="language,core" extends="model:expression" maven="org.apache.camel:camel-base:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.ExchangePropertyExpression" since="2.0.0" description="To use a Camel Exchange property in expressions or predicates."/>
<language name="file" display="File" label="language,core,java" extends="model:expression" maven="org.apache.camel:camel-base:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.FileExpression" since="1.1.0" description="For expressions and predicates using the file/simple language">
<property name="resultType" type="string" display="Result Type" description="Sets the class name of the result type (type from output)"/>
</language>
<language name="groovy" display="Groovy" label="language,script" extends="model:expression" maven="org.apache.camel:camel-groovy:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.GroovyExpression" since="1.3.0" description="To use Groovy scripts in Camel expressions or predicates."/>
<language name="header" display="Header" label="language,core" extends="model:expression" maven="org.apache.camel:camel-base:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.HeaderExpression" since="1.5.0" description="To use a Camel Message header in expressions or predicates."/>
<language name="hl7terser" display="HL7 Terser" label="language,hl7" extends="model:expression" maven="org.apache.camel:camel-hl7:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.Hl7TerserExpression" since="2.11.0" description="To use HL7 terser scripts in Camel expressions or predicates."/>
<language name="jsonpath" display="JsonPath" label="language,json" extends="model:expression" maven="org.apache.camel:camel-jsonpath:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.JsonPathExpression" since="2.13.0" description="To use JsonPath in Camel expressions or predicates.">
<property name="allowEasyPredicate" type="boolean" display="Allow Easy Predicate" description="Whether to allow using the easy predicate parser to pre-parse predicates."/>
<property name="allowSimple" type="boolean" display="Allow Simple" description="Whether to allow in inlined simple exceptions in the JsonPath expression"/>
<property name="headerName" type="string" display="Header Name" description="Name of header to use as input, instead of the message body"/>
<property name="resultType" type="class" display="Result Type" description="Sets the class of the result type (type from output)"/>
<property name="suppressExceptions" type="boolean" display="Suppress Exceptions" description="Whether to suppress exceptions such as PathNotFoundException."/>
<property name="writeAsString" type="boolean" display="Write As String" description="Whether to write the output of each row/element as a JSON String value instead of a Map/POJO value."/>
</language>
<language name="mvel" display="MVEL" label="language,java" extends="model:expression" maven="org.apache.camel:camel-mvel:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.MvelExpression" since="2.0.0" description="To use MVEL scripts in Camel expressions or predicates."/>
<language name="ognl" display="OGNL" label="language,java" extends="model:expression" maven="org.apache.camel:camel-ognl:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.OgnlExpression" since="1.1.0" description="To use OGNL scripts in Camel expressions or predicates."/>
<language name="ref" display="Ref" label="language,core" extends="model:expression" maven="org.apache.camel:camel-base:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.RefExpression" since="2.8.0" description="Reference to an existing Camel expression or predicate, which is looked up from the Camel registry."/>
<language name="simple" display="Simple" label="language,core,java" extends="model:expression" maven="org.apache.camel:camel-base:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.SimpleExpression" since="1.1.0" description="To use Camels built-in Simple language in Camel expressions or predicates.">
<property name="resultType" type="class" display="Result Type" description="Sets the class of the result type (type from output)"/>
</language>
<language name="spel" display="SpEL" label="language,spring" extends="model:expression" maven="org.apache.camel:camel-spring:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.SpELExpression" since="2.7.0" description="To use Spring Expression Language (SpEL) in Camel expressions or predicates."/>
<language name="tokenize" display="Tokenize" label="language,core" extends="model:expression" maven="org.apache.camel:camel-base:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.TokenizerExpression" since="2.0.0" description="To use Camel message body or header with a tokenizer in Camel expressions or predicates.">
<property name="endToken" type="string" display="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."/>
<property name="group" type="string" display="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."/>
<property name="groupDelimiter" type="string" display="Group Delimiter" description="Sets the delimiter to use when grouping. If this has not been set then token will be used as the delimiter."/>
<property name="headerName" type="string" display="Header Name" description="Name of header to tokenize instead of using the message body."/>
<property name="includeTokens" type="boolean" display="Include Tokens" description="Whether to include the tokens in the parts when using pairs The default value is false"/>
<property name="inheritNamespaceTagName" type="string" display="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."/>
<property name="regex" type="boolean" display="Regex" description="If the token is a regular expression pattern. The default value is false"/>
<property name="skipFirst" type="boolean" display="Skip First" description="To skip the very first element"/>
<property name="token" type="string" display="Token" required="true" 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."/>
<property name="xml" type="boolean" display="Xml" description="Whether the input is XML messages. This option must be set to true if working with XML payloads."/>
</language>
<language name="xpath" display="XPath" label="language,core,xml" extends="model:expression" maven="org.apache.camel:camel-xpath:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.XPathExpression" since="1.1.0" description="To use XPath (XML) in Camel expressions or predicates.">
<property name="documentType" type="string" display="Document Type" description="Name of class for document type The default value is org.w3c.dom.Document"/>
<property name="factoryRef" type="string" display="Factory Ref" description="References to a custom XPathFactory to lookup in the registry"/>
<property name="headerName" type="string" display="Header Name" description="Name of header to use as input, instead of the message body"/>
<property name="logNamespaces" type="boolean" display="Log Namespaces" description="Whether to log namespaces which can assist during trouble shooting"/>
<property name="objectModel" type="string" display="Object Model" description="The XPath object model to use"/>
<property name="resultType" type="class" display="Result Type" description="Sets the class of the result type (type from output)"/>
<property name="namespaces" type="map(string,string)" display="Namespaces" description="XML Namespaces of prefix -> uri mappings"/>
<property name="saxon" type="boolean" display="Saxon" description="Whether to use Saxon."/>
<property name="threadSafety" type="boolean" display="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."/>
</language>
<language name="xquery" display="XQuery" label="language,xml" extends="model:expression" maven="org.apache.camel:camel-saxon:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.XQueryExpression" since="1.0.0" description="To use XQuery (XML) in Camel expressions or predicates.">
<property name="headerName" type="string" display="Header Name" description="Name of header to use as input, instead of the message body"/>
<property name="resultType" type="class" display="Result Type" description="Sets the class of the result type (type from output)"/>
<property name="namespaces" type="map(string,string)" display="Namespaces" description="XML Namespaces of prefix -> uri mappings"/>
</language>
<language name="xtokenize" display="XML Tokenize" label="language,core,xml" extends="model:expression" maven="org.apache.camel:camel-jaxp:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.XMLTokenizerExpression" since="2.14.0" description="To use Camel message body or header with a XML tokenizer in Camel expressions or predicates.">
<property name="group" type="int" display="Group" description="To group N parts together"/>
<property name="headerName" type="string" display="Header Name" description="Name of header to tokenize instead of using the message body."/>
<property name="mode" type="string" display="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"/>
<property name="namespaces" type="map(string,string)" display="Namespaces" description="XML Namespaces of prefix -> uri mappings"/>
</language>
<language name="language" display="Language" label="language,core" extends="model:expression" maven="org.apache.camel:camel-base:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.language.LanguageExpression" description="To use the specified language in Camel expressions or predicates.">
<property name="language" type="string" display="Language" description="The name of the language to use"/>
</language>
</languages>
<!--
- Dataformats
-->
<dataFormats>
<dataFormat name="asn1" display="ASN.1 File" label="dataformat,transformation,file" extends="model:dataFormat" maven="org.apache.camel:camel-asn1:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.ASN1DataFormat" since="2.20.0" description="The ASN.1 data format is used for file transfer with telecommunications protocols.">
<property name="clazzName" type="string" display="Clazz Name" description="Name of class to use when unmarshalling"/>
<property name="usingIterator" type="boolean" display="Using Iterator" description="If the asn1 file has more then one entry, the setting this option to true, allows to work with the splitter EIP, to split the data using an iterator in a streaming mode."/>
</dataFormat>
<dataFormat name="avro" display="Avro" label="dataformat,transformation" extends="model:dataFormat" maven="org.apache.camel:camel-avro:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.AvroDataFormat" since="2.14.0" description="The Avro data format is used for serialization and deserialization of messages using Apache Avro binary dataformat.">
<property name="instanceClassName" type="string" display="Instance Class Name" required="true" description="Class name to use for marshal and unmarshalling"/>
<property name="schema" type="object" display="Schema" description="Avro Schema or GenericContainer object"/>
</dataFormat>
<dataFormat name="barcode" display="Barcode" label="dataformat,transformation" extends="model:dataFormat" maven="org.apache.camel:camel-barcode:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.BarcodeDataFormat" since="2.14.0" description="The Barcode data format is used for creating barccode images (such as QR-Code)">
<property name="barcodeFormat" type="string" display="Barcode Format" description="Barcode format such as QR-Code"/>
<property name="height" type="int" display="Height" description="Height of the barcode"/>
<property name="imageType" type="string" display="Image Type" description="Image type of the barcode such as png"/>
<property name="width" type="int" display="Width" description="Width of the barcode"/>
</dataFormat>
<dataFormat name="base64" display="Base64" label="dataformat,transformation" extends="model:dataFormat" maven="org.apache.camel:camel-base64:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.Base64DataFormat" since="2.11.0" description="The Base64 data format is used for base64 encoding and decoding.">
<property name="lineLength" type="int" display="Line Length" description="To specific a maximum line length for the encoded data. By default 76 is used."/>
<property name="lineSeparator" type="string" display="Line Separator" description="The line separators to use. Uses new line characters (CRLF) by default."/>
<property name="urlSafe" type="boolean" display="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."/>
</dataFormat>
<dataFormat name="beanio" display="BeanIO" label="dataformat,transformation,csv" extends="model:dataFormat" maven="org.apache.camel:camel-beanio:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.BeanioDataFormat" since="2.10.0" description="The BeanIO data format is used for working with flat payloads (such as CSV, delimited, or fixed length formats).">
<property name="beanReaderErrorHandlerType" type="string" display="Bean Reader Error Handler Type" description="To use a custom org.apache.camel.dataformat.beanio.BeanIOErrorHandler as error handler while parsing. Configure the fully qualified class name of the error handler. Notice the options ignoreUnidentifiedRecords, ignoreUnexpectedRecords, and ignoreInvalidRecords may not be in use when you use a custom error handler."/>
<property name="encoding" type="string" display="Encoding" description="The charset to use. Is by default the JVM platform default charset."/>
<property name="ignoreInvalidRecords" type="boolean" display="Ignore Invalid Records" description="Whether to ignore invalid records."/>
<property name="ignoreUnexpectedRecords" type="boolean" display="Ignore Unexpected Records" description="Whether to ignore unexpected records."/>
<property name="ignoreUnidentifiedRecords" type="boolean" display="Ignore Unidentified Records" description="Whether to ignore unidentified records."/>
<property name="mapping" type="string" display="Mapping" required="true" description="The BeanIO mapping file. Is by default loaded from the classpath. You can prefix with file:, http:, or classpath: to denote from where to load the mapping file."/>
<property name="streamName" type="string" display="Stream Name" required="true" description="The name of the stream to use."/>
<property name="unmarshalSingleObject" type="boolean" display="Unmarshal Single Object" description="This options controls whether to unmarshal as a list of objects or as a single object only. The former is the default mode, and the latter is only intended in special use-cases where beanio maps the Camel message to a single POJO bean."/>
</dataFormat>
<dataFormat name="bindy" javaType="org.apache.camel.model.dataformat.BindyDataFormat" display="Bindy" label="dataformat,transformation,csv" extends="model:dataFormat" since="2.0.0" description="The Bindy data format is used for working with flat payloads (such as CSV, delimited, fixed length formats, or FIX messages).">
<property name="classType" type="class" display="Class Type" description="Name of model class to use."/>
<property name="locale" type="string" display="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"/>
<property name="type" type="enum:BindyType(Csv,Fixed,KeyValue)" display="Type" required="true" description="Whether to use Csv, Fixed, or KeyValue."/>
<property name="unwrapSingleInstance" type="boolean" display="Unwrap Single Instance" description="When unmarshalling should a single instance be unwrapped and returned instead of wrapped in a java.util.List."/>
</dataFormat>
<dataFormat name="boon" display="Boon" label="dataformat,transformation,json" extends="model:dataFormat" maven="org.apache.camel:camel-boon:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.BoonDataFormat" since="2.16.0" description="Boon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload.">
<property name="unmarshalType" type="class" display="Unmarshal Type" required="true" description="Java type to use when unmarshalling"/>
<property name="useList" type="boolean" display="Use List" description="To unarmshal to a List of Map or a List of Pojo."/>
</dataFormat>
<dataFormat name="cbor" display="CBOR" label="dataformat,transformation,json" extends="model:dataFormat" maven="org.apache.camel:camel-cbor:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.CBORDataFormat" since="3.0.0" description="CBOR data format is used for unmarshal a CBOR payload to POJO or to marshal POJO back to CBOR payload.">
<property name="allowJmsType" type="boolean" display="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."/>
<property name="allowUnmarshallType" type="boolean" display="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."/>
<property name="collectionTypeName" type="string" display="Collection Type Name" 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."/>
<property name="disableFeatures" type="string" display="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"/>
<property name="enableFeatures" type="string" display="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"/>
<property name="objectMapper" type="string" display="Object Mapper" description="Lookup and use the existing CBOR ObjectMapper with the given id when using Jackson."/>
<property name="prettyPrint" type="boolean" display="Pretty Print" description="To enable pretty printing output nicely formatted. Is by default false."/>
<property name="unmarshalType" type="class" display="Unmarshal Type" description="Java type to use when unmarshalling"/>
<property name="useDefaultObjectMapper" type="boolean" display="Use Default Object Mapper" description="Whether to lookup and use default Jackson CBOR ObjectMapper from the registry."/>
<property name="useList" type="boolean" display="Use List" description="To unarmshal to a List of Map or a List of Pojo."/>
</dataFormat>
<dataFormat name="crypto" display="Crypto (Java Cryptographic Extension)" label="dataformat,transformation,security" extends="model:dataFormat" maven="org.apache.camel:camel-crypto:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.CryptoDataFormat" since="2.3.0" description="Crypto data format is used for encrypting and decrypting of messages using Java Cryptographic Extension.">
<property name="algorithm" type="string" display="Algorithm" description="The JCE algorithm name indicating the cryptographic algorithm that will be used. Is by default DES/CBC/PKCS5Padding."/>
<property name="algorithmParameterRef" type="string" display="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."/>
<property name="buffersize" type="int" display="Buffersize" description="The size of the buffer used in the signature process."/>
<property name="cryptoProvider" type="string" display="Crypto Provider" description="The name of the JCE Security Provider that should be used."/>
<property name="initVectorRef" type="string" display="Init Vector Ref" description="Refers to a byte array containing the Initialization Vector that will be used to initialize the Cipher."/>
<property name="inline" type="boolean" display="Inline" description="Flag indicating that the configured IV should be inlined into the encrypted data stream. Is by default false."/>
<property name="keyRef" type="string" display="Key Ref" description="Refers to the secret key to lookup from the register to use."/>
<property name="macAlgorithm" type="string" display="Mac Algorithm" description="The JCE algorithm name indicating the Message Authentication algorithm."/>
<property name="shouldAppendHMAC" type="boolean" display="Should Append HMAC" description="Flag indicating that a Message Authentication Code should be calculated and appended to the encrypted data."/>
</dataFormat>
<dataFormat name="csv" display="CSV" label="dataformat,transformation,csv" extends="model:dataFormat" maven="org.apache.camel:camel-csv:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.CsvDataFormat" since="1.3.0" description="The CSV data format is used for handling CSV payloads.">
<property name="allowMissingColumnNames" type="boolean" display="Allow Missing Column Names" description="Whether to allow missing column names."/>
<property name="commentMarker" type="string" display="Comment Marker" description="Sets the comment marker of the reference format."/>
<property name="commentMarkerDisabled" type="boolean" display="Comment Marker Disabled" description="Disables the comment marker of the reference format."/>
<property name="delimiter" type="string" display="Delimiter" description="Sets the delimiter to use. The default value is , (comma)"/>
<property name="escape" type="string" display="Escape" description="Sets the escape character to use"/>
<property name="escapeDisabled" type="boolean" display="Escape Disabled" description="Use for disabling using escape character"/>
<property name="formatName" type="string" display="Format Name" description="The name of the format to use, the default value is CSVFormat.DEFAULT"/>
<property name="formatRef" type="string" display="Format Ref" description="The reference format to use, it will be updated with the other format options, the default value is CSVFormat.DEFAULT"/>
<property name="header" type="list(string)" display="Header" kind="element" description="To configure the CSV headers"/>
<property name="headerDisabled" type="boolean" display="Header Disabled" description="Use for disabling headers"/>
<property name="ignoreEmptyLines" type="boolean" display="Ignore Empty Lines" description="Whether to ignore empty lines."/>
<property name="ignoreHeaderCase" type="boolean" display="Ignore Header Case" description="Sets whether or not to ignore case when accessing header names."/>
<property name="ignoreSurroundingSpaces" type="boolean" display="Ignore Surrounding Spaces" description="Whether to ignore surrounding spaces"/>
<property name="lazyLoad" type="boolean" display="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."/>
<property name="marshallerFactoryRef" type="string" display="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."/>
<property name="nullString" type="string" display="Null String" description="Sets the null string"/>
<property name="nullStringDisabled" type="boolean" display="Null String Disabled" description="Used to disable null strings"/>
<property name="quote" type="string" display="Quote" description="Sets the quote which by default is"/>
<property name="quoteDisabled" type="boolean" display="Quote Disabled" description="Used to disable quotes"/>
<property name="quoteMode" type="string" display="Quote Mode" description="Sets the quote mode"/>
<property name="recordConverterRef" type="string" display="Record Converter Ref" description="Refers to a custom CsvRecordConverter to lookup from the registry to use."/>
<property name="recordSeparator" type="string" display="Record Separator" description="Sets the record separator (aka new line) which by default is new line characters (CRLF)"/>
<property name="recordSeparatorDisabled" type="string" display="Record Separator Disabled" description="Used for disabling record separator"/>
<property name="skipHeaderRecord" type="boolean" display="Skip Header Record" description="Whether to skip the header record in the output"/>
<property name="trailingDelimiter" type="boolean" display="Trailing Delimiter" description="Sets whether or not to add a trailing delimiter."/>
<property name="trim" type="boolean" display="Trim" description="Sets whether or not to trim leading and trailing blanks."/>
<property name="useMaps" type="boolean" display="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)."/>
<property name="useOrderedMaps" type="boolean" display="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)."/>
</dataFormat>
<dataFormat name="custom" javaType="org.apache.camel.model.dataformat.CustomDataFormat" display="Custom" label="dataformat,transformation" extends="model:dataFormat" description="To use a custom data format implementation that does not come out of the box from Apache Camel.">
<property name="dataFormat" type="java:org.apache.camel.spi.DataFormat" display="Data Format" required="true" description="Instance or reference to the custom org.apache.camel.spi.DataFormat to lookup from the Camel registry."/>
</dataFormat>
<dataFormat name="fhirJson" display="FHIR JSon" label="dataformat,transformation,hl7,json" extends="model:dataFormat" maven="org.apache.camel:camel-fhir:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.FhirJsonDataFormat" since="2.21.0" description="The FHIR JSon data format is used to marshall/unmarshall to/from FHIR objects to/from JSON.">
<property name="dontEncodeElements" type="set(string)" display="Dont Encode Elements" description="If provided, specifies the elements which should NOT be encoded. 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."/>
<property name="dontStripVersionsFromReferencesAtPaths" type="list(string)" display="Dont Strip Versions From References At Paths" 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. This method provides a finer-grained level of control than setStripVersionsFromReferences(Boolean) and any paths specified by this method will be encoded even if setStripVersionsFromReferences(Boolean) has been set to true (which is the default)"/>
<property name="encodeElements" type="set(string)" display="Encode Elements" description="If provided, specifies the elements which should be encoded, to the exclusion of all others. 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"/>
<property name="encodeElementsAppliesToChildResourcesOnly" type="boolean" display="Encode Elements Applies To Child Resources Only" 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)"/>
<property name="fhirVersion" type="string" display="Fhir Version" description="The version of FHIR to use. Possible values are: DSTU2,DSTU2_HL7ORG,DSTU2_1,DSTU3,R4"/>
<property name="omitResourceId" type="boolean" display="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."/>
<property name="overrideResourceIdWithBundleEntryFullUrl" type="boolean" display="Override Resource Id With Bundle Entry Full Url" 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)."/>
<property name="prettyPrint" type="boolean" display="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."/>
<property name="serverBaseUrl" type="string" display="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."/>
<property name="stripVersionsFromReferences" type="boolean" display="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)"/>
<property name="summaryMode" type="boolean" display="Summary Mode" description="If set to true (default is false) only elements marked by the FHIR specification as being summary elements will be included."/>
<property name="suppressNarratives" type="boolean" display="Suppress Narratives" description="If set to true (default is false), narratives will not be included in the encoded values."/>
<property name="fhirContext" type="java:ca.uhn.fhir.context.FhirContext"/>
<property name="forceResourceId" type="java:org.hl7.fhir.instance.model.api.IIdType"/>
<property name="preferTypes" type="list(java:java.lang.Class&lt;? extends IBaseResource>)"/>
<property name="parserOptions" type="java:ca.uhn.fhir.context.ParserOptions"/>
<property name="parserErrorHandler" type="java:ca.uhn.fhir.parser.IParserErrorHandler"/>
</dataFormat>
<dataFormat name="fhirXml" display="FHIR XML" label="dataformat,transformation,hl7,xml" extends="model:dataFormat" maven="org.apache.camel:camel-fhir:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.FhirXmlDataFormat" since="2.21.0" description="The FHIR XML data format is used to marshall/unmarshall from/to FHIR objects to/from XML.">
<property name="dontEncodeElements" type="set(string)" display="Dont Encode Elements" description="If provided, specifies the elements which should NOT be encoded. 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."/>
<property name="dontStripVersionsFromReferencesAtPaths" type="list(string)" display="Dont Strip Versions From References At Paths" 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. This method provides a finer-grained level of control than setStripVersionsFromReferences(Boolean) and any paths specified by this method will be encoded even if setStripVersionsFromReferences(Boolean) has been set to true (which is the default)"/>
<property name="encodeElements" type="set(string)" display="Encode Elements" description="If provided, specifies the elements which should be encoded, to the exclusion of all others. 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"/>
<property name="encodeElementsAppliesToChildResourcesOnly" type="boolean" display="Encode Elements Applies To Child Resources Only" 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)"/>
<property name="fhirVersion" type="string" display="Fhir Version" description="The version of FHIR to use. Possible values are: DSTU2,DSTU2_HL7ORG,DSTU2_1,DSTU3,R4"/>
<property name="omitResourceId" type="boolean" display="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."/>
<property name="overrideResourceIdWithBundleEntryFullUrl" type="boolean" display="Override Resource Id With Bundle Entry Full Url" 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)."/>
<property name="prettyPrint" type="boolean" display="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."/>
<property name="serverBaseUrl" type="string" display="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."/>
<property name="stripVersionsFromReferences" type="boolean" display="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)"/>
<property name="summaryMode" type="boolean" display="Summary Mode" description="If set to true (default is false) only elements marked by the FHIR specification as being summary elements will be included."/>
<property name="suppressNarratives" type="boolean" display="Suppress Narratives" description="If set to true (default is false), narratives will not be included in the encoded values."/>
<property name="fhirContext" type="java:ca.uhn.fhir.context.FhirContext"/>
<property name="forceResourceId" type="java:org.hl7.fhir.instance.model.api.IIdType"/>
<property name="preferTypes" type="list(java:java.lang.Class&lt;? extends IBaseResource>)"/>
<property name="parserOptions" type="java:ca.uhn.fhir.context.ParserOptions"/>
<property name="parserErrorHandler" type="java:ca.uhn.fhir.parser.IParserErrorHandler"/>
</dataFormat>
<dataFormat name="flatpack" display="Flatpack" label="dataformat,transformation,csv" extends="model:dataFormat" maven="org.apache.camel:camel-flatpack:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.FlatpackDataFormat" since="2.1.0" description="The Flatpack data format is used for working with flat payloads (such as CSV, delimited, or fixed length formats).">
<property name="allowShortLines" type="boolean" display="Allow Short Lines" description="Allows for lines to be shorter than expected and ignores the extra characters"/>
<property name="definition" type="string" display="Definition" description="The flatpack pzmap configuration file. Can be omitted in simpler situations, but its preferred to use the pzmap."/>
<property name="delimiter" type="string" display="Delimiter" description="The delimiter char (could be ; , or similar)"/>
<property name="fixed" type="boolean" display="Fixed" description="Delimited or fixed. Is by default false = delimited"/>
<property name="ignoreExtraColumns" type="boolean" display="Ignore Extra Columns" description="Allows for lines to be longer than expected and ignores the extra characters."/>
<property name="ignoreFirstRecord" type="boolean" display="Ignore First Record" description="Whether the first line is ignored for delimited files (for the column headers). Is by default true."/>
<property name="parserFactoryRef" type="string" display="Parser Factory Ref" description="References to a custom parser factory to lookup in the registry"/>
<property name="textQualifier" type="string" display="Text Qualifier" description="If the text is qualified with a character. Uses quote character by default."/>
</dataFormat>
<dataFormat name="grok" display="Grok" label="dataformat,transformation" extends="model:dataFormat" maven="org.apache.camel:camel-grok:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.GrokDataFormat" since="3.0.0" description="The Grok data format is used for unmarshalling unstructured data to objects using Logstash based Grok patterns.">
<property name="allowMultipleMatchesPerLine" type="boolean" display="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."/>
<property name="flattened" type="boolean" display="Flattened" description="Turns on flattened mode. In flattened mode the exception is thrown when there are multiple pattern matches with same key."/>
<property name="namedOnly" type="boolean" display="Named Only" description="Whether to capture named expressions only or not (i.e. %{IP:ip} but not ${IP})"/>
<property name="pattern" type="string" display="Pattern" description="The grok pattern to match lines of input"/>
</dataFormat>
<dataFormat name="gzipdeflater" display="GZip Deflater" label="dataformat,transformation" extends="model:dataFormat" maven="org.apache.camel:camel-zip-deflater:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.GzipDataFormat" since="2.0.0" description="The GZip data format is a message compression and de-compression format (which works with the popular gzip/gunzip tools)."/>
<dataFormat name="hl7" display="HL7" label="dataformat,transformation,hl7" extends="model:dataFormat" maven="org.apache.camel:camel-hl7:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.HL7DataFormat" since="2.0.0" description="The HL7 data format can be used to marshal or unmarshal HL7 (Health Care) model objects.">
<property name="validate" type="boolean" display="Validate" description="Whether to validate the HL7 message Is by default true."/>
<property name="parser" type="object" display="Parser" description="To use a custom HL7 parser."/>
</dataFormat>
<dataFormat name="ical" display="iCal" label="dataformat,transformation" extends="model:dataFormat" maven="org.apache.camel:camel-ical:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.IcalDataFormat" since="2.12.0" description="The iCal dataformat is used for working with iCalendar messages.">
<property name="validating" type="boolean" display="Validating" description="Whether to validate."/>
</dataFormat>
<dataFormat name="jacksonxml" display="JacksonXML" label="dataformat,transformation,xml" extends="model:dataFormat" maven="org.apache.camel:camel-jacksonxml:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.JacksonXMLDataFormat" since="2.16.0" description="JacksonXML data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload.">
<property name="allowJmsType" type="boolean" display="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."/>
<property name="allowUnmarshallType" type="boolean" display="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."/>
<property name="collectionTypeName" type="string" display="Collection Type Name" 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."/>
<property name="disableFeatures" type="string" display="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"/>
<property name="enableFeatures" type="string" display="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"/>
<property name="enableJaxbAnnotationModule" type="boolean" display="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."/>
<property name="include" type="string" display="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"/>
<property name="jsonView" type="class" display="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"/>
<property name="moduleClassNames" type="string" display="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."/>
<property name="moduleRefs" type="string" display="Module Refs" description="To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma."/>
<property name="prettyPrint" type="boolean" display="Pretty Print" description="To enable pretty printing output nicely formatted. Is by default false."/>
<property name="unmarshalType" type="class" display="Unmarshal Type" description="Java type to use when unmarshalling"/>
<property name="useList" type="boolean" display="Use List" description="To unarmshal to a List of Map or a List of Pojo."/>
<property name="xmlMapper" type="string" display="Xml Mapper" description="Lookup and use the existing XmlMapper with the given id."/>
</dataFormat>
<dataFormat name="jaxb" display="JAXB" label="dataformat,transformation,xml" extends="model:dataFormat" maven="org.apache.camel:camel-jaxb:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.JaxbDataFormat" since="1.0.0" description="JAXB data format uses the JAXB2 XML marshalling standard to unmarshal an XML payload into Java objects or to marshal Java objects into an XML payload.">
<property name="contextPath" type="string" display="Context Path" required="true" description="Package name where your JAXB classes are located."/>
<property name="encoding" type="string" display="Encoding" description="To overrule and use a specific encoding"/>
<property name="filterNonXmlChars" type="boolean" display="Filter Non Xml Chars" description="To ignore non xml characheters and replace them with an empty space."/>
<property name="fragment" type="boolean" display="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."/>
<property name="ignoreJAXBElement" type="boolean" display="Ignore JAXBElement" description="Whether to ignore JAXBElement elements - only needed to be set to false in very special use-cases."/>
<property name="jaxbProviderProperties" type="string" display="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."/>
<property name="mustBeJAXBElement" type="boolean" display="Must Be JAXBElement" description="Whether marhsalling must be java objects with JAXB annotations. And if not then it fails. This option can be set to false to relax that, such as when the data is already in XML format."/>
<property name="namespacePrefixRef" type="string" display="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."/>
<property name="noNamespaceSchemaLocation" type="string" display="No Namespace Schema Location" description="To define the location of the namespaceless schema"/>
<property name="objectFactory" type="boolean" display="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."/>
<property name="partClass" type="string" display="Part Class" description="Name of class used for fragment parsing. See more details at the fragment option."/>
<property name="partNamespace" type="string" display="Part Namespace" description="XML namespace to use for fragment parsing. See more details at the fragment option."/>
<property name="prettyPrint" type="boolean" display="Pretty Print" description="To enable pretty printing output nicely formatted. Is by default false."/>
<property name="schema" type="string" display="Schema" description="To validate against an existing schema. Your can use the prefix classpath:, file: or http: to specify how the resource should by resolved. You can separate multiple schema files by using the ',' character."/>
<property name="schemaLocation" type="string" display="Schema Location" description="To define the location of the schema"/>
<property name="schemaSeverityLevel" type="int" display="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."/>
<property name="xmlStreamWriterWrapper" type="string" display="Xml Stream Writer Wrapper" description="To use a custom xml stream writer."/>
</dataFormat>
<dataFormat name="json" javaType="org.apache.camel.model.dataformat.JsonDataFormat" display="JSon" label="dataformat,transformation,json" extends="model:dataFormat" description="JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload.">
<property name="allowJmsType" type="boolean" display="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."/>
<property name="allowUnmarshallType" type="boolean" display="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."/>
<property name="collectionTypeName" type="string" display="Collection Type Name" 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."/>
<property name="disableFeatures" type="string" display="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"/>
<property name="enableFeatures" type="string" display="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"/>
<property name="enableJaxbAnnotationModule" type="boolean" display="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."/>
<property name="include" type="string" display="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"/>
<property name="jsonView" type="class" display="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"/>
<property name="library" type="enum:JsonLibrary(Fastjson,Gson,Jackson,Johnzon,XStream)" display="Library" description="Which json library to use."/>
<property name="moduleClassNames" type="string" display="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."/>
<property name="moduleRefs" type="string" display="Module Refs" description="To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma."/>
<property name="objectMapper" type="string" display="Object Mapper" description="Lookup and use the existing ObjectMapper with the given id when using Jackson."/>
<property name="permissions" type="string" display="Permissions" description="Adds permissions that controls which Java packages and classes XStream is allowed to use during unmarshal from xml/json to Java beans. A permission must be configured either here or globally using a JVM system property. The permission can be specified in a syntax where a plus sign is allow, and minus sign is deny. Wildcards is supported by using . as prefix. For example to allow com.foo and all subpackages then specfy com.foo.. Multiple permissions can be configured separated by comma, such as com.foo.,-com.foo.bar.MySecretBean. The following default permission is always included: -,java.lang.,java.util. unless its overridden by specifying a JVM system property with they key org.apache.camel.xstream.permissions."/>
<property name="prettyPrint" type="boolean" display="Pretty Print" description="To enable pretty printing output nicely formatted. Is by default false."/>
<property name="timezone" type="string" display="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, fastjson and xstream."/>
<property name="unmarshalType" type="class" display="Unmarshal Type" description="Java type to use when unmarshalling"/>
<property name="useDefaultObjectMapper" type="boolean" display="Use Default Object Mapper" description="Whether to lookup and use default Jackson ObjectMapper from the registry."/>
<property name="useList" type="boolean" display="Use List" description="To unarmshal to a List of Map or a List of Pojo."/>
</dataFormat>
<dataFormat name="jsonApi" display="jsonApi" label="dataformat,transformation" extends="model:dataFormat" maven="org.apache.camel:camel-jsonapi:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.JsonApiDataFormat" since="3.0.0" description="JsonApi data format is used for marshal and unmarshal Json API object.">
<property name="dataFormatTypes" type="class[]" display="Data Format Types" description="The classes to take into account for the marshalling"/>
<property name="mainFormatType" type="class" display="Main Format Type" description="The classes to take into account while unmarshalling"/>
</dataFormat>
<dataFormat name="lzf" display="LZF Deflate Compression" label="dataformat,transformation" extends="model:dataFormat" maven="org.apache.camel:camel-lzf:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.LZFDataFormat" since="2.17.0" description="The LZF data format is a message compression and de-compression format (uses the LZF deflate algorithm).">
<property name="usingParallelCompression" type="boolean" display="Using Parallel Compression" description="Enable encoding (compress) using multiple processing cores."/>
</dataFormat>
<dataFormat name="mimeMultipart" display="MIME Multipart" label="dataformat,transformation" extends="model:dataFormat" maven="org.apache.camel:camel-mail:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.MimeMultipartDataFormat" since="2.17.0" description="The MIME Multipart data format can marshal a Camel message with attachments into a Camel message having a MIME-Multipart message as message body (and no attachments), and vise-versa when unmarshalling.">
<property name="binaryContent" type="boolean" display="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."/>
<property name="headersInline" type="boolean" display="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."/>
<property name="includeHeaders" type="string" display="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"/>
<property name="multipartSubType" type="string" display="Multipart Sub Type" description="Specify the subtype of the MIME Multipart. Default is mixed."/>
<property name="multipartWithoutAttachment" type="boolean" display="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."/>
</dataFormat>
<dataFormat name="pgp" display="PGP" label="dataformat,transformation,security" extends="model:dataFormat" maven="org.apache.camel:camel-crypto:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.PGPDataFormat" since="2.9.0" description="PGP data format is used for encrypting and decrypting of messages using Java Cryptographic Extension and PGP.">
<property name="algorithm" type="int" display="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."/>
<property name="armored" type="boolean" display="Armored" description="This option will cause PGP to base64 encode the encrypted text, making it available for copy/paste, etc."/>
<property name="compressionAlgorithm" type="int" display="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."/>
<property name="hashAlgorithm" type="int" display="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."/>
<property name="integrity" type="boolean" display="Integrity" description="Adds an integrity check/sign into the encryption file. The default value is true."/>
<property name="keyFileName" type="string" display="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)."/>
<property name="keyUserid" type="string" display="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."/>
<property name="password" type="string" display="Password" description="Password used when opening the private key (not used for encryption)."/>
<property name="provider" type="string" display="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."/>
<property name="signatureKeyFileName" type="string" display="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)."/>
<property name="signatureKeyRing" type="string" display="Signature Key Ring" description="Keyring used for signing/verifying as byte array. You can not set the signatureKeyFileName and signatureKeyRing at the same time."/>
<property name="signatureKeyUserid" type="string" display="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."/>
<property name="signaturePassword" type="string" display="Signature Password" description="Password used when opening the private key used for signing (during encryption)."/>
<property name="signatureVerificationOption" type="string" display="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."/>
</dataFormat>
<dataFormat name="protobuf" display="Protobuf" label="dataformat,transformation" extends="model:dataFormat" maven="org.apache.camel:camel-protobuf:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.ProtobufDataFormat" since="2.2.0" description="The Protobuf data format is used for serializing between Java objects and the Google Protobuf protocol.">
<property name="contentTypeFormat" type="string" display="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."/>
<property name="instanceClass" type="string" display="Instance Class" description="Name of class to use when unmarshalling"/>
<property name="defaultInstance" type="java:com.google.protobuf.Message" display="Default Instance" description="The message instance to use when unmarshalling"/>
</dataFormat>
<dataFormat name="rss" display="RSS" label="dataformat,transformation" extends="model:dataFormat" maven="org.apache.camel:camel-rss:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.RssDataFormat" since="2.1.0" description="RSS data format is used for working with RSS sync feed Java Objects and transforming to XML and vice-versa."/>
<dataFormat name="secureXML" display="XML Security" label="dataformat,transformation,xml,security" extends="model:dataFormat" maven="org.apache.camel:camel-xmlsecurity:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.XMLSecurityDataFormat" since="2.0.0" description="The XML Security data format facilitates encryption and decryption of XML payloads.">
<property name="addKeyValueForEncryptedKey" type="boolean" display="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."/>
<property name="digestAlgorithm" type="string" display="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"/>
<property name="keyCipherAlgorithm" type="string" display="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"/>
<property name="keyOrTrustStoreParameters" type="java:org.apache.camel.support.jsse.KeyStoreParameters" display="KeyStoreParameters" description="The 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."/>
<property name="namespaces" type="map(string,string)" display="Namespaces" description="XML Namespaces of prefix -> uri mappings"/>
<property name="keyPassword" type="string" display="Key Password" description="The password to be used for retrieving the private key from the KeyStore. This key is used for asymmetric decryption."/>
<property name="mgfAlgorithm" type="string" display="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"/>
<property name="passPhrase" type="string" display="Pass Phrase" description="A String used as passPhrase to encrypt/decrypt content. The passPhrase has to be provided. If no passPhrase is specified, a default passPhrase is used. 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"/>
<property name="recipientKeyAlias" type="string" display="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."/>
<property name="secureTag" type="string" display="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."/>
<property name="secureTagContents" type="boolean" display="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"/>
<property name="xmlCipherAlgorithm" type="string" display="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 MLCipher.TRIPLEDES"/>
</dataFormat>
<dataFormat name="soapjaxb" display="SOAP" label="dataformat,transformation,xml" extends="model:dataFormat" maven="org.apache.camel:camel-soap:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.SoapJaxbDataFormat" since="2.3.0" description="SOAP is a data format which uses JAXB2 and JAX-WS annotations to marshal and unmarshal SOAP payloads.">
<property name="contextPath" type="string" display="Context Path" required="true" description="Package name where your JAXB classes are located."/>
<property name="elementNameStrategy" type="java:org.apache.camel.dataformat.soap.name.ElementNameStrategy" display="Element Name Strategy" description="The 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."/>
<property name="encoding" type="string" display="Encoding" description="To overrule and use a specific encoding"/>
<property name="namespacePrefixRef" type="string" display="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."/>
<property name="schema" type="string" display="Schema" description="To validate against an existing schema. Your can use the prefix classpath:, file: or http: to specify how the resource should by resolved. You can separate multiple schema files by using the ',' character."/>
<property name="version" type="string" display="Version" description="SOAP version should either be 1.1 or 1.2. Is by default 1.1"/>
</dataFormat>
<dataFormat name="syslog" display="Syslog" label="dataformat,transformation,monitoring" extends="model:dataFormat" maven="org.apache.camel:camel-syslog:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.SyslogDataFormat" since="2.6.0" description="The Syslog dataformat is used for working with RFC3164 and RFC5424 messages (logging and monitoring)."/>
<dataFormat name="tarfile" display="Tar File" label="dataformat,transformation,file" extends="model:dataFormat" maven="org.apache.camel:camel-tarfile:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.TarFileDataFormat" since="2.16.0" description="The Tar File data format is a message compression and de-compression format of tar files.">
<property name="allowEmptyDirectory" type="boolean" display="Allow Empty Directory" description="If the tar file has more then one entry, setting this option to true, allows to get the iterator even if the directory is empty"/>
<property name="preservePathElements" type="boolean" display="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."/>
<property name="usingIterator" type="boolean" display="Using Iterator" description="If the tar file has more then one entry, the setting this option to true, allows to work with the splitter EIP, to split the data using an iterator in a streaming mode."/>
</dataFormat>
<dataFormat name="thrift" display="Thrift" label="dataformat,transformation" extends="model:dataFormat" maven="org.apache.camel:camel-thrift:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.ThriftDataFormat" since="2.20.0" description="The Thrift data format is used for serialization and deserialization of messages using Apache Thrift binary dataformat.">
<property name="contentTypeFormat" type="string" display="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."/>
<property name="instanceClass" type="string" display="Instance Class" description="Name of class to use when unmarshalling"/>
<property name="defaultInstance" type="java:org.apache.thrift.TBase" display="Default Instance" description="The TBase instance to use when unmarshalling"/>
</dataFormat>
<dataFormat name="tidyMarkup" display="TidyMarkup" label="dataformat,transformation" extends="model:dataFormat" maven="org.apache.camel:camel-tagsoup:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.TidyMarkupDataFormat" since="2.0.0" description="TidyMarkup data format is used for parsing HTML and return it as pretty well-formed HTML.">
<property name="dataObjectType" type="class" display="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"/>
<property name="omitXmlDeclaration" type="boolean" display="Omit Xml Declaration" description="When returning a String, do we omit the XML declaration in the top."/>
</dataFormat>
<dataFormat name="univocity-csv" display="uniVocity CSV" label="dataformat,transformation,csv" extends="model:dataFormat" maven="org.apache.camel:camel-univocity-parsers:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.UniVocityCsvDataFormat" since="2.15.0" description="The uniVocity CSV data format is used for working with CSV (Comma Separated Values) flat payloads.">
<property name="asMap" type="boolean" display="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"/>
<property name="comment" type="string" display="Comment" description="The comment symbol. The default value is #"/>
<property name="delimiter" type="string" display="Delimiter" description="The delimiter of values"/>
<property name="emptyValue" type="string" display="Empty Value" description="The String representation of an empty value"/>
<property name="headerExtractionEnabled" type="boolean" display="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"/>
<property name="headersDisabled" type="boolean" display="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"/>
<property name="ignoreLeadingWhitespaces" type="boolean" display="Ignore Leading Whitespaces" description="Whether or not the leading white spaces must be ignored. The default value is true"/>
<property name="ignoreTrailingWhitespaces" type="boolean" display="Ignore Trailing Whitespaces" description="Whether or not the trailing white spaces must ignored. The default value is true"/>
<property name="lazyLoad" type="boolean" display="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"/>
<property name="lineSeparator" type="string" display="Line Separator" description="The line separator of the files The default value is to use the JVM platform line separator"/>
<property name="normalizedLineSeparator" type="string" display="Normalized Line Separator" description="The normalized line separator of the files The default value is a new line character."/>
<property name="nullValue" type="string" display="Null Value" description="The string representation of a null value. The default value is null"/>
<property name="numberOfRecordsToRead" type="int" display="Number Of Records To Read" description="The maximum number of record to read."/>
<property name="quote" type="string" display="Quote" description="The quote symbol."/>
<property name="quoteAllFields" type="boolean" display="Quote All Fields" description="Whether or not all values must be quoted when writing them."/>
<property name="quoteEscape" type="string" display="Quote Escape" description="The quote escape symbol"/>
<property name="skipEmptyLines" type="boolean" display="Skip Empty Lines" description="Whether or not the empty lines must be ignored. The default value is true"/>
</dataFormat>
<dataFormat name="univocity-fixed" display="uniVocity Fixed Length" label="dataformat,transformation,csv" extends="model:dataFormat" maven="org.apache.camel:camel-univocity-parsers:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.UniVocityFixedWidthDataFormat" since="2.15.0" description="The uniVocity Fixed Length data format is used for working with fixed length flat payloads.">
<property name="asMap" type="boolean" display="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"/>
<property name="comment" type="string" display="Comment" description="The comment symbol. The default value is #"/>
<property name="emptyValue" type="string" display="Empty Value" description="The String representation of an empty value"/>
<property name="headerExtractionEnabled" type="boolean" display="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"/>
<property name="headersDisabled" type="boolean" display="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"/>
<property name="ignoreLeadingWhitespaces" type="boolean" display="Ignore Leading Whitespaces" description="Whether or not the leading white spaces must be ignored. The default value is true"/>
<property name="ignoreTrailingWhitespaces" type="boolean" display="Ignore Trailing Whitespaces" description="Whether or not the trailing white spaces must ignored. The default value is true"/>
<property name="lazyLoad" type="boolean" display="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"/>
<property name="lineSeparator" type="string" display="Line Separator" description="The line separator of the files The default value is to use the JVM platform line separator"/>
<property name="normalizedLineSeparator" type="string" display="Normalized Line Separator" description="The normalized line separator of the files The default value is a new line character."/>
<property name="nullValue" type="string" display="Null Value" description="The string representation of a null value. The default value is null"/>
<property name="numberOfRecordsToRead" type="int" display="Number Of Records To Read" description="The maximum number of record to read."/>
<property name="padding" type="string" display="Padding" description="The padding character. The default value is a space"/>
<property name="recordEndsOnNewline" type="boolean" display="Record Ends On Newline" description="Whether or not the record ends on new line. The default value is false"/>
<property name="skipEmptyLines" type="boolean" display="Skip Empty Lines" description="Whether or not the empty lines must be ignored. The default value is true"/>
<property name="skipTrailingCharsUntilNewline" type="boolean" display="Skip Trailing Chars Until Newline" description="Whether or not the trailing characters until new line must be ignored. The default value is false"/>
</dataFormat>
<dataFormat name="univocity-tsv" display="uniVocity TSV" label="dataformat,transformation,csv" extends="model:dataFormat" maven="org.apache.camel:camel-univocity-parsers:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.UniVocityTsvDataFormat" since="2.15.0" description="The uniVocity TSV data format is used for working with TSV (Tabular Separated Values) flat payloads.">
<property name="asMap" type="boolean" display="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"/>
<property name="comment" type="string" display="Comment" description="The comment symbol. The default value is #"/>
<property name="emptyValue" type="string" display="Empty Value" description="The String representation of an empty value"/>
<property name="escapeChar" type="string" display="Escape Char" description="The escape character."/>
<property name="headerExtractionEnabled" type="boolean" display="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"/>
<property name="headersDisabled" type="boolean" display="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"/>
<property name="ignoreLeadingWhitespaces" type="boolean" display="Ignore Leading Whitespaces" description="Whether or not the leading white spaces must be ignored. The default value is true"/>
<property name="ignoreTrailingWhitespaces" type="boolean" display="Ignore Trailing Whitespaces" description="Whether or not the trailing white spaces must ignored. The default value is true"/>
<property name="lazyLoad" type="boolean" display="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"/>
<property name="lineSeparator" type="string" display="Line Separator" description="The line separator of the files The default value is to use the JVM platform line separator"/>
<property name="normalizedLineSeparator" type="string" display="Normalized Line Separator" description="The normalized line separator of the files The default value is a new line character."/>
<property name="nullValue" type="string" display="Null Value" description="The string representation of a null value. The default value is null"/>
<property name="numberOfRecordsToRead" type="int" display="Number Of Records To Read" description="The maximum number of record to read."/>
<property name="skipEmptyLines" type="boolean" display="Skip Empty Lines" description="Whether or not the empty lines must be ignored. The default value is true"/>
</dataFormat>
<dataFormat name="xmlrpc" javaType="org.apache.camel.model.dataformat.XmlRpcDataFormat" display="XML RPC" label="dataformat,transformation,xml" extends="model:dataFormat" since="2.11.0" description="The XML RPC data format is used for working with the XML RPC protocol.">
<property name="request" type="boolean" display="Request" description="Whether to marshal/unmarshal request or response Is by default false"/>
</dataFormat>
<dataFormat name="xstream" display="XStream" label="dataformat,transformation,xml,json" extends="model:dataFormat" maven="org.apache.camel:camel-xstream:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.XStreamDataFormat" since="1.3.0" description="XSTream data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload.">
<property name="aliases" type="map(string,string)" display="Aliases" kind="element" description="Alias a Class to a shorter name to be used in XML elements."/>
<property name="converters" type="list(string)" display="Converters" kind="element" description="List of class names for using custom XStream converters. The classes must be of type com.thoughtworks.xstream.converters.Converter"/>
<property name="driver" type="string" display="Driver" description="To use a custom XStream driver. The instance must be of type com.thoughtworks.xstream.io.HierarchicalStreamDriver"/>
<property name="driverRef" type="string" display="Driver Ref" description="To refer to a custom XStream driver to lookup in the registry. The instance must be of type com.thoughtworks.xstream.io.HierarchicalStreamDriver"/>
<property name="encoding" type="string" display="Encoding" description="Sets the encoding to use"/>
<property name="implicitCollections" type="map(string,string[])" display="Implicit Collections" kind="element" description="Adds a default implicit collection which is used for any unmapped XML tag."/>
<property name="mode" type="string" display="Mode" description="Mode for dealing with duplicate references The possible values are: NO_REFERENCES ID_REFERENCES XPATH_RELATIVE_REFERENCES XPATH_ABSOLUTE_REFERENCES SINGLE_NODE_XPATH_RELATIVE_REFERENCES SINGLE_NODE_XPATH_ABSOLUTE_REFERENCES"/>
<property name="omitFields" type="map(string,string[])" display="Omit Fields" kind="element" description="Prevents a field from being serialized. To omit a field you must always provide the declaring type and not necessarily the type that is converted."/>
<property name="permissions" type="string" display="Permissions" description="Adds permissions that controls which Java packages and classes XStream is allowed to use during unmarshal from xml/json to Java beans. A permission must be configured either here or globally using a JVM system property. The permission can be specified in a syntax where a plus sign is allow, and minus sign is deny. Wildcards is supported by using . as prefix. For example to allow com.foo and all subpackages then specfy com.foo.. Multiple permissions can be configured separated by comma, such as com.foo.,-com.foo.bar.MySecretBean. The following default permission is always included: -,java.lang.,java.util. unless its overridden by specifying a JVM system property with they key org.apache.camel.xstream.permissions."/>
</dataFormat>
<dataFormat name="yaml" javaType="org.apache.camel.model.dataformat.YAMLDataFormat" display="YAML" label="dataformat,transformation,yaml" extends="model:dataFormat" since="2.17.0" description="YAML is a data format to marshal and unmarshal Java objects to and from YAML.">
<property name="allowAnyType" type="boolean" display="Allow Any Type" description="Allow any class to be un-marshaled"/>
<property name="constructor" type="string" display="Constructor" description="BaseConstructor to construct incoming documents."/>
<property name="dumperOptions" type="string" display="Dumper Options" description="DumperOptions to configure outgoing objects."/>
<property name="library" type="enum:YAMLLibrary(SnakeYAML)" display="Library" description="Which yaml library to use. By default it is SnakeYAML"/>
<property name="prettyFlow" type="boolean" display="Pretty Flow" description="Force the emitter to produce a pretty YAML document when using the flow style."/>
<property name="representer" type="string" display="Representer" description="Representer to emit outgoing objects."/>
<property name="resolver" type="string" display="Resolver" description="Resolver to detect implicit type"/>
<property name="typeFilters" type="list(model:typeFilter)" display="Type Filter" kind="element" description="Set the types SnakeYAML is allowed to un-marshall"/>
<property name="unmarshalType" type="class" display="Unmarshal Type" description="Java type to use when unmarshalling"/>
<property name="useApplicationContextClassLoader" type="boolean" display="Use Application Context Class Loader" description="Use ApplicationContextClassLoader as custom ClassLoader"/>
<property name="classLoader" type="java:java.lang.ClassLoader"/>
</dataFormat>
<dataFormat name="zipdeflater" display="Zip Deflate Compression" label="dataformat,transformation" extends="model:dataFormat" maven="org.apache.camel:camel-zip-deflater:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.ZipDeflaterDataFormat" since="2.12.0" description="Zip Deflate Compression data format is a message compression and de-compression format (not zip files).">
<property name="compressionLevel" type="int" display="Compression Level" description="To specify a specific compression between 0-9. -1 is default compression, 0 is no compression, and 9 is best compression."/>
</dataFormat>
<dataFormat name="zipfile" display="Zip File" label="dataformat,transformation,file" extends="model:dataFormat" maven="org.apache.camel:camel-zipfile:3.0.0-SNAPSHOT" javaType="org.apache.camel.model.dataformat.ZipFileDataFormat" since="2.11.0" description="The Zip File data format is a message compression and de-compression format of zip files.">
<property name="allowEmptyDirectory" type="boolean" display="Allow Empty Directory" description="If the zip file has more then one entry, setting this option to true, allows to get the iterator even if the directory is empty"/>
<property name="preservePathElements" type="boolean" display="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."/>
<property name="usingIterator" type="boolean" display="Using Iterator" description="If the zip file has more then one entry, the setting this option to true, allows to work with the splitter EIP, to split the data using an iterator in a streaming mode."/>
</dataFormat>
</dataFormats>
<!--
- LoadBalancers
-->
<loadBalancers>
<loadBalancer name="customLoadBalancer" display="Custom Load Balancer" label="eip,routing,loadbalance" extends="model:loadBalancer" description="Custom load balancer" javaType="org.apache.camel.model.loadbalancer.CustomLoadBalancerDefinition">
<property name="loadBalancer" type="org.apache.camel.spi.LoadBalancer"/>
</loadBalancer>
<loadBalancer name="failover" display="Failover" label="eip,routing,loadbalance" extends="model:loadBalancer" description="Failover load balancer" javaType="org.apache.camel.model.loadbalancer.FailoverLoadBalancerDefinition">
<property name="exceptions" type="list(string)" display="Exception" kind="element" description="A list of class names for specific exceptions to monitor. If no exceptions is configured then all exceptions is monitored"/>
<property name="maximumFailoverAttempts" type="int" display="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."/>
<property name="roundRobin" type="boolean" display="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)."/>
<property name="sticky" type="boolean" display="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)."/>
</loadBalancer>
<loadBalancer name="random" display="Random" label="eip,routing,loadbalance" extends="model:loadBalancer" description="Random load balancer" javaType="org.apache.camel.model.loadbalancer.RandomLoadBalancerDefinition"/>
<loadBalancer name="roundRobin" display="Round Robin" label="eip,routing,loadbalance" extends="model:loadBalancer" description="Round robin load balancer" javaType="org.apache.camel.model.loadbalancer.RoundRobinLoadBalancerDefinition"/>
<loadBalancer name="sticky" display="Sticky" label="eip,routing,loadbalance" extends="model:loadBalancer" description="Sticky load balancer" javaType="org.apache.camel.model.loadbalancer.StickyLoadBalancerDefinition">
<property name="correlationExpression" type="model:expression" display="Correlation Expression" required="true" kind="expression" description="The correlation expression to use to calculate the correlation key"/>
</loadBalancer>
<loadBalancer name="topic" display="Topic" label="eip,routing,loadbalance" extends="model:loadBalancer" description="Topic load balancer" javaType="org.apache.camel.model.loadbalancer.TopicLoadBalancerDefinition"/>
<loadBalancer name="weighted" display="Weighted" label="eip,routing,loadbalance" extends="model:loadBalancer" description="Weighted load balancer" javaType="org.apache.camel.model.loadbalancer.WeightedLoadBalancerDefinition">
<property name="distributionRatio" type="string" display="Distribution Ratio" required="true" 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."/>
<property name="distributionRatioDelimiter" type="string" display="Distribution Ratio Delimiter" description="Delimiter used to specify the distribution ratio. The default value is ,"/>
<property name="roundRobin" type="boolean" display="Round Robin" description="To enable round robin mode. By default the weighted distribution mode is used. The default value is false."/>
</loadBalancer>
</loadBalancers>
<!--
- Endpoints
-->
<endpoints>
<endpoint name="activemq" display="ActiveMQ" label="messaging" extends="model:endpoint" javaType="org.apache.camel.component.activemq.ActiveMQComponent" maven="org.apache.camel:camel-activemq:3.0.0-SNAPSHOT" async="true" since="1.0.0" description="The activemq component allows messages to be sent to (or consumed from) Apache ActiveMQ. This component extends the Camel JMS component.">
<property name="acceptMessagesWhileStopping" type="boolean" display="Accept Messages While Stopping" label="consumer,advanced" description="Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option, if you start and stop JMS routes at runtime, while there are still messages enqueued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected, and the JMS broker would have to attempt redeliveries, which yet again may be rejected, and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option."/>
<property name="acknowledgementModeName" type="string" display="Acknowledgement Mode Name" label="consumer" description="The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"/>
<property name="allowAdditionalHeaders" type="string" display="Allow Additional Headers" label="producer,advanced" description="This option is used to allow additional headers which may have values that are invalid according to JMS specification. For example some message systems such as WMQ do this with header names using prefix JMS_IBM_MQMD_ containing values with byte array or other invalid types. You can specify multiple header names separated by comma, and use as suffix for wildcard matching."/>
<property name="allowNullBody" type="boolean" display="Allow Null Body" label="producer,advanced" description="Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."/>
<property name="allowReplyManagerQuickStop" type="boolean" display="Allow Reply Manager Quick Stop" label="consumer,advanced" description="Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer#runningAllowed() flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping() is enabled, and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag."/>
<property name="allowSerializedHeaders" type="boolean" display="Allow Serialized Headers" label="advanced" description="Controls whether or not to include serialized headers. Applies only when isTransferExchange() is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."/>
<property name="alwaysCopyMessage" type="boolean" display="Always Copy Message" label="producer,advanced" description="If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set)"/>
<property name="asyncConsumer" type="boolean" display="Async Consumer" label="consumer" description="Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."/>
<property name="asyncStartListener" type="boolean" display="Async Start Listener" label="advanced" description="Whether to startup the JmsConsumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry."/>
<property name="asyncStopListener" type="boolean" display="Async Stop Listener" label="advanced" description="Whether to stop the JmsConsumer message listener asynchronously, when stopping a route."/>
<property name="autoStartup" type="boolean" display="Auto Startup" label="consumer" description="Specifies whether the consumer container should auto-startup."/>
<property name="cacheLevel" type="int" display="Cache Level" label="consumer" description="Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details."/>
<property name="cacheLevelName" type="string" display="Cache Level Name" label="consumer" description="Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information."/>
<property name="clientId" type="string" display="Client Id" description="Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead."/>
<property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="consumer" description="Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."/>
<property name="connectionFactory" type="java:javax.jms.ConnectionFactory" display="Connection Factory" description="Sets the default connection factory to be used if a connection factory is not specified for either setTemplateConnectionFactory(ConnectionFactory) or setListenerConnectionFactory(ConnectionFactory)"/>
<property name="consumerType" type="enum:ConsumerType(Simple,Default,Custom)" display="Consumer Type" label="consumer,advanced" description="The consumer type to use, which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."/>
<property name="correlationProperty" type="string" display="Correlation Property" label="producer,advanced" description="Use this JMS property to correlate messages in InOut exchange pattern (request-reply) instead of JMSCorrelationID property. This allows you to exchange messages with systems that do not correlate messages using JMSCorrelationID JMS property. If used JMSCorrelationID will not be used or set by Camel. The value of here named property will be generated if not supplied in the header of the message under the same name."/>
<property name="defaultTaskExecutorType" type="enum:DefaultTaskExecutorType(ThreadPool,SimpleAsync)" display="Default Task Executor Type" label="consumer,advanced" description="Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer, for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached threadpool-like). If not set, it defaults to the previous behaviour, which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers."/>
<property name="deliveryMode" type="int" display="Delivery Mode" label="producer" description="Specifies the delivery mode to be used. Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."/>
<property name="deliveryPersistent" type="boolean" display="Delivery Persistent" label="producer" description="Specifies whether persistent delivery is used by default."/>
<property name="destinationName" type="string" display="Destination Name" required="true" kind="path" description="Name of the queue or topic to use as destination"/>
<property name="destinationResolver" type="java:org.springframework.jms.support.destination.DestinationResolver" display="Destination Resolver" label="advanced" description="A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example, to lookup the real destination in a JNDI registry)."/>
<property name="destinationType" type="string" display="Destination Type" kind="path" description="The kind of destination to use"/>
<property name="disableReplyTo" type="boolean" display="Disable Reply To" description="Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."/>
<property name="disableTimeToLive" type="boolean" display="Disable Time To Live" label="producer,advanced" description="Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."/>
<property name="durableSubscriptionName" type="string" display="Durable Subscription Name" description="The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."/>
<property name="eagerLoadingOfProperties" type="boolean" display="Eager Loading Of Properties" label="consumer,advanced" description="Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties"/>
<property name="errorHandler" type="java:org.springframework.util.ErrorHandler" display="Error Handler" label="advanced" description="Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level, if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure, than having to code a custom errorHandler."/>
<property name="errorHandlerLogStackTrace" type="boolean" display="Error Handler Log Stack Trace" label="consumer,logging" description="Allows to control whether stacktraces should be logged or not, by the default errorHandler."/>
<property name="errorHandlerLoggingLevel" type="enum:org.apache.camel.LoggingLevel(TRACE,DEBUG,INFO,WARN,ERROR,OFF)" display="Error Handler Logging Level" label="consumer,logging" description="Allows to configure the default errorHandler logging level for logging uncaught exceptions."/>
<property name="exceptionListener" type="java:javax.jms.ExceptionListener" display="Exception Listener" label="advanced" description="Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions."/>
<property name="explicitQosEnabled" type="boolean" display="Explicit Qos Enabled" label="producer" description="Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."/>
<property name="exposeListenerSession" type="boolean" display="Expose Listener Session" label="consumer,advanced" description="Specifies whether the listener session should be exposed when consuming messages."/>
<property name="forceSendOriginalMessage" type="boolean" display="Force Send Original Message" label="producer,advanced" description="When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received."/>
<property name="formatDateHeadersToIso8601" type="boolean" display="Format Date Headers To Iso8601" label="producer" description="Sets whether date headers should be formatted according to the ISO 8601 standard."/>
<property name="headerFilterStrategy" type="java:org.apache.camel.spi.HeaderFilterStrategy" display="Header Filter Strategy" label="advanced" description="To use a custom HeaderFilterStrategy to filter header to and from Camel message."/>
<property name="idleConsumerLimit" type="int" display="Idle Consumer Limit" label="advanced" description="Specify the limit for the number of consumers that are allowed to be idle at any given time."/>
<property name="idleTaskExecutionLimit" type="int" display="Idle Task Execution Limit" label="advanced" description="Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring."/>
<property name="includeAllJMSXProperties" type="boolean" display="Include All JMSXProperties" label="advanced" description="Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply."/>
<property name="includeSentJMSMessageID" type="boolean" display="Include Sent JMSMessage ID" label="producer,advanced" description="Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination."/>
<property name="jmsKeyFormatStrategy" type="string" display="Jms Key Format Strategy" label="advanced" description="Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation."/>
<property name="jmsMessageType" type="enum:JmsMessageType(Bytes,Map,Object,Stream,Text)" display="Jms Message Type" description="Allows you to force the use of a specific javax.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it."/>
<property name="lazyCreateTransactionManager" type="boolean" display="Lazy Create Transaction Manager" label="transaction,advanced" description="If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true."/>
<property name="mapJmsMessage" type="boolean" display="Map Jms Message" label="advanced" description="Specifies whether Camel should auto map the received JMS message to a suited payload type, such as javax.jms.TextMessage to a String etc."/>
<property name="maxConcurrentConsumers" type="int" display="Max Concurrent Consumers" label="consumer" description="Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."/>
<property name="maxMessagesPerTask" type="int" display="Max Messages Per Task" label="advanced" description="The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max), then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required."/>
<property name="messageConverter" type="java:org.springframework.jms.support.converter.MessageConverter" display="Message Converter" label="advanced" description="To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message."/>
<property name="messageCreatedStrategy" type="java:org.apache.camel.component.jms.MessageCreatedStrategy" display="Message Created Strategy" label="advanced" description="To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message."/>
<property name="messageIdEnabled" type="boolean" display="Message Id Enabled" label="advanced" description="When sending, specifies whether message IDs should be added. This is just an hint to the JMS Broker. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value"/>
<property name="messageListenerContainerFactory" type="java:org.apache.camel.component.jms.MessageListenerContainerFactory" display="Message Listener Container Factory" label="advanced" description="Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom."/>
<property name="messageTimestampEnabled" type="boolean" display="Message Timestamp Enabled" label="advanced" description="Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS Broker. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint, the timestamp must be set to its normal value."/>
<property name="password" type="string" display="Password" label="security" secret="true" description="Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."/>
<property name="preserveMessageQos" type="boolean" display="Preserve Message Qos" label="producer" description="Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."/>
<property name="priority" type="int" display="Priority" label="producer" description="Values greater than 1 specify the message priority when sending (where 0 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect."/>
<property name="pubSubNoLocal" type="boolean" display="Pub Sub No Local" label="advanced" description="Specifies whether to inhibit the delivery of messages published by its own connection."/>
<property name="receiveTimeout" type="long" display="Receive Timeout" label="advanced" description="The timeout for receiving messages (in milliseconds)."/>
<property name="recoveryInterval" type="long" display="Recovery Interval" label="advanced" description="Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds."/>
<property name="replyTo" type="string" display="Reply To" label="consumer" description="Provides an explicit ReplyTo destination, which overrides any incoming value of Message.getJMSReplyTo()."/>
<property name="replyToCacheLevelName" type="string" display="Reply To Cache Level Name" label="producer,advanced" description="Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed, and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION."/>
<property name="replyToConcurrentConsumers" type="int" display="Reply To Concurrent Consumers" label="producer" description="Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."/>
<property name="replyToDeliveryPersistent" type="boolean" display="Reply To Delivery Persistent" label="consumer" description="Specifies whether to use persistent delivery by default for replies."/>
<property name="replyToDestinationSelectorName" type="string" display="Reply To Destination Selector Name" label="producer,advanced" description="Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is, if you are not using a temporary reply queue)."/>
<property name="replyToMaxConcurrentConsumers" type="int" display="Reply To Max Concurrent Consumers" label="producer" description="Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."/>
<property name="replyToOnTimeoutMaxConcurrentConsumers" type="int" display="Reply To On Timeout Max Concurrent Consumers" label="producer" description="Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS."/>
<property name="replyToOverride" type="string" display="Reply To Override" label="producer" description="Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."/>
<property name="replyToSameDestinationAllowed" type="boolean" display="Reply To Same Destination Allowed" label="consumer,advanced" description="Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself."/>
<property name="replyToType" type="enum:ReplyToType(Temporary,Shared,Exclusive)" display="Reply To Type" label="producer" description="Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary, Shared, or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details, and especially the notes about the implications if running in a clustered environment, and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive."/>
<property name="requestTimeout" type="long" display="Request Timeout" label="producer" description="The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."/>
<property name="requestTimeoutCheckerInterval" type="long" display="Request Timeout Checker Interval" label="advanced" description="Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs, then you can lower this interval, to check more frequently. The timeout is determined by the option requestTimeout."/>
<property name="selector" type="string" display="Selector" label="consumer" description="Sets the JMS selector to use"/>
<property name="streamMessageTypeEnabled" type="boolean" display="Stream Message Type Enabled" label="producer,advanced" description="Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data."/>
<property name="subscriptionDurable" type="boolean" display="Subscription Durable" label="consumer" description="Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well."/>
<property name="subscriptionName" type="string" display="Subscription Name" label="consumer" description="Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0)."/>
<property name="subscriptionShared" type="boolean" display="Subscription Shared" label="consumer" description="Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker."/>
<property name="taskExecutor" type="java:org.springframework.core.task.TaskExecutor" display="Task Executor" label="consumer,advanced" description="Allows you to specify a custom task executor for consuming messages."/>
<property name="testConnectionOnStartup" type="boolean" display="Test Connection On Startup" description="Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."/>
<property name="timeToLive" type="long" display="Time To Live" label="producer" description="When sending messages, specifies the time-to-live of the message (in milliseconds)."/>
<property name="transacted" type="boolean" display="Transacted" label="transaction" description="Specifies whether to use transacted mode"/>
<property name="transactionManager" type="java:org.springframework.transaction.PlatformTransactionManager" display="Transaction Manager" label="transaction,advanced" description="The Spring transaction manager to use."/>
<property name="transactionName" type="string" display="Transaction Name" label="transaction,advanced" description="The name of the transaction to use."/>
<property name="transactionTimeout" type="int" display="Transaction Timeout" label="transaction,advanced" description="The timeout value of the transaction (in seconds), if using transacted mode."/>
<property name="transferException" type="boolean" display="Transfer Exception" label="advanced" description="If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a javax.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer."/>
<property name="transferExchange" type="boolean" display="Transfer Exchange" label="advanced" description="You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body, Out body, Fault body, In headers, Out headers, Fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side, so Camel knows the payloads is an Exchange and not a regular payload."/>
<property name="transferFault" type="boolean" display="Transfer Fault" label="advanced" description="If enabled and you are using Request Reply messaging (InOut) and an Exchange failed with a SOAP fault (not exception) on the consumer side, then the fault flag on org.apache.camel.Message#isFault() will be send back in the response as a JMS header with the key JmsConstants#JMS_TRANSFER_FAULT. If the client is Camel, the returned fault flag will be set on the org.apache.camel.Message#setFault(boolean). You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws."/>
<property name="useMessageIDAsCorrelationID" type="boolean" display="Use Message IDAs Correlation ID" label="advanced" description="Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages."/>
<property name="username" type="string" display="Username" label="security" secret="true" description="Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."/>
<property name="waitForProvisionCorrelationToBeUpdatedCounter" type="int" display="Wait For Provision Correlation To Be Updated Counter" label="advanced" description="Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled."/>
<property name="waitForProvisionCorrelationToBeUpdatedThreadSleepingTime" type="long" display="Wait For Provision Correlation To Be Updated Thread Sleeping Time" label="advanced" description="Interval in millis to sleep each time while waiting for provisional correlation id to be updated."/>
</endpoint>
<endpoint name="ahc" display="AHC" label="http" extends="model:endpoint" javaType="org.apache.camel.component.ahc.AhcComponent" maven="org.apache.camel:camel-ahc:3.0.0-SNAPSHOT" producerOnly="true" async="true" lenient="true" since="2.8.0" description="To call external HTTP services using Async Http Client.">
<property name="binding" type="java:org.apache.camel.component.ahc.AhcBinding" display="Binding" label="advanced" description="To use a custom AhcBinding which allows to control how to bind between AHC and Camel."/>
<property name="bridgeEndpoint" type="boolean" display="Bridge Endpoint" description="If the option is true, then the Exchange.HTTP_URI header is ignored, and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the AhcProducer send all the fault response back."/>
<property name="bufferSize" type="int" display="Buffer Size" description="The initial in-memory buffer size used when transferring data between Camel and AHC Client."/>
<property name="clientConfig" type="java:org.asynchttpclient.AsyncHttpClientConfig" display="Client Config" label="advanced" description="To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance."/>
<property name="clientConfigOptions" type="map(string,object)" display="Client Config Options" label="advanced" description="To configure the AsyncHttpClientConfig using the key/values from the Map."/>
<property name="clientConfigRealmOptions" type="map(string,object)" display="Client Config Realm Options" label="advanced,security" description="To configure the AsyncHttpClientConfig Realm using the key/values from the Map."/>
<property name="connectionClose" type="boolean" display="Connection Close" label="producer" description="Define if the Connection Close header has to be added to HTTP Request. This parameter is false by default"/>
<property name="cookieHandler" type="java:org.apache.camel.http.common.cookie.CookieHandler" display="Cookie Handler" label="producer" description="Configure a cookie handler to maintain a HTTP session"/>
<property name="headerFilterStrategy" type="java:org.apache.camel.spi.HeaderFilterStrategy" display="Header Filter Strategy" description="To use a custom HeaderFilterStrategy to filter header to and from Camel message."/>
<property name="httpUri" type="java:java.net.URI" display="Http Uri" required="true" kind="path" description="The URI to use such as http://hostname:port/path"/>
<property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="security" description="Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. See Using the JSSE Configuration Utility. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level."/>
<property name="throwExceptionOnFailure" type="boolean" display="Throw Exception On Failure" description="Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code."/>
<property name="transferException" type="boolean" display="Transfer Exception" description="If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type (for example using Jetty or Servlet Camel components). On the producer side the exception will be deserialized and thrown as is, instead of the AhcOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk."/>
</endpoint>
<endpoint name="ahc-ws" display="AHC Websocket" label="websocket" extends="model:endpoint" javaType="org.apache.camel.component.ahc.ws.WsComponent" maven="org.apache.camel:camel-ahc-ws:3.0.0-SNAPSHOT" async="true" since="2.14.0" description="To exchange data with external Websocket servers using Async Http Client.">
<property name="binding" type="java:org.apache.camel.component.ahc.AhcBinding" display="Binding" label="advanced" description="To use a custom AhcBinding which allows to control how to bind between AHC and Camel."/>
<property name="bridgeEndpoint" type="boolean" display="Bridge Endpoint" description="If the option is true, then the Exchange.HTTP_URI header is ignored, and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the AhcProducer send all the fault response back."/>
<property name="bufferSize" type="int" display="Buffer Size" description="The initial in-memory buffer size used when transferring data between Camel and AHC Client."/>
<property name="clientConfig" type="java:org.asynchttpclient.AsyncHttpClientConfig" display="Client Config" label="advanced" description="To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance."/>
<property name="clientConfigOptions" type="map(string,object)" display="Client Config Options" label="advanced" description="To configure the AsyncHttpClientConfig using the key/values from the Map."/>
<property name="clientConfigRealmOptions" type="map(string,object)" display="Client Config Realm Options" label="advanced,security" description="To configure the AsyncHttpClientConfig Realm using the key/values from the Map."/>
<property name="connectionClose" type="boolean" display="Connection Close" label="producer" description="Define if the Connection Close header has to be added to HTTP Request. This parameter is false by default"/>
<property name="cookieHandler" type="java:org.apache.camel.http.common.cookie.CookieHandler" display="Cookie Handler" label="producer" description="Configure a cookie handler to maintain a HTTP session"/>
<property name="headerFilterStrategy" type="java:org.apache.camel.spi.HeaderFilterStrategy" display="Header Filter Strategy" description="To use a custom HeaderFilterStrategy to filter header to and from Camel message."/>
<property name="httpUri" type="java:java.net.URI" display="Http Uri" required="true" kind="path" description="The URI to use such as http://hostname:port/path"/>
<property name="sendMessageOnError" type="boolean" display="Send Message On Error" label="consumer" description="Whether to send an message if the web-socket listener received an error."/>
<property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="security" description="Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. See Using the JSSE Configuration Utility. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level."/>
<property name="throwExceptionOnFailure" type="boolean" display="Throw Exception On Failure" description="Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code."/>
<property name="transferException" type="boolean" display="Transfer Exception" description="If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type (for example using Jetty or Servlet Camel components). On the producer side the exception will be deserialized and thrown as is, instead of the AhcOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk."/>
<property name="useStreaming" type="boolean" display="Use Streaming" label="producer" description="To enable streaming to send data as multiple text fragments."/>
</endpoint>
<endpoint name="ahc-wss" display="AHC Secure Websocket (Secure)" label="websocket" extends="model:endpoint" javaType="org.apache.camel.component.ahc.ws.WsComponent" maven="org.apache.camel:camel-ahc-ws:3.0.0-SNAPSHOT" async="true" since="2.14.0" description="To exchange data with external Websocket servers using Async Http Client.">
<property name="binding" type="java:org.apache.camel.component.ahc.AhcBinding" display="Binding" label="advanced" description="To use a custom AhcBinding which allows to control how to bind between AHC and Camel."/>
<property name="bridgeEndpoint" type="boolean" display="Bridge Endpoint" description="If the option is true, then the Exchange.HTTP_URI header is ignored, and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the AhcProducer send all the fault response back."/>
<property name="bufferSize" type="int" display="Buffer Size" description="The initial in-memory buffer size used when transferring data between Camel and AHC Client."/>
<property name="clientConfig" type="java:org.asynchttpclient.AsyncHttpClientConfig" display="Client Config" label="advanced" description="To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance."/>
<property name="clientConfigOptions" type="map(string,object)" display="Client Config Options" label="advanced" description="To configure the AsyncHttpClientConfig using the key/values from the Map."/>
<property name="clientConfigRealmOptions" type="map(string,object)" display="Client Config Realm Options" label="advanced,security" description="To configure the AsyncHttpClientConfig Realm using the key/values from the Map."/>
<property name="connectionClose" type="boolean" display="Connection Close" label="producer" description="Define if the Connection Close header has to be added to HTTP Request. This parameter is false by default"/>
<property name="cookieHandler" type="java:org.apache.camel.http.common.cookie.CookieHandler" display="Cookie Handler" label="producer" description="Configure a cookie handler to maintain a HTTP session"/>
<property name="headerFilterStrategy" type="java:org.apache.camel.spi.HeaderFilterStrategy" display="Header Filter Strategy" description="To use a custom HeaderFilterStrategy to filter header to and from Camel message."/>
<property name="httpUri" type="java:java.net.URI" display="Http Uri" required="true" kind="path" description="The URI to use such as http://hostname:port/path"/>
<property name="sendMessageOnError" type="boolean" display="Send Message On Error" label="consumer" description="Whether to send an message if the web-socket listener received an error."/>
<property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="security" description="Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. See Using the JSSE Configuration Utility. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level."/>
<property name="throwExceptionOnFailure" type="boolean" display="Throw Exception On Failure" description="Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code."/>
<property name="transferException" type="boolean" display="Transfer Exception" description="If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type (for example using Jetty or Servlet Camel components). On the producer side the exception will be deserialized and thrown as is, instead of the AhcOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk."/>
<property name="useStreaming" type="boolean" display="Use Streaming" label="producer" description="To enable streaming to send data as multiple text fragments."/>
</endpoint>
<endpoint name="amqp" display="AMQP" label="messaging" extends="model:endpoint" javaType="org.apache.camel.component.amqp.AMQPComponent" maven="org.apache.camel:camel-amqp:3.0.0-SNAPSHOT" async="true" since="1.2.0" description="Messaging with AMQP protocol using Apache QPid Client.">
<property name="acceptMessagesWhileStopping" type="boolean" display="Accept Messages While Stopping" label="consumer,advanced" description="Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option, if you start and stop JMS routes at runtime, while there are still messages enqueued on the queue. If this option is false, and you stop the JMS route, then messages may be rejected, and the JMS broker would have to attempt redeliveries, which yet again may be rejected, and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option."/>
<property name="acknowledgementModeName" type="string" display="Acknowledgement Mode Name" label="consumer" description="The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE"/>
<property name="allowAdditionalHeaders" type="string" display="Allow Additional Headers" label="producer,advanced" description="This option is used to allow additional headers which may have values that are invalid according to JMS specification. For example some message systems such as WMQ do this with header names using prefix JMS_IBM_MQMD_ containing values with byte array or other invalid types. You can specify multiple header names separated by comma, and use as suffix for wildcard matching."/>
<property name="allowNullBody" type="boolean" display="Allow Null Body" label="producer,advanced" description="Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown."/>
<property name="allowReplyManagerQuickStop" type="boolean" display="Allow Reply Manager Quick Stop" label="consumer,advanced" description="Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer#runningAllowed() flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping() is enabled, and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag."/>
<property name="allowSerializedHeaders" type="boolean" display="Allow Serialized Headers" label="advanced" description="Controls whether or not to include serialized headers. Applies only when isTransferExchange() is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level."/>
<property name="alwaysCopyMessage" type="boolean" display="Always Copy Message" label="producer,advanced" description="If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set)"/>
<property name="asyncConsumer" type="boolean" display="Async Consumer" label="consumer" description="Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions)."/>
<property name="asyncStartListener" type="boolean" display="Async Start Listener" label="advanced" description="Whether to startup the JmsConsumer message listener asynchronously, when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker, then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true, you will let routes startup, while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used, then beware that if the connection could not be established, then an exception is logged at WARN level, and the consumer will not be able to receive messages; You can then restart the route to retry."/>
<property name="asyncStopListener" type="boolean" display="Async Stop Listener" label="advanced" description="Whether to stop the JmsConsumer message listener asynchronously, when stopping a route."/>
<property name="autoStartup" type="boolean" display="Auto Startup" label="consumer" description="Specifies whether the consumer container should auto-startup."/>
<property name="cacheLevel" type="int" display="Cache Level" label="consumer" description="Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details."/>
<property name="cacheLevelName" type="string" display="Cache Level Name" label="consumer" description="Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information."/>
<property name="clientId" type="string" display="Client Id" description="Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead."/>
<property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="consumer" description="Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."/>
<property name="connectionFactory" type="java:javax.jms.ConnectionFactory" display="Connection Factory" description="Sets the default connection factory to be used if a connection factory is not specified for either setTemplateConnectionFactory(ConnectionFactory) or setListenerConnectionFactory(ConnectionFactory)"/>
<property name="consumerType" type="enum:ConsumerType(Simple,Default,Custom)" display="Consumer Type" label="consumer,advanced" description="The consumer type to use, which can be one of: Simple, Default, or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer, Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified, the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use."/>
<property name="correlationProperty" type="string" display="Correlation Property" label="producer,advanced" description="Use this JMS property to correlate messages in InOut exchange pattern (request-reply) instead of JMSCorrelationID property. This allows you to exchange messages with systems that do not correlate messages using JMSCorrelationID JMS property. If used JMSCorrelationID will not be used or set by Camel. The value of here named property will be generated if not supplied in the header of the message under the same name."/>
<property name="defaultTaskExecutorType" type="enum:DefaultTaskExecutorType(ThreadPool,SimpleAsync)" display="Default Task Executor Type" label="consumer,advanced" description="Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer, for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached threadpool-like). If not set, it defaults to the previous behaviour, which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers."/>
<property name="deliveryMode" type="int" display="Delivery Mode" label="producer" description="Specifies the delivery mode to be used. Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2."/>
<property name="deliveryPersistent" type="boolean" display="Delivery Persistent" label="producer" description="Specifies whether persistent delivery is used by default."/>
<property name="destinationName" type="string" display="Destination Name" required="true" kind="path" description="Name of the queue or topic to use as destination"/>
<property name="destinationResolver" type="java:org.springframework.jms.support.destination.DestinationResolver" display="Destination Resolver" label="advanced" description="A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example, to lookup the real destination in a JNDI registry)."/>
<property name="destinationType" type="string" display="Destination Type" kind="path" description="The kind of destination to use"/>
<property name="disableReplyTo" type="boolean" display="Disable Reply To" description="Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another."/>
<property name="disableTimeToLive" type="boolean" display="Disable Time To Live" label="producer,advanced" description="Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details."/>
<property name="durableSubscriptionName" type="string" display="Durable Subscription Name" description="The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well."/>
<property name="eagerLoadingOfProperties" type="boolean" display="Eager Loading Of Properties" label="consumer,advanced" description="Enables eager loading of JMS properties and payload as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties"/>
<property name="errorHandler" type="java:org.springframework.util.ErrorHandler" display="Error Handler" label="advanced" description="Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level, if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure, than having to code a custom errorHandler."/>
<property name="errorHandlerLogStackTrace" type="boolean" display="Error Handler Log Stack Trace" label="consumer,logging" description="Allows to control whether stacktraces should be logged or not, by the default errorHandler."/>
<property name="errorHandlerLoggingLevel" type="enum:org.apache.camel.LoggingLevel(TRACE,DEBUG,INFO,WARN,ERROR,OFF)" display="Error Handler Logging Level" label="consumer,logging" description="Allows to configure the default errorHandler logging level for logging uncaught exceptions."/>
<property name="exceptionListener" type="java:javax.jms.ExceptionListener" display="Exception Listener" label="advanced" description="Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions."/>
<property name="explicitQosEnabled" type="boolean" display="Explicit Qos Enabled" label="producer" description="Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode, priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option, which operates at message granularity, reading QoS properties exclusively from the Camel In message headers."/>
<property name="exposeListenerSession" type="boolean" display="Expose Listener Session" label="consumer,advanced" description="Specifies whether the listener session should be exposed when consuming messages."/>
<property name="forceSendOriginalMessage" type="boolean" display="Force Send Original Message" label="producer,advanced" description="When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received."/>
<property name="formatDateHeadersToIso8601" type="boolean" display="Format Date Headers To Iso8601" label="producer" description="Sets whether date headers should be formatted according to the ISO 8601 standard."/>
<property name="headerFilterStrategy" type="java:org.apache.camel.spi.HeaderFilterStrategy" display="Header Filter Strategy" label="advanced" description="To use a custom HeaderFilterStrategy to filter header to and from Camel message."/>
<property name="idleConsumerLimit" type="int" display="Idle Consumer Limit" label="advanced" description="Specify the limit for the number of consumers that are allowed to be idle at any given time."/>
<property name="idleTaskExecutionLimit" type="int" display="Idle Task Execution Limit" label="advanced" description="Specifies the limit for idle executions of a receive task, not having received any message within its execution. If this limit is reached, the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring."/>
<property name="includeAllJMSXProperties" type="boolean" display="Include All JMSXProperties" label="advanced" description="Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID, and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply."/>
<property name="includeSentJMSMessageID" type="boolean" display="Include Sent JMSMessage ID" label="producer,advanced" description="Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination."/>
<property name="jmsKeyFormatStrategy" type="string" display="Jms Key Format Strategy" label="advanced" description="Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation."/>
<property name="jmsMessageType" type="enum:JmsMessageType(Bytes,Map,Object,Stream,Text)" display="Jms Message Type" description="Allows you to force the use of a specific javax.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it."/>
<property name="lazyCreateTransactionManager" type="boolean" display="Lazy Create Transaction Manager" label="transaction,advanced" description="If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true."/>
<property name="mapJmsMessage" type="boolean" display="Map Jms Message" label="advanced" description="Specifies whether Camel should auto map the received JMS message to a suited payload type, such as javax.jms.TextMessage to a String etc."/>
<property name="maxConcurrentConsumers" type="int" display="Max Concurrent Consumers" label="consumer" description="Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener."/>
<property name="maxMessagesPerTask" type="int" display="Max Messages Per Task" label="advanced" description="The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max), then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required."/>
<property name="messageConverter" type="java:org.springframework.jms.support.converter.MessageConverter" display="Message Converter" label="advanced" description="To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message."/>
<property name="messageCreatedStrategy" type="java:org.apache.camel.component.jms.MessageCreatedStrategy" display="Message Created Strategy" label="advanced" description="To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message."/>
<property name="messageIdEnabled" type="boolean" display="Message Id Enabled" label="advanced" description="When sending, specifies whether message IDs should be added. This is just an hint to the JMS Broker. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value"/>
<property name="messageListenerContainerFactory" type="java:org.apache.camel.component.jms.MessageListenerContainerFactory" display="Message Listener Container Factory" label="advanced" description="Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom."/>
<property name="messageTimestampEnabled" type="boolean" display="Message Timestamp Enabled" label="advanced" description="Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS Broker. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint, the timestamp must be set to its normal value."/>
<property name="password" type="string" display="Password" label="security" secret="true" description="Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."/>
<property name="preserveMessageQos" type="boolean" display="Preserve Message Qos" label="producer" description="Set to true, if you want to send message using the QoS settings specified on the message, instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority, JMSDeliveryMode, and JMSExpiration. You can provide all or only some of them. If not provided, Camel will fall back to use the values from the endpoint instead. So, when using this option, the headers override the values from the endpoint. The explicitQosEnabled option, by contrast, will only use options set on the endpoint, and not values from the message header."/>
<property name="priority" type="int" display="Priority" label="producer" description="Values greater than 1 specify the message priority when sending (where 0 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect."/>
<property name="pubSubNoLocal" type="boolean" display="Pub Sub No Local" label="advanced" description="Specifies whether to inhibit the delivery of messages published by its own connection."/>
<property name="receiveTimeout" type="long" display="Receive Timeout" label="advanced" description="The timeout for receiving messages (in milliseconds)."/>
<property name="recoveryInterval" type="long" display="Recovery Interval" label="advanced" description="Specifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds."/>
<property name="replyTo" type="string" display="Reply To" label="consumer" description="Provides an explicit ReplyTo destination, which overrides any incoming value of Message.getJMSReplyTo()."/>
<property name="replyToCacheLevelName" type="string" display="Reply To Cache Level Name" label="producer,advanced" description="Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed, and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION."/>
<property name="replyToConcurrentConsumers" type="int" display="Reply To Concurrent Consumers" label="producer" description="Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."/>
<property name="replyToDeliveryPersistent" type="boolean" display="Reply To Delivery Persistent" label="consumer" description="Specifies whether to use persistent delivery by default for replies."/>
<property name="replyToDestinationSelectorName" type="string" display="Reply To Destination Selector Name" label="producer,advanced" description="Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is, if you are not using a temporary reply queue)."/>
<property name="replyToMaxConcurrentConsumers" type="int" display="Reply To Max Concurrent Consumers" label="producer" description="Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads."/>
<property name="replyToOnTimeoutMaxConcurrentConsumers" type="int" display="Reply To On Timeout Max Concurrent Consumers" label="producer" description="Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS."/>
<property name="replyToOverride" type="string" display="Reply To Override" label="producer" description="Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination."/>
<property name="replyToSameDestinationAllowed" type="boolean" display="Reply To Same Destination Allowed" label="consumer,advanced" description="Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself."/>
<property name="replyToType" type="enum:ReplyToType(Temporary,Shared,Exclusive)" display="Reply To Type" label="producer" description="Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary, Shared, or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured, then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details, and especially the notes about the implications if running in a clustered environment, and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive."/>
<property name="requestTimeout" type="long" display="Request Timeout" label="producer" description="The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value, and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option."/>
<property name="requestTimeoutCheckerInterval" type="long" display="Request Timeout Checker Interval" label="advanced" description="Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs, then you can lower this interval, to check more frequently. The timeout is determined by the option requestTimeout."/>
<property name="selector" type="string" display="Selector" label="consumer" description="Sets the JMS selector to use"/>
<property name="streamMessageTypeEnabled" type="boolean" display="Stream Message Type Enabled" label="producer,advanced" description="Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data."/>
<property name="subscriptionDurable" type="boolean" display="Subscription Durable" label="consumer" description="Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well."/>
<property name="subscriptionName" type="string" display="Subscription Name" label="consumer" description="Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0)."/>
<property name="subscriptionShared" type="boolean" display="Subscription Shared" label="consumer" description="Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker."/>
<property name="taskExecutor" type="java:org.springframework.core.task.TaskExecutor" display="Task Executor" label="consumer,advanced" description="Allows you to specify a custom task executor for consuming messages."/>
<property name="testConnectionOnStartup" type="boolean" display="Test Connection On Startup" description="Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well."/>
<property name="timeToLive" type="long" display="Time To Live" label="producer" description="When sending messages, specifies the time-to-live of the message (in milliseconds)."/>
<property name="transacted" type="boolean" display="Transacted" label="transaction" description="Specifies whether to use transacted mode"/>
<property name="transactionManager" type="java:org.springframework.transaction.PlatformTransactionManager" display="Transaction Manager" label="transaction,advanced" description="The Spring transaction manager to use."/>
<property name="transactionName" type="string" display="Transaction Name" label="transaction,advanced" description="The name of the transaction to use."/>
<property name="transactionTimeout" type="int" display="Transaction Timeout" label="transaction,advanced" description="The timeout value of the transaction (in seconds), if using transacted mode."/>
<property name="transferException" type="boolean" display="Transfer Exception" label="advanced" description="If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side, then the caused Exception will be send back in response as a javax.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer."/>
<property name="transferExchange" type="boolean" display="Transfer Exchange" label="advanced" description="You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body, Out body, Fault body, In headers, Out headers, Fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side, so Camel knows the payloads is an Exchange and not a regular payload."/>
<property name="transferFault" type="boolean" display="Transfer Fault" label="advanced" description="If enabled and you are using Request Reply messaging (InOut) and an Exchange failed with a SOAP fault (not exception) on the consumer side, then the fault flag on org.apache.camel.Message#isFault() will be send back in the response as a JMS header with the key JmsConstants#JMS_TRANSFER_FAULT. If the client is Camel, the returned fault flag will be set on the org.apache.camel.Message#setFault(boolean). You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws."/>
<property name="useMessageIDAsCorrelationID" type="boolean" display="Use Message IDAs Correlation ID" label="advanced" description="Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages."/>
<property name="username" type="string" display="Username" label="security" secret="true" description="Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory."/>
<property name="waitForProvisionCorrelationToBeUpdatedCounter" type="int" display="Wait For Provision Correlation To Be Updated Counter" label="advanced" description="Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled."/>
<property name="waitForProvisionCorrelationToBeUpdatedThreadSleepingTime" type="long" display="Wait For Provision Correlation To Be Updated Thread Sleeping Time" label="advanced" description="Interval in millis to sleep each time while waiting for provisional correlation id to be updated."/>
</endpoint>
<endpoint name="apns" display="APNS" label="eventbus,mobile" extends="model:scheduled" javaType="org.apache.camel.component.apns.ApnsComponent" maven="org.apache.camel:camel-apns:3.0.0-SNAPSHOT" since="2.8.0" description="For sending notifications to Apple iOS devices.">
<property name="name" type="string" display="Name" kind="path" description="Name of the endpoint"/>
<property name="tokens" type="string" display="Tokens" description="Configure this property in case you want to statically declare tokens related to devices you want to notify. Tokens are separated by comma."/>
</endpoint>
<endpoint name="as2" display="AS2" label="AS2" extends="model:endpoint" javaType="org.apache.camel.component.as2.AS2Component" maven="org.apache.camel:camel-as2:3.0.0-SNAPSHOT" since="2.22.0" description="Component used for transferring data secure and reliable over the internet using the AS2 protocol.">
<property name="apiName" type="enum:AS2ApiName(CLIENT,SERVER)" display="Api Name" required="true" kind="path" description="What kind of operation to perform"/>
<property name="as2From" type="string" display="As2 From" description="The value of the AS2From header of AS2 message."/>
<property name="as2MessageStructure" type="enum:AS2MessageStructure(PLAIN,SIGNED,ENCRYPTED,SIGNED_ENCRYPTED,PLAIN_COMPRESSED,SIGNED_COMPRESSED,ENCRYPTED_COMPRESSED,ENCRYPTED_COMPRESSED_SIGNED)" display="As2 Message Structure" description="The structure of AS2 Message. One of: PLAIN - No encryption, no signature, SIGNED - No encryption, signature, ENCRYPTED - Encryption, no signature, ENCRYPTED_SIGNED - Encryption, signature"/>
<property name="as2To" type="string" display="As2 To" description="The value of the AS2To header of AS2 message."/>
<property name="as2Version" type="string" display="As2 Version" description="The version of the AS2 protocol."/>
<property name="clientFqdn" type="string" display="Client Fqdn" description="The Client Fully Qualified Domain Name (FQDN). Used in message ids sent by endpoint."/>
<property name="compressionAlgorithm" type="enum:AS2CompressionAlgorithm(ZLIB)" display="Compression Algorithm" description="The algorithm used to compress EDI message."/>
<property name="decryptingPrivateKey" type="java:java.security.PrivateKey" display="Decrypting Private Key" description="The key used to encrypt the EDI message."/>
<property name="dispositionNotificationTo" type="string" display="Disposition Notification To" description="The value of the Disposition-Notification-To header. Assigning a value to this parameter requests a message disposition notification (MDN) for the AS2 message."/>
<property name="ediMessageTransferEncoding" type="string" display="Edi Message Transfer Encoding" description="The transfer encoding of EDI message."/>
<property name="ediMessageType" type="java:org.apache.http.entity.ContentType" display="Edi Message Type" description="The content type of EDI message. One of application/edifact, application/edi-x12, application/edi-consent"/>
<property name="encryptingAlgorithm" type="enum:AS2EncryptionAlgorithm(AES128_CBC,AES192_CBC,AES256_CBC,AES128_CCM,AES192_CCM,AES256_CCM,AES128_GCM,AES192_GCM,AES256_GCM,CAMELLIA128_CBC,CAMELLIA192_CBC,CAMELLIA256_CBC,CAST5_CBC,DES_CBC,DES_EDE3_CBC,GOST28147_GCFB,IDEA_CBC,RC2_CBC,RC4,SEED_CBC)" display="Encrypting Algorithm" description="The algorithm used to encrypt EDI message."/>
<property name="encryptingCertificateChain" type="java:java.security.cert.Certificate[]" display="Encrypting Certificate Chain" description="The chain of certificates used to encrypt EDI message."/>
<property name="from" type="string" display="From" description="The value of the From header of AS2 message."/>
<property name="inBody" type="string" display="In Body" description="Sets the name of a parameter to be passed in the exchange In Body"/>
<property name="mdnMessageTemplate" type="string" display="Mdn Message Template" description="The template used to format MDN message"/>
<property name="methodName" type="string" display="Method Name" required="true" kind="path" description="What sub operation to use for the selected operation"/>
<property name="requestUri" type="string" display="Request Uri" description="The request URI of EDI message."/>
<property name="server" type="string" display="Server" description="The value included in the Server message header identifying the AS2 Server."/>
<property name="serverFqdn" type="string" display="Server Fqdn" description="The Server Fully Qualified Domain Name (FQDN). Used in message ids sent by endpoint."/>
<property name="serverPortNumber" type="int" display="Server Port Number" description="The port number of server."/>
<property name="signedReceiptMicAlgorithms" type="string[]" display="Signed Receipt Mic Algorithms" description="The list of algorithms, in order of preference, requested to generate a message integrity check (MIC) returned in message dispostion notification (MDN)"/>
<property name="signingAlgorithm" type="enum:AS2SignatureAlgorithm(SHA3_224WITHRSA,SHA3_256WITHRSA,SHA3_384withRSA,SHA3_512WITHRSA,MD5WITHRSA,SHA1WITHRSA,MD2WITHRSA,SHA224WITHRSA,SHA256WITHRSA,SHA384WITHRSA,SHA512WITHRSA,RIPEMD128WITHRSA,RIPEMD160WITHRSA,RIPEMD256WITHRSA,SHA224WITHDSA,SHA256WITHDSA,SHA384WITHDSA,SHA512WITHDSA,SHA3_224WITHDSA,SHA3_256WITHDSA,SHA3_384WITHDSA,SHA3_512WITHDSA,SHA1WITHDSA,SHA3_224WITHECDSA,SHA3_256WITHECDSA,SHA3_384WITHECDSA,SHA3_512WITHECDSA,SHA1WITHECDSA,SHA224WITHECDSA,SHA256WITHECDSA,SHA384WITHECDSA,SHA512WITHECDSA,SHA1WITHPLAIN_ECDSA,SHA224WITHPLAIN_ECDSA,SHA256WITHPLAIN_ECDSA,SHA384WITHPLAIN_ECDSA,SHA512WITHPLAIN_ECDSA,RIPEMD160WITHPLAIN_ECDSA,SHA1WITHRSAANDMGF1,SHA224WITHRSAANDMGF1,SHA256WITHRSAANDMGF1,SHA384WITHRSAANDMGF1,SHA512WITHRSAANDMGF1,SHA3_224WITHRSAANDMGF1,SHA3_256WITHRSAANDMGF1,SHA3_384WITHRSAANDMGF1,SHA3_512WITHRSAANDMGF1)" display="Signing Algorithm" description="The algorithm used to sign EDI message."/>
<property name="signingCertificateChain" type="java:java.security.cert.Certificate[]" display="Signing Certificate Chain" description="The chain of certificates used to sign EDI message."/>
<property name="signingPrivateKey" type="java:java.security.PrivateKey" display="Signing Private Key" description="The key used to sign the EDI message."/>
<property name="subject" type="string" display="Subject" description="The value of Subject header of AS2 message."/>
<property name="targetHostname" type="string" display="Target Hostname" description="The host name (IP or DNS name) of target host."/>
<property name="targetPortNumber" type="int" display="Target Port Number" description="The port number of target host. -1 indicates the scheme default port."/>
<property name="userAgent" type="string" display="User Agent" description="The value included in the User-Agent message header identifying the AS2 user agent."/>
</endpoint>
<endpoint name="asterisk" display="Asterisk" label="voip" extends="model:endpoint" javaType="org.apache.camel.component.asterisk.AsteriskComponent" maven="org.apache.camel:camel-asterisk:3.0.0-SNAPSHOT" since="2.18.0" description="The asterisk component is used to interact with Asterisk PBX Server.">
<property name="action" type="enum:AsteriskAction(QUEUE_STATUS,SIP_PEERS,EXTENSION_STATE)" display="Action" label="producer" description="What action to perform such as getting queue status, sip peers or extension state."/>
<property name="hostname" type="string" display="Hostname" required="true" description="The hostname of the asterisk server"/>
<property name="name" type="string" display="Name" required="true" kind="path" description="Logical name"/>
<property name="password" type="string" display="Password" required="true" description="Login password"/>
<property name="username" type="string" display="Username" required="true" description="Login username"/>
</endpoint>
<endpoint name="atmos" display="Atmos" label="file,cloud" extends="model:endpoint" javaType="org.apache.camel.component.atmos.AtmosComponent" maven="org.apache.camel:camel-atmos:3.0.0-SNAPSHOT" since="2.15.0" description="The atmos component is used for integrating with EMC's Atomos Storage.">
<property name="enableSslValidation" type="boolean" display="Enable Ssl Validation" description="Atmos SSL validation"/>
<property name="fullTokenId" type="string" display="Full Token Id" description="Atmos client fullTokenId"/>
<property name="localPath" type="string" display="Local Path" description="Local path to put files"/>
<property name="name" type="string" display="Name" kind="path" description="Atmos name"/>
<property name="newRemotePath" type="string" display="New Remote Path" description="New path on Atmos when moving files"/>
<property name="operation" type="enum:AtmosOperation(put,del,search,get,move)" display="Operation" required="true" kind="path" description="Operation to perform"/>
<property name="query" type="string" display="Query" description="Search query on Atmos"/>
<property name="remotePath" type="string" display="Remote Path" description="Where to put files on Atmos"/>
<property name="secretKey" type="string" display="Secret Key" description="Atmos shared secret"/>
<property name="uri" type="string" display="Uri" description="Atomos server uri"/>
</endpoint>
<endpoint name="atmosphere-websocket" display="Atmosphere Websocket" label="websocket" extends="model:endpoint" javaType="org.apache.camel.component.atmosphere.websocket.AtmosphereWebsocketComponent" maven="org.apache.camel:camel-atmosphere-websocket:3.0.0-SNAPSHOT" since="2.14.0" description="To exchange data with external Websocket clients using Atmosphere.">
<property name="async" type="boolean" display="Async" label="consumer" description="Configure the consumer to work in async mode"/>
<property name="attachmentMultipartBinding" type="boolean" display="Attachment Multipart Binding" label="consumer,advanced" description="Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. The options attachmentMultipartBinding=true and disableStreamCache=false cannot work together. Remove disableStreamCache to use AttachmentMultipartBinding. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's."/>
<property name="chunked" type="boolean" display="Chunked" description="If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response"/>
<property name="disableStreamCache" type="boolean" display="Disable Stream Cache" label="common" description="Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The http/http4 producer will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is as the message body."/>
<property name="eagerCheckContentAvailable" type="boolean" display="Eager Check Content Available" label="consumer,advanced" description="Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data."/>
<property name="fileNameExtWhitelist" type="string" display="File Name Ext Whitelist" label="consumer,advanced" description="Whitelist of accepted filename extensions for accepting uploaded files. Multiple extensions can be separated by comma, such as txt,xml."/>
<property name="headerFilterStrategy" type="java:org.apache.camel.spi.HeaderFilterStrategy" display="Header Filter Strategy" label="common" description="To use a custom HeaderFilterStrategy to filter header to and from Camel message."/>
<property name="httpBinding" type="java:org.apache.camel.http.common.HttpBinding" display="Http Binding" label="common,advanced" description="To use a custom HttpBinding to control the mapping between Camel message and HttpClient."/>
<property name="httpMethodRestrict" type="string" display="Http Method Restrict" label="consumer" description="Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma."/>
<property name="mapHttpMessageBody" type="boolean" display="Map Http Message Body" label="advanced" description="If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping."/>
<property name="mapHttpMessageFormUrlEncodedBody" type="boolean" display="Map Http Message Form Url Encoded Body" label="advanced" description="If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping."/>
<property name="mapHttpMessageHeaders" type="boolean" display="Map Http Message Headers" label="advanced" description="If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping."/>
<property name="matchOnUriPrefix" type="boolean" display="Match On Uri Prefix" label="consumer" description="Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found."/>
<property name="optionsEnabled" type="boolean" display="Options Enabled" label="consumer,advanced" description="Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off."/>
<property name="responseBufferSize" type="int" display="Response Buffer Size" label="consumer" description="To use a custom buffer size on the javax.servlet.ServletResponse."/>
<property name="sendToAll" type="boolean" display="Send To All" description="Whether to send to all (broadcast) or send to a single receiver."/>
<property name="servicePath" type="string" display="Service Path" required="true" kind="path" description="Name of websocket endpoint"/>
<property name="servletName" type="string" display="Servlet Name" label="consumer" description="Name of the servlet to use"/>
<property name="traceEnabled" type="boolean" display="Trace Enabled" label="consumer,advanced" description="Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off."/>
<property name="transferException" type="boolean" display="Transfer Exception" description="If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk."/>
<property name="useStreaming" type="boolean" display="Use Streaming" description="To enable streaming to send data as multiple text fragments."/>
</endpoint>
<endpoint name="atom" display="Atom" label="rss" extends="model:scheduled" javaType="org.apache.camel.component.atom.AtomComponent" maven="org.apache.camel:camel-atom:3.0.0-SNAPSHOT" consumerOnly="true" lenient="true" since="1.2.0" description="The atom component is used for consuming Atom RSS feeds.">
<property name="feedHeader" type="boolean" display="Feed Header" description="Sets whether to add the feed object as a header"/>
<property name="feedUri" type="string" display="Feed Uri" required="true" kind="path" description="The URI to the feed to poll."/>
<property name="filter" type="boolean" display="Filter" description="Sets whether to use filtering or not of the entries."/>
<property name="lastUpdate" type="java:java.util.Date" display="Last Update" description="Sets the timestamp to be used for filtering entries from the atom feeds. This options is only in conjunction with the splitEntries."/>
<property name="password" type="string" display="Password" description="Sets the password to be used for basic authentication when polling from a HTTP feed"/>
<property name="sortEntries" type="boolean" display="Sort Entries" description="Sets whether to sort entries by published date. Only works when splitEntries = true."/>
<property name="splitEntries" type="boolean" display="Split Entries" description="Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message"/>
<property name="throttleEntries" type="boolean" display="Throttle Entries" description="Sets whether all entries identified in a single feed poll should be delivered immediately. If true, only one entry is processed per consumer.delay. Only applicable when splitEntries = true."/>
<property name="username" type="string" display="Username" description="Sets the username to be used for basic authentication when polling from a HTTP feed"/>
</endpoint>
<endpoint name="atomix-map" display="Atomix Map" label="clustering" extends="model:endpoint" javaType="org.apache.camel.component.atomix.client.map.AtomixMapComponent" maven="org.apache.camel:camel-atomix:3.0.0-SNAPSHOT" since="2.20.0" description="The atomix-map component is used to access Atomix's distributed map.">
<property name="atomix" type="java:io.atomix.Atomix" display="Atomix" description="The Atomix instance to use"/>
<property name="configurationUri" type="string" display="Configuration Uri" description="The Atomix configuration uri."/>
<property name="defaultAction" type="java:org.apache.camel.component.atomix.client.map.AtomixMap.Action" display="Default Action" description="The default action."/>
<property name="defaultResourceConfig" type="java:java.util.Properties" display="Default Resource Config" label="advanced" description="The cluster wide default resource configuration."/>
<property name="defaultResourceOptions" type="java:java.util.Properties" display="Default Resource Options" label="advanced" description="The local default resource options."/>
<property name="ephemeral" type="boolean" display="Ephemeral" label="advanced" description="Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored."/>
<property name="key" type="object" display="Key" description="The key to use if none is set in the header or to listen for events for a specific key."/>
<property name="nodes" type="string" display="Nodes" description="The address of the nodes composing the cluster."/>
<property name="readConsistency" type="enum:io.atomix.resource.ReadConsistency(ATOMIC,ATOMIC_LEASE,SEQUENTIAL,LOCAL)" display="Read Consistency" label="advanced" description="The read consistency level."/>
<property name="resourceConfigs" type="map(string,java:java.util.Properties)" display="Resource Configs" label="advanced" description="Cluster wide resources configuration."/>
<property name="resourceName" type="string" display="Resource Name" required="true" kind="path" description="The distributed resource name"/>
<property name="resourceOptions" type="map(string,java:java.util.Properties)" display="Resource Options" label="advanced" description="Local resources configurations"/>
<property name="resultHeader" type="string" display="Result Header" description="The header that wil carry the result."/>
<property name="transport" type="java:io.atomix.catalyst.transport.Transport" display="Transport" description="Sets the Atomix transport."/>
<property name="ttl" type="long" display="Ttl" description="The resource ttl."/>
</endpoint>
<endpoint name="atomix-messaging" display="Atomix Messaging" label="clustering" extends="model:endpoint" javaType="org.apache.camel.component.atomix.client.messaging.AtomixMessagingComponent" maven="org.apache.camel:camel-atomix:3.0.0-SNAPSHOT" since="2.20.0" description="The atomix-messaging component is used to access Atomix's group messaging.">
<property name="atomix" type="java:io.atomix.Atomix" display="Atomix" description="The Atomix instance to use"/>
<property name="broadcastType" type="java:org.apache.camel.component.atomix.client.messaging.AtomixMessaging.BroadcastType" display="Broadcast Type" description="The broadcast type."/>
<property name="channelName" type="string" display="Channel Name" description="The messaging channel name"/>
<property name="configurationUri" type="string" display="Configuration Uri" description="The Atomix configuration uri."/>
<property name="defaultAction" type="java:org.apache.camel.component.atomix.client.messaging.AtomixMessaging.Action" display="Default Action" description="The default action."/>
<property name="defaultResourceConfig" type="java:java.util.Properties" display="Default Resource Config" label="advanced" description="The cluster wide default resource configuration."/>
<property name="defaultResourceOptions" type="java:java.util.Properties" display="Default Resource Options" label="advanced" description="The local default resource options."/>
<property name="ephemeral" type="boolean" display="Ephemeral" label="advanced" description="Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored."/>
<property name="memberName" type="string" display="Member Name" description="The Atomix Group member name"/>
<property name="nodes" type="string" display="Nodes" description="The address of the nodes composing the cluster."/>
<property name="readConsistency" type="enum:io.atomix.resource.ReadConsistency(ATOMIC,ATOMIC_LEASE,SEQUENTIAL,LOCAL)" display="Read Consistency" label="advanced" description="The read consistency level."/>
<property name="resourceConfigs" type="map(string,java:java.util.Properties)" display="Resource Configs" label="advanced" description="Cluster wide resources configuration."/>
<property name="resourceName" type="string" display="Resource Name" required="true" kind="path" description="The distributed resource name"/>
<property name="resourceOptions" type="map(string,java:java.util.Properties)" display="Resource Options" label="advanced" description="Local resources configurations"/>
<property name="resultHeader" type="string" display="Result Header" description="The header that wil carry the result."/>
<property name="transport" type="java:io.atomix.catalyst.transport.Transport" display="Transport" description="Sets the Atomix transport."/>
</endpoint>
<endpoint name="atomix-multimap" display="Atomix MultiMap" label="clustering" extends="model:endpoint" javaType="org.apache.camel.component.atomix.client.multimap.AtomixMultiMapComponent" maven="org.apache.camel:camel-atomix:3.0.0-SNAPSHOT" consumerOnly="true" since="2.20.0" description="The atomix-multimap component is used to access Atomix's distributed multi map.">
<property name="atomix" type="java:io.atomix.Atomix" display="Atomix" description="The Atomix instance to use"/>
<property name="configurationUri" type="string" display="Configuration Uri" description="The Atomix configuration uri."/>
<property name="defaultAction" type="java:org.apache.camel.component.atomix.client.multimap.AtomixMultiMap.Action" display="Default Action" description="The default action."/>
<property name="defaultResourceConfig" type="java:java.util.Properties" display="Default Resource Config" label="advanced" description="The cluster wide default resource configuration."/>
<property name="defaultResourceOptions" type="java:java.util.Properties" display="Default Resource Options" label="advanced" description="The local default resource options."/>
<property name="ephemeral" type="boolean" display="Ephemeral" label="advanced" description="Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored."/>
<property name="key" type="object" display="Key" description="The key to use if none is set in the header or to listen for events for a specific key."/>
<property name="nodes" type="string" display="Nodes" description="The address of the nodes composing the cluster."/>
<property name="readConsistency" type="enum:io.atomix.resource.ReadConsistency(ATOMIC,ATOMIC_LEASE,SEQUENTIAL,LOCAL)" display="Read Consistency" label="advanced" description="The read consistency level."/>
<property name="resourceConfigs" type="map(string,java:java.util.Properties)" display="Resource Configs" label="advanced" description="Cluster wide resources configuration."/>
<property name="resourceName" type="string" display="Resource Name" required="true" kind="path" description="The distributed resource name"/>
<property name="resourceOptions" type="map(string,java:java.util.Properties)" display="Resource Options" label="advanced" description="Local resources configurations"/>
<property name="resultHeader" type="string" display="Result Header" description="The header that wil carry the result."/>
<property name="transport" type="java:io.atomix.catalyst.transport.Transport" display="Transport" description="Sets the Atomix transport."/>
<property name="ttl" type="long" display="Ttl" description="The resource ttl."/>
</endpoint>
<endpoint name="atomix-queue" display="Atomix Queue" label="clustering" extends="model:endpoint" javaType="org.apache.camel.component.atomix.client.queue.AtomixQueueComponent" maven="org.apache.camel:camel-atomix:3.0.0-SNAPSHOT" since="2.20.0" description="The atomix-queue component is used to access Atomix's distributed queue.">
<property name="atomix" type="java:io.atomix.Atomix" display="Atomix" description="The Atomix instance to use"/>
<property name="configurationUri" type="string" display="Configuration Uri" description="The Atomix configuration uri."/>
<property name="defaultAction" type="java:org.apache.camel.component.atomix.client.queue.AtomixQueue.Action" display="Default Action" description="The default action."/>
<property name="defaultResourceConfig" type="java:java.util.Properties" display="Default Resource Config" label="advanced" description="The cluster wide default resource configuration."/>
<property name="defaultResourceOptions" type="java:java.util.Properties" display="Default Resource Options" label="advanced" description="The local default resource options."/>
<property name="ephemeral" type="boolean" display="Ephemeral" label="advanced" description="Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored."/>
<property name="nodes" type="string" display="Nodes" description="The address of the nodes composing the cluster."/>
<property name="readConsistency" type="enum:io.atomix.resource.ReadConsistency(ATOMIC,ATOMIC_LEASE,SEQUENTIAL,LOCAL)" display="Read Consistency" label="advanced" description="The read consistency level."/>
<property name="resourceConfigs" type="map(string,java:java.util.Properties)" display="Resource Configs" label="advanced" description="Cluster wide resources configuration."/>
<property name="resourceName" type="string" display="Resource Name" required="true" kind="path" description="The distributed resource name"/>
<property name="resourceOptions" type="map(string,java:java.util.Properties)" display="Resource Options" label="advanced" description="Local resources configurations"/>
<property name="resultHeader" type="string" display="Result Header" description="The header that wil carry the result."/>
<property name="transport" type="java:io.atomix.catalyst.transport.Transport" display="Transport" description="Sets the Atomix transport."/>
</endpoint>
<endpoint name="atomix-set" display="Atomix Set" label="clustering" extends="model:endpoint" javaType="org.apache.camel.component.atomix.client.set.AtomixSetComponent" maven="org.apache.camel:camel-atomix:3.0.0-SNAPSHOT" since="2.20.0" description="The atomix-set component is used to access Atomix's distributed set.">
<property name="atomix" type="java:io.atomix.Atomix" display="Atomix" description="The Atomix instance to use"/>
<property name="configurationUri" type="string" display="Configuration Uri" description="The Atomix configuration uri."/>
<property name="defaultAction" type="java:org.apache.camel.component.atomix.client.set.AtomixSet.Action" display="Default Action" description="The default action."/>
<property name="defaultResourceConfig" type="java:java.util.Properties" display="Default Resource Config" label="advanced" description="The cluster wide default resource configuration."/>
<property name="defaultResourceOptions" type="java:java.util.Properties" display="Default Resource Options" label="advanced" description="The local default resource options."/>
<property name="ephemeral" type="boolean" display="Ephemeral" label="advanced" description="Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored."/>
<property name="nodes" type="string" display="Nodes" description="The address of the nodes composing the cluster."/>
<property name="readConsistency" type="enum:io.atomix.resource.ReadConsistency(ATOMIC,ATOMIC_LEASE,SEQUENTIAL,LOCAL)" display="Read Consistency" label="advanced" description="The read consistency level."/>
<property name="resourceConfigs" type="map(string,java:java.util.Properties)" display="Resource Configs" label="advanced" description="Cluster wide resources configuration."/>
<property name="resourceName" type="string" display="Resource Name" required="true" kind="path" description="The distributed resource name"/>
<property name="resourceOptions" type="map(string,java:java.util.Properties)" display="Resource Options" label="advanced" description="Local resources configurations"/>
<property name="resultHeader" type="string" display="Result Header" description="The header that wil carry the result."/>
<property name="transport" type="java:io.atomix.catalyst.transport.Transport" display="Transport" description="Sets the Atomix transport."/>
<property name="ttl" type="long" display="Ttl" description="The resource ttl."/>
</endpoint>
<endpoint name="atomix-value" display="Atomix Value" label="clustering" extends="model:endpoint" javaType="org.apache.camel.component.atomix.client.value.AtomixValueComponent" maven="org.apache.camel:camel-atomix:3.0.0-SNAPSHOT" since="2.20.0" description="The atomix-value component is used to access Atomix's distributed value.">
<property name="atomix" type="java:io.atomix.Atomix" display="Atomix" description="The Atomix instance to use"/>
<property name="configurationUri" type="string" display="Configuration Uri" description="The Atomix configuration uri."/>
<property name="defaultAction" type="java:org.apache.camel.component.atomix.client.value.AtomixValue.Action" display="Default Action" description="The default action."/>
<property name="defaultResourceConfig" type="java:java.util.Properties" display="Default Resource Config" label="advanced" description="The cluster wide default resource configuration."/>
<property name="defaultResourceOptions" type="java:java.util.Properties" display="Default Resource Options" label="advanced" description="The local default resource options."/>
<property name="ephemeral" type="boolean" display="Ephemeral" label="advanced" description="Sets if the local member should join groups as PersistentMember or not. If set to ephemeral the local member will receive an auto generated ID thus the local one is ignored."/>
<property name="nodes" type="string" display="Nodes" description="The address of the nodes composing the cluster."/>
<property name="readConsistency" type="enum:io.atomix.resource.ReadConsistency(ATOMIC,ATOMIC_LEASE,SEQUENTIAL,LOCAL)" display="Read Consistency" label="advanced" description="The read consistency level."/>
<property name="resourceConfigs" type="map(string,java:java.util.Properties)" display="Resource Configs" label="advanced" description="Cluster wide resources configuration."/>
<property name="resourceName" type="string" display="Resource Name" required="true" kind="path" description="The distributed resource name"/>
<property name="resourceOptions" type="map(string,java:java.util.Properties)" display="Resource Options" label="advanced" description="Local resources configurations"/>
<property name="resultHeader" type="string" display="Result Header" description="The header that wil carry the result."/>
<property name="transport" type="java:io.atomix.catalyst.transport.Transport" display="Transport" description="Sets the Atomix transport."/>
<property name="ttl" type="long" display="Ttl" description="The resource ttl."/>
</endpoint>
<endpoint name="avro" display="Avro" label="messaging,transformation" extends="model:endpoint" javaType="org.apache.camel.component.avro.AvroComponent" maven="org.apache.camel:camel-avro:3.0.0-SNAPSHOT" async="true" since="2.10.0" description="Working with Apache Avro for data serialization.">
<property name="host" type="string" display="Host" required="true" kind="path" description="Hostname to use"/>
<property name="messageName" type="string" display="Message Name" kind="path" description="The name of the message to send."/>
<property name="port" type="int" display="Port" required="true" kind="path" description="Port number to use"/>
<property name="protocol" type="java:org.apache.avro.Protocol" display="Protocol" description="Avro protocol to use"/>
<property name="protocolClassName" type="string" display="Protocol Class Name" description="Avro protocol to use defined by the FQN class name"/>
<property name="protocolLocation" type="string" display="Protocol Location" description="Avro protocol location"/>
<property name="reflectionProtocol" type="boolean" display="Reflection Protocol" description="If protocol object provided is reflection protocol. Should be used only with protocol parameter because for protocolClassName protocol type will be auto detected"/>
<property name="singleParameter" type="boolean" display="Single Parameter" description="If true, consumer parameter won't be wrapped into array. Will fail if protocol specifies more then 1 parameter for the message"/>
<property name="transport" type="enum:AvroTransport(http,netty)" display="Transport" required="true" kind="path" description="Transport to use, can be either http or netty"/>
<property name="uriAuthority" type="string" display="Uri Authority" description="Authority to use (username and password)"/>
</endpoint>
<endpoint name="aws-cw" display="AWS CloudWatch" label="cloud,monitoring" extends="model:endpoint" javaType="org.apache.camel.component.aws.cw.CwComponent" maven="org.apache.camel:camel-aws-cw:3.0.0-SNAPSHOT" producerOnly="true" since="2.11.0" description="The aws-cw component is used for sending metrics to an Amazon CloudWatch.">
<property name="accessKey" type="string" display="Access Key" label="security" secret="true" description="Amazon AWS Access Key"/>
<property name="amazonCwClient" type="java:com.amazonaws.services.cloudwatch.AmazonCloudWatch" display="Amazon Cw Client" description="To use the AmazonCloudWatch as the client"/>
<property name="name" type="string" display="Name" description="The metric name"/>
<property name="namespace" type="string" display="Namespace" required="true" kind="path" description="The metric namespace"/>
<property name="proxyHost" type="string" display="Proxy Host" description="To define a proxy host when instantiating the CW client"/>
<property name="proxyPort" type="int" display="Proxy Port" description="To define a proxy port when instantiating the CW client"/>
<property name="region" type="string" display="Region" description="The region in which CW client needs to work"/>
<property name="secretKey" type="string" display="Secret Key" label="security" secret="true" description="Amazon AWS Secret Key"/>
<property name="timestamp" type="java:java.util.Date" display="Timestamp" description="The metric timestamp"/>
<property name="unit" type="string" display="Unit" description="The metric unit"/>
<property name="value" type="double" display="Value" description="The metric value"/>
</endpoint>
<endpoint name="aws-ddb" display="AWS DynamoDB" label="cloud,database,nosql" extends="model:endpoint" javaType="org.apache.camel.component.aws.ddb.DdbComponent" maven="org.apache.camel:camel-aws-ddb:3.0.0-SNAPSHOT" producerOnly="true" since="2.10.0" description="The aws-ddb component is used for storing and retrieving data from Amazon's DynamoDB service.">
<property name="accessKey" type="string" display="Access Key" label="security" secret="true" description="Amazon AWS Access Key"/>
<property name="amazonDDBClient" type="java:com.amazonaws.services.dynamodbv2.AmazonDynamoDB" display="Amazon DDBClient" description="To use the AmazonDynamoDB as the client"/>
<property name="consistentRead" type="boolean" display="Consistent Read" description="Determines whether or not strong consistency should be enforced when data is read."/>
<property name="keyAttributeName" type="string" display="Key Attribute Name" description="Attribute name when creating table"/>
<property name="keyAttributeType" type="string" display="Key Attribute Type" description="Attribute type when creating table"/>
<property name="operation" type="enum:DdbOperations(BatchGetItems,DeleteItem,DeleteTable,DescribeTable,GetItem,PutItem,Query,Scan,UpdateItem,UpdateTable)" display="Operation" description="What operation to perform"/>
<property name="proxyHost" type="string" display="Proxy Host" description="To define a proxy host when instantiating the DDB client"/>
<property name="proxyPort" type="int" display="Proxy Port" description="To define a proxy port when instantiating the DDB client"/>
<property name="readCapacity" type="long" display="Read Capacity" description="The provisioned throughput to reserve for reading resources from your table"/>
<property name="region" type="string" display="Region" description="The region in which DDB client needs to work"/>
<property name="secretKey" type="string" display="Secret Key" label="security" secret="true" description="Amazon AWS Secret Key"/>
<property name="tableName" type="string" display="Table Name" required="true" kind="path" description="The name of the table currently worked with."/>
<property name="writeCapacity" type="long" display="Write Capacity" description="The provisioned throughput to reserved for writing resources to your table"/>
</endpoint>
<endpoint name="aws-ddbstream" display="AWS DynamoDB Streams" label="cloud,messaging,streams" extends="model:scheduled" javaType="org.apache.camel.component.aws.ddbstream.DdbStreamComponent" maven="org.apache.camel:camel-aws-ddb:3.0.0-SNAPSHOT" consumerOnly="true" since="2.17.0" description="The aws-ddbstream component is used for working with Amazon DynamoDB Streams.">
<property name="accessKey" type="string" display="Access Key" label="security" secret="true" description="Amazon AWS Access Key"/>
<property name="amazonDynamoDbStreamsClient" type="java:com.amazonaws.services.dynamodbv2.AmazonDynamoDBStreams" display="Amazon Dynamo Db Streams Client" label="consumer" description="Amazon DynamoDB client to use for all requests for this endpoint"/>
<property name="iteratorType" type="enum:com.amazonaws.services.dynamodbv2.model.ShardIteratorType(TRIM_HORIZON,LATEST,AT_SEQUENCE_NUMBER,AFTER_SEQUENCE_NUMBER)" display="Iterator Type" label="consumer" description="Defines where in the DynaboDB stream to start getting records. Note that using TRIM_HORIZON can cause a significant delay before the stream has caught up to real-time. if {AT,AFTER}_SEQUENCE_NUMBER are used, then a sequenceNumberProvider MUST be supplied."/>
<property name="maxResultsPerRequest" type="int" display="Max Results Per Request" label="consumer" description="Maximum number of records that will be fetched in each poll"/>
<property name="proxyHost" type="string" display="Proxy Host" description="To define a proxy host when instantiating the DDBStreams client"/>
<property name="proxyPort" type="int" display="Proxy Port" description="To define a proxy port when instantiating the DDBStreams client"/>
<property name="region" type="string" display="Region" description="The region in which DDBStreams client needs to work"/>
<property name="secretKey" type="string" display="Secret Key" label="security" secret="true" description="Amazon AWS Secret Key"/>
<property name="sequenceNumberProvider" type="java:org.apache.camel.component.aws.ddbstream.SequenceNumberProvider" display="Sequence Number Provider" label="consumer" description="Provider for the sequence number when using one of the two ShardIteratorType.{AT,AFTER}_SEQUENCE_NUMBER iterator types. Can be a registry reference or a literal sequence number."/>
<property name="tableName" type="string" display="Table Name" label="consumer" required="true" kind="path" description="Name of the dynamodb table"/>
</endpoint>
<endpoint name="aws-ec2" display="AWS EC2" label="cloud,management" extends="model:endpoint" javaType="org.apache.camel.component.aws.ec2.EC2Component" maven="org.apache.camel:camel-aws-ec2:3.0.0-SNAPSHOT" producerOnly="true" since="2.16.0" description="The aws-ec2 is used for managing Amazon EC2 instances.">
<property name="accessKey" type="string" display="Access Key" label="producer" secret="true" description="Amazon AWS Access Key"/>
<property name="amazonEc2Client" type="java:com.amazonaws.services.ec2.AmazonEC2" display="Amazon Ec2 Client" label="producer" description="To use a existing configured AmazonEC2Client as client"/>
<property name="label" type="string" display="Label" required="true" kind="path" description="Logical name"/>
<property name="operation" type="enum:EC2Operations(createAndRunInstances,startInstances,stopInstances,terminateInstances,describeInstances,describeInstancesStatus,rebootInstances,monitorInstances,unmonitorInstances,createTags,deleteTags)" display="Operation" label="producer" required="true" description="The operation to perform. It can be createAndRunInstances, startInstances, stopInstances, terminateInstances, describeInstances, describeInstancesStatus, rebootInstances, monitorInstances, unmonitorInstances, createTags or deleteTags"/>
<property name="proxyHost" type="string" display="Proxy Host" label="producer" description="To define a proxy host when instantiating the EC2 client"/>
<property name="proxyPort" type="int" display="Proxy Port" label="producer" description="To define a proxy port when instantiating the EC2 client"/>
<property name="region" type="string" display="Region" description="The region in which EC2 client needs to work"/>
<property name="secretKey" type="string" display="Secret Key" label="producer" secret="true" description="Amazon AWS Secret Key"/>
</endpoint>
<endpoint name="aws-ecs" display="AWS ECS" label="cloud,management" extends="model:endpoint" javaType="org.apache.camel.component.aws.ecs.ECSComponent" maven="org.apache.camel:camel-aws-ecs:3.0.0-SNAPSHOT" producerOnly="true" since="3.0.0" description="The aws-kms is used for managing Amazon ECS">
<property name="accessKey" type="string" display="Access Key" label="producer" secret="true" description="Amazon AWS Access Key"/>
<property name="ecsClient" type="java:com.amazonaws.services.ecs.AmazonECS" display="Ecs Client" label="producer" description="To use a existing configured AWS ECS as client"/>
<property name="label" type="string" display="Label" required="true" kind="path" description="Logical name"/>
<property name="operation" type="enum:ECSOperations(listClusters,describeCluster,createCluster,deleteCluster)" display="Operation" label="producer" required="true" description="The operation to perform"/>
<property name="proxyHost" type="string" display="Proxy Host" label="producer" description="To define a proxy host when instantiating the ECS client"/>
<property name="proxyPort" type="int" display="Proxy Port" label="producer" description="To define a proxy port when instantiating the ECS client"/>
<property name="region" type="string" display="Region" description="The region in which ECS client needs to work"/>
<property name="secretKey" type="string" display="Secret Key" label="producer" secret="true" description="Amazon AWS Secret Key"/>
</endpoint>
<endpoint name="aws-eks" display="AWS EKS" label="cloud,management" extends="model:endpoint" javaType="org.apache.camel.component.aws.eks.EKSComponent" maven="org.apache.camel:camel-aws-eks:3.0.0-SNAPSHOT" producerOnly="true" since="3.0.0" description="The aws-kms is used for managing Amazon EKS">
<property name="accessKey" type="string" display="Access Key" label="producer" secret="true" description="Amazon AWS Access Key"/>
<property name="eksClient" type="java:com.amazonaws.services.eks.AmazonEKS" display="Eks Client" label="producer" description="To use a existing configured AWS EKS as client"/>
<property name="label" type="string" display="Label" required="true" kind="path" description="Logical name"/>
<property name="operation" type="enum:EKSOperations(listClusters,describeCluster,createCluster,deleteCluster)" display="Operation" label="producer" required="true" description="The operation to perform"/>
<property name="proxyHost" type="string" display="Proxy Host" label="producer" description="To define a proxy host when instantiating the EKS client"/>
<property name="proxyPort" type="int" display="Proxy Port" label="producer" description="To define a proxy port when instantiating the EKS client"/>
<property name="region" type="string" display="Region" description="The region in which EKS client needs to work"/>
<property name="secretKey" type="string" display="Secret Key" label="producer" secret="true" description="Amazon AWS Secret Key"/>
</endpoint>
<endpoint name="aws-iam" display="AWS IAM" label="cloud,management" extends="model:endpoint" javaType="org.apache.camel.component.aws.iam.IAMComponent" maven="org.apache.camel:camel-aws-iam:3.0.0-SNAPSHOT" producerOnly="true" since="2.23.0" description="The aws-iam is used for managing Amazon IAM">
<property name="accessKey" type="string" display="Access Key" label="producer" secret="true" description="Amazon AWS Access Key"/>
<property name="iamClient" type="java:com.amazonaws.services.identitymanagement.AmazonIdentityManagement" display="Iam Client" label="producer" description="To use a existing configured AWS IAM as client"/>
<property name="label" type="string" display="Label" required="true" kind="path" description="Logical name"/>
<property name="operation" type="enum:IAMOperations(listAccessKeys,createUser,deleteUser,getUser,listUsers,createAccessKey,deleteAccessKey,updateAccessKey,createGroup,deleteGroup,listGroups,addUserToGroup,removeUserFromGroup)" display="Operation" label="producer" required="true" description="The operation to perform"/>
<property name="proxyHost" type="string" display="Proxy Host" label="producer" description="To define a proxy host when instantiating the IAM client"/>
<property name="proxyPort" type="int" display="Proxy Port" label="producer" description="To define a proxy port when instantiating the IAM client"/>
<property name="region" type="string" display="Region" description="The region in which IAM client needs to work"/>
<property name="secretKey" type="string" display="Secret Key" label="producer" secret="true" description="Amazon AWS Secret Key"/>
</endpoint>
<endpoint name="aws-kinesis" display="AWS Kinesis" label="cloud,messaging" extends="model:scheduled" javaType="org.apache.camel.component.aws.kinesis.KinesisComponent" maven="org.apache.camel:camel-aws-kinesis:3.0.0-SNAPSHOT" since="2.17.0" description="The aws-kinesis component is for consuming and producing records from Amazon Kinesis Streams.">
<property name="accessKey" type="string" display="Access Key" label="security" secret="true" description="Amazon AWS Access Key"/>
<property name="amazonKinesisClient" type="java:com.amazonaws.services.kinesis.AmazonKinesis" display="Amazon Kinesis Client" description="Amazon Kinesis client to use for all requests for this endpoint"/>
<property name="iteratorType" type="enum:com.amazonaws.services.kinesis.model.ShardIteratorType(AT_SEQUENCE_NUMBER,AFTER_SEQUENCE_NUMBER,TRIM_HORIZON,LATEST,AT_TIMESTAMP)" display="Iterator Type" label="consumer" description="Defines where in the Kinesis stream to start getting records"/>
<property name="maxResultsPerRequest" type="int" display="Max Results Per Request" label="consumer" description="Maximum number of records that will be fetched in each poll"/>
<property name="proxyHost" type="string" display="Proxy Host" description="To define a proxy host when instantiating the DDBStreams client"/>
<property name="proxyPort" type="int" display="Proxy Port" description="To define a proxy port when instantiating the DDBStreams client"/>
<property name="region" type="string" display="Region" description="The region in which Kinesis client needs to work"/>
<property name="secretKey" type="string" display="Secret Key" label="security" secret="true" description="Amazon AWS Secret Key"/>
<property name="sequenceNumber" type="string" display="Sequence Number" label="consumer" description="The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER"/>
<property name="shardClosed" type="enum:KinesisShardClosedStrategyEnum(ignore,fail,silent)" display="Shard Closed" label="consumer" description="Define what will be the behavior in case of shard closed. Possible value are ignore, silent and fail. In case of ignore a message will be logged and the consumer will restart from the beginning,in case of silent there will be no logging and the consumer will start from the beginning,in case of fail a ReachedClosedStateException will be raised"/>
<property name="shardId" type="string" display="Shard Id" label="consumer" description="Defines which shardId in the Kinesis stream to get records from"/>
<property name="streamName" type="string" display="Stream Name" required="true" kind="path" description="Name of the stream"/>
</endpoint>
<endpoint name="aws-kinesis-firehose" display="AWS Kinesis Firehose" label="cloud,messaging" extends="model:endpoint" javaType="org.apache.camel.component.aws.firehose.KinesisFirehoseComponent" maven="org.apache.camel:camel-aws-kinesis:3.0.0-SNAPSHOT" producerOnly="true" since="2.19.0" description="The aws-kinesis-firehose component is used for producing Amazon's Kinesis Firehose streams.">
<property name="accessKey" type="string" display="Access Key" label="security" secret="true" description="Amazon AWS Access Key"/>
<property name="amazonKinesisFirehoseClient" type="java:com.amazonaws.services.kinesisfirehose.AmazonKinesisFirehose" display="Amazon Kinesis Firehose Client" description="Amazon Kinesis Firehose client to use for all requests for this endpoint"/>