Created
July 24, 2019 14:32
-
-
Save gnodet/75457febcca9a893c3c1a2b8499189b2 to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?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<? 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<? 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"/> | |
| <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="streamName" type="string" display="Stream Name" required="true" kind="path" description="Name of the stream"/> | |
| </endpoint> | |
| <endpoint name="aws-kms" display="AWS KMS" label="cloud,management" extends="model:endpoint" javaType="org.apache.camel.component.aws.kms.KMSComponent" maven="org.apache.camel:camel-aws-kms:3.0.0-SNAPSHOT" producerOnly="true" since="2.21.0" description="The aws-kms is used for managing Amazon KMS"> | |
| <property name="accessKey" type="string" display="Access Key" label="producer" secret="true" description="Amazon AWS Access Key"/> | |
| <property name="kmsClient" type="java:com.amazonaws.services.kms.AWSKMS" display="Kms Client" label="producer" description="To use a existing configured AWS KMS as client"/> | |
| <property name="label" type="string" display="Label" required="true" kind="path" description="Logical name"/> | |
| <property name="operation" type="enum:KMSOperations(listKeys,createKey,disableKey,scheduleKeyDeletion,describeKey,enableKey)" 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 KMS client"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" label="producer" description="To define a proxy port when instantiating the KMS client"/> | |
| <property name="region" type="string" display="Region" description="The region in which KMS 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-lambda" display="AWS Lambda" label="cloud,computing,serverless" extends="model:endpoint" javaType="org.apache.camel.component.aws.lambda.LambdaComponent" maven="org.apache.camel:camel-aws-lambda:3.0.0-SNAPSHOT" producerOnly="true" since="2.20.0" description="The aws-lambda is used for managing and invoking functions from Amazon Lambda."> | |
| <property name="accessKey" type="string" display="Access Key" label="security" secret="true" description="Amazon AWS Access Key"/> | |
| <property name="awsLambdaClient" type="java:com.amazonaws.services.lambda.AWSLambda" display="Aws Lambda Client" label="advanced" description="To use a existing configured AwsLambdaClient as client"/> | |
| <property name="function" type="string" display="Function" required="true" kind="path" description="Name of the Lambda function."/> | |
| <property name="operation" type="enum:LambdaOperations(listFunctions,getFunction,createFunction,deleteFunction,invokeFunction,updateFunction,createEventSourceMapping,deleteEventSourceMapping,listEventSourceMapping,listTags,tagResource,untagResource,publishVersion,listVersions)" display="Operation" required="true" description="The operation to perform. It can be listFunctions, getFunction, createFunction, deleteFunction or invokeFunction"/> | |
| <property name="proxyHost" type="string" display="Proxy Host" label="proxy" description="To define a proxy host when instantiating the Lambda client"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" label="proxy" description="To define a proxy port when instantiating the Lambda client"/> | |
| <property name="region" type="string" display="Region" label="producer" description="Amazon AWS Region"/> | |
| <property name="secretKey" type="string" display="Secret Key" label="security" secret="true" description="Amazon AWS Secret Key"/> | |
| </endpoint> | |
| <endpoint name="aws-mq" display="AWS MQ" label="cloud,management" extends="model:endpoint" javaType="org.apache.camel.component.aws.mq.MQComponent" maven="org.apache.camel:camel-aws-mq:3.0.0-SNAPSHOT" producerOnly="true" since="2.21.0" description="The aws-mq is used for managing Amazon MQ instances."> | |
| <property name="accessKey" type="string" display="Access Key" label="producer" secret="true" description="Amazon AWS Access Key"/> | |
| <property name="amazonMqClient" type="java:com.amazonaws.services.mq.AmazonMQ" display="Amazon Mq Client" label="producer" description="To use a existing configured AmazonMQClient as client"/> | |
| <property name="label" type="string" display="Label" required="true" kind="path" description="Logical name"/> | |
| <property name="operation" type="enum:MQOperations(listBrokers,createBroker,deleteBroker,rebootBroker,updateBroker,describeBroker)" display="Operation" label="producer" required="true" description="The operation to perform. It can be listBrokers,createBroker,deleteBroker"/> | |
| <property name="proxyHost" type="string" display="Proxy Host" label="producer" description="To define a proxy host when instantiating the MQ client"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" label="producer" description="To define a proxy port when instantiating the MQ client"/> | |
| <property name="region" type="string" display="Region" description="The region in which MQ 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-msk" display="AWS MSK" label="cloud,management" extends="model:endpoint" javaType="org.apache.camel.component.aws.msk.MSKComponent" maven="org.apache.camel:camel-aws-msk:3.0.0-SNAPSHOT" producerOnly="true" since="3.0.0" description="The aws-kms is used for managing Amazon KMS"> | |
| <property name="accessKey" type="string" display="Access Key" label="producer" secret="true" description="Amazon AWS Access Key"/> | |
| <property name="label" type="string" display="Label" required="true" kind="path" description="Logical name"/> | |
| <property name="mskClient" type="java:com.amazonaws.services.kafka.AWSKafka" display="Msk Client" label="producer" description="To use a existing configured AWS MSK as client"/> | |
| <property name="operation" type="enum:MSKOperations(listClusters,createCluster,deleteCluster,describeCluster)" 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 MSK client"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" label="producer" description="To define a proxy port when instantiating the MSK client"/> | |
| <property name="region" type="string" display="Region" description="The region in which MSK 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-s3" display="AWS S3 Storage Service" label="cloud,file" extends="model:scheduled" javaType="org.apache.camel.component.aws.s3.S3Component" maven="org.apache.camel:camel-aws-s3:3.0.0-SNAPSHOT" since="2.8.0" description="The aws-s3 component is used for storing and retrieving objecct from Amazon S3 Storage Service."> | |
| <property name="accelerateModeEnabled" type="boolean" display="Accelerate Mode Enabled" label="common, advanced" description="Define if Accelerate Mode enabled is true or false"/> | |
| <property name="accessKey" type="string" display="Access Key" label="security" secret="true" description="Amazon AWS Access Key"/> | |
| <property name="amazonS3Client" type="java:com.amazonaws.services.s3.AmazonS3" display="Amazon S3 Client" description="Reference to a com.amazonaws.services.s3.AmazonS3 in the registry."/> | |
| <property name="autoCreateBucket" type="boolean" display="Auto Create Bucket" label="common" description="Setting the autocreation of the bucket"/> | |
| <property name="autocloseBody" type="boolean" display="Autoclose Body" label="consumer,advanced" description="If this option is true and includeBody is true, then the S3Object.close() method will be called on exchange completion. This option is strongly related to includeBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically."/> | |
| <property name="awsKMSKeyId" type="string" display="Aws KMSKey Id" label="producer,advanced" description="Define the id of KMS key to use in case KMS is enabled"/> | |
| <property name="bucketNameOrArn" type="string" display="Bucket Name Or Arn" required="true" kind="path" description="Bucket name or ARN"/> | |
| <property name="chunkedEncodingDisabled" type="boolean" display="Chunked Encoding Disabled" label="common, advanced" description="Define if disabled Chunked Encoding is true or false"/> | |
| <property name="deleteAfterRead" type="boolean" display="Delete After Read" label="consumer" description="Delete objects from S3 after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the S3Constants#BUCKET_NAME and S3Constants#KEY headers, or only the S3Constants#KEY header."/> | |
| <property name="deleteAfterWrite" type="boolean" display="Delete After Write" label="producer" description="Delete file object after the S3 file has been uploaded"/> | |
| <property name="delimiter" type="string" display="Delimiter" label="consumer" description="The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in."/> | |
| <property name="dualstackEnabled" type="boolean" display="Dualstack Enabled" label="common, advanced" description="Define if Dualstack enabled is true or false"/> | |
| <property name="encryptionMaterials" type="java:com.amazonaws.services.s3.model.EncryptionMaterials" display="Encryption Materials" label="common,advanced" description="The encryption materials to use in case of Symmetric/Asymmetric client usage"/> | |
| <property name="fileName" type="string" display="File Name" label="consumer" description="To get the object from the bucket with the given file name"/> | |
| <property name="forceGlobalBucketAccessEnabled" type="boolean" display="Force Global Bucket Access Enabled" label="common, advanced" description="Define if Force Global Bucket Access enabled is true or false"/> | |
| <property name="includeBody" type="boolean" display="Include Body" label="consumer" description="If it is true, the exchange body will be set to a stream to the contents of the file. If false, the headers will be set with the S3 object metadata, but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically."/> | |
| <property name="keyName" type="string" display="Key Name" label="producer" description="Setting the key name for an element in the bucket through endpoint parameter"/> | |
| <property name="maxConnections" type="int" display="Max Connections" label="consumer" description="Set the maxConnections parameter in the S3 client configuration"/> | |
| <property name="maxMessagesPerPoll" type="int" display="Max Messages Per Poll" label="consumer" description="Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited."/> | |
| <property name="multiPartUpload" type="boolean" display="Multi Part Upload" label="producer" description="If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize"/> | |
| <property name="operation" type="enum:S3Operations(copyObject,deleteBucket,listBuckets,downloadLink)" display="Operation" label="producer" description="The operation to do in case the user don't want to do only an upload"/> | |
| <property name="partSize" type="long" display="Part Size" label="producer" description="Setup the partSize which is used in multi part upload, the default size is 25M."/> | |
| <property name="pathStyleAccess" type="boolean" display="Path Style Access" description="Whether or not the S3 client should use path style access"/> | |
| <property name="payloadSigningEnabled" type="boolean" display="Payload Signing Enabled" label="common, advanced" description="Define if Payload Signing enabled is true or false"/> | |
| <property name="policy" type="string" display="Policy" description="The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method."/> | |
| <property name="prefix" type="string" display="Prefix" label="consumer" description="The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in."/> | |
| <property name="proxyHost" type="string" display="Proxy Host" description="To define a proxy host when instantiating the SQS client"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" description="Specify a proxy port to be used inside the client definition."/> | |
| <property name="region" type="string" display="Region" description="The region in which S3 client needs to work"/> | |
| <property name="secretKey" type="string" display="Secret Key" label="security" secret="true" description="Amazon AWS Secret Key"/> | |
| <property name="serverSideEncryption" type="string" display="Server Side Encryption" label="producer" description="Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256."/> | |
| <property name="storageClass" type="string" display="Storage Class" label="producer" description="The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request."/> | |
| <property name="useAwsKMS" type="boolean" display="Use Aws KMS" label="producer,advanced" description="Define if KMS must be used or not"/> | |
| <property name="useEncryption" type="boolean" display="Use Encryption" label="common,advanced" description="Define if encryption must be used or not"/> | |
| <property name="useIAMCredentials" type="boolean" display="Use IAMCredentials" description="Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in."/> | |
| </endpoint> | |
| <endpoint name="aws-sdb" display="AWS SimpleDB" label="cloud,database,nosql" extends="model:endpoint" javaType="org.apache.camel.component.aws.sdb.SdbComponent" maven="org.apache.camel:camel-aws-sdb:3.0.0-SNAPSHOT" producerOnly="true" since="2.9.0" description="The aws-sdb component is for storing and retrieving data from/to Amazon's SDB service."> | |
| <property name="accessKey" type="string" display="Access Key" description="Amazon AWS Access Key"/> | |
| <property name="amazonSDBClient" type="java:com.amazonaws.services.simpledb.AmazonSimpleDB" display="Amazon SDBClient" description="To use the AmazonSimpleDB 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="domainName" type="string" display="Domain Name" required="true" kind="path" description="The name of the domain currently worked with."/> | |
| <property name="maxNumberOfDomains" type="int" display="Max Number Of Domains" description="The maximum number of domain names you want returned. The range is 1 to 100."/> | |
| <property name="operation" type="enum:SdbOperations(BatchDeleteAttributes,BatchPutAttributes,DeleteAttributes,DeleteDomain,DomainMetadata,GetAttributes,ListDomains,PutAttributes,Select)" display="Operation" description="Operation to perform"/> | |
| <property name="proxyHost" type="string" display="Proxy Host" description="To define a proxy host when instantiating the SDB client"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" description="To define a proxy port when instantiating the SDB client"/> | |
| <property name="region" type="string" display="Region" description="The region in which SDB client needs to work"/> | |
| <property name="secretKey" type="string" display="Secret Key" description="Amazon AWS Secret Key"/> | |
| </endpoint> | |
| <endpoint name="aws-ses" display="AWS Simple Email Service" label="cloud,mail" extends="model:endpoint" javaType="org.apache.camel.component.aws.ses.SesComponent" maven="org.apache.camel:camel-aws-ses:3.0.0-SNAPSHOT" producerOnly="true" since="2.9.0" description="The aws-ses component is used for sending emails with Amazon's SES service."> | |
| <property name="accessKey" type="string" display="Access Key" label="security" secret="true" description="Amazon AWS Access Key"/> | |
| <property name="amazonSESClient" type="java:com.amazonaws.services.simpleemail.AmazonSimpleEmailService" display="Amazon SESClient" description="To use the AmazonSimpleEmailService as the client"/> | |
| <property name="from" type="string" display="From" required="true" kind="path" description="The sender's email address."/> | |
| <property name="proxyHost" type="string" display="Proxy Host" description="To define a proxy host when instantiating the SES client"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" description="To define a proxy port when instantiating the SES client"/> | |
| <property name="region" type="string" display="Region" description="The region in which SES client needs to work"/> | |
| <property name="replyToAddresses" type="list(string)" display="Reply To Addresses" description="List of reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header."/> | |
| <property name="returnPath" type="string" display="Return Path" description="The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header."/> | |
| <property name="secretKey" type="string" display="Secret Key" label="security" secret="true" description="Amazon AWS Secret Key"/> | |
| <property name="subject" type="string" display="Subject" description="The subject which is used if the message header 'CamelAwsSesSubject' is not present."/> | |
| <property name="to" type="list(string)" display="To" description="List of destination email address. Can be overriden with 'CamelAwsSesTo' header."/> | |
| </endpoint> | |
| <endpoint name="aws-sns" display="AWS Simple Notification System" label="cloud,mobile,messaging" extends="model:endpoint" javaType="org.apache.camel.component.aws.sns.SnsComponent" maven="org.apache.camel:camel-aws-sns:3.0.0-SNAPSHOT" producerOnly="true" since="2.8.0" description="The aws-sns component is used for sending messages to an Amazon Simple Notification Topic."> | |
| <property name="accessKey" type="string" display="Access Key" label="security" secret="true" description="Amazon AWS Access Key"/> | |
| <property name="amazonSNSClient" type="java:com.amazonaws.services.sns.AmazonSNS" display="Amazon SNSClient" description="To use the AmazonSNS as the client"/> | |
| <property name="amazonSQSClient" type="java:com.amazonaws.services.sqs.AmazonSQS" display="Amazon SQSClient" description="An SQS Client to use as bridge between SNS and SQS"/> | |
| <property name="autoCreateTopic" type="boolean" display="Auto Create Topic" description="Setting the autocreation of the topic"/> | |
| <property name="headerFilterStrategy" type="java:org.apache.camel.spi.HeaderFilterStrategy" display="Header Filter Strategy" description="To use a custom HeaderFilterStrategy to map headers to/from Camel."/> | |
| <property name="kmsMasterKeyId" type="string" display="Kms Master Key Id" description="The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK."/> | |
| <property name="messageStructure" type="string" display="Message Structure" description="The message structure to use such as json"/> | |
| <property name="policy" type="string" display="Policy" description="The policy for this queue"/> | |
| <property name="proxyHost" type="string" display="Proxy Host" description="To define a proxy host when instantiating the SNS client"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" description="To define a proxy port when instantiating the SNS client"/> | |
| <property name="queueUrl" type="string" display="Queue Url" description="The queueUrl to subscribe to"/> | |
| <property name="region" type="string" display="Region" description="The region in which SNS client needs to work"/> | |
| <property name="secretKey" type="string" display="Secret Key" label="security" secret="true" description="Amazon AWS Secret Key"/> | |
| <property name="serverSideEncryptionEnabled" type="boolean" display="Server Side Encryption Enabled" description="Define if Server Side Encryption is enabled or not on the topic"/> | |
| <property name="subject" type="string" display="Subject" description="The subject which is used if the message header 'CamelAwsSnsSubject' is not present."/> | |
| <property name="subscribeSNStoSQS" type="boolean" display="Subscribe SNSto SQS" description="Define if the subscription between SNS Topic and SQS must be done or not"/> | |
| <property name="topicNameOrArn" type="string" display="Topic Name Or Arn" required="true" kind="path" description="Topic name or ARN"/> | |
| </endpoint> | |
| <endpoint name="aws-sqs" display="AWS Simple Queue Service" label="cloud,messaging" extends="model:scheduled" javaType="org.apache.camel.component.aws.sqs.SqsComponent" maven="org.apache.camel:camel-aws-sqs:3.0.0-SNAPSHOT" since="2.6.0" description="The aws-sqs component is used for sending and receiving messages to Amazon's SQS service."> | |
| <property name="accessKey" type="string" display="Access Key" label="security" secret="true" description="Amazon AWS Access Key"/> | |
| <property name="amazonAWSHost" type="string" display="Amazon AWSHost" description="The hostname of the Amazon AWS cloud."/> | |
| <property name="amazonSQSClient" type="java:com.amazonaws.services.sqs.AmazonSQS" display="Amazon SQSClient" description="To use the AmazonSQS as client"/> | |
| <property name="attributeNames" type="string" display="Attribute Names" label="consumer" description="A list of attribute names to receive when consuming. Multiple names can be separated by comma."/> | |
| <property name="autoCreateQueue" type="boolean" display="Auto Create Queue" description="Setting the autocreation of the queue"/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="consumer" description="Allows you to use multiple threads to poll the sqs queue to increase throughput"/> | |
| <property name="defaultVisibilityTimeout" type="int" display="Default Visibility Timeout" label="consumer" description="The default visibility timeout (in seconds)"/> | |
| <property name="delayQueue" type="boolean" display="Delay Queue" label="advanced" description="Define if you want to apply delaySeconds option to the queue or on single messages"/> | |
| <property name="delaySeconds" type="int" display="Delay Seconds" label="producer" description="Delay sending messages for a number of seconds."/> | |
| <property name="deleteAfterRead" type="boolean" display="Delete After Read" label="consumer" description="Delete message from SQS after it has been read"/> | |
| <property name="deleteIfFiltered" type="boolean" display="Delete If Filtered" label="consumer" description="Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter. If 'false' and exchange does not make it through a Camel filter upstream in the route, then don't send DeleteMessage."/> | |
| <property name="extendMessageVisibility" type="boolean" display="Extend Message Visibility" label="consumer" description="If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs."/> | |
| <property name="headerFilterStrategy" type="java:org.apache.camel.spi.HeaderFilterStrategy" display="Header Filter Strategy" description="To use a custom HeaderFilterStrategy to map headers to/from Camel."/> | |
| <property name="kmsDataKeyReusePeriodSeconds" type="int" display="Kms Data Key Reuse Period Seconds" label="consumer" description="The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes)."/> | |
| <property name="kmsMasterKeyId" type="string" display="Kms Master Key Id" label="consumer" description="The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK."/> | |
| <property name="maxMessagesPerPoll" type="int" display="Max Messages Per Poll" label="consumer" description="Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited."/> | |
| <property name="maximumMessageSize" type="int" display="Maximum Message Size" label="queue" description="The maximumMessageSize (in bytes) an SQS message can contain for this queue."/> | |
| <property name="messageAttributeNames" type="string" display="Message Attribute Names" label="consumer" description="A list of message attribute names to receive when consuming. Multiple names can be separated by comma."/> | |
| <property name="messageDeduplicationIdStrategy" type="enum:MessageDeduplicationIdStrategy(useExchangeId,useContentBasedDeduplication)" display="Message Deduplication Id Strategy" label="producer" description="Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message."/> | |
| <property name="messageGroupIdStrategy" type="enum:MessageGroupIdStrategy(useConstant,useExchangeId,usePropertyValue)" display="Message Group Id Strategy" label="producer" description="Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used."/> | |
| <property name="messageRetentionPeriod" type="int" display="Message Retention Period" label="queue" description="The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue."/> | |
| <property name="operation" type="enum:SqsOperations(sendBatchMessage,deleteMessage,listQueues)" display="Operation" label="producer" description="The operation to do in case the user don't want to send only a message"/> | |
| <property name="policy" type="string" display="Policy" label="queue" description="The policy for this queue"/> | |
| <property name="proxyHost" type="string" display="Proxy Host" label="proxy" description="To define a proxy host when instantiating the SQS client"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" label="proxy" description="To define a proxy port when instantiating the SQS client"/> | |
| <property name="queueNameOrArn" type="string" display="Queue Name Or Arn" required="true" kind="path" description="Queue name or ARN"/> | |
| <property name="queueOwnerAWSAccountId" type="string" display="Queue Owner AWSAccount Id" secret="true" description="Specify the queue owner aws account id when you need to connect the queue with different account owner."/> | |
| <property name="queueUrl" type="string" display="Queue Url" label="advanced" description="To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes."/> | |
| <property name="receiveMessageWaitTimeSeconds" type="int" display="Receive Message Wait Time Seconds" label="queue" description="If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait."/> | |
| <property name="redrivePolicy" type="string" display="Redrive Policy" label="queue" description="Specify the policy that send message to DeadLetter queue. See detail at Amazon docs."/> | |
| <property name="region" type="string" display="Region" description="Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL."/> | |
| <property name="secretKey" type="string" display="Secret Key" label="security" secret="true" description="Amazon AWS Secret Key"/> | |
| <property name="serverSideEncryptionEnabled" type="boolean" display="Server Side Encryption Enabled" label="consumer" description="Define if Server Side Encryption is enabled or not on the queue"/> | |
| <property name="visibilityTimeout" type="int" display="Visibility Timeout" label="consumer" description="The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently."/> | |
| <property name="waitTimeSeconds" type="int" display="Wait Time Seconds" label="consumer" description="Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response."/> | |
| </endpoint> | |
| <endpoint name="aws-swf" display="AWS Simple Workflow" label="cloud,workflow" extends="model:endpoint" javaType="org.apache.camel.component.aws.swf.SWFComponent" maven="org.apache.camel:camel-aws-swf:3.0.0-SNAPSHOT" since="2.13.0" description="The aws-swf component is used for managing workflows from Amazon Simple Workflow."> | |
| <property name="accessKey" type="string" display="Access Key" label="security" secret="true" description="Amazon AWS Access Key."/> | |
| <property name="activityList" type="string" display="Activity List" label="consumer,activity" description="The list name to consume activities from."/> | |
| <property name="activitySchedulingOptions" type="java:com.amazonaws.services.simpleworkflow.flow.ActivitySchedulingOptions" display="Activity Scheduling Options" label="producer,activity" description="Activity scheduling options"/> | |
| <property name="activityThreadPoolSize" type="int" display="Activity Thread Pool Size" label="consumer,activity" description="Maximum number of threads in work pool for activity."/> | |
| <property name="activityTypeExecutionOptions" type="java:com.amazonaws.services.simpleworkflow.flow.worker.ActivityTypeExecutionOptions" display="Activity Type Execution Options" label="consumer,activity" description="Activity execution options"/> | |
| <property name="activityTypeRegistrationOptions" type="java:com.amazonaws.services.simpleworkflow.flow.worker.ActivityTypeRegistrationOptions" display="Activity Type Registration Options" label="consumer,activity" description="Activity registration options"/> | |
| <property name="amazonSWClient" type="java:com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow" display="Amazon SWClient" description="To use the given AmazonSimpleWorkflowClient as client"/> | |
| <property name="childPolicy" type="string" display="Child Policy" label="producer,workflow" description="The policy to use on child workflows when terminating a workflow."/> | |
| <property name="clientConfigurationParameters" type="map(string,object)" display="Client Configuration Parameters" label="advanced" description="To configure the ClientConfiguration using the key/values from the Map."/> | |
| <property name="dataConverter" type="java:com.amazonaws.services.simpleworkflow.flow.DataConverter" display="Data Converter" description="An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data."/> | |
| <property name="domainName" type="string" display="Domain Name" description="The workflow domain to use."/> | |
| <property name="eventName" type="string" display="Event Name" description="The workflow or activity event name to use."/> | |
| <property name="executionStartToCloseTimeout" type="string" display="Execution Start To Close Timeout" label="producer,workflow" description="Set the execution start to close timeout."/> | |
| <property name="operation" type="string" display="Operation" label="producer,workflow" description="Workflow operation"/> | |
| <property name="region" type="string" display="Region" label="common" description="Amazon AWS Region."/> | |
| <property name="sWClientParameters" type="map(string,object)" display="SWClient Parameters" label="advanced" description="To configure the AmazonSimpleWorkflowClient using the key/values from the Map."/> | |
| <property name="secretKey" type="string" display="Secret Key" label="security" secret="true" description="Amazon AWS Secret Key."/> | |
| <property name="signalName" type="string" display="Signal Name" label="producer,workflow" description="The name of the signal to send to the workflow."/> | |
| <property name="startWorkflowOptionsParameters" type="map(string,object)" display="Start Workflow Options Parameters" label="advanced" description="To configure the StartWorkflowOptions using the key/values from the Map."/> | |
| <property name="stateResultType" type="string" display="State Result Type" label="producer,workflow" description="The type of the result when a workflow state is queried."/> | |
| <property name="taskStartToCloseTimeout" type="string" display="Task Start To Close Timeout" label="producer,workflow" description="Set the task start to close timeout."/> | |
| <property name="terminationDetails" type="string" display="Termination Details" label="producer,workflow" description="Details for terminating a workflow."/> | |
| <property name="terminationReason" type="string" display="Termination Reason" label="producer,workflow" description="The reason for terminating a workflow."/> | |
| <property name="type" type="string" display="Type" required="true" kind="path" description="Activity or workflow"/> | |
| <property name="version" type="string" display="Version" description="The workflow or activity event version to use."/> | |
| <property name="workflowList" type="string" display="Workflow List" label="consumer,workflow" description="The list name to consume workflows from."/> | |
| <property name="workflowTypeRegistrationOptions" type="java:com.amazonaws.services.simpleworkflow.flow.WorkflowTypeRegistrationOptions" display="Workflow Type Registration Options" label="consumer,workflow" description="Workflow registration options"/> | |
| </endpoint> | |
| <endpoint name="azure-blob" display="Azure Storage Blob Service" label="cloud,database,nosql" extends="model:endpoint" javaType="org.apache.camel.component.azure.blob.BlobServiceComponent" maven="org.apache.camel:camel-azure:3.0.0-SNAPSHOT" since="2.19.0" description="The azure-blob component is used for storing and retrieving blobs from Azure Storage Blob Service."> | |
| <property name="azureBlobClient" type="java:com.microsoft.azure.storage.blob.CloudBlob" display="Azure Blob Client" description="The blob service client"/> | |
| <property name="blobMetadata" type="map(string,string)" display="Blob Metadata" label="producer" description="Set the blob meta-data"/> | |
| <property name="blobOffset" type="long" display="Blob Offset" description="Set the blob offset for the upload or download operations, default is 0"/> | |
| <property name="blobPrefix" type="string" display="Blob Prefix" label="producer" description="Set a prefix which can be used for listing the blobs"/> | |
| <property name="blobType" type="enum:BlobType(blockblob,appendblob,pageblob)" display="Blob Type" description="Set a blob type, 'blockblob' is default"/> | |
| <property name="closeStreamAfterRead" type="boolean" display="Close Stream After Read" description="Close the stream after read or keep it open, default is true"/> | |
| <property name="closeStreamAfterWrite" type="boolean" display="Close Stream After Write" label="producer" description="Close the stream after write or keep it open, default is true"/> | |
| <property name="containerOrBlobUri" type="string" display="Container Or Blob Uri" required="true" kind="path" description="Container or Blob compact Uri"/> | |
| <property name="credentials" type="java:com.microsoft.azure.storage.StorageCredentials" display="Credentials" description="Set the storage credentials, required in most cases"/> | |
| <property name="dataLength" type="long" display="Data Length" description="Set the data length for the download or page blob upload operations"/> | |
| <property name="fileDir" type="string" display="File Dir" description="Set the file directory where the downloaded blobs will be saved to"/> | |
| <property name="operation" type="enum:BlobServiceOperations(getBlob,deleteBlob,listBlobs,updateBlockBlob,uploadBlobBlocks,commitBlobBlockList,getBlobBlockList,createAppendBlob,updateAppendBlob,createPageBlob,updatePageBlob,resizePageBlob,clearPageBlob,getPageBlobRanges)" display="Operation" label="producer" description="Blob service operation hint to the producer"/> | |
| <property name="publicForRead" type="boolean" display="Public For Read" description="Storage resources can be public for reading their content, if this property is enabled then the credentials do not have to be set"/> | |
| <property name="streamReadSize" type="int" display="Stream Read Size" description="Set the minimum read size in bytes when reading the blob content"/> | |
| <property name="streamWriteSize" type="int" display="Stream Write Size" label="producer" description="Set the size of the buffer for writing block and page blocks"/> | |
| <property name="useFlatListing" type="boolean" display="Use Flat Listing" label="producer" description="Specify if the flat or hierarchical blob listing should be used"/> | |
| </endpoint> | |
| <endpoint name="azure-queue" display="Azure Storage Queue Service" label="cloud,queue,azure" extends="model:endpoint" javaType="org.apache.camel.component.azure.queue.QueueServiceComponent" maven="org.apache.camel:camel-azure:3.0.0-SNAPSHOT" since="2.19.0" description="The azure-queue component is used for storing and retrieving messages from Azure Storage Queue Service."> | |
| <property name="azureQueueClient" type="java:com.microsoft.azure.storage.queue.CloudQueue" display="Azure Queue Client" description="The queue service client"/> | |
| <property name="containerAndQueueUri" type="string" display="Container And Queue Uri" required="true" kind="path" description="Container Queue compact Uri"/> | |
| <property name="credentials" type="java:com.microsoft.azure.storage.StorageCredentials" display="Credentials" description="Set the storage credentials, required in most cases"/> | |
| <property name="messageTimeToLive" type="int" display="Message Time To Live" label="producer" description="Message Time To Live in seconds"/> | |
| <property name="messageVisibilityDelay" type="int" display="Message Visibility Delay" label="producer" description="Message Visibility Delay in seconds"/> | |
| <property name="operation" type="enum:QueueServiceOperations(listQueues,createQueue,deleteQueue,addMessage,retrieveMessage,peekMessage,updateMessage,deleteMessage)" display="Operation" label="producer" description="Queue service operation hint to the producer"/> | |
| <property name="queuePrefix" type="string" display="Queue Prefix" label="producer" description="Set a prefix which can be used for listing the queues"/> | |
| </endpoint> | |
| <endpoint name="bean" display="Bean" label="core,java" extends="model:endpoint" javaType="org.apache.camel.component.bean.BeanComponent" maven="org.apache.camel:camel-bean:3.0.0-SNAPSHOT" producerOnly="true" since="1.0.0" description="The bean component is for invoking Java beans from Camel."> | |
| <property name="beanName" type="string" display="Bean Name" label="common" required="true" kind="path" description="Sets the name of the bean to invoke"/> | |
| <property name="cache" type="boolean" display="Cache" label="common" description="If enabled, Camel will cache the result of the first Registry look-up. Cache can be enabled if the bean in the Registry is defined as a singleton scope."/> | |
| <property name="method" type="string" display="Method" label="common" description="Sets the name of the method to invoke on the bean"/> | |
| <property name="parameters" type="map(string,object)" display="Parameters" label="common" description="Used for configuring additional properties on the bean"/> | |
| </endpoint> | |
| <endpoint name="bean-validator" display="Bean Validator" label="validation" extends="model:endpoint" javaType="org.apache.camel.component.bean.validator.BeanValidatorComponent" maven="org.apache.camel:camel-bean-validator:3.0.0-SNAPSHOT" producerOnly="true" since="2.3.0" description="The Validator component performs bean validation of the message body using the Java Bean Validation API."> | |
| <property name="constraintValidatorFactory" type="java:javax.validation.ConstraintValidatorFactory" display="Constraint Validator Factory" description="To use a custom ConstraintValidatorFactory"/> | |
| <property name="group" type="string" display="Group" description="To use a custom validation group"/> | |
| <property name="label" type="string" display="Label" required="true" kind="path" description="Where label is an arbitrary text value describing the endpoint"/> | |
| <property name="messageInterpolator" type="java:javax.validation.MessageInterpolator" display="Message Interpolator" description="To use a custom MessageInterpolator"/> | |
| <property name="traversableResolver" type="java:javax.validation.TraversableResolver" display="Traversable Resolver" description="To use a custom TraversableResolver"/> | |
| <property name="validationProviderResolver" type="java:javax.validation.ValidationProviderResolver" display="Validation Provider Resolver" description="To use a a custom ValidationProviderResolver"/> | |
| </endpoint> | |
| <endpoint name="beanstalk" display="Beanstalk" label="messaging" extends="model:scheduled" javaType="org.apache.camel.component.beanstalk.BeanstalkComponent" maven="org.apache.camel:camel-beanstalk:3.0.0-SNAPSHOT" async="true" since="2.15.0" description="The beanstalk component is used for job retrieval and post-processing of Beanstalk jobs."> | |
| <property name="awaitJob" type="boolean" display="Await Job" label="consumer" description="Whether to wait for job to complete before ack the job from beanstalk"/> | |
| <property name="command" type="enum:BeanstalkCommand(bury,release,put,touch,delete,kick)" display="Command" description="put means to put the job into Beanstalk. Job body is specified in the Camel message body. Job ID will be returned in beanstalk.jobId message header. delete, release, touch or bury expect Job ID in the message header beanstalk.jobId. Result of the operation is returned in beanstalk.result message header kick expects the number of jobs to kick in the message body and returns the number of jobs actually kicked out in the message header beanstalk.result."/> | |
| <property name="connectionSettings" type="string" display="Connection Settings" kind="path" description="Connection settings host:port/tube"/> | |
| <property name="jobDelay" type="int" display="Job Delay" description="Job delay in seconds."/> | |
| <property name="jobPriority" type="long" display="Job Priority" description="Job priority. (0 is the highest, see Beanstalk protocol)"/> | |
| <property name="jobTimeToRun" type="int" display="Job Time To Run" description="Job time to run in seconds. (when 0, the beanstalkd daemon raises it to 1 automatically, see Beanstalk protocol)"/> | |
| <property name="onFailure" type="enum:BeanstalkCommand(bury,release,put,touch,delete,kick)" display="On Failure" label="consumer" description="Command to use when processing failed."/> | |
| <property name="useBlockIO" type="boolean" display="Use Block IO" label="consumer" description="Whether to use blockIO."/> | |
| </endpoint> | |
| <endpoint name="bonita" display="Bonita" label="process" extends="model:endpoint" javaType="org.apache.camel.component.bonita.BonitaComponent" maven="org.apache.camel:camel-bonita:3.0.0-SNAPSHOT" consumerOnly="true" since="2.19.0" description="Used for communicating with a remote Bonita BPM process engine."> | |
| <property name="hostname" type="string" display="Hostname" description="Hostname where Bonita engine runs"/> | |
| <property name="operation" type="enum:BonitaOperation(startCase)" display="Operation" required="true" kind="path" description="Operation to use"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to authenticate to Bonita engine."/> | |
| <property name="port" type="string" display="Port" description="Port of the server hosting Bonita engine"/> | |
| <property name="processName" type="string" display="Process Name" description="Name of the process involved in the operation"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to authenticate to Bonita engine."/> | |
| </endpoint> | |
| <endpoint name="box" display="Box" label="api,file,cloud" extends="model:endpoint" javaType="org.apache.camel.component.box.BoxComponent" maven="org.apache.camel:camel-box:3.0.0-SNAPSHOT" lenient="true" since="2.14.0" description="For uploading downloading and managing files folders groups collaborations etc on box DOT com."> | |
| <property name="accessTokenCache" type="java:com.box.sdk.IAccessTokenCache" display="Access Token Cache" label="advanced,security" description="Custom Access Token Cache for storing and retrieving access tokens."/> | |
| <property name="apiName" type="enum:BoxApiName(COLLABORATIONS,COMMENTS,EVENT_LOGS,FILES,FOLDERS,GROUPS,EVENTS,SEARCH,TASKS,USERS)" display="Api Name" required="true" kind="path" description="What kind of operation to perform"/> | |
| <property name="authenticationType" type="string" display="Authentication Type" label="authentication" description="The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens"/> | |
| <property name="clientId" type="string" display="Client Id" description="Box application client ID"/> | |
| <property name="clientSecret" type="string" display="Client Secret" label="security" secret="true" description="Box application client secret"/> | |
| <property name="encryptionAlgorithm" type="enum:com.box.sdk.EncryptionAlgorithm(RSA_SHA_256,RSA_SHA_384,RSA_SHA_512)" display="Encryption Algorithm" label="advanced,security" description="The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512"/> | |
| <property name="enterpriseId" type="string" display="Enterprise Id" description="The enterprise ID to use for an App Enterprise."/> | |
| <property name="httpParams" type="map(string,object)" display="Http Params" label="advanced" description="Custom HTTP params for settings like proxy host"/> | |
| <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="maxCacheEntries" type="int" display="Max Cache Entries" label="advanced,security" description="The maximum number of access tokens in cache."/> | |
| <property name="methodName" type="string" display="Method Name" required="true" kind="path" description="What sub operation to use for the selected operation"/> | |
| <property name="privateKeyFile" type="string" display="Private Key File" label="security" secret="true" description="The private key for generating the JWT signature."/> | |
| <property name="privateKeyPassword" type="string" display="Private Key Password" label="security" secret="true" description="The password for the private key."/> | |
| <property name="publicKeyId" type="string" display="Public Key Id" label="security" secret="true" description="The ID for public key for validating the JWT signature."/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="security" description="To configure security using SSLContextParameters."/> | |
| <property name="userId" type="string" display="User Id" description="The user ID to use for an App User."/> | |
| <property name="userName" type="string" display="User Name" label="security" secret="true" description="Box user name, MUST be provided"/> | |
| <property name="userPassword" type="string" display="User Password" label="security" secret="true" description="Box user password, MUST be provided if authSecureStorage is not set, or returns null on first call"/> | |
| </endpoint> | |
| <endpoint name="braintree" display="Braintree" label="api,cloud,payment" extends="model:endpoint" javaType="org.apache.camel.component.braintree.BraintreeComponent" maven="org.apache.camel:camel-braintree:3.0.0-SNAPSHOT" since="2.17.0" description="The braintree component is used for integrating with the Braintree Payment System."> | |
| <property name="accessToken" type="string" display="Access Token" label="advanced" description="The access token granted by a merchant to another in order to process transactions on their behalf. Used in place of environment, merchant id, public key and private key fields."/> | |
| <property name="apiName" type="enum:BraintreeApiName(ADDON,ADDRESS,CLIENTTOKEN,CREDITCARDVERIFICATION,CUSTOMER,DISCOUNT,DISPUTE,DOCUMENTUPLOAD,MERCHANTACCOUNT,PAYMENTMETHOD,PAYMENTMETHODNONCE,PLAN,REPORT,SETTLEMENTBATCHSUMMARY,SUBSCRIPTION,TRANSACTION,WEBHOOKNOTIFICATION)" display="Api Name" required="true" kind="path" description="What kind of operation to perform"/> | |
| <property name="environment" type="string" display="Environment" description="The environment Either SANDBOX or PRODUCTION"/> | |
| <property name="httpLogLevel" type="string" display="Http Log Level" label="advanced,logging" description="Set logging level for http calls, see java.util.logging.Level"/> | |
| <property name="httpReadTimeout" type="int" display="Http Read Timeout" label="advanced" description="Set read timeout for http calls."/> | |
| <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="merchantId" type="string" display="Merchant Id" description="The merchant id provided by Braintree."/> | |
| <property name="methodName" type="string" display="Method Name" kind="path" description="What sub operation to use for the selected operation"/> | |
| <property name="privateKey" type="string" display="Private Key" description="The private key provided by Braintree."/> | |
| <property name="proxyHost" type="string" display="Proxy Host" label="proxy" description="The proxy host"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" label="proxy" description="The proxy port"/> | |
| <property name="publicKey" type="string" display="Public Key" description="The public key provided by Braintree."/> | |
| </endpoint> | |
| <endpoint name="browse" display="Browse" label="core,monitoring" extends="model:endpoint" javaType="org.apache.camel.component.browse.BrowseComponent" maven="org.apache.camel:camel-browse:3.0.0-SNAPSHOT" since="1.3.0" description="The browse component is used for viewing the messages received on endpoints that supports BrowsableEndpoint."> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="A name which can be any string to uniquely identify the endpoint"/> | |
| </endpoint> | |
| <endpoint name="caffeine-cache" display="Caffeine Cache" label="cache,datagrid,clustering" extends="model:endpoint" javaType="org.apache.camel.component.caffeine.cache.CaffeineCacheComponent" maven="org.apache.camel:camel-caffeine:3.0.0-SNAPSHOT" since="2.20.0" description="The caffeine-cache component is used for integration with Caffeine Cache."> | |
| <property name="action" type="string" display="Action" label="producer" description="To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence."/> | |
| <property name="cache" type="java:com.github.benmanes.caffeine.cache.Cache" display="Cache" label="producer" description="To configure an already instantiated cache to be used"/> | |
| <property name="cacheLoader" type="java:com.github.benmanes.caffeine.cache.CacheLoader" display="Cache Loader" label="producer" description="To configure a CacheLoader in case of a LoadCache use"/> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="the cache name"/> | |
| <property name="createCacheIfNotExist" type="boolean" display="Create Cache If Not Exist" description="Configure if a cache need to be created if it does exist or can't be pre-configured."/> | |
| <property name="evictionType" type="enum:EvictionType(SIZE_BASED,TIME_BASED)" display="Eviction Type" label="producer" description="Set the eviction Type for this cache"/> | |
| <property name="expireAfterAccessTime" type="int" display="Expire After Access Time" label="producer" description="Set the expire After Access Time in case of time based Eviction (in seconds)"/> | |
| <property name="expireAfterWriteTime" type="int" display="Expire After Write Time" label="producer" description="Set the expire After Access Write in case of time based Eviction (in seconds)"/> | |
| <property name="initialCapacity" type="int" display="Initial Capacity" label="producer" description="Set the initial Capacity for the cache"/> | |
| <property name="key" type="object" display="Key" label="producer" description="To configure the default action key. If a key is set in the message header, then the key from the header takes precedence."/> | |
| <property name="keyType" type="string" display="Key Type" label="advanced" description="The cache key type, default java.lang.Object"/> | |
| <property name="maximumSize" type="int" display="Maximum Size" label="producer" description="Set the maximum size for the cache"/> | |
| <property name="removalListener" type="java:com.github.benmanes.caffeine.cache.RemovalListener" display="Removal Listener" label="producer" description="Set a specific removal Listener for the cache"/> | |
| <property name="statsCounter" type="java:com.github.benmanes.caffeine.cache.stats.StatsCounter" display="Stats Counter" label="producer" description="Set a specific Stats Counter for the cache stats"/> | |
| <property name="statsEnabled" type="boolean" display="Stats Enabled" label="producer" description="To enable stats on the cache"/> | |
| <property name="valueType" type="string" display="Value Type" label="advanced" description="The cache value type, default java.lang.Object"/> | |
| </endpoint> | |
| <endpoint name="caffeine-loadcache" display="Caffeine LoadCache" label="cache,datagrid,clustering" extends="model:endpoint" javaType="org.apache.camel.component.caffeine.load.CaffeineLoadCacheComponent" maven="org.apache.camel:camel-caffeine:3.0.0-SNAPSHOT" since="2.20.0" description="The caffeine-loadcache component is used for integration with Caffeine Load Cache."> | |
| <property name="action" type="string" display="Action" label="producer" description="To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence."/> | |
| <property name="cache" type="java:com.github.benmanes.caffeine.cache.Cache" display="Cache" label="producer" description="To configure an already instantiated cache to be used"/> | |
| <property name="cacheLoader" type="java:com.github.benmanes.caffeine.cache.CacheLoader" display="Cache Loader" label="producer" description="To configure a CacheLoader in case of a LoadCache use"/> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="the cache name"/> | |
| <property name="createCacheIfNotExist" type="boolean" display="Create Cache If Not Exist" description="Configure if a cache need to be created if it does exist or can't be pre-configured."/> | |
| <property name="evictionType" type="enum:EvictionType(SIZE_BASED,TIME_BASED)" display="Eviction Type" label="producer" description="Set the eviction Type for this cache"/> | |
| <property name="expireAfterAccessTime" type="int" display="Expire After Access Time" label="producer" description="Set the expire After Access Time in case of time based Eviction (in seconds)"/> | |
| <property name="expireAfterWriteTime" type="int" display="Expire After Write Time" label="producer" description="Set the expire After Access Write in case of time based Eviction (in seconds)"/> | |
| <property name="initialCapacity" type="int" display="Initial Capacity" label="producer" description="Set the initial Capacity for the cache"/> | |
| <property name="key" type="object" display="Key" label="producer" description="To configure the default action key. If a key is set in the message header, then the key from the header takes precedence."/> | |
| <property name="keyType" type="string" display="Key Type" label="advanced" description="The cache key type, default java.lang.Object"/> | |
| <property name="maximumSize" type="int" display="Maximum Size" label="producer" description="Set the maximum size for the cache"/> | |
| <property name="removalListener" type="java:com.github.benmanes.caffeine.cache.RemovalListener" display="Removal Listener" label="producer" description="Set a specific removal Listener for the cache"/> | |
| <property name="statsCounter" type="java:com.github.benmanes.caffeine.cache.stats.StatsCounter" display="Stats Counter" label="producer" description="Set a specific Stats Counter for the cache stats"/> | |
| <property name="statsEnabled" type="boolean" display="Stats Enabled" label="producer" description="To enable stats on the cache"/> | |
| <property name="valueType" type="string" display="Value Type" label="advanced" description="The cache value type, default java.lang.Object"/> | |
| </endpoint> | |
| <endpoint name="chatscript" display="ChatScript" label="ai,chatscript" extends="model:endpoint" javaType="org.apache.camel.component.chatscript.ChatScriptComponent" maven="org.apache.camel:camel-chatscript:3.0.0-SNAPSHOT" producerOnly="true" since="3.0.0" description="Represents a ChatScript endpoint."> | |
| <property name="botName" type="string" display="Bot Name" required="true" kind="path" description="Name of the Bot in CS to converse with"/> | |
| <property name="chatUserName" type="string" display="Chat User Name" label="username" description="Username who initializes the CS conversation. To be set when chat is initialized from camel route"/> | |
| <property name="host" type="string" display="Host" required="true" kind="path" description="Hostname or IP of the server on which CS server is running"/> | |
| <property name="port" type="int" display="Port" kind="path" description="Port on which ChatScript is listening to"/> | |
| <property name="resetchat" type="boolean" display="Resetchat" label="reset" description="Issues :reset command to start a new conversation everytime"/> | |
| </endpoint> | |
| <endpoint name="chunk" display="Chunk" label="transformation" extends="model:endpoint" javaType="org.apache.camel.component.chunk.ChunkComponent" maven="org.apache.camel:camel-chunk:3.0.0-SNAPSHOT" producerOnly="true" since="2.15.0" description="Transforms the message using a Chunk template."> | |
| <property name="contentCache" type="boolean" display="Content Cache" description="Sets whether to use resource content cache or not"/> | |
| <property name="encoding" type="string" display="Encoding" description="Define the encoding of the body"/> | |
| <property name="extension" type="string" display="Extension" description="Define the file extension of the template"/> | |
| <property name="resourceUri" type="string" display="Resource Uri" required="true" kind="path" description="Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."/> | |
| <property name="themeFolder" type="string" display="Theme Folder" description="Define the themes folder to scan"/> | |
| <property name="themeLayer" type="string" display="Theme Layer" description="Define the theme layer to elaborate"/> | |
| <property name="themeSubfolder" type="string" display="Theme Subfolder" description="Define the themes subfolder to scan"/> | |
| </endpoint> | |
| <endpoint name="class" display="Class" label="core,java" extends="model:endpoint" javaType="org.apache.camel.component.beanclass.ClassComponent" maven="org.apache.camel:camel-bean:3.0.0-SNAPSHOT" producerOnly="true" since="2.4.0" description="The class component is for invoking Java classes (Java beans) from Camel."> | |
| <property name="beanName" type="string" display="Bean Name" label="common" required="true" kind="path" description="Sets the name of the bean to invoke"/> | |
| <property name="cache" type="boolean" display="Cache" label="common" description="If enabled, Camel will cache the result of the first Registry look-up. Cache can be enabled if the bean in the Registry is defined as a singleton scope."/> | |
| <property name="method" type="string" display="Method" label="common" description="Sets the name of the method to invoke on the bean"/> | |
| <property name="parameters" type="map(string,object)" display="Parameters" label="common" description="Used for configuring additional properties on the bean"/> | |
| </endpoint> | |
| <endpoint name="cm-sms" display="CM SMS Gateway" label="mobile" extends="model:endpoint" javaType="org.apache.camel.component.cm.CMComponent" maven="org.apache.camel:camel-cm-sms:3.0.0-SNAPSHOT" producerOnly="true" since="2.18.0" description="The cm-sms component allows to integrate with CM SMS Gateway."> | |
| <property name="defaultFrom" type="string" display="Default From" required="true" description="This is the sender name. The maximum length is 11 characters."/> | |
| <property name="defaultMaxNumberOfParts" type="int" display="Default Max Number Of Parts" description="If it is a multipart message forces the max number. Message can be truncated. Technically the gateway will first check if a message is larger than 160 characters, if so, the message will be cut into multiple 153 characters parts limited by these parameters."/> | |
| <property name="host" type="string" display="Host" required="true" kind="path" description="SMS Provider HOST with scheme"/> | |
| <property name="productToken" type="string" display="Product Token" required="true" description="The unique token to use"/> | |
| <property name="testConnectionOnStartup" type="boolean" display="Test Connection On Startup" description="Whether to test the connection to the SMS Gateway on startup"/> | |
| </endpoint> | |
| <endpoint name="cmis" display="CMIS" label="cms,database" extends="model:endpoint" javaType="org.apache.camel.component.cmis.CMISComponent" maven="org.apache.camel:camel-cmis:3.0.0-SNAPSHOT" since="2.11.0" description="The cmis component uses the Apache Chemistry client API and allows you to add/read nodes to/from a CMIS compliant content repositories."> | |
| <property name="cmsUrl" type="string" display="Cms Url" required="true" kind="path" description="URL to the cmis repository"/> | |
| <property name="pageSize" type="int" display="Page Size" description="Number of nodes to retrieve per page"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password for the cmis repository"/> | |
| <property name="query" type="string" display="Query" label="consumer" description="The cmis query to execute against the repository. If not specified, the consumer will retrieve every node from the content repository by iterating the content tree recursively"/> | |
| <property name="queryMode" type="boolean" display="Query Mode" label="producer" description="If true, will execute the cmis query from the message body and return result, otherwise will create a node in the cmis repository"/> | |
| <property name="readContent" type="boolean" display="Read Content" description="If set to true, the content of document node will be retrieved in addition to the properties"/> | |
| <property name="readCount" type="int" display="Read Count" description="Max number of nodes to read"/> | |
| <property name="repositoryId" type="string" display="Repository Id" description="The Id of the repository to use. If not specified the first available repository is used"/> | |
| <property name="sessionFacadeFactory" type="java:org.apache.camel.component.cmis.CMISSessionFacadeFactory" display="Session Facade Factory" label="advanced" description="To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username for the cmis repository"/> | |
| </endpoint> | |
| <endpoint name="coap" display="CoAP" label="iot" extends="model:endpoint" javaType="org.apache.camel.coap.CoAPComponent" maven="org.apache.camel:camel-coap:3.0.0-SNAPSHOT" since="2.16.0" description="The coap component is used for sending and receiving messages from COAP capable devices."> | |
| <property name="alias" type="string" display="Alias" description="Sets the alias used to query the KeyStore for the private key and certificate. This parameter is used when we are enabling TLS with certificates on the service side, and similarly on the client side when TLS is used with certificates and client authentication. If the parameter is not specified then the default behavior is to use the first alias in the keystore that contains a key entry. This configuration parameter does not apply to configuring TLS via a Raw Public Key or a Pre-Shared Key."/> | |
| <property name="cipherSuites" type="string" display="Cipher Suites" description="Sets the cipherSuites String. This is a comma separated String of ciphersuites to configure. If it is not specified, then it falls back to getting the ciphersuites from the sslContextParameters object."/> | |
| <property name="clientAuthentication" type="string" display="Client Authentication" description="Sets the configuration options for server-side client-authentication requirements. The value must be one of NONE, WANT, REQUIRE. If this value is not specified, then it falls back to checking the sslContextParameters.getServerParameters().getClientAuthentication() value."/> | |
| <property name="coapMethodRestrict" type="string" display="Coap Method Restrict" label="consumer" description="Comma separated list of methods that the CoAP consumer will bind to. The default is to bind to all methods (DELETE, GET, POST, PUT)."/> | |
| <property name="privateKey" type="java:java.security.PrivateKey" display="Private Key" description="Set the configured private key for use with Raw Public Key."/> | |
| <property name="pskStore" type="java:org.eclipse.californium.scandium.dtls.pskstore.PskStore" display="Psk Store" description="Set the PskStore to use for pre-shared key."/> | |
| <property name="publicKey" type="java:java.security.PublicKey" display="Public Key" description="Set the configured public key for use with Raw Public Key."/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" description="Set the SSLContextParameters object for setting up TLS. This is required for coapstcp, and for coaps when we are using certificates for TLS (as opposed to RPK or PKS)."/> | |
| <property name="trustedRpkStore" type="java:org.eclipse.californium.scandium.dtls.rpkstore.TrustedRpkStore" display="Trusted Rpk Store" description="Set the TrustedRpkStore to use to determine trust in raw public keys."/> | |
| <property name="uri" type="java:java.net.URI" display="Uri" kind="path" description="The URI for the CoAP endpoint"/> | |
| </endpoint> | |
| <endpoint name="coap-tcp" display="CoAP" label="iot" extends="model:endpoint" javaType="org.apache.camel.coap.CoAPComponent" maven="org.apache.camel:camel-coap:3.0.0-SNAPSHOT" since="2.16.0" description="The coap component is used for sending and receiving messages from COAP capable devices."> | |
| <property name="alias" type="string" display="Alias" description="Sets the alias used to query the KeyStore for the private key and certificate. This parameter is used when we are enabling TLS with certificates on the service side, and similarly on the client side when TLS is used with certificates and client authentication. If the parameter is not specified then the default behavior is to use the first alias in the keystore that contains a key entry. This configuration parameter does not apply to configuring TLS via a Raw Public Key or a Pre-Shared Key."/> | |
| <property name="cipherSuites" type="string" display="Cipher Suites" description="Sets the cipherSuites String. This is a comma separated String of ciphersuites to configure. If it is not specified, then it falls back to getting the ciphersuites from the sslContextParameters object."/> | |
| <property name="clientAuthentication" type="string" display="Client Authentication" description="Sets the configuration options for server-side client-authentication requirements. The value must be one of NONE, WANT, REQUIRE. If this value is not specified, then it falls back to checking the sslContextParameters.getServerParameters().getClientAuthentication() value."/> | |
| <property name="coapMethodRestrict" type="string" display="Coap Method Restrict" label="consumer" description="Comma separated list of methods that the CoAP consumer will bind to. The default is to bind to all methods (DELETE, GET, POST, PUT)."/> | |
| <property name="privateKey" type="java:java.security.PrivateKey" display="Private Key" description="Set the configured private key for use with Raw Public Key."/> | |
| <property name="pskStore" type="java:org.eclipse.californium.scandium.dtls.pskstore.PskStore" display="Psk Store" description="Set the PskStore to use for pre-shared key."/> | |
| <property name="publicKey" type="java:java.security.PublicKey" display="Public Key" description="Set the configured public key for use with Raw Public Key."/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" description="Set the SSLContextParameters object for setting up TLS. This is required for coapstcp, and for coaps when we are using certificates for TLS (as opposed to RPK or PKS)."/> | |
| <property name="trustedRpkStore" type="java:org.eclipse.californium.scandium.dtls.rpkstore.TrustedRpkStore" display="Trusted Rpk Store" description="Set the TrustedRpkStore to use to determine trust in raw public keys."/> | |
| <property name="uri" type="java:java.net.URI" display="Uri" kind="path" description="The URI for the CoAP endpoint"/> | |
| </endpoint> | |
| <endpoint name="coaps" display="CoAP (Secure)" label="iot" extends="model:endpoint" javaType="org.apache.camel.coap.CoAPComponent" maven="org.apache.camel:camel-coap:3.0.0-SNAPSHOT" since="2.16.0" description="The coap component is used for sending and receiving messages from COAP capable devices."> | |
| <property name="alias" type="string" display="Alias" description="Sets the alias used to query the KeyStore for the private key and certificate. This parameter is used when we are enabling TLS with certificates on the service side, and similarly on the client side when TLS is used with certificates and client authentication. If the parameter is not specified then the default behavior is to use the first alias in the keystore that contains a key entry. This configuration parameter does not apply to configuring TLS via a Raw Public Key or a Pre-Shared Key."/> | |
| <property name="cipherSuites" type="string" display="Cipher Suites" description="Sets the cipherSuites String. This is a comma separated String of ciphersuites to configure. If it is not specified, then it falls back to getting the ciphersuites from the sslContextParameters object."/> | |
| <property name="clientAuthentication" type="string" display="Client Authentication" description="Sets the configuration options for server-side client-authentication requirements. The value must be one of NONE, WANT, REQUIRE. If this value is not specified, then it falls back to checking the sslContextParameters.getServerParameters().getClientAuthentication() value."/> | |
| <property name="coapMethodRestrict" type="string" display="Coap Method Restrict" label="consumer" description="Comma separated list of methods that the CoAP consumer will bind to. The default is to bind to all methods (DELETE, GET, POST, PUT)."/> | |
| <property name="privateKey" type="java:java.security.PrivateKey" display="Private Key" description="Set the configured private key for use with Raw Public Key."/> | |
| <property name="pskStore" type="java:org.eclipse.californium.scandium.dtls.pskstore.PskStore" display="Psk Store" description="Set the PskStore to use for pre-shared key."/> | |
| <property name="publicKey" type="java:java.security.PublicKey" display="Public Key" description="Set the configured public key for use with Raw Public Key."/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" description="Set the SSLContextParameters object for setting up TLS. This is required for coapstcp, and for coaps when we are using certificates for TLS (as opposed to RPK or PKS)."/> | |
| <property name="trustedRpkStore" type="java:org.eclipse.californium.scandium.dtls.rpkstore.TrustedRpkStore" display="Trusted Rpk Store" description="Set the TrustedRpkStore to use to determine trust in raw public keys."/> | |
| <property name="uri" type="java:java.net.URI" display="Uri" kind="path" description="The URI for the CoAP endpoint"/> | |
| </endpoint> | |
| <endpoint name="coaps-tcp" display="CoAP" label="iot" extends="model:endpoint" javaType="org.apache.camel.coap.CoAPComponent" maven="org.apache.camel:camel-coap:3.0.0-SNAPSHOT" since="2.16.0" description="The coap component is used for sending and receiving messages from COAP capable devices."> | |
| <property name="alias" type="string" display="Alias" description="Sets the alias used to query the KeyStore for the private key and certificate. This parameter is used when we are enabling TLS with certificates on the service side, and similarly on the client side when TLS is used with certificates and client authentication. If the parameter is not specified then the default behavior is to use the first alias in the keystore that contains a key entry. This configuration parameter does not apply to configuring TLS via a Raw Public Key or a Pre-Shared Key."/> | |
| <property name="cipherSuites" type="string" display="Cipher Suites" description="Sets the cipherSuites String. This is a comma separated String of ciphersuites to configure. If it is not specified, then it falls back to getting the ciphersuites from the sslContextParameters object."/> | |
| <property name="clientAuthentication" type="string" display="Client Authentication" description="Sets the configuration options for server-side client-authentication requirements. The value must be one of NONE, WANT, REQUIRE. If this value is not specified, then it falls back to checking the sslContextParameters.getServerParameters().getClientAuthentication() value."/> | |
| <property name="coapMethodRestrict" type="string" display="Coap Method Restrict" label="consumer" description="Comma separated list of methods that the CoAP consumer will bind to. The default is to bind to all methods (DELETE, GET, POST, PUT)."/> | |
| <property name="privateKey" type="java:java.security.PrivateKey" display="Private Key" description="Set the configured private key for use with Raw Public Key."/> | |
| <property name="pskStore" type="java:org.eclipse.californium.scandium.dtls.pskstore.PskStore" display="Psk Store" description="Set the PskStore to use for pre-shared key."/> | |
| <property name="publicKey" type="java:java.security.PublicKey" display="Public Key" description="Set the configured public key for use with Raw Public Key."/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" description="Set the SSLContextParameters object for setting up TLS. This is required for coapstcp, and for coaps when we are using certificates for TLS (as opposed to RPK or PKS)."/> | |
| <property name="trustedRpkStore" type="java:org.eclipse.californium.scandium.dtls.rpkstore.TrustedRpkStore" display="Trusted Rpk Store" description="Set the TrustedRpkStore to use to determine trust in raw public keys."/> | |
| <property name="uri" type="java:java.net.URI" display="Uri" kind="path" description="The URI for the CoAP endpoint"/> | |
| </endpoint> | |
| <endpoint name="cometd" display="CometD" label="websocket" extends="model:endpoint" javaType="org.apache.camel.component.cometd.CometdComponent" maven="org.apache.camel:camel-cometd:3.0.0-SNAPSHOT" since="2.0.0" description="The cometd component is a transport for working with the Jetty implementation of the cometd/bayeux protocol."> | |
| <property name="allowedOrigins" type="string" display="Allowed Origins" description="The origins domain that support to cross, if the crosssOriginFilterOn is true"/> | |
| <property name="baseResource" type="string" display="Base Resource" description="The root directory for the web resources or classpath. Use the protocol file: or classpath: depending if you want that the component loads the resource from file system or classpath. Classpath is required for OSGI deployment where the resources are packaged in the jar"/> | |
| <property name="channelName" type="string" display="Channel Name" required="true" kind="path" description="The channelName represents a topic that can be subscribed to by the Camel endpoints."/> | |
| <property name="crossOriginFilterOn" type="boolean" display="Cross Origin Filter On" description="If true, the server will support for cross-domain filtering"/> | |
| <property name="disconnectLocalSession" type="boolean" display="Disconnect Local Session" label="producer" description="Whether to disconnect local sessions after publishing a message to its channel. Disconnecting local session is needed as they are not swept by default by CometD, and therefore you can run out of memory."/> | |
| <property name="filterPath" type="string" display="Filter Path" description="The filterPath will be used by the CrossOriginFilter, if the crosssOriginFilterOn is true"/> | |
| <property name="host" type="string" display="Host" required="true" kind="path" description="Hostname"/> | |
| <property name="interval" type="int" display="Interval" description="The client side poll timeout in milliseconds. How long a client will wait between reconnects"/> | |
| <property name="jsonCommented" type="boolean" display="Json Commented" description="If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment. This is a defence against Ajax Hijacking."/> | |
| <property name="logLevel" type="int" display="Log Level" description="Logging level. 0=none, 1=info, 2=debug."/> | |
| <property name="maxInterval" type="int" display="Max Interval" description="The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time."/> | |
| <property name="multiFrameInterval" type="int" display="Multi Frame Interval" description="The client side poll timeout, if multiple connections are detected from the same browser."/> | |
| <property name="port" type="int" display="Port" required="true" kind="path" description="Host port number"/> | |
| <property name="sessionHeadersEnabled" type="boolean" display="Session Headers Enabled" label="consumer" description="Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests."/> | |
| <property name="timeout" type="int" display="Timeout" description="The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding."/> | |
| </endpoint> | |
| <endpoint name="cometds" display="CometD (Secure)" label="websocket" extends="model:endpoint" javaType="org.apache.camel.component.cometd.CometdComponent" maven="org.apache.camel:camel-cometd:3.0.0-SNAPSHOT" since="2.0.0" description="The cometd component is a transport for working with the Jetty implementation of the cometd/bayeux protocol."> | |
| <property name="allowedOrigins" type="string" display="Allowed Origins" description="The origins domain that support to cross, if the crosssOriginFilterOn is true"/> | |
| <property name="baseResource" type="string" display="Base Resource" description="The root directory for the web resources or classpath. Use the protocol file: or classpath: depending if you want that the component loads the resource from file system or classpath. Classpath is required for OSGI deployment where the resources are packaged in the jar"/> | |
| <property name="channelName" type="string" display="Channel Name" required="true" kind="path" description="The channelName represents a topic that can be subscribed to by the Camel endpoints."/> | |
| <property name="crossOriginFilterOn" type="boolean" display="Cross Origin Filter On" description="If true, the server will support for cross-domain filtering"/> | |
| <property name="disconnectLocalSession" type="boolean" display="Disconnect Local Session" label="producer" description="Whether to disconnect local sessions after publishing a message to its channel. Disconnecting local session is needed as they are not swept by default by CometD, and therefore you can run out of memory."/> | |
| <property name="filterPath" type="string" display="Filter Path" description="The filterPath will be used by the CrossOriginFilter, if the crosssOriginFilterOn is true"/> | |
| <property name="host" type="string" display="Host" required="true" kind="path" description="Hostname"/> | |
| <property name="interval" type="int" display="Interval" description="The client side poll timeout in milliseconds. How long a client will wait between reconnects"/> | |
| <property name="jsonCommented" type="boolean" display="Json Commented" description="If true, the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment. This is a defence against Ajax Hijacking."/> | |
| <property name="logLevel" type="int" display="Log Level" description="Logging level. 0=none, 1=info, 2=debug."/> | |
| <property name="maxInterval" type="int" display="Max Interval" description="The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time."/> | |
| <property name="multiFrameInterval" type="int" display="Multi Frame Interval" description="The client side poll timeout, if multiple connections are detected from the same browser."/> | |
| <property name="port" type="int" display="Port" required="true" kind="path" description="Host port number"/> | |
| <property name="sessionHeadersEnabled" type="boolean" display="Session Headers Enabled" label="consumer" description="Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests."/> | |
| <property name="timeout" type="int" display="Timeout" description="The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding."/> | |
| </endpoint> | |
| <endpoint name="consul" display="Consul" label="api,cloud" extends="model:endpoint" javaType="org.apache.camel.component.consul.ConsulComponent" maven="org.apache.camel:camel-consul:3.0.0-SNAPSHOT" since="2.18.0" description="The camel consul component allows you to work with Consul, a distributed, highly available, datacenter-aware, service discovery and configuration system."> | |
| <property name="apiEndpoint" type="string" display="Api Endpoint" required="true" kind="path" description="The API endpoint"/> | |
| </endpoint> | |
| <endpoint name="controlbus" display="Control Bus" label="core,monitoring" extends="model:endpoint" javaType="org.apache.camel.component.controlbus.ControlBusComponent" maven="org.apache.camel:camel-controlbus:3.0.0-SNAPSHOT" producerOnly="true" since="2.11.0" description="The controlbus component provides easy management of Camel applications based on the Control Bus EIP pattern."> | |
| <property name="action" type="string" display="Action" description="To denote an action that can be either: start, stop, or status. To either start or stop a route, or to get the status of the route as output in the message body. You can use suspend and resume from Camel 2.11.1 onwards to either suspend or resume a route. And from Camel 2.11.1 onwards you can use stats to get performance statics returned in XML format; the routeId option can be used to define which route to get the performance stats for, if routeId is not defined, then you get statistics for the entire CamelContext. The restart action will restart the route."/> | |
| <property name="async" type="boolean" display="Async" description="Whether to execute the control bus task asynchronously. Important: If this option is enabled, then any result from the task is not set on the Exchange. This is only possible if executing tasks synchronously."/> | |
| <property name="command" type="string" display="Command" required="true" kind="path" description="Command can be either route or language"/> | |
| <property name="language" type="enum:org.apache.camel.spi.Language(bean,constant,el,exchangeProperty,file,groovy,header,jsonpath,mvel,ognl,ref,simple,spel,sql,terser,tokenize,xpath,xquery,xtokenize)" display="Language" kind="path" description="Allows you to specify the name of a Language to use for evaluating the message body. If there is any result from the evaluation, then the result is put in the message body."/> | |
| <property name="loggingLevel" type="enum:org.apache.camel.LoggingLevel(TRACE,DEBUG,INFO,WARN,ERROR,OFF)" display="Logging Level" description="Logging level used for logging when task is done, or if any exceptions occurred during processing the task."/> | |
| <property name="restartDelay" type="int" display="Restart Delay" description="The delay in millis to use when restarting a route."/> | |
| <property name="routeId" type="string" display="Route Id" description="To specify a route by its id. The special keyword current indicates the current route."/> | |
| </endpoint> | |
| <endpoint name="corda" display="corda" label="corda,blockchain" extends="model:endpoint" javaType="org.apache.camel.component.corda.CordaComponent" maven="org.apache.camel:camel-corda:3.0.0-SNAPSHOT" since="2.23.0" description="The corda component uses the corda-rpc to interact with corda nodes."> | |
| <property name="configuration" type="java:org.apache.camel.component.corda.CordaConfiguration" display="Configuration" required="true" kind="path" description="URL to the corda node"/> | |
| </endpoint> | |
| <endpoint name="couchbase" display="Couchbase" label="database,nosql" extends="model:scheduled" javaType="org.apache.camel.component.couchbase.CouchbaseComponent" maven="org.apache.camel:camel-couchbase:3.0.0-SNAPSHOT" since="2.19.0" description="Represents a Couchbase endpoint that can query Views with a Poll strategy and/or produce various type of operations."> | |
| <property name="additionalHosts" type="string" display="Additional Hosts" label="advanced" description="The additional hosts"/> | |
| <property name="autoStartIdForInserts" type="boolean" display="Auto Start Id For Inserts" label="producer" description="Define if we want an autostart Id when we are doing an insert operation"/> | |
| <property name="bucket" type="string" display="Bucket" description="The bucket to use"/> | |
| <property name="consumerProcessedStrategy" type="string" display="Consumer Processed Strategy" label="consumer" description="Define the consumer Processed strategy to use"/> | |
| <property name="descending" type="boolean" display="Descending" label="consumer" description="Define if this operation is descending or not"/> | |
| <property name="designDocumentName" type="string" display="Design Document Name" label="consumer" description="The design document name to use"/> | |
| <property name="hostname" type="string" display="Hostname" required="true" kind="path" description="The hostname to use"/> | |
| <property name="key" type="string" display="Key" description="The key to use"/> | |
| <property name="limit" type="int" display="Limit" label="consumer" description="The output limit to use"/> | |
| <property name="maxReconnectDelay" type="long" display="Max Reconnect Delay" label="advanced" description="Define the max delay during a reconnection"/> | |
| <property name="obsPollInterval" type="long" display="Obs Poll Interval" label="advanced" description="Define the observation polling interval"/> | |
| <property name="obsTimeout" type="long" display="Obs Timeout" label="advanced" description="Define the observation timeout"/> | |
| <property name="opQueueMaxBlockTime" type="long" display="Op Queue Max Block Time" label="advanced" description="Define the max time an operation can be in queue blocked"/> | |
| <property name="opTimeOut" type="long" display="Op Time Out" label="advanced" description="Define the operation timeout"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="The operation to do"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="The password to use"/> | |
| <property name="persistTo" type="int" display="Persist To" label="producer" description="Where to persist the data"/> | |
| <property name="port" type="int" display="Port" kind="path" description="The port number to use"/> | |
| <property name="producerRetryAttempts" type="int" display="Producer Retry Attempts" label="producer" description="Define the number of retry attempts"/> | |
| <property name="producerRetryPause" type="int" display="Producer Retry Pause" label="producer" description="Define the retry pause between different attempts"/> | |
| <property name="protocol" type="string" display="Protocol" required="true" kind="path" description="The protocol to use"/> | |
| <property name="rangeEndKey" type="string" display="Range End Key" label="consumer" description="Define a range for the end key"/> | |
| <property name="rangeStartKey" type="string" display="Range Start Key" label="consumer" description="Define a range for the start key"/> | |
| <property name="readBufferSize" type="int" display="Read Buffer Size" label="advanced" description="Define the buffer size"/> | |
| <property name="replicateTo" type="int" display="Replicate To" label="producer" description="Where to replicate the data"/> | |
| <property name="shouldOptimize" type="boolean" display="Should Optimize" label="advanced" description="Define if we want to use optimization or not where possible"/> | |
| <property name="skip" type="int" display="Skip" label="consumer" description="Define the skip to use"/> | |
| <property name="startingIdForInsertsFrom" type="long" display="Starting Id For Inserts From" label="producer" description="Define the starting Id where we are doing an insert operation"/> | |
| <property name="timeoutExceptionThreshold" type="int" display="Timeout Exception Threshold" label="advanced" description="Define the threshold for throwing a timeout Exception"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="The username to use"/> | |
| <property name="viewName" type="string" display="View Name" label="consumer" description="The view name to use"/> | |
| </endpoint> | |
| <endpoint name="couchdb" display="CouchDB" label="database,nosql" extends="model:endpoint" javaType="org.apache.camel.component.couchdb.CouchDbComponent" maven="org.apache.camel:camel-couchdb:3.0.0-SNAPSHOT" since="2.11.0" description="The couchdb component is used for integrate with CouchDB databases."> | |
| <property name="createDatabase" type="boolean" display="Create Database" description="Creates the database if it does not already exist"/> | |
| <property name="database" type="string" display="Database" required="true" kind="path" description="Name of the database to use"/> | |
| <property name="deletes" type="boolean" display="Deletes" label="consumer" description="Document deletes are published as events"/> | |
| <property name="heartbeat" type="long" display="Heartbeat" label="consumer" description="How often to send an empty message to keep socket alive in millis"/> | |
| <property name="hostname" type="string" display="Hostname" required="true" kind="path" description="Hostname of the running couchdb instance"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password for authenticated databases"/> | |
| <property name="port" type="int" display="Port" kind="path" description="Port number for the running couchdb instance"/> | |
| <property name="protocol" type="string" display="Protocol" required="true" kind="path" description="The protocol to use for communicating with the database."/> | |
| <property name="since" type="string" display="Since" label="consumer" description="Start tracking changes immediately after the given update sequence. The default, null, will start monitoring from the latest sequence."/> | |
| <property name="style" type="string" display="Style" label="consumer" description="Specifies how many revisions are returned in the changes array. The default, main_only, will only return the current winning revision; all_docs will return all leaf revisions (including conflicts and deleted former conflicts.)"/> | |
| <property name="updates" type="boolean" display="Updates" label="consumer" description="Document inserts/updates are published as events"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username in case of authenticated databases"/> | |
| </endpoint> | |
| <endpoint name="cql" display="Cassandra CQL" label="database,nosql" extends="model:scheduled" javaType="org.apache.camel.component.cassandra.CassandraComponent" maven="org.apache.camel:camel-cassandraql:3.0.0-SNAPSHOT" since="2.15.0" description="The cql component aims at integrating Cassandra 2.0 using the CQL3 API (not the Thrift API)."> | |
| <property name="beanRef" type="string" display="Bean Ref" kind="path" description="beanRef is defined using bean:id"/> | |
| <property name="cluster" type="java:com.datastax.driver.core.Cluster" display="Cluster" description="To use the Cluster instance (you would normally not use this option)"/> | |
| <property name="clusterName" type="string" display="Cluster Name" description="Cluster name"/> | |
| <property name="consistencyLevel" type="enum:com.datastax.driver.core.ConsistencyLevel(ANY,ONE,TWO,THREE,QUORUM,ALL,LOCAL_QUORUM,EACH_QUORUM,SERIAL,LOCAL_SERIAL,LOCAL_ONE)" display="Consistency Level" description="Consistency level to use"/> | |
| <property name="cql" type="string" display="Cql" description="CQL query to perform. Can be overridden with the message header with key CamelCqlQuery."/> | |
| <property name="hosts" type="string" display="Hosts" kind="path" description="Hostname(s) cassansdra server(s). Multiple hosts can be separated by comma."/> | |
| <property name="keyspace" type="string" display="Keyspace" kind="path" description="Keyspace to use"/> | |
| <property name="loadBalancingPolicy" type="string" display="Load Balancing Policy" description="To use a specific LoadBalancingPolicy"/> | |
| <property name="password" type="string" display="Password" description="Password for session authentication"/> | |
| <property name="port" type="int" display="Port" kind="path" description="Port number of cassansdra server(s)"/> | |
| <property name="prepareStatements" type="boolean" display="Prepare Statements" description="Whether to use PreparedStatements or regular Statements"/> | |
| <property name="resultSetConversionStrategy" type="string" display="Result Set Conversion Strategy" description="To use a custom class that implements logic for converting ResultSet into message body ALL, ONE, LIMIT_10, LIMIT_100..."/> | |
| <property name="session" type="java:com.datastax.driver.core.Session" display="Session" description="To use the Session instance (you would normally not use this option)"/> | |
| <property name="username" type="string" display="Username" description="Username for session authentication"/> | |
| </endpoint> | |
| <endpoint name="crypto" display="Crypto (JCE)" label="security,transformation" extends="model:endpoint" javaType="org.apache.camel.component.crypto.DigitalSignatureComponent" maven="org.apache.camel:camel-crypto:3.0.0-SNAPSHOT" producerOnly="true" since="2.3.0" description="The crypto component is used for signing and verifying exchanges using the Signature Service of the Java Cryptographic Extension (JCE)."> | |
| <property name="algorithm" type="string" display="Algorithm" description="Sets the JCE name of the Algorithm that should be used for the signer."/> | |
| <property name="alias" type="string" display="Alias" description="Sets the alias used to query the KeyStore for keys and {link java.security.cert.Certificate Certificates} to be used in signing and verifying exchanges. This value can be provided at runtime via the message header org.apache.camel.component.crypto.DigitalSignatureConstants#KEYSTORE_ALIAS"/> | |
| <property name="bufferSize" type="int" display="Buffer Size" label="advanced" description="Set the size of the buffer used to read in the Exchange payload data."/> | |
| <property name="certificate" type="java:java.security.cert.Certificate" display="Certificate" label="advanced" description="Set the Certificate that should be used to verify the signature in the exchange based on its payload."/> | |
| <property name="certificateName" type="string" display="Certificate Name" description="Sets the reference name for a PrivateKey that can be found in the registry."/> | |
| <property name="clearHeaders" type="boolean" display="Clear Headers" label="advanced" description="Determines if the Signature specific headers be cleared after signing and verification. Defaults to true, and should only be made otherwise at your extreme peril as vital private information such as Keys and passwords may escape if unset."/> | |
| <property name="cryptoOperation" type="enum:CryptoOperation(sign,verify)" display="Crypto Operation" required="true" kind="path" description="Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto:sign sets sign as the operation."/> | |
| <property name="keyStoreParameters" type="java:org.apache.camel.support.jsse.KeyStoreParameters" display="Key Store Parameters" label="advanced" description="Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges based on the given KeyStoreParameters. A KeyStore is typically used with an alias, either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore, then this single entry will be used."/> | |
| <property name="keystore" type="java:java.security.KeyStore" display="Keystore" description="Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges. A KeyStore is typically used with an alias, either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore, then this single entry will be used."/> | |
| <property name="keystoreName" type="string" display="Keystore Name" description="Sets the reference name for a Keystore that can be found in the registry."/> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="The logical name of this operation."/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Sets the password used to access an aliased PrivateKey in the KeyStore."/> | |
| <property name="privateKey" type="java:java.security.PrivateKey" display="Private Key" secret="true" description="Set the PrivateKey that should be used to sign the exchange"/> | |
| <property name="privateKeyName" type="string" display="Private Key Name" secret="true" description="Sets the reference name for a PrivateKey that can be found in the registry."/> | |
| <property name="provider" type="string" display="Provider" description="Set the id of the security provider that provides the configured Signature algorithm."/> | |
| <property name="publicKey" type="java:java.security.PublicKey" display="Public Key" label="advanced" description="Set the PublicKey that should be used to verify the signature in the exchange."/> | |
| <property name="publicKeyName" type="string" display="Public Key Name" description="references that should be resolved when the context changes"/> | |
| <property name="secureRandom" type="java:java.security.SecureRandom" display="Secure Random" label="advanced" secret="true" description="Set the SecureRandom used to initialize the Signature service"/> | |
| <property name="secureRandomName" type="string" display="Secure Random Name" description="Sets the reference name for a SecureRandom that can be found in the registry."/> | |
| <property name="signatureHeaderName" type="string" display="Signature Header Name" description="Set the name of the message header that should be used to store the base64 encoded signature. This defaults to 'CamelDigitalSignature'"/> | |
| </endpoint> | |
| <endpoint name="crypto-cms" display="Crypto CMS" label="security,transformation" extends="model:endpoint" javaType="org.apache.camel.component.crypto.cms.CryptoCmsComponent" maven="org.apache.camel:camel-crypto-cms:3.0.0-SNAPSHOT" producerOnly="true" since="2.20.0" description="The crypto cms component is used for encrypting data in CMS Enveloped Data format, decrypting CMS Enveloped Data, signing data in CMS Signed Data format, and verifying CMS Signed Data."> | |
| <property name="contentEncryptionAlgorithm" type="string" display="Content Encryption Algorithm" label="encrypt" description="Encryption algorithm, for example DESede/CBC/PKCS5Padding. Further possible values: DESede/CBC/PKCS5Padding, AES/CBC/PKCS5Padding, Camellia/CBC/PKCS5Padding, CAST5/CBC/PKCS5Padding."/> | |
| <property name="cryptoOperation" type="enum:CryptoOperation(sign,verify,encrypt,decrypt)" display="Crypto Operation" required="true" kind="path" description="Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto-cms:sign sets sign as the operation. Possible values: sign, verify, encrypt, or decrypt."/> | |
| <property name="fromBase64" type="boolean" display="From Base64" label="decrypt_verify" description="If true then the CMS message is base 64 encoded and must be decoded during the processing. Default value is false."/> | |
| <property name="includeContent" type="boolean" display="Include Content" label="sign" description="Indicates whether the signed content should be included into the Signed Data instance. If false then a detached Signed Data instance is created in the header CamelCryptoCmsSignedData."/> | |
| <property name="keyStore" type="java:java.security.KeyStore" display="Key Store" label="common" description="Keystore which contains signer private keys, verifier public keys, encryptor public keys, decryptor private keys depending on the operation. Use either this parameter or the parameter 'keyStoreParameters'."/> | |
| <property name="keyStoreParameters" type="java:org.apache.camel.support.jsse.KeyStoreParameters" display="Key Store Parameters" label="common" description="Keystore containing signer private keys, verifier public keys, encryptor public keys, decryptor private keys depending on the operation. Use either this parameter or the parameter 'keystore'."/> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="The name part in the URI can be chosen by the user to distinguish between different signer/verifier/encryptor/decryptor endpoints within the camel context."/> | |
| <property name="originatorInformationProvider" type="java:org.apache.camel.component.crypto.cms.common.OriginatorInformationProvider" display="Originator Information Provider" label="encrypt" description="Provider for the originator info. See https://tools.ietf.org/html/rfc5652#section-6.1. The default value is null."/> | |
| <property name="password" type="char[]" display="Password" label="decrypt" description="Sets the password of the private keys. It is assumed that all private keys in the keystore have the same password. If not set then it is assumed that the password of the private keys is given by the keystore password given in the KeyStoreParameters."/> | |
| <property name="recipient" type="list(java:org.apache.camel.component.crypto.cms.crypt.RecipientInfo)" display="Recipient" label="encrypt" description="Recipient Info: reference to a bean which implements the interface org.apache.camel.component.crypto.cms.api.TransRecipientInfo"/> | |
| <property name="secretKeyLength" type="int" display="Secret Key Length" label="encrypt" description="Key length for the secret symmetric key used for the content encryption. Only used if the specified content-encryption algorithm allows keys of different sizes. If contentEncryptionAlgorithm=AES/CBC/PKCS5Padding or Camellia/CBC/PKCS5Padding then 128; if contentEncryptionAlgorithm=DESede/CBC/PKCS5Padding then 192, 128; if strong encryption is enabled then for AES/CBC/PKCS5Padding and Camellia/CBC/PKCS5Padding also the key lengths 192 and 256 are possible."/> | |
| <property name="signedDataHeaderBase64" type="boolean" display="Signed Data Header Base64" label="verify" description="Indicates whether the value in the header CamelCryptoCmsSignedData is base64 encoded. Default value is false. Only relevant for detached signatures. In the detached signature case, the header contains the Signed Data object."/> | |
| <property name="signer" type="string" display="Signer" label="sign" description="Signer information: reference to bean(s) which implements org.apache.camel.component.crypto.cms.api.SignerInfo. Multiple values can be separated by comma"/> | |
| <property name="toBase64" type="boolean" display="To Base64" label="encrypt_sign" description="Indicates whether the Signed Data or Enveloped Data instance shall be base 64 encoded. Default value is false."/> | |
| <property name="unprotectedAttributesGeneratorProvider" type="java:org.apache.camel.component.crypto.cms.common.AttributesGeneratorProvider" display="Unprotected Attributes Generator Provider" label="encrypt" description="Provider of the generator for the unprotected attributes. The default value is null which means no unprotected attribute is added to the Enveloped Data object. See https://tools.ietf.org/html/rfc5652#section-6.1."/> | |
| <property name="verifySignaturesOfAllSigners" type="boolean" display="Verify Signatures Of All Signers" label="verify" description="If true then the signatures of all signers contained in the Signed Data object are verified. If false then only one signature whose signer info matches with one of the specified certificates is verified. Default value is true."/> | |
| </endpoint> | |
| <endpoint name="cxf" display="CXF" label="soap,webservice" extends="model:endpoint" javaType="org.apache.camel.component.cxf.CxfComponent" maven="org.apache.camel:camel-cxf:3.0.0-SNAPSHOT" async="true" since="1.0.0" description="The cxf component is used for SOAP WebServices using Apache CXF."> | |
| <property name="address" type="string" display="Address" label="service" kind="path" description="The service publish address."/> | |
| <property name="allowStreaming" type="boolean" display="Allow Streaming" label="advanced" description="This option controls whether the CXF component, when running in PAYLOAD mode, will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases."/> | |
| <property name="beanId" type="string" display="Bean Id" kind="path" description="To lookup an existing configured CxfEndpoint. Must used bean: as prefix."/> | |
| <property name="bindingId" type="string" display="Binding Id" label="service" description="The bindingId for the service model to use."/> | |
| <property name="bus" type="java:org.apache.cxf.Bus" display="Bus" label="advanced" description="To use a custom configured CXF Bus."/> | |
| <property name="continuationTimeout" type="long" display="Continuation Timeout" label="advanced" description="This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport."/> | |
| <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="cxfBinding" type="java:org.apache.camel.component.cxf.CxfBinding" display="Cxf Binding" label="advanced" description="To use a custom CxfBinding to control the binding between Camel Message and CXF Message."/> | |
| <property name="cxfEndpointConfigurer" type="java:org.apache.camel.component.cxf.CxfEndpointConfigurer" display="Cxf Endpoint Configurer" label="advanced" description="This option could apply the implementation of org.apache.camel.component.cxf.CxfEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configure{ServerClient} method of CxfEndpointConfigurer."/> | |
| <property name="dataFormat" type="enum:DataFormat(PAYLOAD,RAW,MESSAGE,CXF_MESSAGE,POJO)" display="Data Format" description="The data type messages supported by the CXF endpoint."/> | |
| <property name="defaultBus" type="boolean" display="Default Bus" label="advanced" description="Will set the default bus when CXF endpoint create a bus by itself"/> | |
| <property name="defaultOperationName" type="string" display="Default Operation Name" label="producer" description="This option will set the default operationName that will be used by the CxfProducer which invokes the remote service."/> | |
| <property name="defaultOperationNamespace" type="string" display="Default Operation Namespace" label="producer" description="This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service."/> | |
| <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="hostnameVerifier" type="java:javax.net.ssl.HostnameVerifier" display="Hostname Verifier" label="producer" description="The hostname verifier to be used. Use the # notation to reference a HostnameVerifier from the registry."/> | |
| <property name="loggingFeatureEnabled" type="boolean" display="Logging Feature Enabled" label="logging" description="This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log."/> | |
| <property name="loggingSizeLimit" type="int" display="Logging Size Limit" label="logging" description="To limit the total size of number of bytes the logger will output when logging feature has been enabled and -1 for no limit."/> | |
| <property name="mergeProtocolHeaders" type="boolean" display="Merge Protocol Headers" label="advanced" description="Whether to merge protocol headers. If enabled then propagating headers between Camel and CXF becomes more consistent and similar. For more details see CAMEL-6393."/> | |
| <property name="mtomEnabled" type="boolean" display="Mtom Enabled" label="advanced" description="To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode."/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="This option is used to set the basic authentication information of password for the CXF client."/> | |
| <property name="portName" type="string" display="Port Name" label="service" description="The endpoint name this service is implementing, it maps to the wsdl:portname. In the format of ns:PORT_NAME where ns is a namespace prefix valid at this scope."/> | |
| <property name="properties" type="map(string,object)" display="Properties" label="advanced" description="To set additional CXF options using the key/value pairs from the Map. For example to turn on stacktraces in SOAP faults, properties.faultStackTraceEnabled=true"/> | |
| <property name="publishedEndpointUrl" type="string" display="Published Endpoint Url" label="service" description="This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus wsd"/> | |
| <property name="serviceClass" type="class" display="Service Class" label="service" description="The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not."/> | |
| <property name="serviceName" type="string" display="Service Name" label="service" description="The service name this service is implementing, it maps to the wsdl:servicename."/> | |
| <property name="skipFaultLogging" type="boolean" display="Skip Fault Logging" label="logging" description="This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches."/> | |
| <property name="skipPayloadMessagePartCheck" type="boolean" display="Skip Payload Message Part Check" label="advanced" description="Sets whether SOAP message validation should be disabled."/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="producer" description="The Camel SSL setting reference. Use the # notation to reference the SSL Context."/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="This option is used to set the basic authentication information of username for the CXF client."/> | |
| <property name="wrapped" type="boolean" display="Wrapped" label="producer" description="Which kind of operation that CXF endpoint producer will invoke"/> | |
| <property name="wrappedStyle" type="boolean" display="Wrapped Style" description="The WSDL style that describes how parameters are represented in the SOAP body. If the value is false, CXF will chose the document-literal unwrapped style, If the value is true, CXF will chose the document-literal wrapped style"/> | |
| <property name="wsdlURL" type="string" display="Wsdl URL" label="service" description="The location of the WSDL. Can be on the classpath, file system, or be hosted remotely."/> | |
| </endpoint> | |
| <endpoint name="cxfrs" display="CXF-RS" label="rest" extends="model:endpoint" javaType="org.apache.camel.component.cxf.jaxrs.CxfRsComponent" maven="org.apache.camel:camel-cxf:3.0.0-SNAPSHOT" lenient="true" since="2.0.0" description="The cxfrs component is used for JAX-RS REST services using Apache CXF."> | |
| <property name="address" type="string" display="Address" kind="path" description="The service publish address."/> | |
| <property name="beanId" type="string" display="Bean Id" kind="path" description="To lookup an existing configured CxfRsEndpoint. Must used bean: as prefix."/> | |
| <property name="binding" type="java:org.apache.camel.component.cxf.jaxrs.CxfRsBinding" display="Binding" label="advanced" description="To use a custom CxfBinding to control the binding between Camel Message and CXF Message."/> | |
| <property name="bindingStyle" type="enum:BindingStyle(SimpleConsumer,Default,Custom)" display="Binding Style" label="consumer" description="Sets how requests and responses will be mapped to/from Camel. Two values are possible: SimpleConsumer: This binding style processes request parameters, multiparts, etc. and maps them to IN headers, IN attachments and to the message body. It aims to eliminate low-level processing of org.apache.cxf.message.MessageContentsList. It also also adds more flexibility and simplicity to the response mapping. Only available for consumers. Default: The default style. For consumers this passes on a MessageContentsList to the route, requiring low-level processing in the route. This is the traditional binding style, which simply dumps the org.apache.cxf.message.MessageContentsList coming in from the CXF stack onto the IN message body. The user is then responsible for processing it according to the contract defined by the JAX-RS method signature. Custom: allows you to specify a custom binding through the binding option."/> | |
| <property name="bus" type="java:org.apache.cxf.Bus" display="Bus" label="advanced" description="To use a custom configured CXF Bus."/> | |
| <property name="continuationTimeout" type="long" display="Continuation Timeout" label="advanced" description="This option is used to set the CXF continuation timeout which could be used in CxfConsumer by default when the CXF server is using Jetty or Servlet transport."/> | |
| <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="cxfRsEndpointConfigurer" type="java:org.apache.camel.component.cxf.jaxrs.CxfRsEndpointConfigurer" display="Cxf Rs Endpoint Configurer" label="advanced" description="This option could apply the implementation of org.apache.camel.component.cxf.jaxrs.CxfRsEndpointConfigurer which supports to configure the CXF endpoint in programmatic way. User can configure the CXF server and client by implementing configure{Server/Client} method of CxfEndpointConfigurer."/> | |
| <property name="defaultBus" type="boolean" display="Default Bus" label="advanced" description="Will set the default bus when CXF endpoint create a bus by itself"/> | |
| <property name="features" type="list(java:org.apache.cxf.feature.Feature)" display="Features" description="Set the feature list to the CxfRs endpoint."/> | |
| <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="hostnameVerifier" type="java:javax.net.ssl.HostnameVerifier" display="Hostname Verifier" label="producer" description="The hostname verifier to be used. Use the # notation to reference a HostnameVerifier from the registry."/> | |
| <property name="httpClientAPI" type="boolean" display="Http Client API" label="producer,advanced" description="If it is true, the CxfRsProducer will use the HttpClientAPI to invoke the service. If it is false, the CxfRsProducer will use the ProxyClientAPI to invoke the service"/> | |
| <property name="ignoreDeleteMethodMessageBody" type="boolean" display="Ignore Delete Method Message Body" label="producer,advanced" description="This option is used to tell CxfRsProducer to ignore the message body of the DELETE method when using HTTP API."/> | |
| <property name="loggingFeatureEnabled" type="boolean" display="Logging Feature Enabled" description="This option enables CXF Logging Feature which writes inbound and outbound REST messages to log."/> | |
| <property name="loggingSizeLimit" type="int" display="Logging Size Limit" description="To limit the total size of number of bytes the logger will output when logging feature has been enabled."/> | |
| <property name="maxClientCacheSize" type="int" display="Max Client Cache Size" label="producer,advanced" description="This option allows you to configure the maximum size of the cache. The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider."/> | |
| <property name="modelRef" type="string" display="Model Ref" description="This option is used to specify the model file which is useful for the resource class without annotation. When using this option, then the service class can be omitted, to emulate document-only endpoints"/> | |
| <property name="performInvocation" type="boolean" display="Perform Invocation" label="advanced" description="When the option is true, Camel will perform the invocation of the resource class instance and put the response object into the exchange for further processing."/> | |
| <property name="propagateContexts" type="boolean" display="Propagate Contexts" label="advanced" description="When the option is true, JAXRS UriInfo, HttpHeaders, Request and SecurityContext contexts will be available to custom CXFRS processors as typed Camel exchange properties. These contexts can be used to analyze the current requests using JAX-RS API."/> | |
| <property name="providers" type="string" display="Providers" description="Set custom JAX-RS provider(s) list to the CxfRs endpoint. You can specify a string with a list of providers to lookup in the registy separated by comma."/> | |
| <property name="publishedEndpointUrl" type="string" display="Published Endpoint Url" label="consumer" description="This option can override the endpointUrl that published from the WADL which can be accessed with resource address url plus _wadl"/> | |
| <property name="resourceClasses" type="list(class)" display="Resource Classes" description="The resource classes which you want to export as REST service. Multiple classes can be separated by comma."/> | |
| <property name="schemaLocations" type="list(string)" display="Schema Locations" description="Sets the locations of the schema(s) which can be used to validate the incoming XML or JAXB-driven JSON."/> | |
| <property name="serviceBeans" type="list(object)" display="Service Beans" label="consumer,advanced" description="The service beans which you want to export as REST service. Multiple beans can be separated by comma."/> | |
| <property name="skipFaultLogging" type="boolean" display="Skip Fault Logging" description="This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches."/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="producer" description="The Camel SSL setting reference. Use the # notation to reference the SSL Context."/> | |
| <property name="throwExceptionOnFailure" type="boolean" display="Throw Exception On Failure" label="producer" description="This option tells the CxfRsProducer to inspect return codes and will generate an Exception if the return code is larger than 207."/> | |
| </endpoint> | |
| <endpoint name="dataformat" display="Data Format" label="core,transformation" extends="model:endpoint" javaType="org.apache.camel.component.dataformat.DataFormatComponent" maven="org.apache.camel:camel-dataformat:3.0.0-SNAPSHOT" producerOnly="true" lenient="true" since="2.12.0" description="The dataformat component is used for working with Data Formats as if it was a regular Component supporting Endpoints and URIs."> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="Name of data format"/> | |
| <property name="operation" type="string" display="Operation" required="true" kind="path" description="Operation to use either marshal or unmarshal"/> | |
| </endpoint> | |
| <endpoint name="dataset" display="Dataset" label="core,testing" extends="model:endpoint" javaType="org.apache.camel.component.dataset.DataSetComponent" maven="org.apache.camel:camel-dataset:3.0.0-SNAPSHOT" lenient="true" since="1.3.0" description="The dataset component provides a mechanism to easily perform load & soak testing of your system."> | |
| <property name="assertPeriod" type="long" display="Assert Period" label="producer" description="Sets a grace period after which the mock endpoint will re-assert to ensure the preliminary assertion is still valid. This is used for example to assert that exactly a number of messages arrives. For example if expectedMessageCount(int) was set to 5, then the assertion is satisfied when 5 or more message arrives. To ensure that exactly 5 messages arrives, then you would need to wait a little period to ensure no further message arrives. This is what you can use this method for. By default this period is disabled."/> | |
| <property name="consumeDelay" type="long" display="Consume Delay" label="producer" description="Allows a delay to be specified which causes a delay when a message is consumed by the producer (to simulate slow processing)"/> | |
| <property name="copyOnExchange" type="boolean" display="Copy On Exchange" label="producer,advanced" description="Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true."/> | |
| <property name="dataSetIndex" type="string" display="Data Set Index" description="Controls the behaviour of the CamelDataSetIndex header. For Consumers: - off = the header will not be set - strict/lenient = the header will be set For Producers: - off = the header value will not be verified, and will not be set if it is not present = strict = the header value must be present and will be verified = lenient = the header value will be verified if it is present, and will be set if it is not present"/> | |
| <property name="expectedCount" type="int" display="Expected Count" label="producer" description="Specifies the expected number of message exchanges that should be received by this endpoint. Beware: If you want to expect that 0 messages, then take extra care, as 0 matches when the tests starts, so you need to set a assert period time to let the test run for a while to make sure there are still no messages arrived; for that use setAssertPeriod(long). An alternative is to use NotifyBuilder, and use the notifier to know when Camel is done routing some messages, before you call the assertIsSatisfied() method on the mocks. This allows you to not use a fixed assert period, to speedup testing times. If you want to assert that exactly n'th message arrives to this mock endpoint, then see also the setAssertPeriod(long) method for further details."/> | |
| <property name="initialDelay" type="long" display="Initial Delay" label="consumer" description="Time period in millis to wait before starting sending messages."/> | |
| <property name="minRate" type="int" display="Min Rate" label="consumer" description="Wait until the DataSet contains at least this number of messages"/> | |
| <property name="name" type="java:org.apache.camel.component.dataset.DataSet" display="Name" required="true" kind="path" description="Name of DataSet to lookup in the registry"/> | |
| <property name="preloadSize" type="long" display="Preload Size" label="consumer" description="Sets how many messages should be preloaded (sent) before the route completes its initialization"/> | |
| <property name="produceDelay" type="long" display="Produce Delay" label="consumer" description="Allows a delay to be specified which causes a delay when a message is sent by the consumer (to simulate slow processing)"/> | |
| <property name="reportGroup" type="int" display="Report Group" label="producer" description="A number that is used to turn on throughput logging based on groups of the size."/> | |
| <property name="resultMinimumWaitTime" type="long" display="Result Minimum Wait Time" label="producer" description="Sets the minimum expected amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"/> | |
| <property name="resultWaitTime" type="long" display="Result Wait Time" label="producer" description="Sets the maximum amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"/> | |
| <property name="retainFirst" type="int" display="Retain First" label="producer" description="Specifies to only retain the first n'th number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the first 10 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."/> | |
| <property name="retainLast" type="int" display="Retain Last" label="producer" description="Specifies to only retain the last n'th number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the last 20 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."/> | |
| <property name="sleepForEmptyTest" type="long" display="Sleep For Empty Test" label="producer" description="Allows a sleep to be specified to wait to check that this endpoint really is empty when expectedMessageCount(int) is called with zero"/> | |
| </endpoint> | |
| <endpoint name="dataset-test" display="DataSet Test" label="core,testing" extends="model:endpoint" javaType="org.apache.camel.component.dataset.DataSetTestComponent" maven="org.apache.camel:camel-dataset:3.0.0-SNAPSHOT" producerOnly="true" lenient="true" since="1.3.0" description="The dataset-test component extends the mock component by on startup to pull messages from another endpoint to set the expected message bodies."> | |
| <property name="anyOrder" type="boolean" display="Any Order" description="Whether the expected messages should arrive in the same order or can be in any order."/> | |
| <property name="assertPeriod" type="long" display="Assert Period" label="producer" description="Sets a grace period after which the mock endpoint will re-assert to ensure the preliminary assertion is still valid. This is used for example to assert that exactly a number of messages arrives. For example if expectedMessageCount(int) was set to 5, then the assertion is satisfied when 5 or more message arrives. To ensure that exactly 5 messages arrives, then you would need to wait a little period to ensure no further message arrives. This is what you can use this method for. By default this period is disabled."/> | |
| <property name="copyOnExchange" type="boolean" display="Copy On Exchange" label="producer,advanced" description="Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true."/> | |
| <property name="delimiter" type="string" display="Delimiter" description="The split delimiter to use when split is enabled. By default the delimiter is new line based. The delimiter can be a regular expression."/> | |
| <property name="expectedCount" type="int" display="Expected Count" label="producer" description="Specifies the expected number of message exchanges that should be received by this endpoint. Beware: If you want to expect that 0 messages, then take extra care, as 0 matches when the tests starts, so you need to set a assert period time to let the test run for a while to make sure there are still no messages arrived; for that use setAssertPeriod(long). An alternative is to use NotifyBuilder, and use the notifier to know when Camel is done routing some messages, before you call the assertIsSatisfied() method on the mocks. This allows you to not use a fixed assert period, to speedup testing times. If you want to assert that exactly n'th message arrives to this mock endpoint, then see also the setAssertPeriod(long) method for further details."/> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="Name of endpoint to lookup in the registry to use for polling messages used for testing"/> | |
| <property name="reportGroup" type="int" display="Report Group" label="producer" description="A number that is used to turn on throughput logging based on groups of the size."/> | |
| <property name="resultMinimumWaitTime" type="long" display="Result Minimum Wait Time" label="producer" description="Sets the minimum expected amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"/> | |
| <property name="resultWaitTime" type="long" display="Result Wait Time" label="producer" description="Sets the maximum amount of time (in millis) the assertIsSatisfied() will wait on a latch until it is satisfied"/> | |
| <property name="retainFirst" type="int" display="Retain First" label="producer" description="Specifies to only retain the first n'th number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the first 10 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."/> | |
| <property name="retainLast" type="int" display="Retain Last" label="producer" description="Specifies to only retain the last n'th number of received Exchanges. This is used when testing with big data, to reduce memory consumption by not storing copies of every Exchange this mock endpoint receives. Important: When using this limitation, then the getReceivedCounter() will still return the actual number of received Exchanges. For example if we have received 5000 Exchanges, and have configured to only retain the last 20 Exchanges, then the getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the getExchanges() and getReceivedExchanges() methods. When using this method, then some of the other expectation methods is not supported, for example the expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both setRetainFirst(int) and setRetainLast(int) methods, to limit both the first and last received."/> | |
| <property name="sleepForEmptyTest" type="long" display="Sleep For Empty Test" label="producer" description="Allows a sleep to be specified to wait to check that this endpoint really is empty when expectedMessageCount(int) is called with zero"/> | |
| <property name="split" type="boolean" display="Split" description="If enabled the messages loaded from the test endpoint will be split using new line delimiters so each line is an expected message. For example to use a file endpoint to load a file where each line is an expected message."/> | |
| <property name="timeout" type="long" display="Timeout" description="The timeout to use when polling for message bodies from the URI"/> | |
| </endpoint> | |
| <endpoint name="digitalocean" display="DigitalOcean" label="cloud,management" extends="model:endpoint" javaType="org.apache.camel.component.digitalocean.DigitalOceanComponent" maven="org.apache.camel:camel-digitalocean:3.0.0-SNAPSHOT" producerOnly="true" since="2.19.0" description="The DigitalOcean component allows you to manage Droplets and resources within the DigitalOcean cloud."> | |
| <property name="digitalOceanClient" type="java:com.myjeeva.digitalocean.impl.DigitalOceanClient" display="Digital Ocean Client" label="advanced" description="To use a existing configured DigitalOceanClient as client"/> | |
| <property name="httpProxyHost" type="string" display="Http Proxy Host" label="proxy" description="Set a proxy host if needed"/> | |
| <property name="httpProxyPassword" type="string" display="Http Proxy Password" label="proxy" secret="true" description="Set a proxy password if needed"/> | |
| <property name="httpProxyPort" type="int" display="Http Proxy Port" label="proxy" description="Set a proxy port if needed"/> | |
| <property name="httpProxyUser" type="string" display="Http Proxy User" label="proxy" secret="true" description="Set a proxy host if needed"/> | |
| <property name="oAuthToken" type="string" display="OAuth Token" label="security" secret="true" description="DigitalOcean OAuth Token"/> | |
| <property name="operation" type="enum:DigitalOceanOperations(create,update,delete,list,ownList,get,listBackups,listActions,listNeighbors,listSnapshots,listKernels,listAllNeighbors,enableBackups,disableBackups,reboot,powerCycle,shutdown,powerOn,powerOff,restore,resetPassword,resize,rebuild,rename,changeKernel,enableIpv6,enablePrivateNetworking,takeSnapshot,transfer,convert,attach,detach,assign,unassign,tag,untag)" display="Operation" kind="path" description="The operation to perform to the given resource."/> | |
| <property name="page" type="int" display="Page" description="Use for pagination. Force the page number."/> | |
| <property name="perPage" type="int" display="Per Page" description="Use for pagination. Set the number of item per request. The maximum number of results per page is 200."/> | |
| <property name="resource" type="enum:DigitalOceanResources(account,actions,blockStorages,droplets,mages,snapshots,keys,regions,sizes,floatingIPs,tags)" display="Resource" required="true" description="The DigitalOcean resource type on which perform the operation."/> | |
| </endpoint> | |
| <endpoint name="direct" display="Direct" label="core,endpoint" extends="model:endpoint" javaType="org.apache.camel.component.direct.DirectComponent" maven="org.apache.camel:camel-direct:3.0.0-SNAPSHOT" since="1.0.0" description="The direct component provides direct, synchronous call to another endpoint from the same CamelContext."> | |
| <property name="block" type="boolean" display="Block" label="producer" description="If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active."/> | |
| <property name="failIfNoConsumers" type="boolean" display="Fail If No Consumers" label="producer" description="Whether the producer should fail by throwing an exception, when sending to a DIRECT endpoint with no active consumers."/> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="Name of direct endpoint"/> | |
| <property name="timeout" type="long" display="Timeout" label="producer" description="The timeout value to use if block is enabled."/> | |
| </endpoint> | |
| <endpoint name="direct-vm" display="Direct VM" label="core,endpoint" extends="model:endpoint" javaType="org.apache.camel.component.directvm.DirectVmComponent" maven="org.apache.camel:camel-directvm:3.0.0-SNAPSHOT" async="true" since="2.10.0" description="The direct-vm component provides direct, synchronous call to another endpoint from any CamelContext in the same JVM."> | |
| <property name="block" type="boolean" display="Block" label="producer" description="If sending a message to a direct endpoint which has no active consumer, then we can tell the producer to block and wait for the consumer to become active."/> | |
| <property name="failIfNoConsumers" type="boolean" display="Fail If No Consumers" label="producer" description="Whether the producer should fail by throwing an exception, when sending to a Direct-VM endpoint with no active consumers."/> | |
| <property name="headerFilterStrategy" type="java:org.apache.camel.spi.HeaderFilterStrategy" display="Header Filter Strategy" label="producer,advanced" description="Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none."/> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="Name of direct-vm endpoint"/> | |
| <property name="propagateProperties" type="boolean" display="Propagate Properties" label="advanced" description="Whether to propagate or not properties from the producer side to the consumer side, and vice versa. Default value: true."/> | |
| <property name="timeout" type="long" display="Timeout" label="producer" description="The timeout value to use if block is enabled."/> | |
| </endpoint> | |
| <endpoint name="disruptor" display="Disruptor" label="endpoint" extends="model:endpoint" javaType="org.apache.camel.component.disruptor.DisruptorComponent" maven="org.apache.camel:camel-disruptor:3.0.0-SNAPSHOT" async="true" since="2.12.0" description="The disruptor component provides asynchronous SEDA behavior using LMAX Disruptor."> | |
| <property name="blockWhenFull" type="boolean" display="Block When Full" label="producer" description="Whether a thread that sends messages to a full Disruptor will block until the ringbuffer's capacity is no longer exhausted. By default, the calling thread will block and wait until the message can be accepted. By disabling this option, an exception will be thrown stating that the queue is full."/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="consumer" description="Number of concurrent threads processing exchanges."/> | |
| <property name="multipleConsumers" type="boolean" display="Multiple Consumers" label="consumer" description="Specifies whether multiple consumers are allowed. If enabled, you can use Disruptor for Publish-Subscribe messaging. That is, you can send a message to the queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint."/> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="Name of queue"/> | |
| <property name="producerType" type="enum:DisruptorProducerType(Single,Multi)" display="Producer Type" label="producer" description="Defines the producers allowed on the Disruptor. The options allowed are: Multi to allow multiple producers and Single to enable certain optimizations only allowed when one concurrent producer (on one thread or otherwise synchronized) is active."/> | |
| <property name="size" type="int" display="Size" description="The maximum capacity of the Disruptors ringbuffer Will be effectively increased to the nearest power of two. Notice: Mind if you use this option, then its the first endpoint being created with the queue name, that determines the size. To make sure all endpoints use same size, then configure the size option on all of them, or the first endpoint being created."/> | |
| <property name="timeout" type="long" display="Timeout" label="producer" description="Timeout (in milliseconds) before a producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value."/> | |
| <property name="waitForTaskToComplete" type="enum:org.apache.camel.WaitForTaskToComplete(Never,IfReplyExpected,Always)" display="Wait For Task To Complete" label="producer" description="Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based."/> | |
| <property name="waitStrategy" type="enum:DisruptorWaitStrategy(Blocking,Sleeping,BusySpin,Yielding)" display="Wait Strategy" label="consumer" description="Defines the strategy used by consumer threads to wait on new exchanges to be published. The options allowed are:Blocking, Sleeping, BusySpin and Yielding."/> | |
| </endpoint> | |
| <endpoint name="disruptor-vm" display="Disruptor VM" label="endpoint" extends="model:endpoint" javaType="org.apache.camel.component.disruptor.vm.DisruptorVmComponent" maven="org.apache.camel:camel-disruptor:3.0.0-SNAPSHOT" async="true" since="2.12.0" description="The disruptor component provides asynchronous SEDA behavior using LMAX Disruptor."> | |
| <property name="blockWhenFull" type="boolean" display="Block When Full" label="producer" description="Whether a thread that sends messages to a full Disruptor will block until the ringbuffer's capacity is no longer exhausted. By default, the calling thread will block and wait until the message can be accepted. By disabling this option, an exception will be thrown stating that the queue is full."/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="consumer" description="Number of concurrent threads processing exchanges."/> | |
| <property name="multipleConsumers" type="boolean" display="Multiple Consumers" label="consumer" description="Specifies whether multiple consumers are allowed. If enabled, you can use Disruptor for Publish-Subscribe messaging. That is, you can send a message to the queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint."/> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="Name of queue"/> | |
| <property name="producerType" type="enum:DisruptorProducerType(Single,Multi)" display="Producer Type" label="producer" description="Defines the producers allowed on the Disruptor. The options allowed are: Multi to allow multiple producers and Single to enable certain optimizations only allowed when one concurrent producer (on one thread or otherwise synchronized) is active."/> | |
| <property name="size" type="int" display="Size" description="The maximum capacity of the Disruptors ringbuffer Will be effectively increased to the nearest power of two. Notice: Mind if you use this option, then its the first endpoint being created with the queue name, that determines the size. To make sure all endpoints use same size, then configure the size option on all of them, or the first endpoint being created."/> | |
| <property name="timeout" type="long" display="Timeout" label="producer" description="Timeout (in milliseconds) before a producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value."/> | |
| <property name="waitForTaskToComplete" type="enum:org.apache.camel.WaitForTaskToComplete(Never,IfReplyExpected,Always)" display="Wait For Task To Complete" label="producer" description="Option to specify whether the caller should wait for the async task to complete or not before continuing. The following three options are supported: Always, Never or IfReplyExpected. The first two values are self-explanatory. The last value, IfReplyExpected, will only wait if the message is Request Reply based."/> | |
| <property name="waitStrategy" type="enum:DisruptorWaitStrategy(Blocking,Sleeping,BusySpin,Yielding)" display="Wait Strategy" label="consumer" description="Defines the strategy used by consumer threads to wait on new exchanges to be published. The options allowed are:Blocking, Sleeping, BusySpin and Yielding."/> | |
| </endpoint> | |
| <endpoint name="dns" display="DNS" label="networking" extends="model:endpoint" javaType="org.apache.camel.component.dns.DnsComponent" maven="org.apache.camel:camel-dns:3.0.0-SNAPSHOT" producerOnly="true" since="2.7.0" description="To lookup domain information and run DNS queries using DNSJava."> | |
| <property name="dnsType" type="enum:DnsType(dig,ip,lookup,wikipedia)" display="Dns Type" required="true" kind="path" description="The type of the lookup."/> | |
| </endpoint> | |
| <endpoint name="docker" display="Docker" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.docker.DockerComponent" maven="org.apache.camel:camel-docker:3.0.0-SNAPSHOT" lenient="true" since="2.15.0" description="The docker component is used for managing Docker containers."> | |
| <property name="certPath" type="string" display="Cert Path" label="security" description="Location containing the SSL certificate chain"/> | |
| <property name="cmdExecFactory" type="string" display="Cmd Exec Factory" label="advanced" description="The fully qualified class name of the DockerCmdExecFactory implementation to use"/> | |
| <property name="email" type="string" display="Email" description="Email address associated with the user"/> | |
| <property name="followRedirectFilter" type="boolean" display="Follow Redirect Filter" label="advanced" description="Whether to follow redirect filter"/> | |
| <property name="host" type="string" display="Host" required="true" description="Docker host"/> | |
| <property name="loggingFilter" type="boolean" display="Logging Filter" label="advanced" description="Whether to use logging filter"/> | |
| <property name="maxPerRouteConnections" type="int" display="Max Per Route Connections" label="advanced" description="Maximum route connections"/> | |
| <property name="maxTotalConnections" type="int" display="Max Total Connections" label="advanced" description="Maximum total connections"/> | |
| <property name="operation" type="enum:DockerOperation(events,stats,auth,info,ping,version,imagebuild,imagecreate,imageinspect,imagelist,imagepull,imagepushimageremove,imagesearch,imagetag,containerattach,containercommit,containercopyfile,containercreate,containerdiffinspectcontainer,containerkill,containerlist,containerlog,containerpause,containerrestart,containerremove,containerstartcontainerstop,containertop,containerunpause,containerwait,execcreate,execstart)" display="Operation" required="true" kind="path" description="Which operation to use"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to authenticate with"/> | |
| <property name="port" type="int" display="Port" description="Docker port"/> | |
| <property name="requestTimeout" type="int" display="Request Timeout" description="Request timeout for response (in seconds)"/> | |
| <property name="secure" type="boolean" display="Secure" label="security" description="Use HTTPS communication"/> | |
| <property name="serverAddress" type="string" display="Server Address" label="advanced" description="Server address for docker registry."/> | |
| <property name="socket" type="boolean" display="Socket" label="advanced" description="Socket connection mode"/> | |
| <property name="tlsVerify" type="boolean" display="Tls Verify" label="security" description="Check TLS"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="User name to authenticate with"/> | |
| </endpoint> | |
| <endpoint name="dozer" display="Dozer" label="transformation" extends="model:endpoint" javaType="org.apache.camel.component.dozer.DozerComponent" maven="org.apache.camel:camel-dozer:3.0.0-SNAPSHOT" producerOnly="true" since="2.15.0" description="The dozer component provides the ability to map between Java beans using the Dozer mapping library."> | |
| <property name="mappingConfiguration" type="java:org.apache.camel.converter.dozer.DozerBeanMapperConfiguration" display="Mapping Configuration" description="The name of a DozerBeanMapperConfiguration bean in the Camel registry which should be used for configuring the Dozer mapping. This is an alternative to the mappingFile option that can be used for fine-grained control over how Dozer is configured. Remember to use a # prefix in the value to indicate that the bean is in the Camel registry (e.g. #myDozerConfig)."/> | |
| <property name="mappingFile" type="string" display="Mapping File" description="The location of a Dozer configuration file. The file is loaded from the classpath by default, but you can use file:, classpath:, or http: to load the configuration from a specific location."/> | |
| <property name="marshalId" type="string" display="Marshal Id" description="The id of a dataFormat defined within the Camel Context to use for marshalling the mapping output to a non-Java type."/> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="A human readable name of the mapping."/> | |
| <property name="sourceModel" type="string" display="Source Model" description="Fully-qualified class name for the source type used in the mapping. If specified, the input to the mapping is converted to the specified type before being mapped with Dozer."/> | |
| <property name="targetModel" type="string" display="Target Model" required="true" description="Fully-qualified class name for the target type used in the mapping."/> | |
| <property name="unmarshalId" type="string" display="Unmarshal Id" description="The id of a dataFormat defined within the Camel Context to use for unmarshalling the mapping input from a non-Java type."/> | |
| </endpoint> | |
| <endpoint name="drill" display="Drill" label="database,sql" extends="model:endpoint" javaType="org.apache.camel.component.drill.DrillComponent" maven="org.apache.camel:camel-drill:3.0.0-SNAPSHOT" producerOnly="true" since="2.19.0" description="The drill component gives you the ability to quering into apache drill cluster."> | |
| <property name="clusterId" type="string" display="Cluster Id" description="Cluster ID https://drill.apache.org/docs/using-the-jdbc-driver/#determining-the-cluster-id"/> | |
| <property name="directory" type="string" display="Directory" description="Drill directory in ZooKeeper"/> | |
| <property name="host" type="string" display="Host" required="true" kind="path" description="ZooKeeper host name or IP address. Use local instead of a host name or IP address to connect to the local Drillbit"/> | |
| <property name="mode" type="enum:DrillConnectionMode(ZK,DRILLBIT)" display="Mode" description="Connection mode: zk: Zookeeper drillbit: Drillbit direct connection https://drill.apache.org/docs/using-the-jdbc-driver/"/> | |
| <property name="port" type="int" display="Port" description="ZooKeeper port number"/> | |
| </endpoint> | |
| <endpoint name="dropbox" display="Dropbox" label="api,file" extends="model:endpoint" javaType="org.apache.camel.component.dropbox.DropboxComponent" maven="org.apache.camel:camel-dropbox:3.0.0-SNAPSHOT" since="2.14.0" description="For uploading, downloading and managing files, folders, groups, collaborations, etc on dropbox DOT com."> | |
| <property name="accessToken" type="string" display="Access Token" required="true" description="The access token to make API requests for a specific Dropbox user"/> | |
| <property name="client" type="java:com.dropbox.core.v2.DbxClientV2" display="Client" description="To use an existing DbxClient instance as DropBox client."/> | |
| <property name="clientIdentifier" type="string" display="Client Identifier" description="Name of the app registered to make API requests"/> | |
| <property name="localPath" type="string" display="Local Path" description="Optional folder or file to upload on Dropbox from the local filesystem. If this option has not been configured then the message body is used as the content to upload."/> | |
| <property name="newRemotePath" type="string" display="New Remote Path" description="Destination file or folder"/> | |
| <property name="operation" type="enum:DropboxOperation(put,del,search,get,move)" display="Operation" required="true" kind="path" description="The specific action (typically is a CRUD action) to perform on Dropbox remote folder."/> | |
| <property name="query" type="string" display="Query" description="A space-separated list of sub-strings to search for. A file matches only if it contains all the sub-strings. If this option is not set, all files will be matched."/> | |
| <property name="remotePath" type="string" display="Remote Path" description="Original file or folder to move"/> | |
| <property name="uploadMode" type="enum:DropboxUploadMode(add,force)" display="Upload Mode" description="Which mode to upload. in case of add the new file will be renamed if a file with the same name already exists on dropbox. in case of force if a file with the same name already exists on dropbox, this will be overwritten."/> | |
| </endpoint> | |
| <endpoint name="ehcache" display="Ehcache" label="cache,datagrid,clustering" extends="model:endpoint" javaType="org.apache.camel.component.ehcache.EhcacheComponent" maven="org.apache.camel:camel-ehcache:3.0.0-SNAPSHOT" since="2.18.0" description="The ehcache component enables you to perform caching operations using Ehcache as cache implementation."> | |
| <property name="action" type="string" display="Action" label="producer" description="To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence."/> | |
| <property name="cacheManager" type="java:org.ehcache.CacheManager" display="Cache Manager" description="The cache manager"/> | |
| <property name="cacheManagerConfiguration" type="java:org.ehcache.config.Configuration" display="Cache Manager Configuration" description="The cache manager configuration"/> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="the cache name"/> | |
| <property name="configuration" type="java:org.ehcache.config.CacheConfiguration<?,?>" display="Configuration" label="advanced" description="The default cache configuration to be used to create caches."/> | |
| <property name="configurationUri" type="string" display="Configuration Uri" description="URI pointing to the Ehcache XML configuration file's location"/> | |
| <property name="configurations" type="map(string,java:org.ehcache.config.CacheConfiguration<?,?>)" display="Configurations" label="advanced" description="A map of cache configuration to be used to create caches."/> | |
| <property name="createCacheIfNotExist" type="boolean" display="Create Cache If Not Exist" description="Configure if a cache need to be created if it does exist or can't be pre-configured."/> | |
| <property name="eventFiring" type="enum:org.ehcache.event.EventFiring(ASYNCHRONOUS,SYNCHRONOUS)" display="Event Firing" label="consumer" description="Set the delivery mode (synchronous, asynchronous)"/> | |
| <property name="eventOrdering" type="enum:org.ehcache.event.EventOrdering(UNORDERED,ORDERED)" display="Event Ordering" label="consumer" description="Set the delivery mode (ordered, unordered)"/> | |
| <property name="eventTypes" type="set(enum:org.ehcache.event.EventType(EVICTED,EXPIRED,REMOVED,CREATED,UPDATED))" display="Event Types" label="consumer" description="Set the type of events to listen for"/> | |
| <property name="key" type="object" display="Key" label="producer" description="To configure the default action key. If a key is set in the message header, then the key from the header takes precedence."/> | |
| <property name="keyType" type="string" display="Key Type" label="advanced" description="The cache key type, default java.lang.Object"/> | |
| <property name="valueType" type="string" display="Value Type" label="advanced" description="The cache value type, default java.lang.Object"/> | |
| </endpoint> | |
| <endpoint name="ejb" display="EJB" label="endpoint,java" extends="model:endpoint" javaType="org.apache.camel.component.ejb.EjbComponent" maven="org.apache.camel:camel-ejb:3.0.0-SNAPSHOT" producerOnly="true" since="2.4.0" description="The ejb component is for invoking EJB Java beans from Camel."> | |
| <property name="beanName" type="string" display="Bean Name" label="common" required="true" kind="path" description="Sets the name of the bean to invoke"/> | |
| <property name="cache" type="boolean" display="Cache" label="common" description="If enabled, Camel will cache the result of the first Registry look-up. Cache can be enabled if the bean in the Registry is defined as a singleton scope."/> | |
| <property name="method" type="string" display="Method" label="common" description="Sets the name of the method to invoke on the bean"/> | |
| <property name="parameters" type="map(string,object)" display="Parameters" label="common" description="Used for configuring additional properties on the bean"/> | |
| </endpoint> | |
| <endpoint name="elasticsearch-rest" display="Elastichsearch Rest" label="monitoring,search" extends="model:endpoint" javaType="org.apache.camel.component.elasticsearch.ElasticsearchComponent" maven="org.apache.camel:camel-elasticsearch-rest:3.0.0-SNAPSHOT" producerOnly="true" since="2.21.0" description="The elasticsearch component is used for interfacing with ElasticSearch server using REST API."> | |
| <property name="clusterName" type="string" display="Cluster Name" required="true" kind="path" description="Name of the cluster"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" description="The time in ms to wait before connection will timeout."/> | |
| <property name="disconnect" type="boolean" display="Disconnect" description="Disconnect after it finish calling the producer"/> | |
| <property name="enableSSL" type="boolean" display="Enable SSL" description="Enable SSL"/> | |
| <property name="hostAddresses" type="string" display="Host Addresses" required="true" description="Comma separated list with ip:port formatted remote transport addresses to use."/> | |
| <property name="indexName" type="string" display="Index Name" description="The name of the index to act against"/> | |
| <property name="indexType" type="string" display="Index Type" description="The type of the index to act against"/> | |
| <property name="maxRetryTimeout" type="int" display="Max Retry Timeout" description="The time in ms before retry"/> | |
| <property name="operation" type="enum:ElasticsearchOperation(Index,Update,Bulk,BulkIndex,GetById,MultiGet,MultiSearch,Delete,DeleteIndex,Search,Exists,Ping,Info)" display="Operation" description="What operation to perform"/> | |
| <property name="scrollKeepAliveMs" type="int" display="Scroll Keep Alive Ms" description="Time in ms during which elasticsearch will keep search context alive"/> | |
| <property name="socketTimeout" type="int" display="Socket Timeout" description="The timeout in ms to wait before the socket will timeout."/> | |
| <property name="useScroll" type="boolean" display="Use Scroll" description="Enable scroll usage"/> | |
| <property name="waitForActiveShards" type="int" display="Wait For Active Shards" description="Index creation waits for the write consistency number of shards to be available"/> | |
| </endpoint> | |
| <endpoint name="elsql" display="ElSQL" label="database,sql" extends="model:scheduled" javaType="org.apache.camel.component.elsql.ElsqlComponent" maven="org.apache.camel:camel-elsql:3.0.0-SNAPSHOT" since="2.16.0" description="The elsql component is an extension to the existing SQL Component that uses ElSql to define the SQL queries."> | |
| <property name="allowNamedParameters" type="boolean" display="Allow Named Parameters" description="Whether to allow using named parameters in the queries."/> | |
| <property name="alwaysPopulateStatement" type="boolean" display="Always Populate Statement" label="advanced" description="If enabled then the populateStatement method from org.apache.camel.component.sql.SqlPrepareStatementStrategy is always invoked, also if there is no expected parameters to be prepared. When this is false then the populateStatement is only invoked if there is 1 or more expected parameters to be set; for example this avoids reading the message body/headers for SQL queries with no parameters."/> | |
| <property name="batch" type="boolean" display="Batch" label="producer" description="Enables or disables batch mode"/> | |
| <property name="breakBatchOnConsumeFail" type="boolean" display="Break Batch On Consume Fail" label="consumer" description="Sets whether to break batch if onConsume failed."/> | |
| <property name="dataSource" type="java:javax.sql.DataSource" display="Data Source" description="Sets the DataSource to use to communicate with the database."/> | |
| <property name="dataSourceRef" type="string" display="Data Source Ref" deprecated="true" description="Sets the reference to a DataSource to lookup from the registry, to use for communicating with the database."/> | |
| <property name="databaseVendor" type="enum:ElSqlDatabaseVendor(Default,Postgres,HSql,MySql,Oracle,SqlServer2008,Veritca)" display="Database Vendor" description="To use a vendor specific com.opengamma.elsql.ElSqlConfig"/> | |
| <property name="elSqlConfig" type="java:com.opengamma.elsql.ElSqlConfig" display="El Sql Config" label="advanced" description="To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead."/> | |
| <property name="elsqlName" type="string" display="Elsql Name" required="true" kind="path" description="The name of the elsql to use (is NAMED in the elsql file)"/> | |
| <property name="expectedUpdateCount" type="int" display="Expected Update Count" label="consumer" description="Sets an expected update count to validate when using onConsume."/> | |
| <property name="maxMessagesPerPoll" type="int" display="Max Messages Per Poll" label="consumer" description="Sets the maximum number of messages to poll"/> | |
| <property name="noop" type="boolean" display="Noop" label="producer" description="If set, will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing"/> | |
| <property name="onConsume" type="string" display="On Consume" label="consumer" description="After processing each row then this query can be executed, if the Exchange was processed successfully, for example to mark the row as processed. The query can have parameter."/> | |
| <property name="onConsumeBatchComplete" type="string" display="On Consume Batch Complete" label="consumer" description="After processing the entire batch, this query can be executed to bulk update rows etc. The query cannot have parameters."/> | |
| <property name="onConsumeFailed" type="string" display="On Consume Failed" label="consumer" description="After processing each row then this query can be executed, if the Exchange failed, for example to mark the row as failed. The query can have parameter."/> | |
| <property name="outputClass" type="string" display="Output Class" description="Specify the full package and class name to use as conversion when outputType=SelectOne."/> | |
| <property name="outputHeader" type="string" display="Output Header" description="Store the query result in a header instead of the message body. By default, outputHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If outputHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved."/> | |
| <property name="outputType" type="enum:SqlOutputType(SelectOne,SelectList,StreamList)" display="Output Type" description="Make the output of consumer or producer to SelectList as List of Map, or SelectOne as single Java object in the following way: a) If the query has only single column, then that JDBC Column object is returned. (such as SELECT COUNT( ) FROM PROJECT will return a Long object. b) If the query has more than one column, then it will return a Map of that result. c) If the outputClass is set, then it will convert the query result into an Java bean object by calling all the setters that match the column names. It will assume your class has a default constructor to create instance with. d) If the query resulted in more than one rows, it throws an non-unique result exception. StreamList streams the result of the query using an Iterator. This can be used with the Splitter EIP in streaming mode to process the ResultSet in streaming fashion."/> | |
| <property name="parametersCount" type="int" display="Parameters Count" label="advanced" description="If set greater than zero, then Camel will use this count value of parameters to replace instead of querying via JDBC metadata API. This is useful if the JDBC vendor could not return correct parameters count, then user may override instead."/> | |
| <property name="placeholder" type="string" display="Placeholder" label="advanced" description="Specifies a character that will be replaced to in SQL query. Notice, that it is simple String.replaceAll() operation and no SQL parsing is involved (quoted strings will also change)."/> | |
| <property name="prepareStatementStrategy" type="java:org.apache.camel.component.sql.SqlPrepareStatementStrategy" display="Prepare Statement Strategy" label="advanced" description="Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement."/> | |
| <property name="processingStrategy" type="java:org.apache.camel.component.sql.SqlProcessingStrategy" display="Processing Strategy" label="consumer,advanced" description="Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch."/> | |
| <property name="resourceUri" type="string" display="Resource Uri" kind="path" description="The resource file which contains the elsql SQL statements to use. You can specify multiple resources separated by comma. The resources are loaded on the classpath by default, you can prefix with file: to load from file system. Notice you can set this option on the component and then you do not have to configure this on the endpoint."/> | |
| <property name="routeEmptyResultSet" type="boolean" display="Route Empty Result Set" label="consumer" description="Sets whether empty resultset should be allowed to be sent to the next hop. Defaults to false. So the empty resultset will be filtered out."/> | |
| <property name="separator" type="char" display="Separator" description="The separator to use when parameter values is taken from message body (if the body is a String type), to be inserted at # placeholders. Notice if you use named parameters, then a Map type is used instead. The default value is comma"/> | |
| <property name="templateOptions" type="map(string,object)" display="Template Options" label="advanced" description="Configures the Spring JdbcTemplate with the key/values from the Map"/> | |
| <property name="transacted" type="boolean" display="Transacted" label="consumer" description="Enables or disables transaction. If enabled then if processing an exchange failed then the consumerbreak out processing any further exchanges to cause a rollback eager."/> | |
| <property name="useIterator" type="boolean" display="Use Iterator" label="consumer" description="Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true."/> | |
| <property name="useMessageBodyForSql" type="boolean" display="Use Message Body For Sql" label="producer" description="Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used."/> | |
| <property name="usePlaceholder" type="boolean" display="Use Placeholder" label="advanced" description="Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries."/> | |
| </endpoint> | |
| <endpoint name="etcd" display="etcd" label="clustering,database" extends="model:scheduled" javaType="org.apache.camel.component.etcd.EtcdComponent" maven="org.apache.camel:camel-etcd:3.0.0-SNAPSHOT" since="2.18.0" description="The camel etcd component allows you to work with Etcd, a distributed reliable key-value store."> | |
| <property name="fromIndex" type="long" display="From Index" label="consumer,advanced" description="The index to watch from"/> | |
| <property name="namespace" type="enum:EtcdNamespace(keys,stats,watch)" display="Namespace" required="true" kind="path" description="The API namespace to use"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="The password to use for basic authentication."/> | |
| <property name="path" type="string" display="Path" kind="path" description="The path the endpoint refers to"/> | |
| <property name="recursive" type="boolean" display="Recursive" description="To apply an action recursively."/> | |
| <property name="sendEmptyExchangeOnTimeout" type="boolean" display="Send Empty Exchange On Timeout" label="consumer" description="To send an empty message in case of timeout watching for a key."/> | |
| <property name="servicePath" type="string" display="Service Path" description="The path to look for for service discovery"/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="security" description="To configure security using SSLContextParameters."/> | |
| <property name="timeToLive" type="int" display="Time To Live" label="producer" description="To set the lifespan of a key in milliseconds."/> | |
| <property name="timeout" type="long" display="Timeout" description="To set the maximum time an action could take to complete."/> | |
| <property name="uris" type="string" display="Uris" description="To set the URIs the client connects."/> | |
| <property name="userName" type="string" display="User Name" label="security" secret="true" description="The user name to use for basic authentication."/> | |
| </endpoint> | |
| <endpoint name="eventadmin" display="OSGi EventAdmin" label="eventbus" extends="model:endpoint" javaType="org.apache.camel.component.eventadmin.EventAdminComponent" maven="org.apache.camel:camel-eventadmin:3.0.0-SNAPSHOT" since="2.6.0" description="The eventadmin component can be used in an OSGi environment to receive OSGi EventAdmin events and process them."> | |
| <property name="send" type="boolean" display="Send" description="Whether to use 'send' or 'synchronous' deliver. Default false (async delivery)"/> | |
| <property name="topic" type="string" display="Topic" kind="path" description="Name of topic to listen or send to"/> | |
| </endpoint> | |
| <endpoint name="exec" display="Exec" label="system" extends="model:endpoint" javaType="org.apache.camel.component.exec.ExecComponent" maven="org.apache.camel:camel-exec:3.0.0-SNAPSHOT" producerOnly="true" since="2.3.0" description="The exec component can be used to execute OS system commands."> | |
| <property name="args" type="string" display="Args" description="The arguments may be one or many whitespace-separated tokens."/> | |
| <property name="binding" type="java:org.apache.camel.component.exec.ExecBinding" display="Binding" description="A reference to a org.apache.commons.exec.ExecBinding in the Registry."/> | |
| <property name="commandExecutor" type="java:org.apache.camel.component.exec.ExecCommandExecutor" display="Command Executor" description="A reference to a org.apache.commons.exec.ExecCommandExecutor in the Registry that customizes the command execution. The default command executor utilizes the commons-exec library, which adds a shutdown hook for every executed command."/> | |
| <property name="executable" type="string" display="Executable" required="true" kind="path" description="Sets the executable to be executed. The executable must not be empty or null."/> | |
| <property name="outFile" type="string" display="Out File" description="The name of a file, created by the executable, that should be considered as its output. If no outFile is set, the standard output (stdout) of the executable will be used instead."/> | |
| <property name="timeout" type="long" display="Timeout" description="The timeout, in milliseconds, after which the executable should be terminated. If execution has not completed within the timeout, the component will send a termination request."/> | |
| <property name="useStderrOnEmptyStdout" type="boolean" display="Use Stderr On Empty Stdout" description="A boolean indicating that when stdout is empty, this component will populate the Camel Message Body with stderr. This behavior is disabled (false) by default."/> | |
| <property name="workingDir" type="string" display="Working Dir" description="The directory in which the command should be executed. If null, the working directory of the current process will be used."/> | |
| </endpoint> | |
| <endpoint name="facebook" display="Facebook" label="social" extends="model:endpoint" javaType="org.apache.camel.component.facebook.FacebookComponent" maven="org.apache.camel:camel-facebook:3.0.0-SNAPSHOT" since="2.14.0" description="The Facebook component provides access to all of the Facebook APIs accessible using Facebook4J."> | |
| <property name="achievementURL" type="java:java.net.URL" display="Achievement URL" description="The unique URL of the achievement"/> | |
| <property name="albumId" type="string" display="Album Id" description="The album ID"/> | |
| <property name="albumUpdate" type="java:facebook4j.AlbumUpdate" display="Album Update" description="The facebook Album to be created or updated"/> | |
| <property name="appId" type="string" display="App Id" description="The ID of the Facebook Application"/> | |
| <property name="center" type="java:facebook4j.GeoLocation" display="Center" description="Location latitude and longitude"/> | |
| <property name="checkinId" type="string" display="Checkin Id" description="The checkin ID"/> | |
| <property name="checkinUpdate" type="java:facebook4j.CheckinUpdate" display="Checkin Update" deprecated="true" description="The checkin to be created. Deprecated, instead create a Post with an attached location"/> | |
| <property name="clientURL" type="string" display="Client URL" description="Facebook4J API client URL"/> | |
| <property name="clientVersion" type="string" display="Client Version" description="Facebook4J client API version"/> | |
| <property name="commentId" type="string" display="Comment Id" description="The comment ID"/> | |
| <property name="commentUpdate" type="java:facebook4j.CommentUpdate" display="Comment Update" description="The facebook Comment to be created or updated"/> | |
| <property name="debugEnabled" type="boolean" display="Debug Enabled" description="Enables deubg output. Effective only with the embedded logger"/> | |
| <property name="description" type="string" display="Description" description="The description text"/> | |
| <property name="distance" type="int" display="Distance" description="Distance in meters"/> | |
| <property name="domainId" type="string" display="Domain Id" description="The domain ID"/> | |
| <property name="domainName" type="string" display="Domain Name" description="The domain name"/> | |
| <property name="domainNames" type="list(string)" display="Domain Names" description="The domain names"/> | |
| <property name="eventId" type="string" display="Event Id" description="The event ID"/> | |
| <property name="eventUpdate" type="java:facebook4j.EventUpdate" display="Event Update" description="The event to be created or updated"/> | |
| <property name="friendId" type="string" display="Friend Id" description="The friend ID"/> | |
| <property name="friendUserId" type="string" display="Friend User Id" description="The friend user ID"/> | |
| <property name="friendlistId" type="string" display="Friendlist Id" description="The friend list ID"/> | |
| <property name="friendlistName" type="string" display="Friendlist Name" description="The friend list Name"/> | |
| <property name="groupId" type="string" display="Group Id" description="The group ID"/> | |
| <property name="gzipEnabled" type="boolean" display="Gzip Enabled" description="Use Facebook GZIP encoding"/> | |
| <property name="httpConnectionTimeout" type="int" display="Http Connection Timeout" description="Http connection timeout in milliseconds"/> | |
| <property name="httpDefaultMaxPerRoute" type="int" display="Http Default Max Per Route" description="HTTP maximum connections per route"/> | |
| <property name="httpMaxTotalConnections" type="int" display="Http Max Total Connections" description="HTTP maximum total connections"/> | |
| <property name="httpProxyHost" type="string" display="Http Proxy Host" label="proxy" description="HTTP proxy server host name"/> | |
| <property name="httpProxyPassword" type="string" display="Http Proxy Password" label="proxy" description="HTTP proxy server password"/> | |
| <property name="httpProxyPort" type="int" display="Http Proxy Port" label="proxy" description="HTTP proxy server port"/> | |
| <property name="httpProxyUser" type="string" display="Http Proxy User" label="proxy" description="HTTP proxy server user name"/> | |
| <property name="httpReadTimeout" type="int" display="Http Read Timeout" description="Http read timeout in milliseconds"/> | |
| <property name="httpRetryCount" type="int" display="Http Retry Count" description="Number of HTTP retries"/> | |
| <property name="httpRetryIntervalSeconds" type="int" display="Http Retry Interval Seconds" description="HTTP retry interval in seconds"/> | |
| <property name="httpStreamingReadTimeout" type="int" display="Http Streaming Read Timeout" description="HTTP streaming read timeout in milliseconds"/> | |
| <property name="ids" type="list(string)" display="Ids" description="The ids of users"/> | |
| <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="includeRead" type="boolean" display="Include Read" description="Enables notifications that the user has already read in addition to unread ones"/> | |
| <property name="isHidden" type="boolean" display="Is Hidden" description="Whether hidden"/> | |
| <property name="jsonStoreEnabled" type="boolean" display="Json Store Enabled" description="If set to true, raw JSON forms will be stored in DataObjectFactory"/> | |
| <property name="link" type="java:java.net.URL" display="Link" description="Link URL"/> | |
| <property name="linkId" type="string" display="Link Id" description="Link ID"/> | |
| <property name="locale" type="java:java.util.Locale" display="Locale" description="Desired FQL locale"/> | |
| <property name="mbeanEnabled" type="boolean" display="Mbean Enabled" description="If set to true, Facebook4J mbean will be registerd"/> | |
| <property name="message" type="string" display="Message" description="The message text"/> | |
| <property name="messageId" type="string" display="Message Id" description="The message ID"/> | |
| <property name="methodName" type="string" display="Method Name" required="true" kind="path" description="What operation to perform"/> | |
| <property name="metric" type="string" display="Metric" description="The metric name"/> | |
| <property name="milestoneId" type="string" display="Milestone Id" description="The milestone id"/> | |
| <property name="name" type="string" display="Name" description="Test user name, must be of the form 'first last'"/> | |
| <property name="noteId" type="string" display="Note Id" description="The note ID"/> | |
| <property name="notificationId" type="string" display="Notification Id" description="The notification ID"/> | |
| <property name="oAuthAccessToken" type="string" display="OAuth Access Token" label="security" secret="true" description="The user access token"/> | |
| <property name="oAuthAccessTokenURL" type="string" display="OAuth Access Token URL" label="security" description="OAuth access token URL"/> | |
| <property name="oAuthAppId" type="string" display="OAuth App Id" label="security" secret="true" description="The application Id"/> | |
| <property name="oAuthAppSecret" type="string" display="OAuth App Secret" label="security" secret="true" description="The application Secret"/> | |
| <property name="oAuthAuthorizationURL" type="string" display="OAuth Authorization URL" label="security" description="OAuth authorization URL"/> | |
| <property name="oAuthPermissions" type="string" display="OAuth Permissions" label="security" description="Default OAuth permissions. Comma separated permission names. See https://developers.facebook.com/docs/reference/login/#permissions for the detail"/> | |
| <property name="objectId" type="string" display="Object Id" description="The insight object ID"/> | |
| <property name="offerId" type="string" display="Offer Id" description="The offer id"/> | |
| <property name="optionDescription" type="string" display="Option Description" description="The question's answer option description"/> | |
| <property name="pageId" type="string" display="Page Id" description="The page id"/> | |
| <property name="permissionName" type="string" display="Permission Name" description="The permission name"/> | |
| <property name="permissions" type="string" display="Permissions" description="Test user permissions in the format perm1,perm2,..."/> | |
| <property name="photoId" type="string" display="Photo Id" description="The photo ID"/> | |
| <property name="pictureId" type="int" display="Picture Id" description="The picture id"/> | |
| <property name="pictureId2" type="int" display="Picture Id2" description="The picture2 id"/> | |
| <property name="pictureSize" type="enum:facebook4j.PictureSize(square,small,normal,large,thumbnail,album)" display="Picture Size" description="The picture size"/> | |
| <property name="placeId" type="string" display="Place Id" description="The place ID"/> | |
| <property name="postId" type="string" display="Post Id" description="The post ID"/> | |
| <property name="postUpdate" type="java:facebook4j.PostUpdate" display="Post Update" description="The post to create or update"/> | |
| <property name="prettyDebugEnabled" type="boolean" display="Pretty Debug Enabled" description="Prettify JSON debug output if set to true"/> | |
| <property name="queries" type="map(string,string)" display="Queries" description="FQL queries"/> | |
| <property name="query" type="string" display="Query" description="FQL query or search terms for search endpoints"/> | |
| <property name="questionId" type="string" display="Question Id" description="The question id"/> | |
| <property name="reading" type="java:facebook4j.Reading" display="Reading" description="Optional reading parameters. See Reading Options(#reading)"/> | |
| <property name="readingOptions" type="map(string,object)" display="Reading Options" description="To configure Reading using key/value pairs from the Map."/> | |
| <property name="restBaseURL" type="string" display="Rest Base URL" description="API base URL"/> | |
| <property name="scoreValue" type="int" display="Score Value" description="The numeric score with value"/> | |
| <property name="size" type="enum:facebook4j.PictureSize(square,small,normal,large,thumbnail,album)" display="Size" description="The picture size, one of large, normal, small or square"/> | |
| <property name="source" type="java:facebook4j.Media" display="Source" description="The media content from either a java.io.File or java.io.Inputstream"/> | |
| <property name="subject" type="string" display="Subject" description="The note of the subject"/> | |
| <property name="tabId" type="string" display="Tab Id" description="The tab id"/> | |
| <property name="tagUpdate" type="java:facebook4j.TagUpdate" display="Tag Update" description="Photo tag information"/> | |
| <property name="testUser1" type="java:facebook4j.TestUser" display="Test User1" description="Test user 1"/> | |
| <property name="testUser2" type="java:facebook4j.TestUser" display="Test User2" description="Test user 2"/> | |
| <property name="testUserId" type="string" display="Test User Id" description="The ID of the test user"/> | |
| <property name="title" type="string" display="Title" description="The title text"/> | |
| <property name="toUserId" type="string" display="To User Id" description="The ID of the user to tag"/> | |
| <property name="toUserIds" type="list(string)" display="To User Ids" description="The IDs of the users to tag"/> | |
| <property name="useSSL" type="boolean" display="Use SSL" description="Use SSL"/> | |
| <property name="userId" type="string" display="User Id" description="The Facebook user ID"/> | |
| <property name="userId1" type="string" display="User Id1" description="The ID of a user 1"/> | |
| <property name="userId2" type="string" display="User Id2" description="The ID of a user 2"/> | |
| <property name="userIds" type="list(string)" display="User Ids" description="The IDs of users to invite to event"/> | |
| <property name="userLocale" type="string" display="User Locale" description="The test user locale"/> | |
| <property name="videoBaseURL" type="string" display="Video Base URL" description="Video API base URL"/> | |
| <property name="videoId" type="string" display="Video Id" description="The video ID"/> | |
| </endpoint> | |
| <endpoint name="fhir" display="FHIR" label="hl7,api" extends="model:endpoint" javaType="org.apache.camel.component.fhir.FhirComponent" maven="org.apache.camel:camel-fhir:3.0.0-SNAPSHOT" since="2.23.0" description="The fhir component is used for working with the FHIR protocol (health care)."> | |
| <property name="accessToken" type="string" display="Access Token" label="security" secret="true" description="OAuth access token"/> | |
| <property name="apiName" type="enum:FhirApiName(CAPABILITIES:capabilities,CREATE:create,DELETE:delete,HISTORY:history,LOAD_PAGE:load-page,META:meta,PATCH:patch,READ:read,SEARCH:search,TRANSACTION:transaction,UPDATE:update,VALIDATE:validate)" display="Api Name" required="true" kind="path" description="What kind of operation to perform"/> | |
| <property name="client" type="java:ca.uhn.fhir.rest.client.api.IGenericClient" display="Client" label="advanced" description="To use the custom client"/> | |
| <property name="clientFactory" type="java:ca.uhn.fhir.rest.client.api.IRestfulClientFactory" display="Client Factory" label="advanced" description="To use the custom client factory"/> | |
| <property name="compress" type="boolean" display="Compress" label="advanced" description="Compresses outgoing (POST/PUT) contents to the GZIP format"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="How long to try and establish the initial TCP connection (in ms)"/> | |
| <property name="deferModelScanning" type="boolean" display="Defer Model Scanning" label="advanced" description="When this option is set, model classes will not be scanned for children until the child list for the given type is actually accessed."/> | |
| <property name="encoding" type="string" display="Encoding" description="Encoding to use for all request"/> | |
| <property name="fhirContext" type="java:ca.uhn.fhir.context.FhirContext" display="Fhir Context" label="advanced" description="FhirContext is an expensive object to create. To avoid creating multiple instances, it can be set directly."/> | |
| <property name="fhirVersion" type="string" display="Fhir Version" description="The FHIR Version to use"/> | |
| <property name="forceConformanceCheck" type="boolean" display="Force Conformance Check" label="advanced" description="Force conformance check"/> | |
| <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="log" type="boolean" display="Log" description="Will log every requests and responses"/> | |
| <property name="methodName" type="string" display="Method Name" required="true" kind="path" description="What sub operation to use for the selected operation"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Username to use for basic authentication"/> | |
| <property name="prettyPrint" type="boolean" display="Pretty Print" description="Pretty print all request"/> | |
| <property name="proxyHost" type="string" display="Proxy Host" label="proxy" description="The proxy host"/> | |
| <property name="proxyPassword" type="string" display="Proxy Password" label="proxy" description="The proxy password"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" label="proxy" description="The proxy port"/> | |
| <property name="proxyUser" type="string" display="Proxy User" label="proxy" description="The proxy username"/> | |
| <property name="serverUrl" type="string" display="Server Url" description="The FHIR server base URL"/> | |
| <property name="sessionCookie" type="string" display="Session Cookie" label="advanced" description="HTTP session cookie to add to every request"/> | |
| <property name="socketTimeout" type="int" display="Socket Timeout" label="advanced" description="How long to block for individual read/write operations (in ms)"/> | |
| <property name="summary" type="string" display="Summary" label="advanced" description="Request that the server modify the response using the _summary param"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to use for basic authentication"/> | |
| <property name="validationMode" type="string" display="Validation Mode" label="advanced" description="When should Camel validate the FHIR Server's conformance statement"/> | |
| </endpoint> | |
| <endpoint name="file" display="File" label="core,file" extends="model:scheduled" javaType="org.apache.camel.component.file.FileComponent" maven="org.apache.camel:camel-file:3.0.0-SNAPSHOT" since="1.0.0" description="The file component is used for reading or writing files."> | |
| <property name="allowNullBody" type="boolean" display="Allow Null Body" label="producer,advanced" description="Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."/> | |
| <property name="antExclude" type="string" display="Ant Exclude" label="consumer,filter" description="Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format."/> | |
| <property name="antFilterCaseSensitive" type="boolean" display="Ant Filter Case Sensitive" label="consumer,filter" description="Sets case sensitive flag on ant filter"/> | |
| <property name="antInclude" type="string" display="Ant Include" label="consumer,filter" description="Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format."/> | |
| <property name="autoCreate" type="boolean" display="Auto Create" label="advanced" description="Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to."/> | |
| <property name="bufferSize" type="int" display="Buffer Size" label="advanced" description="Write buffer sized in bytes."/> | |
| <property name="charset" type="string" display="Charset" description="This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages."/> | |
| <property name="chmod" type="string" display="Chmod" label="producer,advanced" description="Specify the file permissions which is sent by the producer, the chmod value must be between 000 and 777; If there is a leading digit like in 0755 we will ignore it."/> | |
| <property name="chmodDirectory" type="string" display="Chmod Directory" label="producer,advanced" description="Specify the directory permissions used when the producer creates missing directories, the chmod value must be between 000 and 777; If there is a leading digit like in 0755 we will ignore it."/> | |
| <property name="copyAndDeleteOnRenameFail" type="boolean" display="Copy And Delete On Rename Fail" label="advanced" description="Whether to fallback and do a copy and delete file, in case the file could not be renamed directly. This option is not available for the FTP component."/> | |
| <property name="delete" type="boolean" display="Delete" label="consumer" description="If true, the file will be deleted after it is processed successfully."/> | |
| <property name="directoryMustExist" type="boolean" display="Directory Must Exist" label="consumer,advanced" description="Similar to the startingDirectoryMustExist option but this applies during polling (after starting the consumer)."/> | |
| <property name="directoryName" type="java:java.io.File" display="Directory Name" required="true" kind="path" description="The starting directory"/> | |
| <property name="doneFileName" type="string" display="Done File Name" description="Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.noext} is supported as dynamic placeholders."/> | |
| <property name="eagerDeleteTargetFile" type="boolean" display="Eager Delete Target File" label="producer,advanced" description="Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation."/> | |
| <property name="eagerMaxMessagesPerPoll" type="boolean" display="Eager Max Messages Per Poll" label="consumer,filter" description="Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting."/> | |
| <property name="exclude" type="string" display="Exclude" label="consumer,filter" description="Is used to exclude files, if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"/> | |
| <property name="exclusiveReadLockStrategy" type="java:org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy<T>" display="Exclusive Read Lock Strategy" label="consumer,lock" description="Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation."/> | |
| <property name="extendedAttributes" type="string" display="Extended Attributes" label="consumer,advanced" description="To define which file attributes of interest. Like posix:permissions,posix:owner,basic:lastAccessTime, it supports basic wildcard like posix:, basic:lastAccessTime"/> | |
| <property name="fileExist" type="enum:GenericFileExist(Override,Append,Fail,Ignore,Move,TryRename)" display="File Exist" label="producer" description="What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. Append - adds content to the existing file. Fail - throws a GenericFileOperationException, indicating that there is already an existing file. Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers."/> | |
| <property name="fileName" type="string" display="File Name" description="Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."/> | |
| <property name="filter" type="java:org.apache.camel.component.file.GenericFileFilter<T>" display="Filter" label="consumer,filter" description="Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method."/> | |
| <property name="filterDirectory" type="string" display="Filter Directory" label="consumer,filter" description="Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}"/> | |
| <property name="filterFile" type="string" display="Filter File" label="consumer,filter" description="Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000"/> | |
| <property name="flatten" type="boolean" display="Flatten" label="producer" description="Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."/> | |
| <property name="forceWrites" type="boolean" display="Force Writes" label="producer,advanced" description="Whether to force syncing writes to the file system. You can turn this off if you do not want this level of guarantee, for example if writing to logs / audit logs etc; this would yield better performance."/> | |
| <property name="idempotent" type="boolean" display="Idempotent" label="consumer,filter" description="Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."/> | |
| <property name="idempotentKey" type="string" display="Idempotent Key" label="consumer,filter" description="To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}"/> | |
| <property name="idempotentRepository" type="java:org.apache.camel.spi.IdempotentRepository" display="Idempotent Repository" label="consumer,filter" description="A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true."/> | |
| <property name="inProgressRepository" type="java:org.apache.camel.spi.IdempotentRepository" display="In Progress Repository" label="consumer,advanced" description="A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."/> | |
| <property name="include" type="string" display="Include" label="consumer,filter" description="Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"/> | |
| <property name="jailStartingDirectory" type="boolean" display="Jail Starting Directory" label="producer" description="Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."/> | |
| <property name="keepLastModified" type="boolean" display="Keep Last Modified" label="producer,advanced" description="Will keep the last modified timestamp from the source file (if any). Will use the Exchange.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers."/> | |
| <property name="localWorkDirectory" type="string" display="Local Work Directory" label="consumer,advanced" description="When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory."/> | |
| <property name="maxDepth" type="int" display="Max Depth" label="consumer,filter" description="The maximum depth to traverse when recursively processing a directory."/> | |
| <property name="maxMessagesPerPoll" type="int" display="Max Messages Per Poll" label="consumer,filter" description="To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards."/> | |
| <property name="minDepth" type="int" display="Min Depth" label="consumer,filter" description="The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory."/> | |
| <property name="move" type="string" display="Move" label="consumer,filter" description="Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done."/> | |
| <property name="moveExisting" type="string" display="Move Existing" label="producer" description="Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base."/> | |
| <property name="moveExistingFileStrategy" type="java:org.apache.camel.component.file.strategy.FileMoveExistingStrategy" display="Move Existing File Strategy" label="producer,advanced" description="Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"/> | |
| <property name="moveFailed" type="string" display="Move Failed" label="consumer" description="Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again."/> | |
| <property name="noop" type="boolean" display="Noop" label="consumer" description="If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again."/> | |
| <property name="onCompletionExceptionHandler" type="java:org.apache.camel.spi.ExceptionHandler" display="On Completion Exception Handler" label="consumer,advanced" description="To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore."/> | |
| <property name="preMove" type="string" display="Pre Move" label="consumer" description="Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order."/> | |
| <property name="preSort" type="boolean" display="Pre Sort" label="consumer" description="When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled."/> | |
| <property name="probeContentType" type="boolean" display="Probe Content Type" label="consumer,advanced" description="Whether to enable probing of the content type. If enable then the consumer uses Files#probeContentType(java.nio.file.Path) to determine the content-type of the file, and store that as a header with key Exchange#FILE_CONTENT_TYPE on the Message."/> | |
| <property name="processStrategy" type="java:org.apache.camel.component.file.GenericFileProcessStrategy<T>" display="Process Strategy" label="consumer,advanced" description="A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply."/> | |
| <property name="readLock" type="string" display="Read Lock" label="consumer,lock" description="Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: none - No read lock is in use markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan."/> | |
| <property name="readLockCheckInterval" type="long" display="Read Lock Check Interval" label="consumer,lock" description="Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit."/> | |
| <property name="readLockDeleteOrphanLockFiles" type="boolean" display="Read Lock Delete Orphan Lock Files" label="consumer,lock" description="Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory."/> | |
| <property name="readLockIdempotentReleaseAsync" type="boolean" display="Read Lock Idempotent Release Async" label="consumer,lock" description="Whether the delayed release task should be synchronous or asynchronous. See more details at the readLockIdempotentReleaseDelay option."/> | |
| <property name="readLockIdempotentReleaseAsyncPoolSize" type="int" display="Read Lock Idempotent Release Async Pool Size" label="consumer,lock" description="The number of threads in the scheduled thread pool when using asynchronous release tasks. Using a default of 1 core threads should be sufficient in almost all use-cases, only set this to a higher value if either updating the idempotent repository is slow, or there are a lot of files to process. This option is not in-use if you use a shared thread pool by configuring the readLockIdempotentReleaseExecutorService option. See more details at the readLockIdempotentReleaseDelay option."/> | |
| <property name="readLockIdempotentReleaseDelay" type="int" display="Read Lock Idempotent Release Delay" label="consumer,lock" description="Whether to delay the release task for a period of millis. This can be used to delay the release tasks to expand the window when a file is regarded as read-locked, in an active/active cluster scenario with a shared idempotent repository, to ensure other nodes cannot potentially scan and acquire the same file, due to race-conditions. By expanding the time-window of the release tasks helps prevents these situations. Note delaying is only needed if you have configured readLockRemoveOnCommit to true."/> | |
| <property name="readLockIdempotentReleaseExecutorService" type="java:java.util.concurrent.ScheduledExecutorService" display="Read Lock Idempotent Release Executor Service" label="consumer,lock" description="To use a custom and shared thread pool for asynchronous release tasks. See more details at the readLockIdempotentReleaseDelay option."/> | |
| <property name="readLockLoggingLevel" type="enum:org.apache.camel.LoggingLevel(TRACE,DEBUG,INFO,WARN,ERROR,OFF)" display="Read Lock Logging Level" label="consumer,lock" description="Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename."/> | |
| <property name="readLockMarkerFile" type="boolean" display="Read Lock Marker File" label="consumer,lock" description="Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application."/> | |
| <property name="readLockMinAge" type="long" display="Read Lock Min Age" label="consumer,lock" description="This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age."/> | |
| <property name="readLockMinLength" type="long" display="Read Lock Min Length" label="consumer,lock" description="This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files."/> | |
| <property name="readLockRemoveOnCommit" type="boolean" display="Read Lock Remove On Commit" label="consumer,lock" description="This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option."/> | |
| <property name="readLockRemoveOnRollback" type="boolean" display="Read Lock Remove On Rollback" label="consumer,lock" description="This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit)."/> | |
| <property name="readLockTimeout" type="long" display="Read Lock Timeout" label="consumer,lock" description="Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit."/> | |
| <property name="recursive" type="boolean" display="Recursive" label="consumer" description="If a directory, will look for files in all the sub-directories as well."/> | |
| <property name="renameUsingCopy" type="boolean" display="Rename Using Copy" label="advanced" description="Perform rename operations using a copy and delete strategy. This is primarily used in environments where the regular rename operation is unreliable (e.g. across different file systems or networks). This option takes precedence over the copyAndDeleteOnRenameFail parameter that will automatically fall back to the copy and delete strategy, but only after additional delays."/> | |
| <property name="shuffle" type="boolean" display="Shuffle" label="consumer,sort" description="To shuffle the list of files (sort in random order)"/> | |
| <property name="sortBy" type="string" display="Sort By" label="consumer,sort" description="Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date."/> | |
| <property name="sorter" type="java:java.util.Comparator<org.apache.camel.component.file.GenericFile<T>>" display="Sorter" label="consumer,sort" description="Pluggable sorter as a java.util.Comparator class."/> | |
| <property name="startingDirectoryMustExist" type="boolean" display="Starting Directory Must Exist" label="consumer,advanced" description="Whether the starting directory must exist. Mind that the autoCreate option is default enabled, which means the starting directory is normally auto created if it doesn't exist. You can disable autoCreate and enable this to ensure the starting directory must exist. Will thrown an exception if the directory doesn't exist."/> | |
| <property name="startingDirectoryMustHaveAccess" type="boolean" display="Starting Directory Must Have Access" label="consumer,advanced" description="Whether the starting directory has access permissions. Mind that the startingDirectoryMustExist parameter must be set to true in order to verify that the directory exists. Will thrown an exception if the directory doesn't have read and write permissions."/> | |
| <property name="tempFileName" type="string" display="Temp File Name" label="producer" description="The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir."/> | |
| <property name="tempPrefix" type="string" display="Temp Prefix" label="producer" description="This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files."/> | |
| </endpoint> | |
| <endpoint name="flatpack" display="Flatpack" label="transformation" extends="model:scheduled" javaType="org.apache.camel.component.flatpack.FlatpackComponent" maven="org.apache.camel:camel-flatpack:3.0.0-SNAPSHOT" since="1.4.0" description="The flatpack component supports fixed width and delimited file parsing via the FlatPack library."> | |
| <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="delimiter" type="char" display="Delimiter" description="The default character delimiter for delimited files."/> | |
| <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)."/> | |
| <property name="resourceUri" type="string" display="Resource Uri" required="true" kind="path" description="URL for loading the flatpack mapping file from classpath or file system"/> | |
| <property name="splitRows" type="boolean" display="Split Rows" description="Sets the Component to send each row as a separate exchange once parsed"/> | |
| <property name="textQualifier" type="char" display="Text Qualifier" description="The text qualifier for delimited files."/> | |
| <property name="type" type="enum:FlatpackType(fixed,delim)" display="Type" kind="path" description="Whether to use fixed or delimiter"/> | |
| </endpoint> | |
| <endpoint name="flink" display="Apache Flink" label="hadoop" extends="model:endpoint" javaType="org.apache.camel.component.flink.FlinkComponent" maven="org.apache.camel:camel-flink:3.0.0-SNAPSHOT" producerOnly="true" since="2.18.0" description="The flink component can be used to send DataSet jobs to Apache Flink cluster."> | |
| <property name="collect" type="boolean" display="Collect" description="Indicates if results should be collected or counted."/> | |
| <property name="dataSet" type="java:org.apache.flink.api.java.DataSet" display="Data Set" description="DataSet to compute against."/> | |
| <property name="dataSetCallback" type="java:org.apache.camel.component.flink.DataSetCallback" display="Data Set Callback" description="Function performing action against a DataSet."/> | |
| <property name="dataStream" type="java:org.apache.flink.streaming.api.datastream.DataStream" display="Data Stream" description="DataStream to compute against."/> | |
| <property name="dataStreamCallback" type="java:org.apache.camel.component.flink.DataStreamCallback" display="Data Stream Callback" description="Function performing action against a DataStream."/> | |
| <property name="endpointType" type="enum:EndpointType(dataset,datastream)" display="Endpoint Type" required="true" kind="path" description="Type of the endpoint (dataset, datastream)."/> | |
| </endpoint> | |
| <endpoint name="fop" display="FOP" label="transformation" extends="model:endpoint" javaType="org.apache.camel.component.fop.FopComponent" maven="org.apache.camel:camel-fop:3.0.0-SNAPSHOT" producerOnly="true" since="2.10.0" description="The fop component allows you to render a message into different output formats using Apache FOP."> | |
| <property name="fopFactory" type="java:org.apache.fop.apps.FopFactory" display="Fop Factory" description="Allows to use a custom configured or implementation of org.apache.fop.apps.FopFactory."/> | |
| <property name="outputType" type="enum:FopOutputType(pdf,ps,pcl,png,jpeg,svg,xml,mif,rtf,txt)" display="Output Type" required="true" kind="path" description="The primary output format is PDF but other output formats are also supported."/> | |
| <property name="userConfigURL" type="string" display="User Config URL" description="The location of a configuration file which can be loaded from classpath or file system."/> | |
| </endpoint> | |
| <endpoint name="freemarker" display="Freemarker" label="transformation" extends="model:endpoint" javaType="org.apache.camel.component.freemarker.FreemarkerComponent" maven="org.apache.camel:camel-freemarker:3.0.0-SNAPSHOT" producerOnly="true" since="2.10.0" description="Transforms the message using a FreeMarker template."> | |
| <property name="configuration" type="java:freemarker.template.Configuration" display="Configuration" description="Sets the Freemarker configuration to use"/> | |
| <property name="contentCache" type="boolean" display="Content Cache" description="Sets whether to use resource content cache or not"/> | |
| <property name="encoding" type="string" display="Encoding" description="Sets the encoding to be used for loading the template file."/> | |
| <property name="resourceUri" type="string" display="Resource Uri" required="true" kind="path" description="Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."/> | |
| <property name="templateUpdateDelay" type="int" display="Template Update Delay" description="Number of seconds the loaded template resource will remain in the cache."/> | |
| </endpoint> | |
| <endpoint name="ftp" display="FTP" label="file" extends="model:scheduled" javaType="org.apache.camel.component.file.remote.FtpComponent" maven="org.apache.camel:camel-ftp:3.0.0-SNAPSHOT" since="1.1.0" description="The ftp component is used for uploading or downloading files from FTP servers."> | |
| <property name="account" type="string" display="Account" label="security" secret="true" description="Account to use for login"/> | |
| <property name="activePortRange" type="string" display="Active Port Range" label="advanced" description="Set the client side port range in active mode. The syntax is: minPort-maxPort Both port numbers are inclusive, eg 10000-19999 to include all 1xxxx ports."/> | |
| <property name="allowNullBody" type="boolean" display="Allow Null Body" label="producer,advanced" description="Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."/> | |
| <property name="antExclude" type="string" display="Ant Exclude" label="consumer,filter" description="Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format."/> | |
| <property name="antFilterCaseSensitive" type="boolean" display="Ant Filter Case Sensitive" label="consumer,filter" description="Sets case sensitive flag on ant filter"/> | |
| <property name="antInclude" type="string" display="Ant Include" label="consumer,filter" description="Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format."/> | |
| <property name="autoCreate" type="boolean" display="Auto Create" label="advanced" description="Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to."/> | |
| <property name="binary" type="boolean" display="Binary" description="Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false)."/> | |
| <property name="bufferSize" type="int" display="Buffer Size" label="advanced" description="Write buffer sized in bytes."/> | |
| <property name="charset" type="string" display="Charset" description="This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages."/> | |
| <property name="chmod" type="string" display="Chmod" label="producer,advanced" description="Allows you to set chmod on the stored file. For example chmod=640."/> | |
| <property name="connectTimeout" type="int" display="Connect Timeout" label="advanced" description="Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH"/> | |
| <property name="delete" type="boolean" display="Delete" label="consumer" description="If true, the file will be deleted after it is processed successfully."/> | |
| <property name="directoryName" type="string" display="Directory Name" kind="path" description="The starting directory"/> | |
| <property name="disconnect" type="boolean" display="Disconnect" label="common" description="Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead."/> | |
| <property name="disconnectOnBatchComplete" type="boolean" display="Disconnect On Batch Complete" label="producer,advanced" description="Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server."/> | |
| <property name="doneFileName" type="string" display="Done File Name" description="Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.noext} is supported as dynamic placeholders."/> | |
| <property name="download" type="boolean" display="Download" label="consumer,advanced" description="Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded."/> | |
| <property name="eagerDeleteTargetFile" type="boolean" display="Eager Delete Target File" label="producer,advanced" description="Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation."/> | |
| <property name="eagerMaxMessagesPerPoll" type="boolean" display="Eager Max Messages Per Poll" label="consumer,filter" description="Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting."/> | |
| <property name="exclude" type="string" display="Exclude" label="consumer,filter" description="Is used to exclude files, if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"/> | |
| <property name="exclusiveReadLockStrategy" type="java:org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy<T>" display="Exclusive Read Lock Strategy" label="consumer,lock" description="Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation."/> | |
| <property name="fastExistsCheck" type="boolean" display="Fast Exists Check" label="common,advanced" description="If set this option to be true, camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly, if the option is false, camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files."/> | |
| <property name="fileExist" type="enum:GenericFileExist(Override,Append,Fail,Ignore,Move,TryRename)" display="File Exist" label="producer" description="What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. Append - adds content to the existing file. Fail - throws a GenericFileOperationException, indicating that there is already an existing file. Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers."/> | |
| <property name="fileName" type="string" display="File Name" description="Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."/> | |
| <property name="filter" type="java:org.apache.camel.component.file.GenericFileFilter<T>" display="Filter" label="consumer,filter" description="Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method."/> | |
| <property name="filterDirectory" type="string" display="Filter Directory" label="consumer,filter" description="Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}"/> | |
| <property name="filterFile" type="string" display="Filter File" label="consumer,filter" description="Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000"/> | |
| <property name="flatten" type="boolean" display="Flatten" label="producer" description="Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."/> | |
| <property name="ftpClient" type="java:org.apache.commons.net.ftp.FTPClient" display="Ftp Client" label="advanced" description="To use a custom instance of FTPClient"/> | |
| <property name="ftpClientConfig" type="java:org.apache.commons.net.ftp.FTPClientConfig" display="Ftp Client Config" label="advanced" description="To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use."/> | |
| <property name="ftpClientConfigParameters" type="map(string,object)" display="Ftp Client Config Parameters" label="advanced" description="Used by FtpComponent to provide additional parameters for the FTPClientConfig"/> | |
| <property name="ftpClientParameters" type="map(string,object)" display="Ftp Client Parameters" label="advanced" description="Used by FtpComponent to provide additional parameters for the FTPClient"/> | |
| <property name="handleDirectoryParserAbsoluteResult" type="boolean" display="Handle Directory Parser Absolute Result" label="consumer,advanced" description="Allows you to set how the consumer will handle subfolders and files in the path if the directory parser results in with absolute paths The reason for this is that some FTP servers may return file names with absolute paths, and if so then the FTP component needs to handle this by converting the returned path into a relative path."/> | |
| <property name="host" type="string" display="Host" required="true" kind="path" description="Hostname of the FTP server"/> | |
| <property name="idempotent" type="boolean" display="Idempotent" label="consumer,filter" description="Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."/> | |
| <property name="idempotentKey" type="string" display="Idempotent Key" label="consumer,filter" description="To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}"/> | |
| <property name="idempotentRepository" type="java:org.apache.camel.spi.IdempotentRepository" display="Idempotent Repository" label="consumer,filter" description="A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true."/> | |
| <property name="ignoreFileNotFoundOrPermissionError" type="boolean" display="Ignore File Not Found Or Permission Error" label="consumer,advanced" description="Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exists or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead."/> | |
| <property name="inProgressRepository" type="java:org.apache.camel.spi.IdempotentRepository" display="In Progress Repository" label="consumer,advanced" description="A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."/> | |
| <property name="include" type="string" display="Include" label="consumer,filter" description="Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"/> | |
| <property name="jailStartingDirectory" type="boolean" display="Jail Starting Directory" label="producer" description="Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."/> | |
| <property name="keepLastModified" type="boolean" display="Keep Last Modified" label="producer,advanced" description="Will keep the last modified timestamp from the source file (if any). Will use the Exchange.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers."/> | |
| <property name="localWorkDirectory" type="string" display="Local Work Directory" label="consumer,advanced" description="When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory."/> | |
| <property name="maxDepth" type="int" display="Max Depth" label="consumer,filter" description="The maximum depth to traverse when recursively processing a directory."/> | |
| <property name="maxMessagesPerPoll" type="int" display="Max Messages Per Poll" label="consumer,filter" description="To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards."/> | |
| <property name="maximumReconnectAttempts" type="int" display="Maximum Reconnect Attempts" label="advanced" description="Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior."/> | |
| <property name="minDepth" type="int" display="Min Depth" label="consumer,filter" description="The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory."/> | |
| <property name="move" type="string" display="Move" label="consumer,filter" description="Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done."/> | |
| <property name="moveExisting" type="string" display="Move Existing" label="producer" description="Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base."/> | |
| <property name="moveExistingFileStrategy" type="java:org.apache.camel.component.file.strategy.FileMoveExistingStrategy" display="Move Existing File Strategy" label="producer,advanced" description="Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"/> | |
| <property name="moveFailed" type="string" display="Move Failed" label="consumer" description="Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again."/> | |
| <property name="noop" type="boolean" display="Noop" label="consumer" description="If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again."/> | |
| <property name="onCompletionExceptionHandler" type="java:org.apache.camel.spi.ExceptionHandler" display="On Completion Exception Handler" label="consumer,advanced" description="To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore."/> | |
| <property name="passiveMode" type="boolean" display="Passive Mode" description="Sets passive mode connections. Default is active mode connections."/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to use for login"/> | |
| <property name="port" type="int" display="Port" kind="path" description="Port of the FTP server"/> | |
| <property name="preMove" type="string" display="Pre Move" label="consumer" description="Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order."/> | |
| <property name="preSort" type="boolean" display="Pre Sort" label="consumer" description="When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled."/> | |
| <property name="processStrategy" type="java:org.apache.camel.component.file.GenericFileProcessStrategy<T>" display="Process Strategy" label="consumer,advanced" description="A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply."/> | |
| <property name="readLock" type="string" display="Read Lock" label="consumer,lock" description="Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: none - No read lock is in use markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan."/> | |
| <property name="readLockCheckInterval" type="long" display="Read Lock Check Interval" label="consumer,lock" description="Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit."/> | |
| <property name="readLockDeleteOrphanLockFiles" type="boolean" display="Read Lock Delete Orphan Lock Files" label="consumer,lock" description="Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory."/> | |
| <property name="readLockLoggingLevel" type="enum:org.apache.camel.LoggingLevel(TRACE,DEBUG,INFO,WARN,ERROR,OFF)" display="Read Lock Logging Level" label="consumer,lock" description="Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename."/> | |
| <property name="readLockMarkerFile" type="boolean" display="Read Lock Marker File" label="consumer,lock" description="Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application."/> | |
| <property name="readLockMinAge" type="long" display="Read Lock Min Age" label="consumer,lock" description="This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age."/> | |
| <property name="readLockMinLength" type="long" display="Read Lock Min Length" label="consumer,lock" description="This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files."/> | |
| <property name="readLockRemoveOnCommit" type="boolean" display="Read Lock Remove On Commit" label="consumer,lock" description="This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option."/> | |
| <property name="readLockRemoveOnRollback" type="boolean" display="Read Lock Remove On Rollback" label="consumer,lock" description="This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit)."/> | |
| <property name="readLockTimeout" type="long" display="Read Lock Timeout" label="consumer,lock" description="Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit."/> | |
| <property name="receiveBufferSize" type="int" display="Receive Buffer Size" label="consumer,advanced" description="The receive (download) buffer size Used only by FTPClient"/> | |
| <property name="reconnectDelay" type="long" display="Reconnect Delay" label="advanced" description="Delay in millis Camel will wait before performing a reconnect attempt."/> | |
| <property name="recursive" type="boolean" display="Recursive" label="consumer" description="If a directory, will look for files in all the sub-directories as well."/> | |
| <property name="resumeDownload" type="boolean" display="Resume Download" label="consumer" description="Configures whether resume download is enabled. This must be supported by the FTP server (almost all FTP servers support it). In addition the options localWorkDirectory must be configured so downloaded files are stored in a local directory, and the option binary must be enabled, which is required to support resuming of downloads."/> | |
| <property name="sendNoop" type="boolean" display="Send Noop" label="producer,advanced" description="Whether to send a noop command as a pre-write check before uploading files to the FTP server. This is enabled by default as a validation of the connection is still valid, which allows to silently re-connect to be able to upload the file. However if this causes problems, you can turn this option off."/> | |
| <property name="separator" type="java:org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator" display="Separator" description="Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name"/> | |
| <property name="shuffle" type="boolean" display="Shuffle" label="consumer,sort" description="To shuffle the list of files (sort in random order)"/> | |
| <property name="siteCommand" type="string" display="Site Command" label="advanced" description="Sets optional site command(s) to be executed after successful login. Multiple site commands can be separated using a new line character."/> | |
| <property name="soTimeout" type="int" display="So Timeout" label="advanced" description="Sets the so timeout FTP and FTPS Only for Camel 2.4. SFTP for Camel 2.14.3/2.15.3/2.16 onwards. Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance."/> | |
| <property name="sortBy" type="string" display="Sort By" label="consumer,sort" description="Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date."/> | |
| <property name="sorter" type="java:java.util.Comparator<org.apache.camel.component.file.GenericFile<T>>" display="Sorter" label="consumer,sort" description="Pluggable sorter as a java.util.Comparator class."/> | |
| <property name="stepwise" type="boolean" display="Stepwise" label="advanced" description="Sets whether we should stepwise change directories while traversing file structures when downloading files, or as well when uploading a file to a directory. You can disable this if you for example are in a situation where you cannot change directory on the FTP server due security reasons."/> | |
| <property name="streamDownload" type="boolean" display="Stream Download" label="consumer" description="Sets the download method to use when not using a local working directory. If set to true, the remote files are streamed to the route as they are read. When set to false, the remote files are loaded into memory before being sent into the route."/> | |
| <property name="tempFileName" type="string" display="Temp File Name" label="producer" description="The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir."/> | |
| <property name="tempPrefix" type="string" display="Temp Prefix" label="producer" description="This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files."/> | |
| <property name="throwExceptionOnConnectFailed" type="boolean" display="Throw Exception On Connect Failed" label="advanced" description="Should an exception be thrown if connection failed (exhausted) By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method."/> | |
| <property name="timeout" type="int" display="Timeout" label="advanced" description="Sets the data timeout for waiting for reply Used only by FTPClient"/> | |
| <property name="transferLoggingIntervalSeconds" type="int" display="Transfer Logging Interval Seconds" label="common" description="Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight. This is used for logging progress when operations takes longer time."/> | |
| <property name="transferLoggingLevel" type="enum:org.apache.camel.LoggingLevel(TRACE,DEBUG,INFO,WARN,ERROR,OFF)" display="Transfer Logging Level" label="common" description="Configure the logging level to use when logging the progress of upload and download operations."/> | |
| <property name="transferLoggingVerbose" type="boolean" display="Transfer Logging Verbose" label="common" description="Configures whether the perform verbose (fine grained) logging of the progress of upload and download operations."/> | |
| <property name="useList" type="boolean" display="Use List" label="consumer,advanced" description="Whether to allow using LIST command when downloading a file. Default is true. In some use cases you may want to download a specific file and are not allowed to use the LIST command, and therefore you can set this option to false. Notice when using this option, then the specific file to download does not include meta-data information such as file size, timestamp, permissions etc, because those information is only possible to retrieve when LIST command is in use."/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to use for login"/> | |
| </endpoint> | |
| <endpoint name="ftps" display="FTPS" label="file" extends="model:scheduled" javaType="org.apache.camel.component.file.remote.FtpsComponent" maven="org.apache.camel:camel-ftp:3.0.0-SNAPSHOT" since="2.2.0" description="The ftps (FTP secure SSL/TLS) component is used for uploading or downloading files from FTP servers."> | |
| <property name="account" type="string" display="Account" label="security" secret="true" description="Account to use for login"/> | |
| <property name="activePortRange" type="string" display="Active Port Range" label="advanced" description="Set the client side port range in active mode. The syntax is: minPort-maxPort Both port numbers are inclusive, eg 10000-19999 to include all 1xxxx ports."/> | |
| <property name="allowNullBody" type="boolean" display="Allow Null Body" label="producer,advanced" description="Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged."/> | |
| <property name="antExclude" type="string" display="Ant Exclude" label="consumer,filter" description="Ant style filter exclusion. If both antInclude and antExclude are used, antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format."/> | |
| <property name="antFilterCaseSensitive" type="boolean" display="Ant Filter Case Sensitive" label="consumer,filter" description="Sets case sensitive flag on ant filter"/> | |
| <property name="antInclude" type="string" display="Ant Include" label="consumer,filter" description="Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format."/> | |
| <property name="autoCreate" type="boolean" display="Auto Create" label="advanced" description="Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to."/> | |
| <property name="binary" type="boolean" display="Binary" description="Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false)."/> | |
| <property name="bufferSize" type="int" display="Buffer Size" label="advanced" description="Write buffer sized in bytes."/> | |
| <property name="charset" type="string" display="Charset" description="This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages."/> | |
| <property name="chmod" type="string" display="Chmod" label="producer,advanced" description="Allows you to set chmod on the stored file. For example chmod=640."/> | |
| <property name="connectTimeout" type="int" display="Connect Timeout" label="advanced" description="Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH"/> | |
| <property name="delete" type="boolean" display="Delete" label="consumer" description="If true, the file will be deleted after it is processed successfully."/> | |
| <property name="directoryName" type="string" display="Directory Name" kind="path" description="The starting directory"/> | |
| <property name="disableSecureDataChannelDefaults" type="boolean" display="Disable Secure Data Channel Defaults" label="security" description="Use this option to disable default options when using secure data channel. This allows you to be in full control what the execPbsz and execProt setting should be used. Default is false"/> | |
| <property name="disconnect" type="boolean" display="Disconnect" label="common" description="Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead."/> | |
| <property name="disconnectOnBatchComplete" type="boolean" display="Disconnect On Batch Complete" label="producer,advanced" description="Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server."/> | |
| <property name="doneFileName" type="string" display="Done File Name" description="Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.noext} is supported as dynamic placeholders."/> | |
| <property name="download" type="boolean" display="Download" label="consumer,advanced" description="Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded."/> | |
| <property name="eagerDeleteTargetFile" type="boolean" display="Eager Delete Target File" label="producer,advanced" description="Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation."/> | |
| <property name="eagerMaxMessagesPerPoll" type="boolean" display="Eager Max Messages Per Poll" label="consumer,filter" description="Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files, and then perform sorting. Setting this option to false allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting."/> | |
| <property name="exclude" type="string" display="Exclude" label="consumer,filter" description="Is used to exclude files, if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"/> | |
| <property name="exclusiveReadLockStrategy" type="java:org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy<T>" display="Exclusive Read Lock Strategy" label="consumer,lock" description="Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation."/> | |
| <property name="execPbsz" type="long" display="Exec Pbsz" label="security" description="When using secure data channel you can set the exec protection buffer size"/> | |
| <property name="execProt" type="string" display="Exec Prot" label="security" description="The exec protection level PROT command. C - Clear S - Safe(SSL protocol only) E - Confidential(SSL protocol only) P - Private"/> | |
| <property name="fastExistsCheck" type="boolean" display="Fast Exists Check" label="common,advanced" description="If set this option to be true, camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly, if the option is false, camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files."/> | |
| <property name="fileExist" type="enum:GenericFileExist(Override,Append,Fail,Ignore,Move,TryRename)" display="File Exist" label="producer" description="What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. Append - adds content to the existing file. Fail - throws a GenericFileOperationException, indicating that there is already an existing file. Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers."/> | |
| <property name="fileName" type="string" display="File Name" description="Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards."/> | |
| <property name="filter" type="java:org.apache.camel.component.file.GenericFileFilter<T>" display="Filter" label="consumer,filter" description="Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method."/> | |
| <property name="filterDirectory" type="string" display="Filter Directory" label="consumer,filter" description="Filters the directory based on Simple language. For example to filter on current date, you can use a simple date pattern such as ${date:now:yyyMMdd}"/> | |
| <property name="filterFile" type="string" display="Filter File" label="consumer,filter" description="Filters the file based on Simple language. For example to filter on file size, you can use ${file:size} 5000"/> | |
| <property name="flatten" type="boolean" display="Flatten" label="producer" description="Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths."/> | |
| <property name="ftpClient" type="java:org.apache.commons.net.ftp.FTPClient" display="Ftp Client" label="advanced" description="To use a custom instance of FTPClient"/> | |
| <property name="ftpClientConfig" type="java:org.apache.commons.net.ftp.FTPClientConfig" display="Ftp Client Config" label="advanced" description="To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use."/> | |
| <property name="ftpClientConfigParameters" type="map(string,object)" display="Ftp Client Config Parameters" label="advanced" description="Used by FtpComponent to provide additional parameters for the FTPClientConfig"/> | |
| <property name="ftpClientKeyStoreParameters" type="map(string,object)" display="Ftp Client Key Store Parameters" label="security" description="Set the key store parameters"/> | |
| <property name="ftpClientParameters" type="map(string,object)" display="Ftp Client Parameters" label="advanced" description="Used by FtpComponent to provide additional parameters for the FTPClient"/> | |
| <property name="ftpClientTrustStoreParameters" type="map(string,object)" display="Ftp Client Trust Store Parameters" label="security" description="Set the trust store parameters"/> | |
| <property name="handleDirectoryParserAbsoluteResult" type="boolean" display="Handle Directory Parser Absolute Result" label="consumer,advanced" description="Allows you to set how the consumer will handle subfolders and files in the path if the directory parser results in with absolute paths The reason for this is that some FTP servers may return file names with absolute paths, and if so then the FTP component needs to handle this by converting the returned path into a relative path."/> | |
| <property name="host" type="string" display="Host" required="true" kind="path" description="Hostname of the FTP server"/> | |
| <property name="idempotent" type="boolean" display="Idempotent" label="consumer,filter" description="Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again."/> | |
| <property name="idempotentKey" type="string" display="Idempotent Key" label="consumer,filter" description="To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language, for example to use the file name and file size, you can do: idempotentKey=${file:name}-${file:size}"/> | |
| <property name="idempotentRepository" type="java:org.apache.camel.spi.IdempotentRepository" display="Idempotent Repository" label="consumer,filter" description="A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true."/> | |
| <property name="ignoreFileNotFoundOrPermissionError" type="boolean" display="Ignore File Not Found Or Permission Error" label="consumer,advanced" description="Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exists or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead."/> | |
| <property name="inProgressRepository" type="java:org.apache.camel.spi.IdempotentRepository" display="In Progress Repository" label="consumer,advanced" description="A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used."/> | |
| <property name="include" type="string" display="Include" label="consumer,filter" description="Is used to include files, if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris"/> | |
| <property name="isImplicit" type="boolean" display="Is Implicit" label="security" description="Set the security mode(Implicit/Explicit). true - Implicit Mode / False - Explicit Mode"/> | |
| <property name="jailStartingDirectory" type="boolean" display="Jail Starting Directory" label="producer" description="Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders."/> | |
| <property name="keepLastModified" type="boolean" display="Keep Last Modified" label="producer,advanced" description="Will keep the last modified timestamp from the source file (if any). Will use the Exchange.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers."/> | |
| <property name="localWorkDirectory" type="string" display="Local Work Directory" label="consumer,advanced" description="When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory."/> | |
| <property name="maxDepth" type="int" display="Max Depth" label="consumer,filter" description="The maximum depth to traverse when recursively processing a directory."/> | |
| <property name="maxMessagesPerPoll" type="int" display="Max Messages Per Poll" label="consumer,filter" description="To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500, then only the first 500 files will be picked up, and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards."/> | |
| <property name="maximumReconnectAttempts" type="int" display="Maximum Reconnect Attempts" label="advanced" description="Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior."/> | |
| <property name="minDepth" type="int" display="Min Depth" label="consumer,filter" description="The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory."/> | |
| <property name="move" type="string" display="Move" label="consumer,filter" description="Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done."/> | |
| <property name="moveExisting" type="string" display="Move Existing" label="producer" description="Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base."/> | |
| <property name="moveExistingFileStrategy" type="java:org.apache.camel.component.file.strategy.FileMoveExistingStrategy" display="Move Existing File Strategy" label="producer,advanced" description="Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided"/> | |
| <property name="moveFailed" type="string" display="Move Failed" label="consumer" description="Sets the move failure expression based on Simple language. For example, to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again."/> | |
| <property name="noop" type="boolean" display="Noop" label="consumer" description="If true, the file is not moved or deleted in any way. This option is good for readonly data, or for ETL type requirements. If noop=true, Camel will set idempotent=true as well, to avoid consuming the same files over and over again."/> | |
| <property name="onCompletionExceptionHandler" type="java:org.apache.camel.spi.ExceptionHandler" display="On Completion Exception Handler" label="consumer,advanced" description="To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore."/> | |
| <property name="passiveMode" type="boolean" display="Passive Mode" description="Sets passive mode connections. Default is active mode connections."/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to use for login"/> | |
| <property name="port" type="int" display="Port" kind="path" description="Port of the FTP server"/> | |
| <property name="preMove" type="string" display="Pre Move" label="consumer" description="Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order."/> | |
| <property name="preSort" type="boolean" display="Pre Sort" label="consumer" description="When pre-sort is enabled then the consumer will sort the file and directory names during polling, that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter, and accept files to process by Camel. This option is default=false meaning disabled."/> | |
| <property name="processStrategy" type="java:org.apache.camel.component.file.GenericFileProcessStrategy<T>" display="Process Strategy" label="consumer,advanced" description="A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special ready file exists. If this option is set then the readLock option does not apply."/> | |
| <property name="readLock" type="string" display="Read Lock" label="consumer,lock" description="Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: none - No read lock is in use markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. fileLock - is for using java.nio.channels.FileLock. This option is not avail for Windows OS and the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. Notice: The various read locks is not all suited to work in clustered mode, where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file, but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks, and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering, such as Hazelcast Component or Infinispan."/> | |
| <property name="readLockCheckInterval" type="long" display="Read Lock Check Interval" label="consumer,lock" description="Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock, you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit."/> | |
| <property name="readLockDeleteOrphanLockFiles" type="boolean" display="Read Lock Delete Orphan Lock Files" label="consumer,lock" description="Whether or not read lock with marker files should upon startup delete any orphan read lock files, which may have been left on the file system, if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file, this could also be due another node is concurrently reading files from the same shared directory."/> | |
| <property name="readLockIdempotentReleaseAsync" type="boolean" display="Read Lock Idempotent Release Async" label="consumer,lock" description="Whether the delayed release task should be synchronous or asynchronous. See more details at the readLockIdempotentReleaseDelay option."/> | |
| <property name="readLockIdempotentReleaseAsyncPoolSize" type="int" display="Read Lock Idempotent Release Async Pool Size" label="consumer,lock" description="The number of threads in the scheduled thread pool when using asynchronous release tasks. Using a default of 1 core threads should be sufficient in almost all use-cases, only set this to a higher value if either updating the idempotent repository is slow, or there are a lot of files to process. This option is not in-use if you use a shared thread pool by configuring the readLockIdempotentReleaseExecutorService option. See more details at the readLockIdempotentReleaseDelay option."/> | |
| <property name="readLockIdempotentReleaseDelay" type="int" display="Read Lock Idempotent Release Delay" label="consumer,lock" description="Whether to delay the release task for a period of millis. This can be used to delay the release tasks to expand the window when a file is regarded as read-locked, in an active/active cluster scenario with a shared idempotent repository, to ensure other nodes cannot potentially scan and acquire the same file, due to race-conditions. By expanding the time-window of the release tasks helps prevents these situations. Note delaying is only needed if you have configured readLockRemoveOnCommit to true."/> | |
| <property name="readLockIdempotentReleaseExecutorService" type="java:java.util.concurrent.ScheduledExecutorService" display="Read Lock Idempotent Release Executor Service" label="consumer,lock" description="To use a custom and shared thread pool for asynchronous release tasks. See more details at the readLockIdempotentReleaseDelay option."/> | |
| <property name="readLockLoggingLevel" type="enum:org.apache.camel.LoggingLevel(TRACE,DEBUG,INFO,WARN,ERROR,OFF)" display="Read Lock Logging Level" label="consumer,lock" description="Logging level used when a read lock could not be acquired. By default a DEBUG is logged. You can change this level, for example to OFF to not have any logging. This option is only applicable for readLock of types: changed, fileLock, idempotent, idempotent-changed, idempotent-rename, rename."/> | |
| <property name="readLockMarkerFile" type="boolean" display="Read Lock Marker File" label="consumer,lock" description="Whether to use marker file with the changed, rename, or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application."/> | |
| <property name="readLockMinAge" type="long" display="Read Lock Min Age" label="consumer,lock" description="This option is applied only for readLock=changed. It allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age."/> | |
| <property name="readLockMinLength" type="long" display="Read Lock Min Length" label="consumer,lock" description="This option is applied only for readLock=changed. It allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files."/> | |
| <property name="readLockRemoveOnCommit" type="boolean" display="Read Lock Remove On Commit" label="consumer,lock" description="This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. See more details at the readLockIdempotentReleaseDelay option."/> | |
| <property name="readLockRemoveOnRollback" type="boolean" display="Read Lock Remove On Rollback" label="consumer,lock" description="This option is applied only for readLock=idempotent. It allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false, then the file name entry is confirmed (as if the file did a commit)."/> | |
| <property name="readLockTimeout" type="long" display="Read Lock Timeout" label="consumer,lock" description="Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock, changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval, but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit."/> | |
| <property name="receiveBufferSize" type="int" display="Receive Buffer Size" label="consumer,advanced" description="The receive (download) buffer size Used only by FTPClient"/> | |
| <property name="reconnectDelay" type="long" display="Reconnect Delay" label="advanced" description="Delay in millis Camel will wait before performing a reconnect attempt."/> | |
| <property name="recursive" type="boolean" display="Recursive" label="consumer" description="If a directory, will look for files in all the sub-directories as well."/> | |
| <property name="resumeDownload" type="boolean" display="Resume Download" label="consumer" description="Configures whether resume download is enabled. This must be supported by the FTP server (almost all FTP servers support it). In addition the options localWorkDirectory must be configured so downloaded files are stored in a local directory, and the option binary must be enabled, which is required to support resuming of downloads."/> | |
| <property name="securityProtocol" type="string" display="Security Protocol" label="security" description="Set the underlying security protocol."/> | |
| <property name="sendNoop" type="boolean" display="Send Noop" label="producer,advanced" description="Whether to send a noop command as a pre-write check before uploading files to the FTP server. This is enabled by default as a validation of the connection is still valid, which allows to silently re-connect to be able to upload the file. However if this causes problems, you can turn this option off."/> | |
| <property name="separator" type="java:org.apache.camel.component.file.remote.RemoteFileConfiguration.PathSeparator" display="Separator" description="Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name"/> | |
| <property name="shuffle" type="boolean" display="Shuffle" label="consumer,sort" description="To shuffle the list of files (sort in random order)"/> | |
| <property name="siteCommand" type="string" display="Site Command" label="advanced" description="Sets optional site command(s) to be executed after successful login. Multiple site commands can be separated using a new line character."/> | |
| <property name="soTimeout" type="int" display="So Timeout" label="advanced" description="Sets the so timeout FTP and FTPS Only for Camel 2.4. SFTP for Camel 2.14.3/2.15.3/2.16 onwards. Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance."/> | |
| <property name="sortBy" type="string" display="Sort By" label="consumer,sort" description="Built-in sort by using the File Language. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date."/> | |
| <property name="sorter" type="java:java.util.Comparator<org.apache.camel.component.file.GenericFile<T>>" display="Sorter" label="consumer,sort" description="Pluggable sorter as a java.util.Comparator class."/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="security" description="Gets the JSSE configuration that overrides any settings in FtpsEndpoint#ftpClientKeyStoreParameters, ftpClientTrustStoreParameters, and FtpsConfiguration#getSecurityProtocol()."/> | |
| <property name="stepwise" type="boolean" display="Stepwise" label="advanced" description="Sets whether we should stepwise change directories while traversing file structures when downloading files, or as well when uploading a file to a directory. You can disable this if you for example are in a situation where you cannot change directory on the FTP server due security reasons."/> | |
| <property name="streamDownload" type="boolean" display="Stream Download" label="consumer" description="Sets the download method to use when not using a local working directory. If set to true, the remote files are streamed to the route as they are read. When set to false, the remote files are loaded into memory before being sent into the route."/> | |
| <property name="tempFileName" type="string" display="Temp File Name" label="producer" description="The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir."/> | |
| <property name="tempPrefix" type="string" display="Temp Prefix" label="producer" description="This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files."/> | |
| <property name="throwExceptionOnConnectFailed" type="boolean" display="Throw Exception On Connect Failed" label="advanced" description="Should an exception be thrown if connection failed (exhausted) By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method."/> | |
| <property name="timeout" type="int" display="Timeout" label="advanced" description="Sets the data timeout for waiting for reply Used only by FTPClient"/> | |
| <property name="transferLoggingIntervalSeconds" type="int" display="Transfer Logging Interval Seconds" label="common" description="Configures the interval in seconds to use when logging the progress of upload and download operations that are in-flight. This is used for logging progress when operations takes longer time."/> | |
| <property name="transferLoggingLevel" type="enum:org.apache.camel.LoggingLevel(TRACE,DEBUG,INFO,WARN,ERROR,OFF)" display="Transfer Logging Level" label="common" description="Configure the logging level to use when logging the progress of upload and download operations."/> | |
| <property name="transferLoggingVerbose" type="boolean" display="Transfer Logging Verbose" label="common" description="Configures whether the perform verbose (fine grained) logging of the progress of upload and download operations."/> | |
| <property name="useList" type="boolean" display="Use List" label="consumer,advanced" description="Whether to allow using LIST command when downloading a file. Default is true. In some use cases you may want to download a specific file and are not allowed to use the LIST command, and therefore you can set this option to false. Notice when using this option, then the specific file to download does not include meta-data information such as file size, timestamp, permissions etc, because those information is only possible to retrieve when LIST command is in use."/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to use for login"/> | |
| </endpoint> | |
| <endpoint name="ganglia" display="Ganglia" label="monitoring" extends="model:endpoint" javaType="org.apache.camel.component.ganglia.GangliaComponent" maven="org.apache.camel:camel-ganglia:3.0.0-SNAPSHOT" producerOnly="true" since="2.15.0" description="The ganglia component is used for sending metrics to the Ganglia monitoring system."> | |
| <property name="dmax" type="int" display="Dmax" description="Minumum time in seconds before Ganglia will purge the metric value if it expires. Set to 0 and the value will remain in Ganglia indefinitely until a gmond agent restart."/> | |
| <property name="groupName" type="string" display="Group Name" description="The group that the metric belongs to."/> | |
| <property name="host" type="string" display="Host" kind="path" description="Host name for Ganglia server"/> | |
| <property name="metricName" type="string" display="Metric Name" description="The name to use for the metric."/> | |
| <property name="mode" type="java:info.ganglia.gmetric4j.gmetric.GMetric.UDPAddressingMode" display="Mode" description="Send the UDP metric packets using MULTICAST or UNICAST"/> | |
| <property name="port" type="int" display="Port" kind="path" description="Port for Ganglia server"/> | |
| <property name="prefix" type="string" display="Prefix" description="Prefix the metric name with this string and an underscore."/> | |
| <property name="slope" type="enum:info.ganglia.gmetric4j.gmetric.GMetricSlope(ZERO,POSITIVE,NEGATIVE,BOTH)" display="Slope" description="The slope"/> | |
| <property name="spoofHostname" type="string" display="Spoof Hostname" description="Spoofing information IP:hostname"/> | |
| <property name="tmax" type="int" display="Tmax" description="Maximum time in seconds that the value can be considered current. After this, Ganglia considers the value to have expired."/> | |
| <property name="ttl" type="int" display="Ttl" description="If using multicast, set the TTL of the packets"/> | |
| <property name="type" type="enum:info.ganglia.gmetric4j.gmetric.GMetricType(STRING,INT8,UINT8,INT16,UINT16,INT32,UINT32,FLOAT,DOUBLE)" display="Type" description="The type of value"/> | |
| <property name="units" type="string" display="Units" description="Any unit of measurement that qualifies the metric, e.g. widgets, litres, bytes. Do not include a prefix such as k (kilo) or m (milli), other tools may scale the units later. The value should be unscaled."/> | |
| <property name="wireFormat31x" type="boolean" display="Wire Format31x" description="Use the wire format of Ganglia 3.1.0 and later versions. Set this to false to use Ganglia 3.0.x or earlier."/> | |
| </endpoint> | |
| <endpoint name="geocoder" display="Geocoder" label="api,location" extends="model:endpoint" javaType="org.apache.camel.component.geocoder.GeoCoderComponent" maven="org.apache.camel:camel-geocoder:3.0.0-SNAPSHOT" producerOnly="true" since="2.12.0" description="The geocoder component is used for looking up geocodes (latitude and longitude) for a given address, or reverse lookup."> | |
| <property name="address" type="string" display="Address" kind="path" description="The geo address which should be prefixed with address:"/> | |
| <property name="apiKey" type="string" display="Api Key" label="security" secret="true" description="To use google apiKey"/> | |
| <property name="clientId" type="string" display="Client Id" label="security" secret="true" description="To use google premium with this client id"/> | |
| <property name="clientKey" type="string" display="Client Key" label="security" secret="true" description="To use google premium with this client key"/> | |
| <property name="headersOnly" type="boolean" display="Headers Only" description="Whether to only enrich the Exchange with headers, and leave the body as-is."/> | |
| <property name="language" type="string" display="Language" description="The language to use."/> | |
| <property name="latlng" type="string" display="Latlng" kind="path" description="The geo latitude and longitude which should be prefixed with latlng:"/> | |
| <property name="proxyAuthDomain" type="string" display="Proxy Auth Domain" label="proxy" description="Domain for proxy NTML authentication"/> | |
| <property name="proxyAuthHost" type="string" display="Proxy Auth Host" label="proxy" description="Optional host for proxy NTML authentication"/> | |
| <property name="proxyAuthMethod" type="string" display="Proxy Auth Method" label="proxy" description="Authentication method for proxy, either as Basic, Digest or NTLM."/> | |
| <property name="proxyAuthPassword" type="string" display="Proxy Auth Password" label="proxy" description="Password for proxy authentication"/> | |
| <property name="proxyAuthUsername" type="string" display="Proxy Auth Username" label="proxy" description="Username for proxy authentication"/> | |
| <property name="proxyHost" type="string" display="Proxy Host" label="proxy" description="The proxy host name"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" label="proxy" description="The proxy port number"/> | |
| </endpoint> | |
| <endpoint name="git" display="Git" label="file" extends="model:endpoint" javaType="org.apache.camel.component.git.GitComponent" maven="org.apache.camel:camel-git:3.0.0-SNAPSHOT" since="2.16.0" description="The git component is used for working with git repositories."> | |
| <property name="allowEmpty" type="boolean" display="Allow Empty" label="producer" description="The flag to manage empty git commits"/> | |
| <property name="branchName" type="string" display="Branch Name" description="The branch name to work on"/> | |
| <property name="localPath" type="string" display="Local Path" required="true" kind="path" description="Local repository path"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="The operation to do on the repository"/> | |
| <property name="password" type="string" display="Password" description="Remote repository password"/> | |
| <property name="remoteName" type="string" display="Remote Name" description="The remote repository name to use in particular operation like pull"/> | |
| <property name="remotePath" type="string" display="Remote Path" description="The remote repository path"/> | |
| <property name="tagName" type="string" display="Tag Name" description="The tag name to work on"/> | |
| <property name="type" type="enum:GitType(commit,tag,branch)" display="Type" label="consumer" description="The consumer type"/> | |
| <property name="username" type="string" display="Username" description="Remote repository username"/> | |
| </endpoint> | |
| <endpoint name="github" display="GitHub" label="api,file" extends="model:endpoint" javaType="org.apache.camel.component.github.GitHubComponent" maven="org.apache.camel:camel-github:3.0.0-SNAPSHOT" since="2.15.0" description="The github component is used for integrating Camel with github."> | |
| <property name="branchName" type="string" display="Branch Name" label="consumer" kind="path" description="Name of branch"/> | |
| <property name="encoding" type="string" display="Encoding" label="producer" description="To use the given encoding when getting a git commit file"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" description="GitHub OAuth token, required unless username & password are provided"/> | |
| <property name="password" type="string" display="Password" description="GitHub password, required unless oauthToken is provided"/> | |
| <property name="repoName" type="string" display="Repo Name" required="true" description="GitHub repository name"/> | |
| <property name="repoOwner" type="string" display="Repo Owner" required="true" description="GitHub repository owner (organization)"/> | |
| <property name="state" type="string" display="State" label="producer" description="To set git commit status state"/> | |
| <property name="targetUrl" type="string" display="Target Url" label="producer" description="To set git commit status target url"/> | |
| <property name="type" type="enum:GitHubType(CLOSEPULLREQUEST,PULLREQUESTCOMMENT,COMMIT,PULLREQUEST,TAG,PULLREQUESTSTATE,PULLREQUESTFILES,GETCOMMITFILE,CREATEISSUE)" display="Type" required="true" kind="path" description="What git operation to execute"/> | |
| <property name="username" type="string" display="Username" description="GitHub username, required unless oauthToken is provided"/> | |
| </endpoint> | |
| <endpoint name="google-bigquery" display="Google BigQuery" label="cloud,messaging" extends="model:endpoint" javaType="org.apache.camel.component.google.bigquery.GoogleBigQueryComponent" maven="org.apache.camel:camel-google-bigquery:3.0.0-SNAPSHOT" producerOnly="true" since="2.20.0" description="Google BigQuery data warehouse for analytics."> | |
| <property name="connectionFactory" type="java:org.apache.camel.component.google.bigquery.GoogleBigQueryConnectionFactory" display="Connection Factory" description="ConnectionFactory to obtain connection to Bigquery Service. If non provided the default will be used."/> | |
| <property name="datasetId" type="string" display="Dataset Id" label="common" required="true" kind="path" description="BigQuery Dataset Id"/> | |
| <property name="projectId" type="string" display="Project Id" label="common" required="true" kind="path" description="Google Cloud Project Id"/> | |
| <property name="tableId" type="string" display="Table Id" label="common" kind="path" description="BigQuery table id"/> | |
| <property name="useAsInsertId" type="string" display="Use As Insert Id" description="Field name to use as insert id"/> | |
| </endpoint> | |
| <endpoint name="google-bigquery-sql" display="Google BigQuery Standard SQL" label="cloud,messaging" extends="model:endpoint" javaType="org.apache.camel.component.google.bigquery.sql.GoogleBigQuerySQLComponent" maven="org.apache.camel:camel-google-bigquery:3.0.0-SNAPSHOT" producerOnly="true" since="2.23.0" description="Google BigQuery data warehouse for analytics (using SQL queries)."> | |
| <property name="connectionFactory" type="java:org.apache.camel.component.google.bigquery.GoogleBigQueryConnectionFactory" display="Connection Factory" description="ConnectionFactory to obtain connection to Bigquery Service. If non provided the default will be used."/> | |
| <property name="projectId" type="string" display="Project Id" label="common" required="true" kind="path" description="Google Cloud Project Id"/> | |
| <property name="query" type="string" display="Query" label="common" required="true" kind="path" description="BigQuery standard SQL query"/> | |
| </endpoint> | |
| <endpoint name="google-calendar" display="Google Calendar" label="api,cloud" extends="model:endpoint" javaType="org.apache.camel.component.google.calendar.GoogleCalendarComponent" maven="org.apache.camel:camel-google-calendar:3.0.0-SNAPSHOT" since="2.15.0" description="The google-calendar component provides access to Google Calendar."> | |
| <property name="accessToken" type="string" display="Access Token" description="OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."/> | |
| <property name="apiName" type="enum:GoogleCalendarApiName(ACL,LIST,CALENDARS,CHANNELS,COLORS,FREEBUSY,EVENTS,SETTINGS)" display="Api Name" required="true" kind="path" description="What kind of operation to perform"/> | |
| <property name="applicationName" type="string" display="Application Name" description="Google calendar application name. Example would be camel-google-calendar/1.0"/> | |
| <property name="clientId" type="string" display="Client Id" description="Client ID of the calendar application"/> | |
| <property name="clientSecret" type="string" display="Client Secret" description="Client secret of the calendar application"/> | |
| <property name="emailAddress" type="string" display="Email Address" description="The emailAddress of the Google Service Account."/> | |
| <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="methodName" type="string" display="Method Name" required="true" kind="path" description="What sub operation to use for the selected operation"/> | |
| <property name="p12FileName" type="string" display="P12 File Name" description="The name of the p12 file which has the private key to use with the Google Service Account."/> | |
| <property name="refreshToken" type="string" display="Refresh Token" description="OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."/> | |
| <property name="scopes" type="string" display="Scopes" description="Specifies the level of permissions you want a calendar application to have to a user account. You can separate multiple scopes by comma. See https://developers.google.com/google-apps/calendar/auth for more info."/> | |
| <property name="user" type="string" display="User" description="The email address of the user the application is trying to impersonate in the service account flow"/> | |
| </endpoint> | |
| <endpoint name="google-calendar-stream" display="Google Calendar Stream" label="api,cloud" extends="model:scheduled" javaType="org.apache.camel.component.google.calendar.stream.GoogleCalendarStreamComponent" maven="org.apache.camel:camel-google-calendar:3.0.0-SNAPSHOT" consumerOnly="true" since="2.23.0" description="The google-calendar component provides access to Google Calendar in a streaming mode."> | |
| <property name="accessToken" type="string" display="Access Token" description="OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."/> | |
| <property name="applicationName" type="string" display="Application Name" description="Google Calendar application name. Example would be camel-google-calendar/1.0"/> | |
| <property name="calendarId" type="string" display="Calendar Id" description="The calendarId to be used"/> | |
| <property name="clientId" type="string" display="Client Id" description="Client ID of the calendar application"/> | |
| <property name="clientSecret" type="string" display="Client Secret" description="Client secret of the calendar application"/> | |
| <property name="considerLastUpdate" type="boolean" display="Consider Last Update" description="Take into account the lastUpdate of the last event polled as start date for the next poll"/> | |
| <property name="consumeFromNow" type="boolean" display="Consume From Now" description="Consume events in the selected calendar from now on"/> | |
| <property name="index" type="string" display="Index" kind="path" description="Specifies an index for the endpoint"/> | |
| <property name="maxResults" type="int" display="Max Results" description="Max results to be returned"/> | |
| <property name="query" type="string" display="Query" description="The query to execute on calendar"/> | |
| <property name="refreshToken" type="string" display="Refresh Token" description="OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."/> | |
| <property name="scopes" type="list(string)" display="Scopes" description="Specifies the level of permissions you want a calendar application to have to a user account. See https://developers.google.com/calendar/auth for more info."/> | |
| </endpoint> | |
| <endpoint name="google-drive" display="Google Drive" label="api,cloud,file" extends="model:endpoint" javaType="org.apache.camel.component.google.drive.GoogleDriveComponent" maven="org.apache.camel:camel-google-drive:3.0.0-SNAPSHOT" since="2.14.0" description="The google-drive component provides access to Google Drive file storage service."> | |
| <property name="accessToken" type="string" display="Access Token" description="OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."/> | |
| <property name="apiName" type="enum:GoogleDriveApiName(DRIVE_ABOUT:drive-about,DRIVE_APPS:drive-apps,DRIVE_CHANGES:drive-changes,DRIVE_CHANNELS:drive-channels,DRIVE_CHILDREN:drive-children,DRIVE_COMMENTS:drive-comments,DRIVE_FILES:drive-files,DRIVE_PARENTS:drive-parents,DRIVE_PERMISSIONS:drive-permissions,DRIVE_PROPERTIES:drive-properties,DRIVE_REALTIME:drive-realtime,DRIVE_REPLIES:drive-replies,DRIVE_REVISIONS:drive-revisions)" display="Api Name" required="true" kind="path" description="What kind of operation to perform"/> | |
| <property name="applicationName" type="string" display="Application Name" description="Google drive application name. Example would be camel-google-drive/1.0"/> | |
| <property name="clientFactory" type="java:org.apache.camel.component.google.drive.GoogleDriveClientFactory" display="Client Factory" description="To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory"/> | |
| <property name="clientId" type="string" display="Client Id" description="Client ID of the drive application"/> | |
| <property name="clientSecret" type="string" display="Client Secret" description="Client secret of the drive application"/> | |
| <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="methodName" type="string" display="Method Name" required="true" kind="path" description="What sub operation to use for the selected operation"/> | |
| <property name="refreshToken" type="string" display="Refresh Token" description="OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."/> | |
| <property name="scopes" type="list(string)" display="Scopes" description="Specifies the level of permissions you want a drive application to have to a user account. See https://developers.google.com/drive/web/scopes for more info."/> | |
| </endpoint> | |
| <endpoint name="google-mail" display="Google Mail" label="api,cloud,mail" extends="model:endpoint" javaType="org.apache.camel.component.google.mail.GoogleMailComponent" maven="org.apache.camel:camel-google-mail:3.0.0-SNAPSHOT" since="2.15.0" description="The google-mail component provides access to Google Mail."> | |
| <property name="accessToken" type="string" display="Access Token" description="OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."/> | |
| <property name="apiName" type="enum:GoogleMailApiName(THREADS,MESSAGES,ATTACHMENTS,LABELS,HISTORY,DRAFTS,USERS)" display="Api Name" required="true" kind="path" description="What kind of operation to perform"/> | |
| <property name="applicationName" type="string" display="Application Name" description="Google mail application name. Example would be camel-google-mail/1.0"/> | |
| <property name="clientId" type="string" display="Client Id" description="Client ID of the mail application"/> | |
| <property name="clientSecret" type="string" display="Client Secret" description="Client secret of the mail application"/> | |
| <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="methodName" type="string" display="Method Name" required="true" kind="path" description="What sub operation to use for the selected operation"/> | |
| <property name="refreshToken" type="string" display="Refresh Token" description="OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."/> | |
| </endpoint> | |
| <endpoint name="google-mail-stream" display="Google Mail Stream" label="api,cloud,mail" extends="model:scheduled" javaType="org.apache.camel.component.google.mail.stream.GoogleMailStreamComponent" maven="org.apache.camel:camel-google-mail:3.0.0-SNAPSHOT" consumerOnly="true" since="2.22.0" description="The google-mail component provides access to Google Mail."> | |
| <property name="accessToken" type="string" display="Access Token" description="OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."/> | |
| <property name="applicationName" type="string" display="Application Name" description="Google mail application name. Example would be camel-google-mail/1.0"/> | |
| <property name="clientId" type="string" display="Client Id" description="Client ID of the mail application"/> | |
| <property name="clientSecret" type="string" display="Client Secret" description="Client secret of the mail application"/> | |
| <property name="index" type="string" display="Index" kind="path" description="Specifies an index for the endpoint"/> | |
| <property name="labels" type="string" display="Labels" description="Comma separated list of labels to take into account"/> | |
| <property name="markAsRead" type="boolean" display="Mark As Read" description="Mark the message as read once it has been consumed"/> | |
| <property name="maxResults" type="long" display="Max Results" description="Max results to be returned"/> | |
| <property name="query" type="string" display="Query" description="The query to execute on gmail box"/> | |
| <property name="refreshToken" type="string" display="Refresh Token" description="OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."/> | |
| </endpoint> | |
| <endpoint name="google-pubsub" display="Google Pubsub" label="messaging" extends="model:endpoint" javaType="org.apache.camel.component.google.pubsub.GooglePubsubComponent" maven="org.apache.camel:camel-google-pubsub:3.0.0-SNAPSHOT" since="2.19.0" description="Messaging client for Google Cloud Platform PubSub Service"> | |
| <property name="ackMode" type="enum:AckMode(AUTO,NONE)" display="Ack Mode" description="AUTO = exchange gets ack'ed/nack'ed on completion. NONE = downstream process has to ack/nack explicitly"/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" description="The number of parallel streams consuming from the subscription"/> | |
| <property name="connectionFactory" type="java:org.apache.camel.component.google.pubsub.GooglePubsubConnectionFactory" display="Connection Factory" description="ConnectionFactory to obtain connection to PubSub Service. If non provided the default will be used."/> | |
| <property name="destinationName" type="string" display="Destination Name" required="true" kind="path" description="Destination Name"/> | |
| <property name="loggerId" type="string" display="Logger Id" description="Logger ID to use when a match to the parent route required"/> | |
| <property name="maxMessagesPerPoll" type="int" display="Max Messages Per Poll" description="The max number of messages to receive from the server in a single API call"/> | |
| <property name="projectId" type="string" display="Project Id" required="true" kind="path" description="Project Id"/> | |
| </endpoint> | |
| <endpoint name="google-sheets" display="Google Sheets" label="api,cloud,sheets" extends="model:endpoint" javaType="org.apache.camel.component.google.sheets.GoogleSheetsComponent" maven="org.apache.camel:camel-google-sheets:3.0.0-SNAPSHOT" since="2.23.0" description="The google-sheets component provides access to Google Sheets."> | |
| <property name="accessToken" type="string" display="Access Token" description="OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."/> | |
| <property name="apiName" type="enum:GoogleSheetsApiName(SPREADSHEETS,DATA)" display="Api Name" required="true" kind="path" description="What kind of operation to perform"/> | |
| <property name="applicationName" type="string" display="Application Name" description="Google Sheets application name. Example would be camel-google-sheets/1.0"/> | |
| <property name="clientId" type="string" display="Client Id" description="Client ID of the sheets application"/> | |
| <property name="clientSecret" type="string" display="Client Secret" description="Client secret of the sheets application"/> | |
| <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="methodName" type="string" display="Method Name" required="true" kind="path" description="What sub operation to use for the selected operation"/> | |
| <property name="refreshToken" type="string" display="Refresh Token" description="OAuth 2 refresh token. Using this, the Google Sheets component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."/> | |
| </endpoint> | |
| <endpoint name="google-sheets-stream" display="Google Sheets Stream" label="api,cloud,sheets" extends="model:scheduled" javaType="org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamComponent" maven="org.apache.camel:camel-google-sheets:3.0.0-SNAPSHOT" consumerOnly="true" since="2.23.0" description="The google-sheets component provides access to Google Sheets."> | |
| <property name="accessToken" type="string" display="Access Token" description="OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage."/> | |
| <property name="apiName" type="string" display="Api Name" kind="path" description="Sets the apiName."/> | |
| <property name="applicationName" type="string" display="Application Name" description="Google sheets application name. Example would be camel-google-sheets/1.0"/> | |
| <property name="clientId" type="string" display="Client Id" description="Client ID of the sheets application"/> | |
| <property name="clientSecret" type="string" display="Client Secret" description="Client secret of the sheets application"/> | |
| <property name="includeGridData" type="boolean" display="Include Grid Data" description="True if grid data should be returned."/> | |
| <property name="majorDimension" type="string" display="Major Dimension" description="Specifies the major dimension that results should use.."/> | |
| <property name="maxResults" type="int" display="Max Results" description="Specify the maximum number of returned results. This will limit the number of rows in a returned value range data set or the number of returned value ranges in a batch request."/> | |
| <property name="range" type="string" display="Range" description="Specifies the range of rows and columns in a sheet to get data from."/> | |
| <property name="refreshToken" type="string" display="Refresh Token" description="OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived."/> | |
| <property name="scopes" type="list(string)" display="Scopes" description="Specifies the level of permissions you want a sheets application to have to a user account. See https://developers.google.com/identity/protocols/googlescopes for more info."/> | |
| <property name="splitResults" type="boolean" display="Split Results" description="True if value range result should be split into rows or columns to process each of them individually. When true each row or column is represented with a separate exchange in batch processing. Otherwise value range object is used as exchange junk size."/> | |
| <property name="spreadsheetId" type="string" display="Spreadsheet Id" description="Specifies the spreadsheet identifier that is used to identify the target to obtain."/> | |
| <property name="valueRenderOption" type="string" display="Value Render Option" description="Determines how values should be rendered in the output."/> | |
| </endpoint> | |
| <endpoint name="gora" display="Gora" label="database,hadoop,nosql" extends="model:endpoint" javaType="org.apache.camel.component.gora.GoraComponent" maven="org.apache.camel:camel-gora:3.0.0-SNAPSHOT" since="2.14.0" description="The gora component allows you to work with NoSQL databases using the Apache Gora framework."> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="consumer" description="Number of concurrent consumers"/> | |
| <property name="dataStoreClass" type="string" display="Data Store Class" description="The type of the dataStore"/> | |
| <property name="endKey" type="object" display="End Key" label="consumer" description="The End Key"/> | |
| <property name="endTime" type="long" display="End Time" label="consumer" description="The End Time"/> | |
| <property name="fields" type="java:com.google.common.base.Strings" display="Fields" label="consumer" description="The Fields"/> | |
| <property name="flushOnEveryOperation" type="boolean" display="Flush On Every Operation" label="producer" description="Flush on every operation"/> | |
| <property name="hadoopConfiguration" type="java:org.apache.hadoop.conf.Configuration" display="Hadoop Configuration" label="advanced" description="Hadoop Configuration"/> | |
| <property name="keyClass" type="string" display="Key Class" description="The type class of the key"/> | |
| <property name="keyRangeFrom" type="object" display="Key Range From" label="consumer" description="The Key Range From"/> | |
| <property name="keyRangeTo" type="object" display="Key Range To" label="consumer" description="The Key Range To"/> | |
| <property name="limit" type="long" display="Limit" label="consumer" description="The Limit"/> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="Instance name"/> | |
| <property name="startKey" type="object" display="Start Key" label="consumer" description="The Start Key"/> | |
| <property name="startTime" type="long" display="Start Time" label="consumer" description="The Start Time"/> | |
| <property name="timeRangeFrom" type="long" display="Time Range From" label="consumer" description="The Time Range From"/> | |
| <property name="timeRangeTo" type="long" display="Time Range To" label="consumer" description="The Time Range To"/> | |
| <property name="timestamp" type="long" display="Timestamp" label="consumer" description="The Timestamp"/> | |
| <property name="valueClass" type="string" display="Value Class" description="The type of the value"/> | |
| </endpoint> | |
| <endpoint name="grape" display="Grape" label="management,deployment" extends="model:endpoint" javaType="org.apache.camel.component.grape.GrapeComponent" maven="org.apache.camel:camel-grape:3.0.0-SNAPSHOT" producerOnly="true" since="2.16.0" description="The grape component allows you to fetch, load and manage additional jars when CamelContext is running."> | |
| <property name="defaultCoordinates" type="string" display="Default Coordinates" required="true" kind="path" description="Maven coordinates to use as default to grab if the message body is empty."/> | |
| </endpoint> | |
| <endpoint name="grpc" display="gRPC" label="rpc" extends="model:endpoint" javaType="org.apache.camel.component.grpc.GrpcComponent" maven="org.apache.camel:camel-grpc:3.0.0-SNAPSHOT" since="2.19.0" description="The gRPC component allows to call and expose remote procedures via HTTP/2 with protobuf dataformat"> | |
| <property name="authenticationType" type="enum:GrpcAuthType(NONE,GOOGLE,JWT)" display="Authentication Type" label="security" description="Authentication method type in advance to the SSL/TLS negotiation"/> | |
| <property name="consumerStrategy" type="enum:GrpcConsumerStrategy(AGGREGATION,PROPAGATION)" display="Consumer Strategy" label="consumer" description="This option specifies the top-level strategy for processing service requests and responses in streaming mode. If an aggregation strategy is selected, all requests will be accumulated in the list, then transferred to the flow, and the accumulated responses will be sent to the sender. If a propagation strategy is selected, request is sent to the stream, and the response will be immediately sent back to the sender."/> | |
| <property name="flowControlWindow" type="int" display="Flow Control Window" description="The HTTP/2 flow control window size (MiB)"/> | |
| <property name="forwardOnCompleted" type="boolean" display="Forward On Completed" label="consumer" description="Determines if onCompleted events should be pushed to the Camel route."/> | |
| <property name="forwardOnError" type="boolean" display="Forward On Error" label="consumer" description="Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body."/> | |
| <property name="host" type="string" display="Host" required="true" kind="path" description="The gRPC server host name. This is localhost or 0.0.0.0 when being a consumer or remote server host name when using producer."/> | |
| <property name="jwtAlgorithm" type="enum:JwtAlgorithm(HMAC256,HMAC384,HMAC512)" display="Jwt Algorithm" label="security" description="JSON Web Token sign algorithm"/> | |
| <property name="jwtIssuer" type="string" display="Jwt Issuer" label="security" description="JSON Web Token issuer"/> | |
| <property name="jwtSecret" type="string" display="Jwt Secret" label="security" secret="true" description="JSON Web Token secret"/> | |
| <property name="jwtSubject" type="string" display="Jwt Subject" label="security" description="JSON Web Token subject"/> | |
| <property name="keyCertChainResource" type="string" display="Key Cert Chain Resource" label="security" description="The X.509 certificate chain file resource in PEM format link"/> | |
| <property name="keyPassword" type="string" display="Key Password" label="security" secret="true" description="The PKCS#8 private key file password"/> | |
| <property name="keyResource" type="string" display="Key Resource" label="security" description="The PKCS#8 private key file resource in PEM format link"/> | |
| <property name="maxConcurrentCallsPerConnection" type="int" display="Max Concurrent Calls Per Connection" label="consumer" description="The maximum number of concurrent calls permitted for each incoming server connection"/> | |
| <property name="maxMessageSize" type="int" display="Max Message Size" description="The maximum message size allowed to be received/sent (MiB)"/> | |
| <property name="method" type="string" display="Method" label="producer" description="gRPC method name"/> | |
| <property name="negotiationType" type="enum:io.grpc.netty.NegotiationType(TLS,PLAINTEXT_UPGRADE,PLAINTEXT)" display="Negotiation Type" label="security" description="Identifies the security negotiation type used for HTTP/2 communication"/> | |
| <property name="port" type="int" display="Port" required="true" kind="path" description="The gRPC local or remote server port"/> | |
| <property name="producerStrategy" type="enum:GrpcProducerStrategy(SIMPLE,STREAMING)" display="Producer Strategy" label="producer" description="The mode used to communicate with a remote gRPC server. In SIMPLE mode a single exchange is translated into a remote procedure call. In STREAMING mode all exchanges will be sent within the same request (input and output of the recipient gRPC service must be of type 'stream')."/> | |
| <property name="service" type="string" display="Service" required="true" kind="path" description="Fully qualified service name from the protocol buffer descriptor file (package dot service definition name)"/> | |
| <property name="serviceAccountResource" type="string" display="Service Account Resource" label="security" description="Service Account key file in JSON format resource link supported by the Google Cloud SDK"/> | |
| <property name="streamRepliesTo" type="string" display="Stream Replies To" label="producer" description="When using STREAMING client mode, it indicates the endpoint where responses should be forwarded."/> | |
| <property name="trustCertCollectionResource" type="string" display="Trust Cert Collection Resource" label="security" description="The trusted certificates collection file resource in PEM format for verifying the remote endpoint's certificate"/> | |
| <property name="userAgent" type="string" display="User Agent" label="producer" description="The user agent header passed to the server"/> | |
| </endpoint> | |
| <endpoint name="guava-eventbus" display="Guava EventBus" label="eventbus" extends="model:endpoint" javaType="org.apache.camel.component.guava.eventbus.GuavaEventBusComponent" maven="org.apache.camel:camel-guava-eventbus:3.0.0-SNAPSHOT" since="2.10.0" description="The guava-eventbus component provides integration bridge between Camel and Google Guava EventBus."> | |
| <property name="eventBusRef" type="string" display="Event Bus Ref" kind="path" description="To lookup the Guava EventBus from the registry with the given name"/> | |
| <property name="eventClass" type="class" display="Event Class" description="If used on the consumer side of the route, will filter events received from the EventBus to the instances of the class and superclasses of eventClass. Null value of this option is equal to setting it to the java.lang.Object i.e. the consumer will capture all messages incoming to the event bus. This option cannot be used together with listenerInterface option."/> | |
| <property name="listenerInterface" type="class" display="Listener Interface" description="The interface with method(s) marked with the Subscribe annotation. Dynamic proxy will be created over the interface so it could be registered as the EventBus listener. Particularly useful when creating multi-event listeners and for handling DeadEvent properly. This option cannot be used together with eventClass option."/> | |
| </endpoint> | |
| <endpoint name="hazelcast-atomicvalue" display="Hazelcast Atomic Number" label="cache,datagrid" extends="model:endpoint" javaType="org.apache.camel.component.hazelcast.atomicnumber.HazelcastAtomicnumberComponent" maven="org.apache.camel:camel-hazelcast:3.0.0-SNAPSHOT" producerOnly="true" since="2.7.0" description="The hazelcast-atomicvalue component is used to access Hazelcast atomic number, which is an object that simply provides a grid wide number (long)."> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="The name of the cache"/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="seda" description="To use concurrent consumers polling from the SEDA queue."/> | |
| <property name="defaultOperation" type="enum:HazelcastOperation(PUT,DELETE,GET,UPDATE,QUERY,GET_ALL,CLEAR,PUT_IF_ABSENT,ADD_ALL,REMOVE_ALL,RETAIN_ALL,EVICT,EVICT_ALL,VALUE_COUNT,CONTAINS_KEY,CONTAINS_VALUE,GET_KEYS,REMOVE_VALUE,INCREMENT,DECREMENT,SET_VALUE,DESTROY,COMPARE_AND_SET,GET_AND_ADD,ADD,OFFER,PEEK,POLL,REMAINING_CAPACITY,DRAIN_TO,REMOVE_IF,TAKE,PUBLISH,READ_ONCE_HEAD,READ_ONCE_TAIL,CAPACITY)" display="Default Operation" description="To specify a default operation to use, if no operation header has been provided."/> | |
| <property name="hazelcastInstance" type="java:com.hazelcast.core.HazelcastInstance" display="Hazelcast Instance" description="The hazelcast instance reference which can be used for hazelcast endpoint."/> | |
| <property name="hazelcastInstanceName" type="string" display="Hazelcast Instance Name" description="The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."/> | |
| <property name="onErrorDelay" type="int" display="On Error Delay" label="seda" description="Milliseconds before consumer continues polling after an error has occurred."/> | |
| <property name="pollTimeout" type="int" display="Poll Timeout" label="seda" description="The timeout used when consuming from the SEDA queue. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."/> | |
| <property name="reliable" type="boolean" display="Reliable" label="common" description="Define if the endpoint will use a reliable Topic struct or not."/> | |
| <property name="transacted" type="boolean" display="Transacted" label="seda" description="If set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete."/> | |
| <property name="transferExchange" type="boolean" display="Transfer Exchange" label="seda" description="If set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped."/> | |
| </endpoint> | |
| <endpoint name="hazelcast-instance" display="Hazelcast Instance" label="cache,datagrid" extends="model:endpoint" javaType="org.apache.camel.component.hazelcast.instance.HazelcastInstanceComponent" maven="org.apache.camel:camel-hazelcast:3.0.0-SNAPSHOT" consumerOnly="true" since="2.7.0" description="The hazelcast-instance component is used to consume join/leave events of the cache instance in the cluster."> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="The name of the cache"/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="seda" description="To use concurrent consumers polling from the SEDA queue."/> | |
| <property name="defaultOperation" type="enum:HazelcastOperation(PUT,DELETE,GET,UPDATE,QUERY,GET_ALL,CLEAR,PUT_IF_ABSENT,ADD_ALL,REMOVE_ALL,RETAIN_ALL,EVICT,EVICT_ALL,VALUE_COUNT,CONTAINS_KEY,CONTAINS_VALUE,GET_KEYS,REMOVE_VALUE,INCREMENT,DECREMENT,SET_VALUE,DESTROY,COMPARE_AND_SET,GET_AND_ADD,ADD,OFFER,PEEK,POLL,REMAINING_CAPACITY,DRAIN_TO,REMOVE_IF,TAKE,PUBLISH,READ_ONCE_HEAD,READ_ONCE_TAIL,CAPACITY)" display="Default Operation" description="To specify a default operation to use, if no operation header has been provided."/> | |
| <property name="hazelcastInstance" type="java:com.hazelcast.core.HazelcastInstance" display="Hazelcast Instance" description="The hazelcast instance reference which can be used for hazelcast endpoint."/> | |
| <property name="hazelcastInstanceName" type="string" display="Hazelcast Instance Name" description="The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."/> | |
| <property name="onErrorDelay" type="int" display="On Error Delay" label="seda" description="Milliseconds before consumer continues polling after an error has occurred."/> | |
| <property name="pollTimeout" type="int" display="Poll Timeout" label="seda" description="The timeout used when consuming from the SEDA queue. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."/> | |
| <property name="pollingTimeout" type="long" display="Polling Timeout" label="consumer" description="Define the polling timeout of the Queue consumer in Poll mode"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="Define the Pool size for Queue Consumer Executor"/> | |
| <property name="queueConsumerMode" type="enum:HazelcastQueueConsumerMode(LISTEN,POLL)" display="Queue Consumer Mode" label="consumer" description="Define the Queue Consumer mode: Listen or Poll"/> | |
| <property name="reliable" type="boolean" display="Reliable" label="common" description="Define if the endpoint will use a reliable Topic struct or not."/> | |
| <property name="transacted" type="boolean" display="Transacted" label="seda" description="If set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete."/> | |
| <property name="transferExchange" type="boolean" display="Transfer Exchange" label="seda" description="If set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped."/> | |
| </endpoint> | |
| <endpoint name="hazelcast-list" display="Hazelcast List" label="cache,datagrid" extends="model:endpoint" javaType="org.apache.camel.component.hazelcast.list.HazelcastListComponent" maven="org.apache.camel:camel-hazelcast:3.0.0-SNAPSHOT" since="2.7.0" description="The hazelcast-list component is used to access Hazelcast distributed list."> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="The name of the cache"/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="seda" description="To use concurrent consumers polling from the SEDA queue."/> | |
| <property name="defaultOperation" type="enum:HazelcastOperation(PUT,DELETE,GET,UPDATE,QUERY,GET_ALL,CLEAR,PUT_IF_ABSENT,ADD_ALL,REMOVE_ALL,RETAIN_ALL,EVICT,EVICT_ALL,VALUE_COUNT,CONTAINS_KEY,CONTAINS_VALUE,GET_KEYS,REMOVE_VALUE,INCREMENT,DECREMENT,SET_VALUE,DESTROY,COMPARE_AND_SET,GET_AND_ADD,ADD,OFFER,PEEK,POLL,REMAINING_CAPACITY,DRAIN_TO,REMOVE_IF,TAKE,PUBLISH,READ_ONCE_HEAD,READ_ONCE_TAIL,CAPACITY)" display="Default Operation" description="To specify a default operation to use, if no operation header has been provided."/> | |
| <property name="hazelcastInstance" type="java:com.hazelcast.core.HazelcastInstance" display="Hazelcast Instance" description="The hazelcast instance reference which can be used for hazelcast endpoint."/> | |
| <property name="hazelcastInstanceName" type="string" display="Hazelcast Instance Name" description="The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."/> | |
| <property name="onErrorDelay" type="int" display="On Error Delay" label="seda" description="Milliseconds before consumer continues polling after an error has occurred."/> | |
| <property name="pollTimeout" type="int" display="Poll Timeout" label="seda" description="The timeout used when consuming from the SEDA queue. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."/> | |
| <property name="pollingTimeout" type="long" display="Polling Timeout" label="consumer" description="Define the polling timeout of the Queue consumer in Poll mode"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="Define the Pool size for Queue Consumer Executor"/> | |
| <property name="queueConsumerMode" type="enum:HazelcastQueueConsumerMode(LISTEN,POLL)" display="Queue Consumer Mode" label="consumer" description="Define the Queue Consumer mode: Listen or Poll"/> | |
| <property name="reliable" type="boolean" display="Reliable" label="common" description="Define if the endpoint will use a reliable Topic struct or not."/> | |
| <property name="transacted" type="boolean" display="Transacted" label="seda" description="If set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete."/> | |
| <property name="transferExchange" type="boolean" display="Transfer Exchange" label="seda" description="If set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped."/> | |
| </endpoint> | |
| <endpoint name="hazelcast-map" display="Hazelcast Map" label="cache,datagrid" extends="model:endpoint" javaType="org.apache.camel.component.hazelcast.map.HazelcastMapComponent" maven="org.apache.camel:camel-hazelcast:3.0.0-SNAPSHOT" since="2.7.0" description="The hazelcast-map component is used to access Hazelcast distributed map."> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="The name of the cache"/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="seda" description="To use concurrent consumers polling from the SEDA queue."/> | |
| <property name="defaultOperation" type="enum:HazelcastOperation(PUT,DELETE,GET,UPDATE,QUERY,GET_ALL,CLEAR,PUT_IF_ABSENT,ADD_ALL,REMOVE_ALL,RETAIN_ALL,EVICT,EVICT_ALL,VALUE_COUNT,CONTAINS_KEY,CONTAINS_VALUE,GET_KEYS,REMOVE_VALUE,INCREMENT,DECREMENT,SET_VALUE,DESTROY,COMPARE_AND_SET,GET_AND_ADD,ADD,OFFER,PEEK,POLL,REMAINING_CAPACITY,DRAIN_TO,REMOVE_IF,TAKE,PUBLISH,READ_ONCE_HEAD,READ_ONCE_TAIL,CAPACITY)" display="Default Operation" description="To specify a default operation to use, if no operation header has been provided."/> | |
| <property name="hazelcastInstance" type="java:com.hazelcast.core.HazelcastInstance" display="Hazelcast Instance" description="The hazelcast instance reference which can be used for hazelcast endpoint."/> | |
| <property name="hazelcastInstanceName" type="string" display="Hazelcast Instance Name" description="The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."/> | |
| <property name="onErrorDelay" type="int" display="On Error Delay" label="seda" description="Milliseconds before consumer continues polling after an error has occurred."/> | |
| <property name="pollTimeout" type="int" display="Poll Timeout" label="seda" description="The timeout used when consuming from the SEDA queue. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."/> | |
| <property name="pollingTimeout" type="long" display="Polling Timeout" label="consumer" description="Define the polling timeout of the Queue consumer in Poll mode"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="Define the Pool size for Queue Consumer Executor"/> | |
| <property name="queueConsumerMode" type="enum:HazelcastQueueConsumerMode(LISTEN,POLL)" display="Queue Consumer Mode" label="consumer" description="Define the Queue Consumer mode: Listen or Poll"/> | |
| <property name="reliable" type="boolean" display="Reliable" label="common" description="Define if the endpoint will use a reliable Topic struct or not."/> | |
| <property name="transacted" type="boolean" display="Transacted" label="seda" description="If set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete."/> | |
| <property name="transferExchange" type="boolean" display="Transfer Exchange" label="seda" description="If set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped."/> | |
| </endpoint> | |
| <endpoint name="hazelcast-multimap" display="Hazelcast Multimap" label="cache,datagrid" extends="model:endpoint" javaType="org.apache.camel.component.hazelcast.multimap.HazelcastMultimapComponent" maven="org.apache.camel:camel-hazelcast:3.0.0-SNAPSHOT" since="2.7.0" description="The hazelcast-multimap component is used to to access Hazelcast distributed multimap."> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="The name of the cache"/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="seda" description="To use concurrent consumers polling from the SEDA queue."/> | |
| <property name="defaultOperation" type="enum:HazelcastOperation(PUT,DELETE,GET,UPDATE,QUERY,GET_ALL,CLEAR,PUT_IF_ABSENT,ADD_ALL,REMOVE_ALL,RETAIN_ALL,EVICT,EVICT_ALL,VALUE_COUNT,CONTAINS_KEY,CONTAINS_VALUE,GET_KEYS,REMOVE_VALUE,INCREMENT,DECREMENT,SET_VALUE,DESTROY,COMPARE_AND_SET,GET_AND_ADD,ADD,OFFER,PEEK,POLL,REMAINING_CAPACITY,DRAIN_TO,REMOVE_IF,TAKE,PUBLISH,READ_ONCE_HEAD,READ_ONCE_TAIL,CAPACITY)" display="Default Operation" description="To specify a default operation to use, if no operation header has been provided."/> | |
| <property name="hazelcastInstance" type="java:com.hazelcast.core.HazelcastInstance" display="Hazelcast Instance" description="The hazelcast instance reference which can be used for hazelcast endpoint."/> | |
| <property name="hazelcastInstanceName" type="string" display="Hazelcast Instance Name" description="The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."/> | |
| <property name="onErrorDelay" type="int" display="On Error Delay" label="seda" description="Milliseconds before consumer continues polling after an error has occurred."/> | |
| <property name="pollTimeout" type="int" display="Poll Timeout" label="seda" description="The timeout used when consuming from the SEDA queue. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."/> | |
| <property name="pollingTimeout" type="long" display="Polling Timeout" label="consumer" description="Define the polling timeout of the Queue consumer in Poll mode"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="Define the Pool size for Queue Consumer Executor"/> | |
| <property name="queueConsumerMode" type="enum:HazelcastQueueConsumerMode(LISTEN,POLL)" display="Queue Consumer Mode" label="consumer" description="Define the Queue Consumer mode: Listen or Poll"/> | |
| <property name="reliable" type="boolean" display="Reliable" label="common" description="Define if the endpoint will use a reliable Topic struct or not."/> | |
| <property name="transacted" type="boolean" display="Transacted" label="seda" description="If set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete."/> | |
| <property name="transferExchange" type="boolean" display="Transfer Exchange" label="seda" description="If set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped."/> | |
| </endpoint> | |
| <endpoint name="hazelcast-queue" display="Hazelcast Queue" label="cache,datagrid" extends="model:endpoint" javaType="org.apache.camel.component.hazelcast.queue.HazelcastQueueComponent" maven="org.apache.camel:camel-hazelcast:3.0.0-SNAPSHOT" since="2.7.0" description="The hazelcast-queue component is used to access Hazelcast distributed queue."> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="The name of the cache"/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="seda" description="To use concurrent consumers polling from the SEDA queue."/> | |
| <property name="defaultOperation" type="enum:HazelcastOperation(PUT,DELETE,GET,UPDATE,QUERY,GET_ALL,CLEAR,PUT_IF_ABSENT,ADD_ALL,REMOVE_ALL,RETAIN_ALL,EVICT,EVICT_ALL,VALUE_COUNT,CONTAINS_KEY,CONTAINS_VALUE,GET_KEYS,REMOVE_VALUE,INCREMENT,DECREMENT,SET_VALUE,DESTROY,COMPARE_AND_SET,GET_AND_ADD,ADD,OFFER,PEEK,POLL,REMAINING_CAPACITY,DRAIN_TO,REMOVE_IF,TAKE,PUBLISH,READ_ONCE_HEAD,READ_ONCE_TAIL,CAPACITY)" display="Default Operation" description="To specify a default operation to use, if no operation header has been provided."/> | |
| <property name="hazelcastInstance" type="java:com.hazelcast.core.HazelcastInstance" display="Hazelcast Instance" description="The hazelcast instance reference which can be used for hazelcast endpoint."/> | |
| <property name="hazelcastInstanceName" type="string" display="Hazelcast Instance Name" description="The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."/> | |
| <property name="onErrorDelay" type="int" display="On Error Delay" label="seda" description="Milliseconds before consumer continues polling after an error has occurred."/> | |
| <property name="pollTimeout" type="int" display="Poll Timeout" label="seda" description="The timeout used when consuming from the SEDA queue. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."/> | |
| <property name="pollingTimeout" type="long" display="Polling Timeout" label="consumer" description="Define the polling timeout of the Queue consumer in Poll mode"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="Define the Pool size for Queue Consumer Executor"/> | |
| <property name="queueConsumerMode" type="enum:HazelcastQueueConsumerMode(LISTEN,POLL)" display="Queue Consumer Mode" label="consumer" description="Define the Queue Consumer mode: Listen or Poll"/> | |
| <property name="reliable" type="boolean" display="Reliable" label="common" description="Define if the endpoint will use a reliable Topic struct or not."/> | |
| <property name="transacted" type="boolean" display="Transacted" label="seda" description="If set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete."/> | |
| <property name="transferExchange" type="boolean" display="Transfer Exchange" label="seda" description="If set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped."/> | |
| </endpoint> | |
| <endpoint name="hazelcast-replicatedmap" display="Hazelcast Replicated Map" label="cache,datagrid" extends="model:endpoint" javaType="org.apache.camel.component.hazelcast.replicatedmap.HazelcastReplicatedmapComponent" maven="org.apache.camel:camel-hazelcast:3.0.0-SNAPSHOT" since="2.16.0" description="The hazelcast-replicatedmap component is used to access Hazelcast replicated map."> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="The name of the cache"/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="seda" description="To use concurrent consumers polling from the SEDA queue."/> | |
| <property name="defaultOperation" type="enum:HazelcastOperation(PUT,DELETE,GET,UPDATE,QUERY,GET_ALL,CLEAR,PUT_IF_ABSENT,ADD_ALL,REMOVE_ALL,RETAIN_ALL,EVICT,EVICT_ALL,VALUE_COUNT,CONTAINS_KEY,CONTAINS_VALUE,GET_KEYS,REMOVE_VALUE,INCREMENT,DECREMENT,SET_VALUE,DESTROY,COMPARE_AND_SET,GET_AND_ADD,ADD,OFFER,PEEK,POLL,REMAINING_CAPACITY,DRAIN_TO,REMOVE_IF,TAKE,PUBLISH,READ_ONCE_HEAD,READ_ONCE_TAIL,CAPACITY)" display="Default Operation" description="To specify a default operation to use, if no operation header has been provided."/> | |
| <property name="hazelcastInstance" type="java:com.hazelcast.core.HazelcastInstance" display="Hazelcast Instance" description="The hazelcast instance reference which can be used for hazelcast endpoint."/> | |
| <property name="hazelcastInstanceName" type="string" display="Hazelcast Instance Name" description="The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."/> | |
| <property name="onErrorDelay" type="int" display="On Error Delay" label="seda" description="Milliseconds before consumer continues polling after an error has occurred."/> | |
| <property name="pollTimeout" type="int" display="Poll Timeout" label="seda" description="The timeout used when consuming from the SEDA queue. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."/> | |
| <property name="pollingTimeout" type="long" display="Polling Timeout" label="consumer" description="Define the polling timeout of the Queue consumer in Poll mode"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="Define the Pool size for Queue Consumer Executor"/> | |
| <property name="queueConsumerMode" type="enum:HazelcastQueueConsumerMode(LISTEN,POLL)" display="Queue Consumer Mode" label="consumer" description="Define the Queue Consumer mode: Listen or Poll"/> | |
| <property name="reliable" type="boolean" display="Reliable" label="common" description="Define if the endpoint will use a reliable Topic struct or not."/> | |
| <property name="transacted" type="boolean" display="Transacted" label="seda" description="If set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete."/> | |
| <property name="transferExchange" type="boolean" display="Transfer Exchange" label="seda" description="If set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped."/> | |
| </endpoint> | |
| <endpoint name="hazelcast-ringbuffer" display="Hazelcast Ringbuffer" label="cache,datagrid" extends="model:endpoint" javaType="org.apache.camel.component.hazelcast.ringbuffer.HazelcastRingbufferComponent" maven="org.apache.camel:camel-hazelcast:3.0.0-SNAPSHOT" producerOnly="true" since="2.16.0" description="The hazelcast-ringbuffer component is used to access Hazelcast distributed ringbuffer."> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="The name of the cache"/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="seda" description="To use concurrent consumers polling from the SEDA queue."/> | |
| <property name="defaultOperation" type="enum:HazelcastOperation(PUT,DELETE,GET,UPDATE,QUERY,GET_ALL,CLEAR,PUT_IF_ABSENT,ADD_ALL,REMOVE_ALL,RETAIN_ALL,EVICT,EVICT_ALL,VALUE_COUNT,CONTAINS_KEY,CONTAINS_VALUE,GET_KEYS,REMOVE_VALUE,INCREMENT,DECREMENT,SET_VALUE,DESTROY,COMPARE_AND_SET,GET_AND_ADD,ADD,OFFER,PEEK,POLL,REMAINING_CAPACITY,DRAIN_TO,REMOVE_IF,TAKE,PUBLISH,READ_ONCE_HEAD,READ_ONCE_TAIL,CAPACITY)" display="Default Operation" description="To specify a default operation to use, if no operation header has been provided."/> | |
| <property name="hazelcastInstance" type="java:com.hazelcast.core.HazelcastInstance" display="Hazelcast Instance" description="The hazelcast instance reference which can be used for hazelcast endpoint."/> | |
| <property name="hazelcastInstanceName" type="string" display="Hazelcast Instance Name" description="The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."/> | |
| <property name="onErrorDelay" type="int" display="On Error Delay" label="seda" description="Milliseconds before consumer continues polling after an error has occurred."/> | |
| <property name="pollTimeout" type="int" display="Poll Timeout" label="seda" description="The timeout used when consuming from the SEDA queue. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."/> | |
| <property name="reliable" type="boolean" display="Reliable" label="common" description="Define if the endpoint will use a reliable Topic struct or not."/> | |
| <property name="transacted" type="boolean" display="Transacted" label="seda" description="If set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete."/> | |
| <property name="transferExchange" type="boolean" display="Transfer Exchange" label="seda" description="If set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped."/> | |
| </endpoint> | |
| <endpoint name="hazelcast-seda" display="Hazelcast SEDA" label="cache,datagrid" extends="model:endpoint" javaType="org.apache.camel.component.hazelcast.seda.HazelcastSedaComponent" maven="org.apache.camel:camel-hazelcast:3.0.0-SNAPSHOT" since="2.7.0" description="The hazelcast-seda component is used to access Hazelcast BlockingQueue."> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="The name of the cache"/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="seda" description="To use concurrent consumers polling from the SEDA queue."/> | |
| <property name="defaultOperation" type="enum:HazelcastOperation(PUT,DELETE,GET,UPDATE,QUERY,GET_ALL,CLEAR,PUT_IF_ABSENT,ADD_ALL,REMOVE_ALL,RETAIN_ALL,EVICT,EVICT_ALL,VALUE_COUNT,CONTAINS_KEY,CONTAINS_VALUE,GET_KEYS,REMOVE_VALUE,INCREMENT,DECREMENT,SET_VALUE,DESTROY,COMPARE_AND_SET,GET_AND_ADD,ADD,OFFER,PEEK,POLL,REMAINING_CAPACITY,DRAIN_TO,REMOVE_IF,TAKE,PUBLISH,READ_ONCE_HEAD,READ_ONCE_TAIL,CAPACITY)" display="Default Operation" description="To specify a default operation to use, if no operation header has been provided."/> | |
| <property name="hazelcastInstance" type="java:com.hazelcast.core.HazelcastInstance" display="Hazelcast Instance" description="The hazelcast instance reference which can be used for hazelcast endpoint."/> | |
| <property name="hazelcastInstanceName" type="string" display="Hazelcast Instance Name" description="The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."/> | |
| <property name="onErrorDelay" type="int" display="On Error Delay" label="seda" description="Milliseconds before consumer continues polling after an error has occurred."/> | |
| <property name="pollTimeout" type="int" display="Poll Timeout" label="seda" description="The timeout used when consuming from the SEDA queue. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."/> | |
| <property name="pollingTimeout" type="long" display="Polling Timeout" label="consumer" description="Define the polling timeout of the Queue consumer in Poll mode"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="Define the Pool size for Queue Consumer Executor"/> | |
| <property name="queueConsumerMode" type="enum:HazelcastQueueConsumerMode(LISTEN,POLL)" display="Queue Consumer Mode" label="consumer" description="Define the Queue Consumer mode: Listen or Poll"/> | |
| <property name="reliable" type="boolean" display="Reliable" label="common" description="Define if the endpoint will use a reliable Topic struct or not."/> | |
| <property name="transacted" type="boolean" display="Transacted" label="seda" description="If set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete."/> | |
| <property name="transferExchange" type="boolean" display="Transfer Exchange" label="seda" description="If set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped."/> | |
| </endpoint> | |
| <endpoint name="hazelcast-set" display="Hazelcast Set" label="cache,datagrid" extends="model:endpoint" javaType="org.apache.camel.component.hazelcast.set.HazelcastSetComponent" maven="org.apache.camel:camel-hazelcast:3.0.0-SNAPSHOT" since="2.7.0" description="The camel Endpoint to access Hazelcast distributed set."> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="The name of the cache"/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="seda" description="To use concurrent consumers polling from the SEDA queue."/> | |
| <property name="defaultOperation" type="enum:HazelcastOperation(PUT,DELETE,GET,UPDATE,QUERY,GET_ALL,CLEAR,PUT_IF_ABSENT,ADD_ALL,REMOVE_ALL,RETAIN_ALL,EVICT,EVICT_ALL,VALUE_COUNT,CONTAINS_KEY,CONTAINS_VALUE,GET_KEYS,REMOVE_VALUE,INCREMENT,DECREMENT,SET_VALUE,DESTROY,COMPARE_AND_SET,GET_AND_ADD,ADD,OFFER,PEEK,POLL,REMAINING_CAPACITY,DRAIN_TO,REMOVE_IF,TAKE,PUBLISH,READ_ONCE_HEAD,READ_ONCE_TAIL,CAPACITY)" display="Default Operation" description="To specify a default operation to use, if no operation header has been provided."/> | |
| <property name="hazelcastInstance" type="java:com.hazelcast.core.HazelcastInstance" display="Hazelcast Instance" description="The hazelcast instance reference which can be used for hazelcast endpoint."/> | |
| <property name="hazelcastInstanceName" type="string" display="Hazelcast Instance Name" description="The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."/> | |
| <property name="onErrorDelay" type="int" display="On Error Delay" label="seda" description="Milliseconds before consumer continues polling after an error has occurred."/> | |
| <property name="pollTimeout" type="int" display="Poll Timeout" label="seda" description="The timeout used when consuming from the SEDA queue. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."/> | |
| <property name="pollingTimeout" type="long" display="Polling Timeout" label="consumer" description="Define the polling timeout of the Queue consumer in Poll mode"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="Define the Pool size for Queue Consumer Executor"/> | |
| <property name="queueConsumerMode" type="enum:HazelcastQueueConsumerMode(LISTEN,POLL)" display="Queue Consumer Mode" label="consumer" description="Define the Queue Consumer mode: Listen or Poll"/> | |
| <property name="reliable" type="boolean" display="Reliable" label="common" description="Define if the endpoint will use a reliable Topic struct or not."/> | |
| <property name="transacted" type="boolean" display="Transacted" label="seda" description="If set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete."/> | |
| <property name="transferExchange" type="boolean" display="Transfer Exchange" label="seda" description="If set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped."/> | |
| </endpoint> | |
| <endpoint name="hazelcast-topic" display="Hazelcast Topic" label="cache,datagrid" extends="model:endpoint" javaType="org.apache.camel.component.hazelcast.topic.HazelcastTopicComponent" maven="org.apache.camel:camel-hazelcast:3.0.0-SNAPSHOT" since="2.15.0" description="The hazelcast-topic component is used to access Hazelcast distributed topic."> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="The name of the cache"/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="seda" description="To use concurrent consumers polling from the SEDA queue."/> | |
| <property name="defaultOperation" type="enum:HazelcastOperation(PUT,DELETE,GET,UPDATE,QUERY,GET_ALL,CLEAR,PUT_IF_ABSENT,ADD_ALL,REMOVE_ALL,RETAIN_ALL,EVICT,EVICT_ALL,VALUE_COUNT,CONTAINS_KEY,CONTAINS_VALUE,GET_KEYS,REMOVE_VALUE,INCREMENT,DECREMENT,SET_VALUE,DESTROY,COMPARE_AND_SET,GET_AND_ADD,ADD,OFFER,PEEK,POLL,REMAINING_CAPACITY,DRAIN_TO,REMOVE_IF,TAKE,PUBLISH,READ_ONCE_HEAD,READ_ONCE_TAIL,CAPACITY)" display="Default Operation" description="To specify a default operation to use, if no operation header has been provided."/> | |
| <property name="hazelcastInstance" type="java:com.hazelcast.core.HazelcastInstance" display="Hazelcast Instance" description="The hazelcast instance reference which can be used for hazelcast endpoint."/> | |
| <property name="hazelcastInstanceName" type="string" display="Hazelcast Instance Name" description="The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance."/> | |
| <property name="onErrorDelay" type="int" display="On Error Delay" label="seda" description="Milliseconds before consumer continues polling after an error has occurred."/> | |
| <property name="pollTimeout" type="int" display="Poll Timeout" label="seda" description="The timeout used when consuming from the SEDA queue. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown."/> | |
| <property name="pollingTimeout" type="long" display="Polling Timeout" label="consumer" description="Define the polling timeout of the Queue consumer in Poll mode"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="Define the Pool size for Queue Consumer Executor"/> | |
| <property name="queueConsumerMode" type="enum:HazelcastQueueConsumerMode(LISTEN,POLL)" display="Queue Consumer Mode" label="consumer" description="Define the Queue Consumer mode: Listen or Poll"/> | |
| <property name="reliable" type="boolean" display="Reliable" label="common" description="Define if the endpoint will use a reliable Topic struct or not."/> | |
| <property name="transacted" type="boolean" display="Transacted" label="seda" description="If set to true then the consumer runs in transaction mode, where the messages in the seda queue will only be removed if the transaction commits, which happens when the processing is complete."/> | |
| <property name="transferExchange" type="boolean" display="Transfer Exchange" label="seda" description="If set to true the whole Exchange will be transfered. If header or body contains not serializable objects, they will be skipped."/> | |
| </endpoint> | |
| <endpoint name="hbase" display="HBase" label="hadoop" extends="model:endpoint" javaType="org.apache.camel.component.hbase.HBaseComponent" maven="org.apache.camel:camel-hbase:3.0.0-SNAPSHOT" since="2.10.0" description="For reading/writing from/to an HBase store (Hadoop database)."> | |
| <property name="cellMappingStrategyFactory" type="java:org.apache.camel.component.hbase.mapping.CellMappingStrategyFactory" display="Cell Mapping Strategy Factory" description="To use a custom CellMappingStrategyFactory that is responsible for mapping cells."/> | |
| <property name="filters" type="list(java:org.apache.hadoop.hbase.filter.Filter)" display="Filters" description="A list of filters to use."/> | |
| <property name="mappingStrategyClassName" type="string" display="Mapping Strategy Class Name" description="The class name of a custom mapping strategy implementation."/> | |
| <property name="mappingStrategyName" type="string" display="Mapping Strategy Name" description="The strategy to use for mapping Camel messages to HBase columns. Supported values: header, or body."/> | |
| <property name="maxMessagesPerPoll" type="int" display="Max Messages Per Poll" label="consumer" description="Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited."/> | |
| <property name="maxResults" type="int" display="Max Results" label="producer" description="The maximum number of rows to scan."/> | |
| <property name="operation" type="string" display="Operation" label="consumer" description="The HBase operation to perform"/> | |
| <property name="remove" type="boolean" display="Remove" label="consumer" description="If the option is true, Camel HBase Consumer will remove the rows which it processes."/> | |
| <property name="removeHandler" type="java:org.apache.camel.component.hbase.HBaseRemoveHandler" display="Remove Handler" label="consumer" description="To use a custom HBaseRemoveHandler that is executed when a row is to be removed."/> | |
| <property name="rowMapping" type="map(string,object)" display="Row Mapping" description="To map the key/values from the Map to a HBaseRow. The following keys is supported: rowId - The id of the row. This has limited use as the row usually changes per Exchange. rowType - The type to covert row id to. Supported operations: CamelHBaseScan. family - The column family. Supports a number suffix for referring to more than one columns. qualifier - The column qualifier. Supports a number suffix for referring to more than one columns. value - The value. Supports a number suffix for referring to more than one columns valueType - The value type. Supports a number suffix for referring to more than one columns. Supported operations: CamelHBaseGet, and CamelHBaseScan."/> | |
| <property name="rowModel" type="java:org.apache.camel.component.hbase.model.HBaseRow" display="Row Model" description="An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled"/> | |
| <property name="tableName" type="string" display="Table Name" required="true" kind="path" description="The name of the table"/> | |
| <property name="userGroupInformation" type="java:org.apache.hadoop.security.UserGroupInformation" display="User Group Information" description="Defines privileges to communicate with HBase such as using kerberos."/> | |
| </endpoint> | |
| <endpoint name="hdfs" display="HDFS2" label="hadoop,file" extends="model:scheduled" javaType="org.apache.camel.component.hdfs2.HdfsComponent" maven="org.apache.camel:camel-hdfs2:3.0.0-SNAPSHOT" since="2.14.0" description="For reading/writing from/to an HDFS filesystem using Hadoop 2.x."> | |
| <property name="append" type="boolean" display="Append" label="producer" description="Append to existing file. Notice that not all HDFS file systems support the append option."/> | |
| <property name="blockSize" type="long" display="Block Size" label="advanced" description="The size of the HDFS blocks"/> | |
| <property name="bufferSize" type="int" display="Buffer Size" label="advanced" description="The buffer size used by HDFS"/> | |
| <property name="checkIdleInterval" type="int" display="Check Idle Interval" label="advanced" description="How often (time in millis) in to run the idle checker background task. This option is only in use if the splitter strategy is IDLE."/> | |
| <property name="chunkSize" type="int" display="Chunk Size" label="advanced" description="When reading a normal file, this is split into chunks producing a message per chunk."/> | |
| <property name="compressionCodec" type="enum:HdfsCompressionCodec(DEFAULT,GZIP,BZIP2)" display="Compression Codec" label="advanced" description="The compression codec to use"/> | |
| <property name="compressionType" type="java:org.apache.hadoop.io.SequenceFile.CompressionType" display="Compression Type" label="advanced" description="The compression type to use (is default not in use)"/> | |
| <property name="connectOnStartup" type="boolean" display="Connect On Startup" description="Whether to connect to the HDFS file system on starting the producer/consumer. If false then the connection is created on-demand. Notice that HDFS may take up till 15 minutes to establish a connection, as it has hardcoded 45 x 20 sec redelivery. By setting this option to false allows your application to startup, and not block for up till 15 minutes."/> | |
| <property name="fileSystemType" type="enum:HdfsFileSystemType(LOCAL,HDFS)" display="File System Type" description="Set to LOCAL to not use HDFS but local java.io.File instead."/> | |
| <property name="fileType" type="enum:HdfsFileType(NORMAL_FILE,SEQUENCE_FILE,MAP_FILE,BLOOMMAP_FILE,ARRAY_FILE)" display="File Type" description="The file type to use. For more details see Hadoop HDFS documentation about the various files types."/> | |
| <property name="hostName" type="string" display="Host Name" required="true" kind="path" description="HDFS host to use"/> | |
| <property name="keyType" type="enum:WritableType(NULL,BOOLEAN,BYTE,INT,FLOAT,LONG,DOUBLE,TEXT,BYTES)" display="Key Type" description="The type for the key in case of sequence or map files."/> | |
| <property name="openedSuffix" type="string" display="Opened Suffix" label="advanced" description="When a file is opened for reading/writing the file is renamed with this suffix to avoid to read it during the writing phase."/> | |
| <property name="overwrite" type="boolean" display="Overwrite" label="producer" description="Whether to overwrite existing files with the same name"/> | |
| <property name="owner" type="string" display="Owner" description="The file owner must match this owner for the consumer to pickup the file. Otherwise the file is skipped."/> | |
| <property name="path" type="string" display="Path" required="true" kind="path" description="The directory path to use"/> | |
| <property name="pattern" type="string" display="Pattern" label="consumer" description="The pattern used for scanning the directory"/> | |
| <property name="port" type="int" display="Port" kind="path" description="HDFS port to use"/> | |
| <property name="readSuffix" type="string" display="Read Suffix" label="advanced" description="Once the file has been read is renamed with this suffix to avoid to read it again."/> | |
| <property name="replication" type="java:short" display="Replication" label="advanced" description="The HDFS replication factor"/> | |
| <property name="splitStrategy" type="string" display="Split Strategy" label="advanced" description="In the current version of Hadoop opening a file in append mode is disabled since it's not very reliable. So, for the moment, it's only possible to create new files. The Camel HDFS endpoint tries to solve this problem in this way: If the split strategy option has been defined, the hdfs path will be used as a directory and files will be created using the configured UuidGenerator. Every time a splitting condition is met, a new file is created. The splitStrategy option is defined as a string with the following syntax: splitStrategy=ST:value,ST:value,... where ST can be: BYTES a new file is created, and the old is closed when the number of written bytes is more than value MESSAGES a new file is created, and the old is closed when the number of written messages is more than value IDLE a new file is created, and the old is closed when no writing happened in the last value milliseconds"/> | |
| <property name="valueType" type="enum:WritableType(NULL,BOOLEAN,BYTE,INT,FLOAT,LONG,DOUBLE,TEXT,BYTES)" display="Value Type" description="The type for the key in case of sequence or map files"/> | |
| </endpoint> | |
| <endpoint name="hdfs2" display="HDFS2" label="hadoop,file" extends="model:scheduled" javaType="org.apache.camel.component.hdfs2.HdfsComponent" maven="org.apache.camel:camel-hdfs2:3.0.0-SNAPSHOT" since="2.14.0" description="For reading/writing from/to an HDFS filesystem using Hadoop 2.x."> | |
| <property name="append" type="boolean" display="Append" label="producer" description="Append to existing file. Notice that not all HDFS file systems support the append option."/> | |
| <property name="blockSize" type="long" display="Block Size" label="advanced" description="The size of the HDFS blocks"/> | |
| <property name="bufferSize" type="int" display="Buffer Size" label="advanced" description="The buffer size used by HDFS"/> | |
| <property name="checkIdleInterval" type="int" display="Check Idle Interval" label="advanced" description="How often (time in millis) in to run the idle checker background task. This option is only in use if the splitter strategy is IDLE."/> | |
| <property name="chunkSize" type="int" display="Chunk Size" label="advanced" description="When reading a normal file, this is split into chunks producing a message per chunk."/> | |
| <property name="compressionCodec" type="enum:HdfsCompressionCodec(DEFAULT,GZIP,BZIP2)" display="Compression Codec" label="advanced" description="The compression codec to use"/> | |
| <property name="compressionType" type="java:org.apache.hadoop.io.SequenceFile.CompressionType" display="Compression Type" label="advanced" description="The compression type to use (is default not in use)"/> | |
| <property name="connectOnStartup" type="boolean" display="Connect On Startup" description="Whether to connect to the HDFS file system on starting the producer/consumer. If false then the connection is created on-demand. Notice that HDFS may take up till 15 minutes to establish a connection, as it has hardcoded 45 x 20 sec redelivery. By setting this option to false allows your application to startup, and not block for up till 15 minutes."/> | |
| <property name="fileSystemType" type="enum:HdfsFileSystemType(LOCAL,HDFS)" display="File System Type" description="Set to LOCAL to not use HDFS but local java.io.File instead."/> | |
| <property name="fileType" type="enum:HdfsFileType(NORMAL_FILE,SEQUENCE_FILE,MAP_FILE,BLOOMMAP_FILE,ARRAY_FILE)" display="File Type" description="The file type to use. For more details see Hadoop HDFS documentation about the various files types."/> | |
| <property name="hostName" type="string" display="Host Name" required="true" kind="path" description="HDFS host to use"/> | |
| <property name="keyType" type="enum:WritableType(NULL,BOOLEAN,BYTE,INT,FLOAT,LONG,DOUBLE,TEXT,BYTES)" display="Key Type" description="The type for the key in case of sequence or map files."/> | |
| <property name="openedSuffix" type="string" display="Opened Suffix" label="advanced" description="When a file is opened for reading/writing the file is renamed with this suffix to avoid to read it during the writing phase."/> | |
| <property name="overwrite" type="boolean" display="Overwrite" label="producer" description="Whether to overwrite existing files with the same name"/> | |
| <property name="owner" type="string" display="Owner" description="The file owner must match this owner for the consumer to pickup the file. Otherwise the file is skipped."/> | |
| <property name="path" type="string" display="Path" required="true" kind="path" description="The directory path to use"/> | |
| <property name="pattern" type="string" display="Pattern" label="consumer" description="The pattern used for scanning the directory"/> | |
| <property name="port" type="int" display="Port" kind="path" description="HDFS port to use"/> | |
| <property name="readSuffix" type="string" display="Read Suffix" label="advanced" description="Once the file has been read is renamed with this suffix to avoid to read it again."/> | |
| <property name="replication" type="java:short" display="Replication" label="advanced" description="The HDFS replication factor"/> | |
| <property name="splitStrategy" type="string" display="Split Strategy" label="advanced" description="In the current version of Hadoop opening a file in append mode is disabled since it's not very reliable. So, for the moment, it's only possible to create new files. The Camel HDFS endpoint tries to solve this problem in this way: If the split strategy option has been defined, the hdfs path will be used as a directory and files will be created using the configured UuidGenerator. Every time a splitting condition is met, a new file is created. The splitStrategy option is defined as a string with the following syntax: splitStrategy=ST:value,ST:value,... where ST can be: BYTES a new file is created, and the old is closed when the number of written bytes is more than value MESSAGES a new file is created, and the old is closed when the number of written messages is more than value IDLE a new file is created, and the old is closed when no writing happened in the last value milliseconds"/> | |
| <property name="valueType" type="enum:WritableType(NULL,BOOLEAN,BYTE,INT,FLOAT,LONG,DOUBLE,TEXT,BYTES)" display="Value Type" description="The type for the key in case of sequence or map files"/> | |
| </endpoint> | |
| <endpoint name="hipchat" display="Hipchat" label="api,cloud" extends="model:scheduled" javaType="org.apache.camel.component.hipchat.HipchatComponent" maven="org.apache.camel:camel-hipchat:3.0.0-SNAPSHOT" since="2.15.0" description="The hipchat component supports producing and consuming messages from/to Hipchat service."> | |
| <property name="authToken" type="string" display="Auth Token" description="OAuth 2 auth token"/> | |
| <property name="consumeUsers" type="string" display="Consume Users" description="Username(s) when consuming messages from the hiptchat server. Multiple user names can be separated by comma."/> | |
| <property name="host" type="string" display="Host" required="true" kind="path" description="The host for the hipchat server, such as api.hipchat.com"/> | |
| <property name="httpClient" type="java:org.apache.http.impl.client.CloseableHttpClient" display="Http Client" description="The CloseableHttpClient reference from registry to be used during API HTTP requests."/> | |
| <property name="port" type="int" display="Port" kind="path" description="The port for the hipchat server. Is by default 80."/> | |
| <property name="protocol" type="string" display="Protocol" required="true" kind="path" description="The protocol for the hipchat server, such as http."/> | |
| </endpoint> | |
| <endpoint name="http" display="HTTP4" label="http" extends="model:endpoint" javaType="org.apache.camel.component.http4.HttpComponent" maven="org.apache.camel:camel-http4:3.0.0-SNAPSHOT" producerOnly="true" lenient="true" since="2.3.0" description="For calling out to external HTTP servers using Apache HTTP Client 4.x."> | |
| <property name="authDomain" type="string" display="Auth Domain" label="producer,security" description="Authentication domain to use with NTML"/> | |
| <property name="authHost" type="string" display="Auth Host" label="producer,security" description="Authentication host to use with NTML"/> | |
| <property name="authMethod" type="string" display="Auth Method" label="producer,security" description="Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM."/> | |
| <property name="authMethodPriority" type="string" display="Auth Method Priority" label="producer,security" description="Which authentication method to prioritize to use, either as Basic, Digest or NTLM."/> | |
| <property name="authPassword" type="string" display="Auth Password" label="producer,security" secret="true" description="Authentication password"/> | |
| <property name="authUsername" type="string" display="Auth Username" label="producer,security" secret="true" description="Authentication username"/> | |
| <property name="authenticationPreemptive" type="boolean" display="Authentication Preemptive" label="producer" description="If this option is true, camel-http4 sends preemptive basic authentication to the server."/> | |
| <property name="bridgeEndpoint" type="boolean" display="Bridge Endpoint" label="producer" description="If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back."/> | |
| <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="clearExpiredCookies" type="boolean" display="Clear Expired Cookies" label="producer" description="Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired."/> | |
| <property name="clientBuilder" type="java:org.apache.http.impl.client.HttpClientBuilder" display="Client Builder" label="advanced" description="Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint."/> | |
| <property name="clientConnectionManager" type="java:org.apache.http.conn.HttpClientConnectionManager" display="Client Connection Manager" label="advanced" description="To use a custom HttpClientConnectionManager to manage connections"/> | |
| <property name="connectionClose" type="boolean" display="Connection Close" label="producer" description="Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false."/> | |
| <property name="connectionsPerRoute" type="int" display="Connections Per Route" label="advanced" description="The maximum number of connections per route."/> | |
| <property name="cookieHandler" type="java:org.apache.camel.http.common.cookie.CookieHandler" display="Cookie Handler" label="producer,advanced" description="Configure a cookie handler to maintain a HTTP session"/> | |
| <property name="cookieStore" type="java:org.apache.http.client.CookieStore" display="Cookie Store" label="producer" description="To use a custom CookieStore. By default the BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler."/> | |
| <property name="copyHeaders" type="boolean" display="Copy Headers" label="producer" description="If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers)."/> | |
| <property name="deleteWithBody" type="boolean" display="Delete With Body" label="producer" description="Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP message. However in some rare cases users may need to be able to include the message body."/> | |
| <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="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="httpClient" type="java:org.apache.http.client.HttpClient" display="Http Client" label="advanced" description="Sets a custom HttpClient to be used by the producer"/> | |
| <property name="httpClientConfigurer" type="java:org.apache.camel.component.http4.HttpClientConfigurer" display="Http Client Configurer" label="advanced" description="Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc"/> | |
| <property name="httpClientOptions" type="map(string,object)" display="Http Client Options" label="advanced" description="To configure the HttpClient using the key/values from the Map."/> | |
| <property name="httpContext" type="java:org.apache.http.protocol.HttpContext" display="Http Context" label="advanced" description="To use a custom HttpContext instance"/> | |
| <property name="httpMethod" type="enum:org.apache.camel.http.common.HttpMethods(GET,POST,PUT,DELETE,HEAD,OPTIONS,TRACE,PATCH)" display="Http Method" label="producer" description="Configure the HTTP method to use. The HttpMethod header cannot override this option if set."/> | |
| <property name="httpUri" type="java:java.net.URI" display="Http Uri" label="common" required="true" kind="path" description="The url of the HTTP endpoint to call."/> | |
| <property name="ignoreResponseBody" type="boolean" display="Ignore Response Body" label="producer" description="If this option is true, The http producer won't read response body and cache the input stream"/> | |
| <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="maxTotalConnections" type="int" display="Max Total Connections" label="advanced" description="The maximum number of connections."/> | |
| <property name="okStatusCodeRange" type="string" display="Ok Status Code Range" label="producer,advanced" description="The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included."/> | |
| <property name="preserveHostHeader" type="boolean" display="Preserve Host Header" label="producer" description="If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service"/> | |
| <property name="proxyAuthDomain" type="string" display="Proxy Auth Domain" label="producer,proxy" description="Proxy authentication domain to use with NTML"/> | |
| <property name="proxyAuthHost" type="string" display="Proxy Auth Host" label="producer,proxy" description="Proxy authentication host"/> | |
| <property name="proxyAuthMethod" type="string" display="Proxy Auth Method" label="producer,proxy" description="Proxy authentication method to use"/> | |
| <property name="proxyAuthPassword" type="string" display="Proxy Auth Password" label="producer,proxy" secret="true" description="Proxy authentication password"/> | |
| <property name="proxyAuthPort" type="int" display="Proxy Auth Port" label="producer,proxy" description="Proxy authentication port"/> | |
| <property name="proxyAuthScheme" type="string" display="Proxy Auth Scheme" label="producer,proxy" description="Proxy authentication scheme to use"/> | |
| <property name="proxyAuthUsername" type="string" display="Proxy Auth Username" label="producer,proxy" secret="true" description="Proxy authentication username"/> | |
| <property name="proxyHost" type="string" display="Proxy Host" label="producer,proxy" description="Proxy hostname to use"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" label="producer,proxy" description="Proxy port to use"/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="security" description="To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need."/> | |
| <property name="throwExceptionOnFailure" type="boolean" display="Throw Exception On Failure" label="producer" description="Option to disable throwing the HttpOperationFailedException 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. 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="urlRewrite" type="java:org.apache.camel.http.common.UrlRewrite" display="Url Rewrite" label="producer,advanced" deprecated="true" description="Refers to a custom org.apache.camel.component.http.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints. See more details at http://camel.apache.org/urlrewrite.html"/> | |
| <property name="useSystemProperties" type="boolean" display="Use System Properties" label="advanced" description="To use System Properties as fallback for configuration"/> | |
| <property name="x509HostnameVerifier" type="java:javax.net.ssl.HostnameVerifier" display="X509 Hostname Verifier" label="security" description="To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or org.apache.http.conn.ssl.NoopHostnameVerifier."/> | |
| </endpoint> | |
| <endpoint name="http4" display="HTTP4" label="http" extends="model:endpoint" javaType="org.apache.camel.component.http4.HttpComponent" maven="org.apache.camel:camel-http4:3.0.0-SNAPSHOT" producerOnly="true" lenient="true" since="2.3.0" description="For calling out to external HTTP servers using Apache HTTP Client 4.x."> | |
| <property name="authDomain" type="string" display="Auth Domain" label="producer,security" description="Authentication domain to use with NTML"/> | |
| <property name="authHost" type="string" display="Auth Host" label="producer,security" description="Authentication host to use with NTML"/> | |
| <property name="authMethod" type="string" display="Auth Method" label="producer,security" description="Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM."/> | |
| <property name="authMethodPriority" type="string" display="Auth Method Priority" label="producer,security" description="Which authentication method to prioritize to use, either as Basic, Digest or NTLM."/> | |
| <property name="authPassword" type="string" display="Auth Password" label="producer,security" secret="true" description="Authentication password"/> | |
| <property name="authUsername" type="string" display="Auth Username" label="producer,security" secret="true" description="Authentication username"/> | |
| <property name="authenticationPreemptive" type="boolean" display="Authentication Preemptive" label="producer" description="If this option is true, camel-http4 sends preemptive basic authentication to the server."/> | |
| <property name="bridgeEndpoint" type="boolean" display="Bridge Endpoint" label="producer" description="If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back."/> | |
| <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="clearExpiredCookies" type="boolean" display="Clear Expired Cookies" label="producer" description="Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired."/> | |
| <property name="clientBuilder" type="java:org.apache.http.impl.client.HttpClientBuilder" display="Client Builder" label="advanced" description="Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint."/> | |
| <property name="clientConnectionManager" type="java:org.apache.http.conn.HttpClientConnectionManager" display="Client Connection Manager" label="advanced" description="To use a custom HttpClientConnectionManager to manage connections"/> | |
| <property name="connectionClose" type="boolean" display="Connection Close" label="producer" description="Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false."/> | |
| <property name="connectionsPerRoute" type="int" display="Connections Per Route" label="advanced" description="The maximum number of connections per route."/> | |
| <property name="cookieHandler" type="java:org.apache.camel.http.common.cookie.CookieHandler" display="Cookie Handler" label="producer,advanced" description="Configure a cookie handler to maintain a HTTP session"/> | |
| <property name="cookieStore" type="java:org.apache.http.client.CookieStore" display="Cookie Store" label="producer" description="To use a custom CookieStore. By default the BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler."/> | |
| <property name="copyHeaders" type="boolean" display="Copy Headers" label="producer" description="If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers)."/> | |
| <property name="deleteWithBody" type="boolean" display="Delete With Body" label="producer" description="Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP message. However in some rare cases users may need to be able to include the message body."/> | |
| <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="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="httpClient" type="java:org.apache.http.client.HttpClient" display="Http Client" label="advanced" description="Sets a custom HttpClient to be used by the producer"/> | |
| <property name="httpClientConfigurer" type="java:org.apache.camel.component.http4.HttpClientConfigurer" display="Http Client Configurer" label="advanced" description="Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc"/> | |
| <property name="httpClientOptions" type="map(string,object)" display="Http Client Options" label="advanced" description="To configure the HttpClient using the key/values from the Map."/> | |
| <property name="httpContext" type="java:org.apache.http.protocol.HttpContext" display="Http Context" label="advanced" description="To use a custom HttpContext instance"/> | |
| <property name="httpMethod" type="enum:org.apache.camel.http.common.HttpMethods(GET,POST,PUT,DELETE,HEAD,OPTIONS,TRACE,PATCH)" display="Http Method" label="producer" description="Configure the HTTP method to use. The HttpMethod header cannot override this option if set."/> | |
| <property name="httpUri" type="java:java.net.URI" display="Http Uri" label="common" required="true" kind="path" description="The url of the HTTP endpoint to call."/> | |
| <property name="ignoreResponseBody" type="boolean" display="Ignore Response Body" label="producer" description="If this option is true, The http producer won't read response body and cache the input stream"/> | |
| <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="maxTotalConnections" type="int" display="Max Total Connections" label="advanced" description="The maximum number of connections."/> | |
| <property name="okStatusCodeRange" type="string" display="Ok Status Code Range" label="producer,advanced" description="The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included."/> | |
| <property name="preserveHostHeader" type="boolean" display="Preserve Host Header" label="producer" description="If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service"/> | |
| <property name="proxyAuthDomain" type="string" display="Proxy Auth Domain" label="producer,proxy" description="Proxy authentication domain to use with NTML"/> | |
| <property name="proxyAuthHost" type="string" display="Proxy Auth Host" label="producer,proxy" description="Proxy authentication host"/> | |
| <property name="proxyAuthMethod" type="string" display="Proxy Auth Method" label="producer,proxy" description="Proxy authentication method to use"/> | |
| <property name="proxyAuthPassword" type="string" display="Proxy Auth Password" label="producer,proxy" secret="true" description="Proxy authentication password"/> | |
| <property name="proxyAuthPort" type="int" display="Proxy Auth Port" label="producer,proxy" description="Proxy authentication port"/> | |
| <property name="proxyAuthScheme" type="string" display="Proxy Auth Scheme" label="producer,proxy" description="Proxy authentication scheme to use"/> | |
| <property name="proxyAuthUsername" type="string" display="Proxy Auth Username" label="producer,proxy" secret="true" description="Proxy authentication username"/> | |
| <property name="proxyHost" type="string" display="Proxy Host" label="producer,proxy" description="Proxy hostname to use"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" label="producer,proxy" description="Proxy port to use"/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="security" description="To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need."/> | |
| <property name="throwExceptionOnFailure" type="boolean" display="Throw Exception On Failure" label="producer" description="Option to disable throwing the HttpOperationFailedException 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. 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="urlRewrite" type="java:org.apache.camel.http.common.UrlRewrite" display="Url Rewrite" label="producer,advanced" deprecated="true" description="Refers to a custom org.apache.camel.component.http.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints. See more details at http://camel.apache.org/urlrewrite.html"/> | |
| <property name="useSystemProperties" type="boolean" display="Use System Properties" label="advanced" description="To use System Properties as fallback for configuration"/> | |
| <property name="x509HostnameVerifier" type="java:javax.net.ssl.HostnameVerifier" display="X509 Hostname Verifier" label="security" description="To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or org.apache.http.conn.ssl.NoopHostnameVerifier."/> | |
| </endpoint> | |
| <endpoint name="https" display="HTTP4" label="http" extends="model:endpoint" javaType="org.apache.camel.component.http4.HttpComponent" maven="org.apache.camel:camel-http4:3.0.0-SNAPSHOT" producerOnly="true" lenient="true" since="2.3.0" description="For calling out to external HTTP servers using Apache HTTP Client 4.x."> | |
| <property name="authDomain" type="string" display="Auth Domain" label="producer,security" description="Authentication domain to use with NTML"/> | |
| <property name="authHost" type="string" display="Auth Host" label="producer,security" description="Authentication host to use with NTML"/> | |
| <property name="authMethod" type="string" display="Auth Method" label="producer,security" description="Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM."/> | |
| <property name="authMethodPriority" type="string" display="Auth Method Priority" label="producer,security" description="Which authentication method to prioritize to use, either as Basic, Digest or NTLM."/> | |
| <property name="authPassword" type="string" display="Auth Password" label="producer,security" secret="true" description="Authentication password"/> | |
| <property name="authUsername" type="string" display="Auth Username" label="producer,security" secret="true" description="Authentication username"/> | |
| <property name="authenticationPreemptive" type="boolean" display="Authentication Preemptive" label="producer" description="If this option is true, camel-http4 sends preemptive basic authentication to the server."/> | |
| <property name="bridgeEndpoint" type="boolean" display="Bridge Endpoint" label="producer" description="If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back."/> | |
| <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="clearExpiredCookies" type="boolean" display="Clear Expired Cookies" label="producer" description="Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired."/> | |
| <property name="clientBuilder" type="java:org.apache.http.impl.client.HttpClientBuilder" display="Client Builder" label="advanced" description="Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint."/> | |
| <property name="clientConnectionManager" type="java:org.apache.http.conn.HttpClientConnectionManager" display="Client Connection Manager" label="advanced" description="To use a custom HttpClientConnectionManager to manage connections"/> | |
| <property name="connectionClose" type="boolean" display="Connection Close" label="producer" description="Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false."/> | |
| <property name="connectionsPerRoute" type="int" display="Connections Per Route" label="advanced" description="The maximum number of connections per route."/> | |
| <property name="cookieHandler" type="java:org.apache.camel.http.common.cookie.CookieHandler" display="Cookie Handler" label="producer,advanced" description="Configure a cookie handler to maintain a HTTP session"/> | |
| <property name="cookieStore" type="java:org.apache.http.client.CookieStore" display="Cookie Store" label="producer" description="To use a custom CookieStore. By default the BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler."/> | |
| <property name="copyHeaders" type="boolean" display="Copy Headers" label="producer" description="If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers)."/> | |
| <property name="deleteWithBody" type="boolean" display="Delete With Body" label="producer" description="Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP message. However in some rare cases users may need to be able to include the message body."/> | |
| <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="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="httpClient" type="java:org.apache.http.client.HttpClient" display="Http Client" label="advanced" description="Sets a custom HttpClient to be used by the producer"/> | |
| <property name="httpClientConfigurer" type="java:org.apache.camel.component.http4.HttpClientConfigurer" display="Http Client Configurer" label="advanced" description="Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc"/> | |
| <property name="httpClientOptions" type="map(string,object)" display="Http Client Options" label="advanced" description="To configure the HttpClient using the key/values from the Map."/> | |
| <property name="httpContext" type="java:org.apache.http.protocol.HttpContext" display="Http Context" label="advanced" description="To use a custom HttpContext instance"/> | |
| <property name="httpMethod" type="enum:org.apache.camel.http.common.HttpMethods(GET,POST,PUT,DELETE,HEAD,OPTIONS,TRACE,PATCH)" display="Http Method" label="producer" description="Configure the HTTP method to use. The HttpMethod header cannot override this option if set."/> | |
| <property name="httpUri" type="java:java.net.URI" display="Http Uri" label="common" required="true" kind="path" description="The url of the HTTP endpoint to call."/> | |
| <property name="ignoreResponseBody" type="boolean" display="Ignore Response Body" label="producer" description="If this option is true, The http producer won't read response body and cache the input stream"/> | |
| <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="maxTotalConnections" type="int" display="Max Total Connections" label="advanced" description="The maximum number of connections."/> | |
| <property name="okStatusCodeRange" type="string" display="Ok Status Code Range" label="producer,advanced" description="The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included."/> | |
| <property name="preserveHostHeader" type="boolean" display="Preserve Host Header" label="producer" description="If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service"/> | |
| <property name="proxyAuthDomain" type="string" display="Proxy Auth Domain" label="producer,proxy" description="Proxy authentication domain to use with NTML"/> | |
| <property name="proxyAuthHost" type="string" display="Proxy Auth Host" label="producer,proxy" description="Proxy authentication host"/> | |
| <property name="proxyAuthMethod" type="string" display="Proxy Auth Method" label="producer,proxy" description="Proxy authentication method to use"/> | |
| <property name="proxyAuthPassword" type="string" display="Proxy Auth Password" label="producer,proxy" secret="true" description="Proxy authentication password"/> | |
| <property name="proxyAuthPort" type="int" display="Proxy Auth Port" label="producer,proxy" description="Proxy authentication port"/> | |
| <property name="proxyAuthScheme" type="string" display="Proxy Auth Scheme" label="producer,proxy" description="Proxy authentication scheme to use"/> | |
| <property name="proxyAuthUsername" type="string" display="Proxy Auth Username" label="producer,proxy" secret="true" description="Proxy authentication username"/> | |
| <property name="proxyHost" type="string" display="Proxy Host" label="producer,proxy" description="Proxy hostname to use"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" label="producer,proxy" description="Proxy port to use"/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="security" description="To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need."/> | |
| <property name="throwExceptionOnFailure" type="boolean" display="Throw Exception On Failure" label="producer" description="Option to disable throwing the HttpOperationFailedException 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. 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="urlRewrite" type="java:org.apache.camel.http.common.UrlRewrite" display="Url Rewrite" label="producer,advanced" deprecated="true" description="Refers to a custom org.apache.camel.component.http.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints. See more details at http://camel.apache.org/urlrewrite.html"/> | |
| <property name="useSystemProperties" type="boolean" display="Use System Properties" label="advanced" description="To use System Properties as fallback for configuration"/> | |
| <property name="x509HostnameVerifier" type="java:javax.net.ssl.HostnameVerifier" display="X509 Hostname Verifier" label="security" description="To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or org.apache.http.conn.ssl.NoopHostnameVerifier."/> | |
| </endpoint> | |
| <endpoint name="https4" display="HTTPS4" label="http" extends="model:endpoint" javaType="org.apache.camel.component.http4.HttpComponent" maven="org.apache.camel:camel-http4:3.0.0-SNAPSHOT" producerOnly="true" lenient="true" since="2.3.0" description="For calling out to external HTTP servers using Apache HTTP Client 4.x."> | |
| <property name="authDomain" type="string" display="Auth Domain" label="producer,security" description="Authentication domain to use with NTML"/> | |
| <property name="authHost" type="string" display="Auth Host" label="producer,security" description="Authentication host to use with NTML"/> | |
| <property name="authMethod" type="string" display="Auth Method" label="producer,security" description="Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM."/> | |
| <property name="authMethodPriority" type="string" display="Auth Method Priority" label="producer,security" description="Which authentication method to prioritize to use, either as Basic, Digest or NTLM."/> | |
| <property name="authPassword" type="string" display="Auth Password" label="producer,security" secret="true" description="Authentication password"/> | |
| <property name="authUsername" type="string" display="Auth Username" label="producer,security" secret="true" description="Authentication username"/> | |
| <property name="authenticationPreemptive" type="boolean" display="Authentication Preemptive" label="producer" description="If this option is true, camel-http4 sends preemptive basic authentication to the server."/> | |
| <property name="bridgeEndpoint" type="boolean" display="Bridge Endpoint" label="producer" description="If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back."/> | |
| <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="clearExpiredCookies" type="boolean" display="Clear Expired Cookies" label="producer" description="Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired."/> | |
| <property name="clientBuilder" type="java:org.apache.http.impl.client.HttpClientBuilder" display="Client Builder" label="advanced" description="Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint."/> | |
| <property name="clientConnectionManager" type="java:org.apache.http.conn.HttpClientConnectionManager" display="Client Connection Manager" label="advanced" description="To use a custom HttpClientConnectionManager to manage connections"/> | |
| <property name="connectionClose" type="boolean" display="Connection Close" label="producer" description="Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false."/> | |
| <property name="connectionsPerRoute" type="int" display="Connections Per Route" label="advanced" description="The maximum number of connections per route."/> | |
| <property name="cookieHandler" type="java:org.apache.camel.http.common.cookie.CookieHandler" display="Cookie Handler" label="producer,advanced" description="Configure a cookie handler to maintain a HTTP session"/> | |
| <property name="cookieStore" type="java:org.apache.http.client.CookieStore" display="Cookie Store" label="producer" description="To use a custom CookieStore. By default the BasicCookieStore is used which is an in-memory only cookie store. Notice if bridgeEndpoint=true then the cookie store is forced to be a noop cookie store as cookie shouldn't be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler."/> | |
| <property name="copyHeaders" type="boolean" display="Copy Headers" label="producer" description="If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers)."/> | |
| <property name="deleteWithBody" type="boolean" display="Delete With Body" label="producer" description="Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP message. However in some rare cases users may need to be able to include the message body."/> | |
| <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="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="httpClient" type="java:org.apache.http.client.HttpClient" display="Http Client" label="advanced" description="Sets a custom HttpClient to be used by the producer"/> | |
| <property name="httpClientConfigurer" type="java:org.apache.camel.component.http4.HttpClientConfigurer" display="Http Client Configurer" label="advanced" description="Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc"/> | |
| <property name="httpClientOptions" type="map(string,object)" display="Http Client Options" label="advanced" description="To configure the HttpClient using the key/values from the Map."/> | |
| <property name="httpContext" type="java:org.apache.http.protocol.HttpContext" display="Http Context" label="advanced" description="To use a custom HttpContext instance"/> | |
| <property name="httpMethod" type="enum:org.apache.camel.http.common.HttpMethods(GET,POST,PUT,DELETE,HEAD,OPTIONS,TRACE,PATCH)" display="Http Method" label="producer" description="Configure the HTTP method to use. The HttpMethod header cannot override this option if set."/> | |
| <property name="httpUri" type="java:java.net.URI" display="Http Uri" label="common" required="true" kind="path" description="The url of the HTTP endpoint to call."/> | |
| <property name="ignoreResponseBody" type="boolean" display="Ignore Response Body" label="producer" description="If this option is true, The http producer won't read response body and cache the input stream"/> | |
| <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="maxTotalConnections" type="int" display="Max Total Connections" label="advanced" description="The maximum number of connections."/> | |
| <property name="okStatusCodeRange" type="string" display="Ok Status Code Range" label="producer,advanced" description="The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included."/> | |
| <property name="preserveHostHeader" type="boolean" display="Preserve Host Header" label="producer" description="If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service"/> | |
| <property name="proxyAuthDomain" type="string" display="Proxy Auth Domain" label="producer,proxy" description="Proxy authentication domain to use with NTML"/> | |
| <property name="proxyAuthHost" type="string" display="Proxy Auth Host" label="producer,proxy" description="Proxy authentication host"/> | |
| <property name="proxyAuthMethod" type="string" display="Proxy Auth Method" label="producer,proxy" description="Proxy authentication method to use"/> | |
| <property name="proxyAuthPassword" type="string" display="Proxy Auth Password" label="producer,proxy" secret="true" description="Proxy authentication password"/> | |
| <property name="proxyAuthPort" type="int" display="Proxy Auth Port" label="producer,proxy" description="Proxy authentication port"/> | |
| <property name="proxyAuthScheme" type="string" display="Proxy Auth Scheme" label="producer,proxy" description="Proxy authentication scheme to use"/> | |
| <property name="proxyAuthUsername" type="string" display="Proxy Auth Username" label="producer,proxy" secret="true" description="Proxy authentication username"/> | |
| <property name="proxyHost" type="string" display="Proxy Host" label="producer,proxy" description="Proxy hostname to use"/> | |
| <property name="proxyPort" type="int" display="Proxy Port" label="producer,proxy" description="Proxy port to use"/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="security" description="To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need."/> | |
| <property name="throwExceptionOnFailure" type="boolean" display="Throw Exception On Failure" label="producer" description="Option to disable throwing the HttpOperationFailedException 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. 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="urlRewrite" type="java:org.apache.camel.http.common.UrlRewrite" display="Url Rewrite" label="producer,advanced" deprecated="true" description="Refers to a custom org.apache.camel.component.http.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints. See more details at http://camel.apache.org/urlrewrite.html"/> | |
| <property name="useSystemProperties" type="boolean" display="Use System Properties" label="advanced" description="To use System Properties as fallback for configuration"/> | |
| <property name="x509HostnameVerifier" type="java:javax.net.ssl.HostnameVerifier" display="X509 Hostname Verifier" label="security" description="To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or org.apache.http.conn.ssl.NoopHostnameVerifier."/> | |
| </endpoint> | |
| <endpoint name="iec60870-client" display="IEC 60870 Client" label="iot" extends="model:endpoint" javaType="org.apache.camel.component.iec60870.client.ClientComponent" maven="org.apache.camel:camel-iec60870:3.0.0-SNAPSHOT" since="2.20.0" description="IEC 60870 component used for telecontrol (supervisory control and data acquisition) such as controlling electric power transmission grids and other geographically widespread control systems."> | |
| <property name="acknowledgeWindow" type="java:short" display="Acknowledge Window" label="connection" description="Parameter W - Acknowledgment window."/> | |
| <property name="adsuAddressType" type="enum:org.eclipse.neoscada.protocol.iec60870.ASDUAddressType(SIZE_1, SIZE_2)" display="Adsu Address Type" label="connection" description="The common ASDU address size. May be either SIZE_1 or SIZE_2."/> | |
| <property name="causeOfTransmissionType" type="enum:org.eclipse.neoscada.protocol.iec60870.CauseOfTransmissionType(SIZE_1, SIZE_2)" display="Cause Of Transmission Type" label="connection" description="The cause of transmission type. May be either SIZE_1 or SIZE_2."/> | |
| <property name="causeSourceAddress" type="boolean" display="Cause Source Address" label="data" description="Whether to include the source address"/> | |
| <property name="connectionId" type="string" display="Connection Id" label="id" description="An identifier grouping connection instances"/> | |
| <property name="dataModuleOptions" type="java:DataModuleOptions" display="Data Module Options" description="Data module options"/> | |
| <property name="ignoreBackgroundScan" type="boolean" display="Ignore Background Scan" label="data" description="Whether background scan transmissions should be ignored."/> | |
| <property name="ignoreDaylightSavingTime" type="boolean" display="Ignore Daylight Saving Time" label="data" description="Whether to ignore or respect DST"/> | |
| <property name="informationObjectAddressType" type="enum:org.eclipse.neoscada.protocol.iec60870.InformationObjectAddressType(SIZE_1, SIZE_2, SIZE_3)" display="Information Object Address Type" label="connection" description="The information address size. May be either SIZE_1, SIZE_2 or SIZE_3."/> | |
| <property name="maxUnacknowledged" type="java:short" display="Max Unacknowledged" label="connection" description="Parameter K - Maximum number of un-acknowledged messages."/> | |
| <property name="protocolOptions" type="java:ProtocolOptions" display="Protocol Options" description="Protocol options"/> | |
| <property name="timeZone" type="java:java.util.TimeZone" display="Time Zone" label="data" description="The timezone to use. May be any Java time zone string"/> | |
| <property name="timeout1" type="int" display="Timeout1" label="connection" description="Timeout T1 in milliseconds."/> | |
| <property name="timeout2" type="int" display="Timeout2" label="connection" description="Timeout T2 in milliseconds."/> | |
| <property name="timeout3" type="int" display="Timeout3" label="connection" description="Timeout T3 in milliseconds."/> | |
| <property name="uriPath" type="java:org.apache.camel.component.iec60870.ObjectAddress" display="Uri Path" required="true" kind="path" description="The object information address"/> | |
| </endpoint> | |
| <endpoint name="iec60870-server" display="IEC 60870 Server" label="iot" extends="model:endpoint" javaType="org.apache.camel.component.iec60870.server.ServerComponent" maven="org.apache.camel:camel-iec60870:3.0.0-SNAPSHOT" since="2.20.0" description="IEC 60870 component used for telecontrol (supervisory control and data acquisition) such as controlling electric power transmission grids and other geographically widespread control systems."> | |
| <property name="acknowledgeWindow" type="java:short" display="Acknowledge Window" label="connection" description="Parameter W - Acknowledgment window."/> | |
| <property name="adsuAddressType" type="enum:org.eclipse.neoscada.protocol.iec60870.ASDUAddressType(SIZE_1, SIZE_2)" display="Adsu Address Type" label="connection" description="The common ASDU address size. May be either SIZE_1 or SIZE_2."/> | |
| <property name="causeOfTransmissionType" type="enum:org.eclipse.neoscada.protocol.iec60870.CauseOfTransmissionType(SIZE_1, SIZE_2)" display="Cause Of Transmission Type" label="connection" description="The cause of transmission type. May be either SIZE_1 or SIZE_2."/> | |
| <property name="causeSourceAddress" type="boolean" display="Cause Source Address" label="data" description="Whether to include the source address"/> | |
| <property name="connectionId" type="string" display="Connection Id" label="id" description="An identifier grouping connection instances"/> | |
| <property name="dataModuleOptions" type="java:DataModuleOptions" display="Data Module Options" description="Data module options"/> | |
| <property name="filterNonExecute" type="boolean" display="Filter Non Execute" description="Filter out all requests which don't have the execute bit set"/> | |
| <property name="ignoreBackgroundScan" type="boolean" display="Ignore Background Scan" label="data" description="Whether background scan transmissions should be ignored."/> | |
| <property name="ignoreDaylightSavingTime" type="boolean" display="Ignore Daylight Saving Time" label="data" description="Whether to ignore or respect DST"/> | |
| <property name="informationObjectAddressType" type="enum:org.eclipse.neoscada.protocol.iec60870.InformationObjectAddressType(SIZE_1, SIZE_2, SIZE_3)" display="Information Object Address Type" label="connection" description="The information address size. May be either SIZE_1, SIZE_2 or SIZE_3."/> | |
| <property name="maxUnacknowledged" type="java:short" display="Max Unacknowledged" label="connection" description="Parameter K - Maximum number of un-acknowledged messages."/> | |
| <property name="protocolOptions" type="java:ProtocolOptions" display="Protocol Options" description="Protocol options"/> | |
| <property name="timeZone" type="java:java.util.TimeZone" display="Time Zone" label="data" description="The timezone to use. May be any Java time zone string"/> | |
| <property name="timeout1" type="int" display="Timeout1" label="connection" description="Timeout T1 in milliseconds."/> | |
| <property name="timeout2" type="int" display="Timeout2" label="connection" description="Timeout T2 in milliseconds."/> | |
| <property name="timeout3" type="int" display="Timeout3" label="connection" description="Timeout T3 in milliseconds."/> | |
| <property name="uriPath" type="java:org.apache.camel.component.iec60870.ObjectAddress" display="Uri Path" required="true" kind="path" description="The object information address"/> | |
| </endpoint> | |
| <endpoint name="ignite-cache" display="Ignite Cache" label="nosql,cache,compute" extends="model:endpoint" javaType="org.apache.camel.component.ignite.cache.IgniteCacheComponent" maven="org.apache.camel:camel-ignite:3.0.0-SNAPSHOT" since="2.17.0" description="The Ignite Cache endpoint is one of camel-ignite endpoints which allows you to interact with an Ignite Cache."> | |
| <property name="autoUnsubscribe" type="boolean" display="Auto Unsubscribe" label="consumer" description="Whether auto unsubscribe is enabled in the Continuous Query Consumer."/> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="The cache name."/> | |
| <property name="cachePeekMode" type="enum:org.apache.ignite.cache.CachePeekMode(ALL,NEAR,PRIMARY,BACKUP,ONHEAP,OFFHEAP)" display="Cache Peek Mode" label="producer" description="The CachePeekMode, only needed for operations that require it (IgniteCacheOperation#SIZE)."/> | |
| <property name="failIfInexistentCache" type="boolean" display="Fail If Inexistent Cache" label="producer" description="Whether to fail the initialization if the cache doesn't exist."/> | |
| <property name="fireExistingQueryResults" type="boolean" display="Fire Existing Query Results" label="consumer" description="Whether to process existing results that match the query. Used on initialization of the Continuous Query Consumer."/> | |
| <property name="oneExchangePerUpdate" type="boolean" display="One Exchange Per Update" label="consumer" description="Whether to pack each update in an individual Exchange, even if multiple updates are received in one batch. Only used by the Continuous Query Consumer."/> | |
| <property name="operation" type="enum:IgniteCacheOperation(GET,PUT,REMOVE,SIZE,REBALANCE,QUERY,CLEAR)" display="Operation" label="producer" description="The cache operation to invoke. Possible values: GET, PUT, REMOVE, SIZE, REBALANCE, QUERY, CLEAR."/> | |
| <property name="pageSize" type="int" display="Page Size" label="consumer" description="The page size. Only used by the Continuous Query Consumer."/> | |
| <property name="propagateIncomingBodyIfNoReturnValue" type="boolean" display="Propagate Incoming Body If No Return Value" description="Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."/> | |
| <property name="query" type="java:org.apache.ignite.cache.query.Query<javax.cache.Cache.Entry<java.lang.Object,java.lang.Object>>" display="Query" label="producer,consumer" description="The Query to execute, only needed for operations that require it, and for the Continuous Query Consumer."/> | |
| <property name="remoteFilter" type="java:org.apache.ignite.cache.CacheEntryEventSerializableFilter<java.lang.Object,java.lang.Object>" display="Remote Filter" label="consumer" description="The remote filter, only used by the Continuous Query Consumer."/> | |
| <property name="timeInterval" type="long" display="Time Interval" label="consumer" description="The time interval for the Continuous Query Consumer."/> | |
| <property name="treatCollectionsAsCacheObjects" type="boolean" display="Treat Collections As Cache Objects" description="Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."/> | |
| </endpoint> | |
| <endpoint name="ignite-compute" display="Ignite Compute" label="nosql,cache,compute" extends="model:endpoint" javaType="org.apache.camel.component.ignite.compute.IgniteComputeComponent" maven="org.apache.camel:camel-ignite:3.0.0-SNAPSHOT" producerOnly="true" since="2.17.0" description="The Ignite Compute endpoint is one of camel-ignite endpoints which allows you to run compute operations on the cluster by passing in an IgniteCallable, an IgniteRunnable, an IgniteClosure, or collections of them, along with their parameters if necessary."> | |
| <property name="clusterGroupExpression" type="java:org.apache.camel.component.ignite.ClusterGroupExpression" display="Cluster Group Expression" label="producer" description="An expression that returns the Cluster Group for the IgniteCompute instance."/> | |
| <property name="computeName" type="string" display="Compute Name" label="producer" description="The name of the compute job, which will be set via IgniteCompute#withName(String)."/> | |
| <property name="endpointId" type="string" display="Endpoint Id" required="true" kind="path" description="The endpoint ID (not used)."/> | |
| <property name="executionType" type="enum:IgniteComputeExecutionType(CALL,BROADCAST,APPLY,EXECUTE,RUN,AFFINITY_CALL,AFFINITY_RUN)" display="Execution Type" label="producer" required="true" description="The compute operation to perform. Possible values: CALL, BROADCAST, APPLY, EXECUTE, RUN, AFFINITY_CALL, AFFINITY_RUN. The component expects different payload types depending on the operation."/> | |
| <property name="propagateIncomingBodyIfNoReturnValue" type="boolean" display="Propagate Incoming Body If No Return Value" description="Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."/> | |
| <property name="taskName" type="string" display="Task Name" label="producer" description="The task name, only applicable if using the IgniteComputeExecutionType#EXECUTE execution type."/> | |
| <property name="timeoutMillis" type="long" display="Timeout Millis" label="producer" description="The timeout interval for triggered jobs, in milliseconds, which will be set via IgniteCompute#withTimeout(long)."/> | |
| <property name="treatCollectionsAsCacheObjects" type="boolean" display="Treat Collections As Cache Objects" description="Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."/> | |
| </endpoint> | |
| <endpoint name="ignite-events" display="Ignite Events" label="nosql,cache,compute,messaging,data" extends="model:endpoint" javaType="org.apache.camel.component.ignite.events.IgniteEventsComponent" maven="org.apache.camel:camel-ignite:3.0.0-SNAPSHOT" consumerOnly="true" since="2.17.0" description="The Ignite Events endpoint is one of camel-ignite endpoints which allows you to receive events from the Ignite cluster by creating a local event listener."> | |
| <property name="clusterGroupExpression" type="java:org.apache.camel.component.ignite.ClusterGroupExpression" display="Cluster Group Expression" label="consumer" description="The cluster group expression."/> | |
| <property name="endpointId" type="string" display="Endpoint Id" kind="path" description="The endpoint ID (not used)."/> | |
| <property name="events" type="java:Set<Integer> or String" display="Events" label="consumer" description="The event IDs to subscribe to as a Set directly where the IDs are the different constants in org.apache.ignite.events.EventType."/> | |
| <property name="propagateIncomingBodyIfNoReturnValue" type="boolean" display="Propagate Incoming Body If No Return Value" description="Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."/> | |
| <property name="treatCollectionsAsCacheObjects" type="boolean" display="Treat Collections As Cache Objects" description="Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."/> | |
| </endpoint> | |
| <endpoint name="ignite-idgen" display="Ignite ID Generator" label="nosql,cache,compute" extends="model:endpoint" javaType="org.apache.camel.component.ignite.idgen.IgniteIdGenComponent" maven="org.apache.camel:camel-ignite:3.0.0-SNAPSHOT" producerOnly="true" since="2.17.0" description="The Ignite ID Generator endpoint is one of camel-ignite endpoints which allows you to interact with Ignite Atomic Sequences and ID Generators."> | |
| <property name="batchSize" type="int" display="Batch Size" label="producer" description="The batch size."/> | |
| <property name="initialValue" type="long" display="Initial Value" label="producer" description="The initial value."/> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="The sequence name."/> | |
| <property name="operation" type="enum:IgniteIdGenOperation(ADD_AND_GET,GET,GET_AND_ADD,GET_AND_INCREMENT,INCREMENT_AND_GET)" display="Operation" label="producer" description="The operation to invoke on the Ignite ID Generator. Superseded by the IgniteConstants.IGNITE_IDGEN_OPERATION header in the IN message. Possible values: ADD_AND_GET, GET, GET_AND_ADD, GET_AND_INCREMENT, INCREMENT_AND_GET."/> | |
| <property name="propagateIncomingBodyIfNoReturnValue" type="boolean" display="Propagate Incoming Body If No Return Value" description="Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."/> | |
| <property name="treatCollectionsAsCacheObjects" type="boolean" display="Treat Collections As Cache Objects" description="Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."/> | |
| </endpoint> | |
| <endpoint name="ignite-messaging" display="Ignite Messaging" label="nosql,cache,messaging" extends="model:endpoint" javaType="org.apache.camel.component.ignite.messaging.IgniteMessagingComponent" maven="org.apache.camel:camel-ignite:3.0.0-SNAPSHOT" since="2.17.0" description="The Ignite Messaging endpoint is one of camel-ignite endpoints which allows you to send and consume messages from an Ignite topic."> | |
| <property name="clusterGroupExpression" type="java:org.apache.camel.component.ignite.ClusterGroupExpression" display="Cluster Group Expression" label="consumer,producer" description="The cluster group expression."/> | |
| <property name="propagateIncomingBodyIfNoReturnValue" type="boolean" display="Propagate Incoming Body If No Return Value" description="Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."/> | |
| <property name="sendMode" type="enum:IgniteMessagingSendMode(ORDERED,UNORDERED)" display="Send Mode" label="producer" description="The send mode to use. Possible values: UNORDERED, ORDERED."/> | |
| <property name="timeout" type="long" display="Timeout" label="producer" description="The timeout for the send operation when using ordered messages."/> | |
| <property name="topic" type="string" display="Topic" required="true" kind="path" description="The topic name."/> | |
| <property name="treatCollectionsAsCacheObjects" type="boolean" display="Treat Collections As Cache Objects" description="Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."/> | |
| </endpoint> | |
| <endpoint name="ignite-queue" display="Ignite Queues" label="nosql,cache" extends="model:endpoint" javaType="org.apache.camel.component.ignite.queue.IgniteQueueComponent" maven="org.apache.camel:camel-ignite:3.0.0-SNAPSHOT" producerOnly="true" since="2.17.0" description="The Ignite Queue endpoint is one of camel-ignite endpoints which allows you to interact with Ignite Queue data structures."> | |
| <property name="capacity" type="int" display="Capacity" label="producer" description="The queue capacity. Default: non-bounded."/> | |
| <property name="configuration" type="java:org.apache.ignite.configuration.CollectionConfiguration" display="Configuration" label="producer" description="The collection configuration. Default: empty configuration. You can also conveniently set inner properties by using configuration.xyz=123 options."/> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="The queue name."/> | |
| <property name="operation" type="enum:IgniteQueueOperation(CONTAINS,ADD,SIZE,REMOVE,ITERATOR,CLEAR,RETAIN_ALL,ARRAY,DRAIN,ELEMENT,PEEK,OFFER,POLL,TAKE,PUT)" display="Operation" label="producer" description="The operation to invoke on the Ignite Queue. Superseded by the IgniteConstants.IGNITE_QUEUE_OPERATION header in the IN message. Possible values: CONTAINS, ADD, SIZE, REMOVE, ITERATOR, CLEAR, RETAIN_ALL, ARRAY, DRAIN, ELEMENT, PEEK, OFFER, POLL, TAKE, PUT."/> | |
| <property name="propagateIncomingBodyIfNoReturnValue" type="boolean" display="Propagate Incoming Body If No Return Value" description="Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."/> | |
| <property name="timeoutMillis" type="long" display="Timeout Millis" label="producer" description="The queue timeout in milliseconds. Default: no timeout."/> | |
| <property name="treatCollectionsAsCacheObjects" type="boolean" display="Treat Collections As Cache Objects" description="Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."/> | |
| </endpoint> | |
| <endpoint name="ignite-set" display="Ignite Sets" label="nosql,cache" extends="model:endpoint" javaType="org.apache.camel.component.ignite.set.IgniteSetComponent" maven="org.apache.camel:camel-ignite:3.0.0-SNAPSHOT" producerOnly="true" since="2.17.0" description="The Ignite Sets endpoint is one of camel-ignite endpoints which allows you to interact with Ignite Set data structures."> | |
| <property name="configuration" type="java:org.apache.ignite.configuration.CollectionConfiguration" display="Configuration" label="producer" description="The collection configuration. Default: empty configuration. You can also conveniently set inner properties by using configuration.xyz=123 options."/> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="The set name."/> | |
| <property name="operation" type="enum:IgniteSetOperation(CONTAINS,ADD,SIZE,REMOVE,ITERATOR,CLEAR,RETAIN_ALL,ARRAY)" display="Operation" label="producer" description="The operation to invoke on the Ignite Set. Superseded by the IgniteConstants.IGNITE_SETS_OPERATION header in the IN message. Possible values: CONTAINS, ADD, SIZE, REMOVE, ITERATOR, CLEAR, RETAIN_ALL, ARRAY.The set operation to perform."/> | |
| <property name="propagateIncomingBodyIfNoReturnValue" type="boolean" display="Propagate Incoming Body If No Return Value" description="Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void."/> | |
| <property name="treatCollectionsAsCacheObjects" type="boolean" display="Treat Collections As Cache Objects" description="Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc."/> | |
| </endpoint> | |
| <endpoint name="imap" display="IMAP" label="mail" extends="model:scheduled" javaType="org.apache.camel.component.mail.MailComponent" maven="org.apache.camel:camel-mail:3.0.0-SNAPSHOT" since="1.0.0" description="To send or receive emails using imap/pop3 or smtp protocols."> | |
| <property name="additionalJavaMailProperties" type="java:java.util.Properties" display="Additional Java Mail Properties" label="advanced" description="Sets additional java mail properties, that will append/override any default properties that is set based on all the other options. This is useful if you need to add some special options but want to keep the others as is."/> | |
| <property name="alternativeBodyHeader" type="string" display="Alternative Body Header" label="advanced" description="Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header."/> | |
| <property name="attachmentsContentTransferEncodingResolver" type="java:org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver" display="Attachments Content Transfer Encoding Resolver" label="advanced" description="To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments."/> | |
| <property name="bcc" type="string" display="Bcc" label="producer" description="Sets the BCC email address. Separate multiple email addresses with comma."/> | |
| <property name="binding" type="java:org.apache.camel.component.mail.MailBinding" display="Binding" label="advanced" description="Sets the binding used to convert from a Camel message to and from a Mail message"/> | |
| <property name="cc" type="string" display="Cc" label="producer" description="Sets the CC email address. Separate multiple email addresses with comma."/> | |
| <property name="closeFolder" type="boolean" display="Close Folder" label="consumer" description="Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keep the folder open between polls."/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="The connection timeout in milliseconds."/> | |
| <property name="contentType" type="string" display="Content Type" label="advanced" description="The mail message content type. Use text/html for HTML mails."/> | |
| <property name="contentTypeResolver" type="java:org.apache.camel.component.mail.ContentTypeResolver" display="Content Type Resolver" label="advanced" description="Resolver to determine Content-Type for file attachments."/> | |
| <property name="copyTo" type="string" display="Copy To" label="consumer" description="After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value, with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime."/> | |
| <property name="debugMode" type="boolean" display="Debug Mode" label="advanced" description="Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default."/> | |
| <property name="delete" type="boolean" display="Delete" label="consumer" description="Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. As of Camel 2.10 you can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not."/> | |
| <property name="disconnect" type="boolean" display="Disconnect" label="consumer" description="Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll."/> | |
| <property name="fetchSize" type="int" display="Fetch Size" label="consumer,advanced" description="Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. Default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all."/> | |
| <property name="folderName" type="string" display="Folder Name" label="consumer,advanced" description="The folder to poll."/> | |
| <property name="from" type="string" display="From" label="producer" description="The from email address"/> | |
| <property name="handleFailedMessage" type="boolean" display="Handle Failed Message" label="consumer" description="If the mail consumer cannot retrieve a given mail message, then this option allows to handle the caused exception by the consumer's error handler. By enable the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."/> | |
| <property name="headerFilterStrategy" type="java:org.apache.camel.spi.HeaderFilterStrategy" display="Header Filter Strategy" label="advanced" description="To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."/> | |
| <property name="host" type="string" display="Host" required="true" kind="path" description="The mail server host name"/> | |
| <property name="idempotentRepository" type="java:org.apache.camel.spi.IdempotentRepository" display="Idempotent Repository" label="consumer,filter" description="A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use."/> | |
| <property name="idempotentRepositoryRemoveOnCommit" type="boolean" display="Idempotent Repository Remove On Commit" label="consumer,filter" description="When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have."/> | |
| <property name="ignoreUnsupportedCharset" type="boolean" display="Ignore Unsupported Charset" label="advanced" description="Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type and it relies on the platform default instead."/> | |
| <property name="ignoreUriScheme" type="boolean" display="Ignore Uri Scheme" label="advanced" description="Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type and it relies on the platform default instead."/> | |
| <property name="javaMailSender" type="java:org.apache.camel.component.mail.JavaMailSender" display="Java Mail Sender" label="producer,advanced" description="To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails."/> | |
| <property name="mailUidGenerator" type="java:org.apache.camel.component.mail.MailUidGenerator" display="Mail Uid Generator" label="consumer,advanced" description="A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message."/> | |
| <property name="mapMailMessage" type="boolean" display="Map Mail Message" label="consumer,advanced" description="Specifies whether Camel should map the received mail message to Camel body/headers. If set to true, the body of the mail message is mapped to the body of the Camel IN message and the mail headers are mapped to IN headers. If this option is set to false then the IN message contains a raw javax.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(javax.mail.Message.class)."/> | |
| <property name="maxMessagesPerPoll" type="int" display="Max Messages Per Poll" label="consumer" description="Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option."/> | |
| <property name="mimeDecodeHeaders" type="boolean" display="Mime Decode Headers" label="consumer" description="This option enables transparent MIME decoding and unfolding for mail headers."/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="The password for login"/> | |
| <property name="peek" type="boolean" display="Peek" label="consumer" description="Will mark the javax.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek the mail will not be eager marked as SEEN on the mail server, which allows us to rollback the mail message if there is an error processing in Camel."/> | |
| <property name="port" type="int" display="Port" kind="path" description="The port number of the mail server"/> | |
| <property name="postProcessAction" type="java:org.apache.camel.component.mail.MailBoxPostProcessAction" display="Post Process Action" label="consumer,advanced" description="Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended."/> | |
| <property name="replyTo" type="string" display="Reply To" label="producer" description="The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma."/> | |
| <property name="searchTerm" type="java:javax.mail.search.SearchTerm" display="Search Term" label="consumer,filter" description="Refers to a javax.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc."/> | |
| <property name="session" type="java:javax.mail.Session" display="Session" label="advanced" description="Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. If this is not specified, Camel automatically creates the mail session for you."/> | |
| <property name="skipFailedMessage" type="boolean" display="Skip Failed Message" label="consumer" description="If the mail consumer cannot retrieve a given mail message, then this option allows to skip the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."/> | |
| <property name="sortTerm" type="string" display="Sort Term" label="consumer,sort" description="Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability."/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="security" description="To configure security using SSLContextParameters."/> | |
| <property name="subject" type="string" display="Subject" label="producer" description="The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option."/> | |
| <property name="to" type="string" display="To" label="producer" description="Sets the To email address. Separate multiple email addresses with comma."/> | |
| <property name="unseen" type="boolean" display="Unseen" label="consumer" description="Whether to limit by unseen mails only."/> | |
| <property name="useInlineAttachments" type="boolean" display="Use Inline Attachments" label="advanced" description="Whether to use disposition inline or attachment."/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="The username for login"/> | |
| </endpoint> | |
| <endpoint name="imaps" display="IMAPS (Secure)" label="mail" extends="model:scheduled" javaType="org.apache.camel.component.mail.MailComponent" maven="org.apache.camel:camel-mail:3.0.0-SNAPSHOT" since="1.0.0" description="To send or receive emails using imap/pop3 or smtp protocols."> | |
| <property name="additionalJavaMailProperties" type="java:java.util.Properties" display="Additional Java Mail Properties" label="advanced" description="Sets additional java mail properties, that will append/override any default properties that is set based on all the other options. This is useful if you need to add some special options but want to keep the others as is."/> | |
| <property name="alternativeBodyHeader" type="string" display="Alternative Body Header" label="advanced" description="Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header."/> | |
| <property name="attachmentsContentTransferEncodingResolver" type="java:org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver" display="Attachments Content Transfer Encoding Resolver" label="advanced" description="To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments."/> | |
| <property name="bcc" type="string" display="Bcc" label="producer" description="Sets the BCC email address. Separate multiple email addresses with comma."/> | |
| <property name="binding" type="java:org.apache.camel.component.mail.MailBinding" display="Binding" label="advanced" description="Sets the binding used to convert from a Camel message to and from a Mail message"/> | |
| <property name="cc" type="string" display="Cc" label="producer" description="Sets the CC email address. Separate multiple email addresses with comma."/> | |
| <property name="closeFolder" type="boolean" display="Close Folder" label="consumer" description="Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keep the folder open between polls."/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="The connection timeout in milliseconds."/> | |
| <property name="contentType" type="string" display="Content Type" label="advanced" description="The mail message content type. Use text/html for HTML mails."/> | |
| <property name="contentTypeResolver" type="java:org.apache.camel.component.mail.ContentTypeResolver" display="Content Type Resolver" label="advanced" description="Resolver to determine Content-Type for file attachments."/> | |
| <property name="copyTo" type="string" display="Copy To" label="consumer" description="After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value, with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime."/> | |
| <property name="debugMode" type="boolean" display="Debug Mode" label="advanced" description="Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default."/> | |
| <property name="delete" type="boolean" display="Delete" label="consumer" description="Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. As of Camel 2.10 you can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not."/> | |
| <property name="disconnect" type="boolean" display="Disconnect" label="consumer" description="Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll."/> | |
| <property name="fetchSize" type="int" display="Fetch Size" label="consumer,advanced" description="Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. Default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all."/> | |
| <property name="folderName" type="string" display="Folder Name" label="consumer,advanced" description="The folder to poll."/> | |
| <property name="from" type="string" display="From" label="producer" description="The from email address"/> | |
| <property name="handleFailedMessage" type="boolean" display="Handle Failed Message" label="consumer" description="If the mail consumer cannot retrieve a given mail message, then this option allows to handle the caused exception by the consumer's error handler. By enable the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."/> | |
| <property name="headerFilterStrategy" type="java:org.apache.camel.spi.HeaderFilterStrategy" display="Header Filter Strategy" label="advanced" description="To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers."/> | |
| <property name="host" type="string" display="Host" required="true" kind="path" description="The mail server host name"/> | |
| <property name="idempotentRepository" type="java:org.apache.camel.spi.IdempotentRepository" display="Idempotent Repository" label="consumer,filter" description="A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use."/> | |
| <property name="idempotentRepositoryRemoveOnCommit" type="boolean" display="Idempotent Repository Remove On Commit" label="consumer,filter" description="When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have."/> | |
| <property name="ignoreUnsupportedCharset" type="boolean" display="Ignore Unsupported Charset" label="advanced" description="Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type and it relies on the platform default instead."/> | |
| <property name="ignoreUriScheme" type="boolean" display="Ignore Uri Scheme" label="advanced" description="Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type and it relies on the platform default instead."/> | |
| <property name="javaMailSender" type="java:org.apache.camel.component.mail.JavaMailSender" display="Java Mail Sender" label="producer,advanced" description="To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails."/> | |
| <property name="mailUidGenerator" type="java:org.apache.camel.component.mail.MailUidGenerator" display="Mail Uid Generator" label="consumer,advanced" description="A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message."/> | |
| <property name="mapMailMessage" type="boolean" display="Map Mail Message" label="consumer,advanced" description="Specifies whether Camel should map the received mail message to Camel body/headers. If set to true, the body of the mail message is mapped to the body of the Camel IN message and the mail headers are mapped to IN headers. If this option is set to false then the IN message contains a raw javax.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(javax.mail.Message.class)."/> | |
| <property name="maxMessagesPerPoll" type="int" display="Max Messages Per Poll" label="consumer" description="Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option."/> | |
| <property name="mimeDecodeHeaders" type="boolean" display="Mime Decode Headers" label="consumer" description="This option enables transparent MIME decoding and unfolding for mail headers."/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="The password for login"/> | |
| <property name="peek" type="boolean" display="Peek" label="consumer" description="Will mark the javax.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek the mail will not be eager marked as SEEN on the mail server, which allows us to rollback the mail message if there is an error processing in Camel."/> | |
| <property name="port" type="int" display="Port" kind="path" description="The port number of the mail server"/> | |
| <property name="postProcessAction" type="java:org.apache.camel.component.mail.MailBoxPostProcessAction" display="Post Process Action" label="consumer,advanced" description="Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended."/> | |
| <property name="replyTo" type="string" display="Reply To" label="producer" description="The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma."/> | |
| <property name="searchTerm" type="java:javax.mail.search.SearchTerm" display="Search Term" label="consumer,filter" description="Refers to a javax.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc."/> | |
| <property name="session" type="java:javax.mail.Session" display="Session" label="advanced" description="Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. If this is not specified, Camel automatically creates the mail session for you."/> | |
| <property name="skipFailedMessage" type="boolean" display="Skip Failed Message" label="consumer" description="If the mail consumer cannot retrieve a given mail message, then this option allows to skip the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel."/> | |
| <property name="sortTerm" type="string" display="Sort Term" label="consumer,sort" description="Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability."/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="security" description="To configure security using SSLContextParameters."/> | |
| <property name="subject" type="string" display="Subject" label="producer" description="The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option."/> | |
| <property name="to" type="string" display="To" label="producer" description="Sets the To email address. Separate multiple email addresses with comma."/> | |
| <property name="unseen" type="boolean" display="Unseen" label="consumer" description="Whether to limit by unseen mails only."/> | |
| <property name="useInlineAttachments" type="boolean" display="Use Inline Attachments" label="advanced" description="Whether to use disposition inline or attachment."/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="The username for login"/> | |
| </endpoint> | |
| <endpoint name="infinispan" display="Infinispan" label="cache,datagrid,clustering" extends="model:endpoint" javaType="org.apache.camel.component.infinispan.InfinispanComponent" maven="org.apache.camel:camel-infinispan:3.0.0-SNAPSHOT" since="2.13.0" description="For reading/writing from/to Infinispan distributed key/value store and data grid."> | |
| <property name="cacheContainer" type="java:org.infinispan.commons.api.BasicCacheContainer" display="Cache Container" label="advanced" description="Specifies the cache Container to connect"/> | |
| <property name="cacheContainerConfiguration" type="object" display="Cache Container Configuration" label="advanced" description="The CacheContainer configuration. Uses if the cacheContainer is not defined. Must be the following types: org.infinispan.client.hotrod.configuration.Configuration - for remote cache interaction configuration; org.infinispan.configuration.cache.Configuration - for embedded cache interaction configuration;"/> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="The cache to use"/> | |
| <property name="clusteredListener" type="boolean" display="Clustered Listener" label="consumer" description="If true, the listener will be installed for the entire cluster"/> | |
| <property name="command" type="string" display="Command" label="consumer" deprecated="true" description="The operation to perform."/> | |
| <property name="configurationProperties" type="map(string,string)" display="Configuration Properties" label="advanced" description="Implementation specific properties for the CacheManager"/> | |
| <property name="configurationUri" type="string" display="Configuration Uri" label="advanced" description="An implementation specific URI for the CacheManager"/> | |
| <property name="customListener" type="java:org.apache.camel.component.infinispan.InfinispanCustomListener" display="Custom Listener" label="consumer" description="Returns the custom listener in use, if provided"/> | |
| <property name="eventTypes" type="string" display="Event Types" label="consumer" description="Specifies the set of event types to register by the consumer. Multiple event can be separated by comma. The possible event types are: CACHE_ENTRY_ACTIVATED, CACHE_ENTRY_PASSIVATED, CACHE_ENTRY_VISITED, CACHE_ENTRY_LOADED, CACHE_ENTRY_EVICTED, CACHE_ENTRY_CREATED, CACHE_ENTRY_REMOVED, CACHE_ENTRY_MODIFIED, TRANSACTION_COMPLETED, TRANSACTION_REGISTERED, CACHE_ENTRY_INVALIDATED, DATA_REHASHED, TOPOLOGY_CHANGED, PARTITION_STATUS_CHANGED"/> | |
| <property name="flags" type="string" display="Flags" label="advanced" description="A comma separated list of Flag to be applied by default on each cache invocation, not applicable to remote caches."/> | |
| <property name="hosts" type="string" display="Hosts" description="Specifies the host of the cache on Infinispan instance"/> | |
| <property name="operation" type="enum:InfinispanOperation(PUT,PUTASYNC,PUTALL,PUTALLASYNC,PUTIFABSENT,PUTIFABSENTASYNC,GET,GETORDEFAULT,CONTAINSKEY,CONTAINSVALUE,REMOVE,REMOVEASYNC,REPLACE,REPLACEASYNC,SIZE,CLEAR,CLEARASYNC,QUERY,STATS,COMPUTE,COMPUTEASYNC)" display="Operation" label="producer" description="The operation to perform."/> | |
| <property name="queryBuilder" type="java:org.apache.camel.component.infinispan.InfinispanQueryBuilder" display="Query Builder" description="Specifies the query builder."/> | |
| <property name="remappingFunction" type="java:java.util.function.BiFunction" display="Remapping Function" label="advanced" description="Set a specific remappingFunction to use in a compute operation"/> | |
| <property name="resultHeader" type="object" display="Result Header" label="advanced" description="Store the operation result in a header instead of the message body. By default, resultHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If resultHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. This value can be overridden by an in message header named: CamelInfinispanOperationResultHeader"/> | |
| <property name="sync" type="boolean" display="Sync" label="consumer" description="If true, the consumer will receive notifications synchronously"/> | |
| </endpoint> | |
| <endpoint name="influxdb" display="InfluxDB" label="database" extends="model:endpoint" javaType="org.apache.camel.component.influxdb.InfluxDbComponent" maven="org.apache.camel:camel-influxdb:3.0.0-SNAPSHOT" producerOnly="true" since="2.18.0" description="The influxdb component allows you to interact with InfluxDB, a time series database."> | |
| <property name="batch" type="boolean" display="Batch" description="Define if this operation is a batch operation or not"/> | |
| <property name="connectionBean" type="string" display="Connection Bean" required="true" kind="path" description="Connection to the influx database, of class InfluxDB.class"/> | |
| <property name="databaseName" type="string" display="Database Name" description="The name of the database where the time series will be stored"/> | |
| <property name="operation" type="string" display="Operation" description="Define if this operation is an insert or a query"/> | |
| <property name="query" type="string" display="Query" description="Define the query in case of operation query"/> | |
| <property name="retentionPolicy" type="string" display="Retention Policy" description="The string that defines the retention policy to the data created by the endpoint"/> | |
| </endpoint> | |
| <endpoint name="iota" display="IOTA" label="dlt" extends="model:endpoint" javaType="org.apache.camel.component.iota.IOTAComponent" maven="org.apache.camel:camel-iota:3.0.0-SNAPSHOT" since="2.23.0" description="Component for integrate IOTA DLT"> | |
| <property name="depth" type="int" display="Depth" description="The depth determines how deep the tangle is analysed for getting Tips"/> | |
| <property name="minWeightMagnitude" type="int" display="Min Weight Magnitude" description="The minWeightMagnitude is the minimum number of zeroes that a proof-of-work output/transaction hash must end with to be considered valid by full nodes"/> | |
| <property name="name" type="string" display="Name" required="true" kind="path" description="Component name"/> | |
| <property name="operation" type="string" display="Operation" description="Supported operations are 'sendTransfer', 'getNewAddress'"/> | |
| <property name="securityLevel" type="int" display="Security Level" description="Address security level"/> | |
| <property name="tag" type="string" display="Tag" description="TAG"/> | |
| <property name="url" type="string" display="Url" description="Node url"/> | |
| </endpoint> | |
| <endpoint name="ipfs" display="IPFS" label="file,ipfs" extends="model:endpoint" javaType="org.apache.camel.component.ipfs.IPFSComponent" maven="org.apache.camel:camel-ipfs:3.0.0-SNAPSHOT" producerOnly="true" since="2.23.0" description="The camel-ipfs component provides access to the Interplanetary File System (IPFS)."> | |
| <property name="ipfsCmd" type="string" display="Ipfs Cmd" kind="path" description="The ipfs command"/> | |
| <property name="outdir" type="java:java.nio.file.Path" display="Outdir" description="The ipfs output directory"/> | |
| </endpoint> | |
| <endpoint name="irc" display="IRC" label="chat" extends="model:endpoint" javaType="org.apache.camel.component.irc.IrcComponent" maven="org.apache.camel:camel-irc:3.0.0-SNAPSHOT" since="1.1.0" description="The irc component implements an IRC (Internet Relay Chat) transport."> | |
| <property name="autoRejoin" type="boolean" display="Auto Rejoin" description="Whether to auto re-join when being kicked"/> | |
| <property name="colors" type="boolean" display="Colors" label="advanced" description="Whether or not the server supports color codes."/> | |
| <property name="commandTimeout" type="long" display="Command Timeout" description="Delay in milliseconds before sending commands after the connection is established."/> | |
| <property name="hostname" type="string" display="Hostname" required="true" kind="path" description="Hostname for the IRC chat server"/> | |
| <property name="namesOnJoin" type="boolean" display="Names On Join" description="Sends NAMES command to channel after joining it. onReply has to be true in order to process the result which will have the header value irc.num = '353'."/> | |
| <property name="nickPassword" type="string" display="Nick Password" label="security" secret="true" description="Your IRC server nickname password."/> | |
| <property name="nickname" type="string" display="Nickname" description="The nickname used in chat."/> | |
| <property name="onJoin" type="boolean" display="On Join" label="filter" description="Handle user join events."/> | |
| <property name="onKick" type="boolean" display="On Kick" label="filter" description="Handle kick events."/> | |
| <property name="onMode" type="boolean" display="On Mode" label="filter" description="Handle mode change events."/> | |
| <property name="onNick" type="boolean" display="On Nick" label="filter" description="Handle nickname change events."/> | |
| <property name="onPart" type="boolean" display="On Part" label="filter" description="Handle user part events."/> | |
| <property name="onPrivmsg" type="boolean" display="On Privmsg" label="filter" description="Handle private message events."/> | |
| <property name="onQuit" type="boolean" display="On Quit" label="filter" description="Handle user quit events."/> | |
| <property name="onReply" type="boolean" display="On Reply" label="filter" description="Whether or not to handle general responses to commands or informational messages."/> | |
| <property name="onTopic" type="boolean" display="On Topic" label="filter" description="Handle topic change events."/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="The IRC server password."/> | |
| <property name="persistent" type="boolean" display="Persistent" deprecated="true" description="Use persistent messages."/> | |
| <property name="port" type="int" display="Port" kind="path" description="Port number for the IRC chat server. If no port is configured then a default port of either 6667, 6668 or 6669 is used."/> | |
| <property name="realname" type="string" display="Realname" description="The IRC user's actual name."/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="security" description="Used for configuring security using SSL. Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. Note that this setting overrides the trustManager option."/> | |
| <property name="trustManager" type="java:org.schwering.irc.lib.ssl.SSLTrustManager" display="Trust Manager" label="security" description="The trust manager used to verify the SSL server's certificate."/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="The IRC server user name."/> | |
| </endpoint> | |
| <endpoint name="ironmq" display="IronMQ" label="cloud,messaging" extends="model:scheduled" javaType="org.apache.camel.component.ironmq.IronMQComponent" maven="org.apache.camel:camel-ironmq:3.0.0-SNAPSHOT" since="2.17.0" description="The ironmq provides integration with IronMQ an elastic and durable hosted message queue as a service."> | |
| <property name="batchDelete" type="boolean" display="Batch Delete" label="consumer" description="Should messages be deleted in one batch. This will limit the number of api requests since messages are deleted in one request, instead of one pr. exchange. If enabled care should be taken that the consumer is idempotent when processing exchanges."/> | |
| <property name="client" type="java:io.iron.ironmq.Client" display="Client" description="Reference to a io.iron.ironmq.Client in the Registry."/> | |
| <property name="concurrentConsumers" type="int" display="Concurrent Consumers" label="consumer" description="The number of concurrent consumers."/> | |
| <property name="ironMQCloud" type="string" display="Iron MQCloud" description="IronMq Cloud url. Urls for public clusters: https://mq-aws-us-east-1-1.iron.io (US) and https://mq-aws-eu-west-1-1.iron.io (EU)"/> | |
| <property name="maxMessagesPerPoll" type="int" display="Max Messages Per Poll" label="consumer" description="Number of messages to poll pr. call. Maximum is 100."/> | |
| <property name="preserveHeaders" type="boolean" display="Preserve Headers" description="Should message headers be preserved when publishing messages. This will add the Camel headers to the Iron MQ message as a json payload with a header list, and a message body. Useful when Camel is both consumer and producer."/> | |
| <property name="projectId" type="string" display="Project Id" description="IronMQ projectId"/> | |
| <property name="queueName" type="string" display="Queue Name" required="true" kind="path" description="The name of the IronMQ queue"/> | |
| <property name="timeout" type="int" display="Timeout" label="consumer" description="After timeout (in seconds), item will be placed back onto the queue."/> | |
| <property name="token" type="string" display="Token" description="IronMQ token"/> | |
| <property name="visibilityDelay" type="int" display="Visibility Delay" label="producer" description="The item will not be available on the queue until this many seconds have passed. Default is 0 seconds."/> | |
| <property name="wait" type="int" display="Wait" label="consumer" description="Time in seconds to wait for a message to become available. This enables long polling. Default is 0 (does not wait), maximum is 30."/> | |
| </endpoint> | |
| <endpoint name="jbpm" display="JBPM" label="process" extends="model:endpoint" javaType="org.apache.camel.component.jbpm.JBPMComponent" maven="org.apache.camel:camel-jbpm:3.0.0-SNAPSHOT" since="2.6.0" description="The jbpm component provides integration with jBPM (Business Process Management)."> | |
| <property name="attachmentId" type="long" display="Attachment Id" description="attachId to use when retrieving attachments"/> | |
| <property name="connectionURL" type="java:java.net.URL" display="Connection URL" required="true" kind="path" description="The URL to the jBPM server."/> | |
| <property name="contentId" type="long" display="Content Id" description="contentId to use when retrieving attachments"/> | |
| <property name="deploymentId" type="string" display="Deployment Id" required="true" description="The id of the deployment"/> | |
| <property name="emitterSendItems" type="boolean" display="Emitter Send Items" description="Sets if event produced by emitter should be sent as single items or complete collection"/> | |
| <property name="entities" type="list(string)" display="Entities" label="advanced" description="The potentialOwners when nominateTask operation is performed"/> | |
| <property name="event" type="object" display="Event" description="the data associated with this event when signalEvent operation is performed"/> | |
| <property name="eventListenerType" type="string" display="Event Listener Type" kind="path" description="Sets the event listener type to attach to"/> | |
| <property name="eventType" type="string" display="Event Type" description="the type of event to use when signalEvent operation is performed"/> | |
| <property name="extraJaxbClasses" type="java:java.lang.Class[]" display="Extra Jaxb Classes" label="advanced" description="To load additional classes when working with XML"/> | |
| <property name="identifier" type="string" display="Identifier" description="identifier the global identifier"/> | |
| <property name="maxNumber" type="int" display="Max Number" description="the maximum number of rules that should be fired"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="The operation to perform"/> | |
| <property name="page" type="int" display="Page" description="The page to use when retrieving user tasks"/> | |
| <property name="pageSize" type="int" display="Page Size" description="The page size to use when retrieving user tasks"/> | |
| <property name="parameters" type="map(string,object)" display="Parameters" label="advanced" description="the variables that should be set for various operations"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password for authentication"/> | |
| <property name="processId" type="string" display="Process Id" description="the id of the process that should be acted upon"/> | |
| <property name="processInstanceId" type="long" display="Process Instance Id" description="the id of the process instance"/> | |
| <property name="statuses" type="list(string)" display="Statuses" label="filter" description="The list of status to use when filtering tasks"/> | |
| <property name="targetUserId" type="string" display="Target User Id" description="The targetUserId used when delegating a task"/> | |
| <property name="task" type="java:org.kie.api.task.model.Task" display="Task" description="The task instance to use with task operations"/> | |
| <property name="taskId" type="long" display="Task Id" description="the id of the task"/> | |
| <property name="timeout" type="int" display="Timeout" description="A timeout value"/> | |
| <property name="userId" type="string" display="User Id" description="userId to use with task operations"/> | |
| <property name="userName" type="string" display="User Name" label="security" secret="true" description="Username for authentication"/> | |
| <property name="value" type="object" display="Value" description="the value to assign to the global identifier"/> | |
| <property name="workItemId" type="long" display="Work Item Id" description="the id of the work item"/> | |
| </endpoint> | |
| <endpoint name="jcache" display="JCache" label="cache,datagrid,clustering" extends="model:endpoint" javaType="org.apache.camel.component.jcache.JCacheComponent" maven="org.apache.camel:camel-jcache:3.0.0-SNAPSHOT" since="2.17.0" description="The jcache component enables you to perform caching operations using JSR107/JCache as cache implementation."> | |
| <property name="action" type="string" display="Action" label="producer" description="To configure using a cache operation by default. If an operation in the message header, then the operation from the header takes precedence."/> | |
| <property name="cacheConfiguration" type="java:javax.cache.configuration.Configuration" display="Cache Configuration" description="A Configuration for the Cache"/> | |
| <property name="cacheConfigurationProperties" type="java:java.util.Properties" display="Cache Configuration Properties" description="The Properties for the javax.cache.spi.CachingProvider to create the CacheManager"/> | |
| <property name="cacheLoaderFactory" type="java:javax.cache.configuration.Factory<javax.cache.integration.CacheLoader>" display="Cache Loader Factory" label="advanced" description="The CacheLoader factory"/> | |
| <property name="cacheName" type="string" display="Cache Name" required="true" kind="path" description="The name of the cache"/> | |
| <property name="cacheWriterFactory" type="java:javax.cache.configuration.Factory<javax.cache.integration.CacheWriter>" display="Cache Writer Factory" label="advanced" description="The CacheWriter factory"/> | |
| <property name="cachingProvider" type="string" display="Caching Provider" label="common" description="The fully qualified class name of the javax.cache.spi.CachingProvider"/> | |
| <property name="configurationUri" type="string" display="Configuration Uri" description="An implementation specific URI for the CacheManager"/> | |
| <property name="createCacheIfNotExists" type="boolean" display="Create Cache If Not Exists" label="advanced" description="Configure if a cache need to be created if it does exist or can't be pre-configured."/> | |
| <property name="eventFilters" type="list(java:javax.cache.event.CacheEntryEventFilter)" display="Event Filters" label="consumer,advanced" description="The CacheEntryEventFilter. If using eventFilters option, then filteredEvents one will be ignored"/> | |
| <property name="expiryPolicyFactory" type="java:javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy>" display="Expiry Policy Factory" label="advanced" description="The ExpiryPolicy factory"/> | |
| <property name="filteredEvents" type="list(enum:javax.cache.event.EventType(CREATED,UPDATED,REMOVED,EXPIRED))" display="Filtered Events" label="consumer" description="Events a consumer should filter. If using filteredEvents option, then eventFilters one will be ignored"/> | |
| <property name="lookupProviders" type="boolean" display="Lookup Providers" label="advanced" description="Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi."/> | |
| <property name="managementEnabled" type="boolean" display="Management Enabled" description="Whether management gathering is enabled"/> | |
| <property name="oldValueRequired" type="boolean" display="Old Value Required" label="consumer" description="if the old value is required for events"/> | |
| <property name="readThrough" type="boolean" display="Read Through" description="If read-through caching should be used"/> | |
| <property name="statisticsEnabled" type="boolean" display="Statistics Enabled" description="Whether statistics gathering is enabled"/> | |
| <property name="storeByValue" type="boolean" display="Store By Value" description="If cache should use store-by-value or store-by-reference semantics"/> | |
| <property name="writeThrough" type="boolean" display="Write Through" description="If write-through caching should be used"/> | |
| </endpoint> | |
| <endpoint name="jclouds" display="JClouds" label="api,cloud" extends="model:endpoint" javaType="org.apache.camel.component.jclouds.JcloudsComponent" maven="org.apache.camel:camel-jclouds:3.0.0-SNAPSHOT" since="2.9.0" description="For interacting with cloud compute & blobstore service via jclouds."> | |
| <property name="blobName" type="string" display="Blob Name" label="producer,blobstore" description="The name of the blob."/> | |
| <property name="command" type="enum:JcloudsCommand(blobstore,compute)" display="Command" required="true" kind="path" description="What command to execute such as blobstore or compute."/> | |
| <property name="container" type="string" display="Container" label="blobstore" description="The name of the blob container."/> | |
| <property name="directory" type="string" display="Directory" label="consumer,blobstore" description="An optional directory name to use"/> | |
| <property name="group" type="string" display="Group" label="producer,compute" description="The group that will be assigned to the newly created node. Values depend on the actual cloud provider."/> | |
| <property name="hardwareId" type="string" display="Hardware Id" label="producer,compute" description="The hardware that will be used for creating a node. Values depend on the actual cloud provider."/> | |
| <property name="imageId" type="string" display="Image Id" label="producer,compute" description="The imageId that will be used for creating a node. Values depend on the actual cloud provider."/> | |
| <property name="locationId" type="string" display="Location Id" label="producer,compute" description="The location that will be used for creating a node. Values depend on the actual cloud provider."/> | |
| <property name="nodeId" type="string" display="Node Id" label="producer,compute" description="The id of the node that will run the script or destroyed."/> | |
| <property name="nodeState" type="string" display="Node State" label="producer,compute" description="To filter by node status to only select running nodes etc."/> | |
| <property name="operation" type="string" display="Operation" label="producer,compute" description="Specifies the type of operation that will be performed to the blobstore."/> | |
| <property name="providerId" type="string" display="Provider Id" required="true" kind="path" description="The name of the cloud provider that provides the target service (e.g. aws-s3 or aws_ec2)."/> | |
| <property name="user" type="string" display="User" label="producer,compute" description="The user on the target node that will run the script."/> | |
| </endpoint> | |
| <endpoint name="jcr" display="JCR" label="cms,database" extends="model:endpoint" javaType="org.apache.camel.component.jcr.JcrComponent" maven="org.apache.camel:camel-jcr:3.0.0-SNAPSHOT" since="1.3.0" description="The jcr component allows you to add/read nodes to/from a JCR compliant content repository."> | |
| <property name="base" type="string" display="Base" kind="path" description="Get the base node when accessing the repository"/> | |
| <property name="deep" type="boolean" display="Deep" description="When isDeep is true, events whose associated parent node is at absPath or within its subgraph are received."/> | |
| <property name="eventTypes" type="int" display="Event Types" description="eventTypes (a combination of one or more event types encoded as a bit mask value such as javax.jcr.observation.Event.NODE_ADDED, javax.jcr.observation.Event.NODE_REMOVED, etc.)."/> | |
| <property name="host" type="string" display="Host" required="true" kind="path" description="Name of the javax.jcr.Repository to lookup from the Camel registry to be used."/> | |
| <property name="noLocal" type="boolean" display="No Local" description="If noLocal is true, then events generated by the session through which the listener was registered are ignored. Otherwise, they are not ignored."/> | |
| <property name="nodeTypeNames" type="string" display="Node Type Names" description="When a comma separated nodeTypeName list string is set, only events whose associated parent node has one of the node types (or a subtype of one of the node types) in this list will be received."/> | |
| <property name="password" type="string" display="Password" description="Password for login"/> | |
| <property name="sessionLiveCheckInterval" type="long" display="Session Live Check Interval" description="Interval in milliseconds to wait before each session live checking The default value is 60000 ms."/> | |
| <property name="sessionLiveCheckIntervalOnStart" type="long" display="Session Live Check Interval On Start" description="Interval in milliseconds to wait before the first session live checking. The default value is 3000 ms."/> | |
| <property name="username" type="string" display="Username" description="Username for login"/> | |
| <property name="uuids" type="string" display="Uuids" description="When a comma separated uuid list string is set, only events whose associated parent node has one of the identifiers in the comma separated uuid list will be received."/> | |
| <property name="workspaceName" type="string" display="Workspace Name" description="The workspace to access. If it's not specified then the default one will be used"/> | |
| </endpoint> | |
| <endpoint name="jdbc" display="JDBC" label="database,sql" extends="model:endpoint" javaType="org.apache.camel.component.jdbc.JdbcComponent" maven="org.apache.camel:camel-jdbc:3.0.0-SNAPSHOT" producerOnly="true" since="1.2.0" description="The jdbc component enables you to access databases through JDBC, where SQL queries are sent in the message body."> | |
| <property name="allowNamedParameters" type="boolean" display="Allow Named Parameters" description="Whether to allow using named parameters in the queries."/> | |
| <property name="beanRowMapper" type="java:org.apache.camel.component.jdbc.BeanRowMapper" display="Bean Row Mapper" label="advanced" description="To use a custom org.apache.camel.component.jdbc.BeanRowMapper when using outputClass. The default implementation will lower case the row names and skip underscores, and dashes. For example CUST_ID is mapped as custId."/> | |
| <property name="dataSourceName" type="string" display="Data Source Name" required="true" kind="path" description="Name of DataSource to lookup in the Registry. If the name is dataSource or default, then Camel will attempt to lookup a default DataSource from the registry, meaning if there is a only one instance of DataSource found, then this DataSource will be used."/> | |
| <property name="outputClass" type="string" display="Output Class" description="Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList."/> | |
| <property name="outputType" type="enum:JdbcOutputType(SelectOne,SelectList,StreamList)" display="Output Type" description="Determines the output the producer should use."/> | |
| <property name="parameters" type="map(string,object)" display="Parameters" description="Optional parameters to the java.sql.Statement. For example to set maxRows, fetchSize etc."/> | |
| <property name="prepareStatementStrategy" type="java:org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy" display="Prepare Statement Strategy" label="advanced" description="Allows to plugin to use a custom org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy to control preparation of the query and prepared statement."/> | |
| <property name="readSize" type="int" display="Read Size" description="The default maximum number of rows that can be read by a polling query. The default value is 0."/> | |
| <property name="resetAutoCommit" type="boolean" display="Reset Auto Commit" description="Camel will set the autoCommit on the JDBC connection to be false, commit the change after executed the statement and reset the autoCommit flag of the connection at the end, if the resetAutoCommit is true. If the JDBC connection doesn't support to reset the autoCommit flag, you can set the resetAutoCommit flag to be false, and Camel will not try to reset the autoCommit flag. When used with XA transactions you most likely need to set it to false so that the transaction manager is in charge of committing this tx."/> | |
| <property name="transacted" type="boolean" display="Transacted" description="Whether transactions are in use."/> | |
| <property name="useGetBytesForBlob" type="boolean" display="Use Get Bytes For Blob" description="To read BLOB columns as bytes instead of string data. This may be needed for certain databases such as Oracle where you must read BLOB columns as bytes."/> | |
| <property name="useHeadersAsParameters" type="boolean" display="Use Headers As Parameters" description="Set this option to true to use the prepareStatementStrategy with named parameters. This allows to define queries with named placeholders, and use headers with the dynamic values for the query placeholders."/> | |
| <property name="useJDBC4ColumnNameAndLabelSemantics" type="boolean" display="Use JDBC4 Column Name And Label Semantics" description="Sets whether to use JDBC 4 or JDBC 3.0 or older semantic when retrieving column name. JDBC 4.0 uses columnLabel to get the column name where as JDBC 3.0 uses both columnName or columnLabel. Unfortunately JDBC drivers behave differently so you can use this option to work out issues around your JDBC driver if you get problem using this component This option is default true."/> | |
| </endpoint> | |
| <endpoint name="jetty" display="Jetty" label="http" extends="model:endpoint" javaType="org.apache.camel.component.jetty9.JettyHttpComponent9" maven="org.apache.camel:camel-jetty:3.0.0-SNAPSHOT" consumerOnly="true" async="true" lenient="true" since="1.2.0" description="The jetty component provides HTTP-based endpoints for consuming and producing HTTP requests."> | |
| <property name="async" type="boolean" display="Async" label="consumer" description="Configure the consumer to work in async mode"/> | |
| <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="continuationTimeout" type="long" display="Continuation Timeout" label="consumer" description="Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 30000. You can use a value of = 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine."/> | |
| <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="enableCORS" type="boolean" display="Enable CORS" label="consumer" description="If the option is true, Jetty server will setup the CrossOriginFilter which supports the CORS out of box."/> | |
| <property name="enableJmx" type="boolean" display="Enable Jmx" label="consumer" description="If this option is true, Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details."/> | |
| <property name="enableMultipartFilter" type="boolean" display="Enable Multipart Filter" description="Whether Jetty org.eclipse.jetty.servlets.MultiPartFilter is enabled or not. You should set this value to false when bridging endpoints, to ensure multipart requests is proxied/bridged as well."/> | |
| <property name="filterInitParameters" type="map(string,string)" display="Filter Init Parameters" label="consumer,advanced" description="Configuration of the filter init parameters. These parameters will be applied to the filter list before starting the jetty server."/> | |
| <property name="filtersRef" type="string" display="Filters Ref" label="consumer,advanced" description="Allows using a custom filters which is putted into a list and can be find in the Registry. Multiple values can be separated by comma."/> | |
| <property name="handlers" type="string" display="Handlers" label="consumer,advanced" description="Specifies a comma-delimited set of Handler instances to lookup in your Registry. These handlers are added to the Jetty servlet context (for example, to add security). Important: You can not use different handlers with different Jetty endpoints using the same port number. The handlers is associated to the port number. If you need different handlers, then use different port numbers."/> | |
| <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="httpUri" type="java:java.net.URI" display="Http Uri" label="common" required="true" kind="path" description="The url of the HTTP endpoint to call."/> | |
| <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="multipartFilter" type="java:javax.servlet.Filter" display="Multipart Filter" label="consumer,advanced" description="Allows using a custom multipart filter. Note: setting multipartFilterRef forces the value of enableMultipartFilter to true."/> | |
| <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="sendDateHeader" type="boolean" display="Send Date Header" label="consumer" description="If the option is true, jetty server will send the date header to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected."/> | |
| <property name="sendServerVersion" type="boolean" display="Send Server Version" label="consumer" description="If the option is true, jetty will send the server header with the jetty version information to the client which sends the request. NOTE please make sure there is no any other camel-jetty endpoint is share the same port, otherwise this option may not work as expected."/> | |
| <property name="sessionSupport" type="boolean" display="Session Support" label="consumer" description="Specifies whether to enable the session manager on the server side of Jetty."/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="security" description="To configure security using SSLContextParameters"/> | |
| <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="useContinuation" type="boolean" display="Use Continuation" label="consumer" description="Whether or not to use Jetty continuations for the Jetty Server."/> | |
| </endpoint> | |
| <endpoint name="jgroups" display="JGroups" label="clustering,messaging" extends="model:endpoint" javaType="org.apache.camel.component.jgroups.JGroupsComponent" maven="org.apache.camel:camel-jgroups:3.0.0-SNAPSHOT" since="2.13.0" description="The jgroups component provides exchange of messages between Camel and JGroups clusters."> | |
| <property name="channelProperties" type="string" display="Channel Properties" description="Specifies configuration properties of the JChannel used by the endpoint."/> | |
| <property name="clusterName" type="string" display="Cluster Name" required="true" kind="path" description="The name of the JGroups cluster the component should connect to."/> | |
| <property name="enableViewMessages" type="boolean" display="Enable View Messages" label="consumer" description="If set to true, the consumer endpoint will receive org.jgroups.View messages as well (not only org.jgroups.Message instances). By default only regular messages are consumed by the endpoint."/> | |
| </endpoint> | |
| <endpoint name="jgroups-raft" display="JGroups raft" label="clustering,messaging" extends="model:endpoint" javaType="org.apache.camel.component.jgroups.raft.JGroupsRaftComponent" maven="org.apache.camel:camel-jgroups-raft:3.0.0-SNAPSHOT" since="2.24.0" description="The jgroups component provides exchange of messages between Camel and JGroups clusters."> | |
| <property name="clusterName" type="string" display="Cluster Name" required="true" kind="path" description="The name of the JGroupsraft cluster the component should connect to."/> | |
| <property name="enableRoleChangeEvents" type="boolean" display="Enable Role Change Events" label="consumer" description="If set to true, the consumer endpoint will receive roleChange event as well (not just connecting and/or using the state machine). By default it is set to false."/> | |
| </endpoint> | |
| <endpoint name="jing" display="Jing" label="validation" extends="model:endpoint" javaType="org.apache.camel.component.validator.jing.JingComponent" maven="org.apache.camel:camel-jing:3.0.0-SNAPSHOT" producerOnly="true" since="1.1.0" description="Validates the payload of a message using RelaxNG Syntax using Jing library."> | |
| <property name="compactSyntax" type="boolean" display="Compact Syntax" description="Whether to validate using RelaxNG compact syntax or not. By default this is false for using RelaxNG XML Syntax (rng) And true is for using RelaxNG Compact Syntax (rnc)"/> | |
| <property name="resourceUri" type="string" display="Resource Uri" required="true" kind="path" description="URL to a local resource on the classpath or a full URL to a remote resource or resource on the file system which contains the schema to validate against."/> | |
| </endpoint> | |
| <endpoint name="jira" display="Jira" label="api,reporting" extends="model:endpoint" javaType="org.apache.camel.component.jira.JiraComponent" maven="org.apache.camel:camel-jira:3.0.0-SNAPSHOT" since="3.0" description="The jira component interacts with the JIRA issue tracker."> | |
| <property name="accessToken" type="string" display="Access Token" label="security" secret="true" description="(OAuth only) The access token generated by the Jira server."/> | |
| <property name="consumerKey" type="string" display="Consumer Key" label="security" secret="true" description="(OAuth only) The consumer key from Jira settings."/> | |
| <property name="delay" type="int" display="Delay" description="Time in milliseconds to elapse for the next poll."/> | |
| <property name="jiraUrl" type="string" display="Jira Url" required="true" description="The Jira server url, example: http://my_jira.com:8081"/> | |
| <property name="jql" type="string" display="Jql" label="consumer" description="JQL is the query language from JIRA which allows you to retrieve the data you want. For example jql=project=MyProject Where MyProject is the product key in Jira. It is important to use the RAW() and set the JQL inside it to prevent camel parsing it, example: RAW(project in (MYP, COM) AND resolution = Unresolved)"/> | |
| <property name="maxResults" type="int" display="Max Results" label="consumer" description="Max number of issues to search for"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="(Basic authentication only) The password to authenticate to the Jira server. Use only if username basic authentication is used."/> | |
| <property name="privateKey" type="string" display="Private Key" label="security" secret="true" description="(OAuth only) The private key generated by the client to encrypt the conversation to the server."/> | |
| <property name="type" type="enum:JiraType(ADDCOMMENT,ADDISSUE,ATTACH,DELETEISSUE,NEWISSUES,NEWCOMMENTS,UPDATEISSUE,TRANSITIONISSUE,WATCHERS)" display="Type" required="true" kind="path" description="Operation to perform. Consumers: NewIssues, NewComments. Producers: AddIssue, AttachFile, DeleteIssue, TransitionIssue, UpdateIssue, Watchers. See this class javadoc description for more information."/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="(Basic authentication only) The username to authenticate to the Jira server. Use only if OAuth is not enabled on the Jira server. Do not set the username and OAuth token parameter, if they are both set, the username basic authentication takes precedence."/> | |
| <property name="verificationCode" type="string" display="Verification Code" label="security" secret="true" description="(OAuth only) The verification code from Jira generated in the first step of the authorization proccess."/> | |
| </endpoint> | |
| <endpoint name="jms" display="JMS" label="messaging" extends="model:endpoint" javaType="org.apache.camel.component.jms.JmsComponent" maven="org.apache.camel:camel-jms:3.0.0-SNAPSHOT" async="true" since="1.0.0" description="The jms component allows messages to be sent to (or consumed from) a JMS Queue or Topic."> | |
| <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="jmx" display="JMX" label="monitoring" extends="model:endpoint" javaType="org.apache.camel.component.jmx.JMXComponent" maven="org.apache.camel:camel-jmx:3.0.0-SNAPSHOT" consumerOnly="true" since="2.6.0" description="The jmx component allows to receive JMX notifications."> | |
| <property name="differenceMode" type="boolean" display="Difference Mode" label="counter,gauge" description="If true, then the value reported in the notification is the difference from the threshold as opposed to the value itself (counter and gauge monitor only)."/> | |
| <property name="executorService" type="java:java.util.concurrent.ExecutorService" display="Executor Service" label="advanced" description="To use a custom shared thread pool for the consumers. By default each consume has their own thread-pool to process and route notifications."/> | |
| <property name="format" type="string" display="Format" description="Format for the message body. Either xml or raw. If xml, the notification is serialized to xml. If raw, then the raw java object is set as the body."/> | |
| <property name="granularityPeriod" type="long" display="Granularity Period" description="The frequency to poll the bean to check the monitor (monitor types only)."/> | |
| <property name="handback" type="object" display="Handback" label="advanced" description="Value to handback to the listener when a notification is received. This value will be put in the message header with the key jmx.handback"/> | |
| <property name="initThreshold" type="int" display="Init Threshold" label="counter" description="Initial threshold for the monitor. The value must exceed this before notifications are fired (counter monitor only)."/> | |
| <property name="modulus" type="int" display="Modulus" label="counter" description="The value at which the counter is reset to zero (counter monitor only)."/> | |
| <property name="monitorType" type="string" display="Monitor Type" description="The type of monitor to create. One of string, gauge, counter (monitor types only)."/> | |
| <property name="notificationFilter" type="java:javax.management.NotificationFilter" display="Notification Filter" label="advanced" description="Reference to a bean that implements the NotificationFilter."/> | |
| <property name="notifyDiffer" type="boolean" display="Notify Differ" label="consumer,string" description="If true, will fire a notification when the string attribute differs from the string to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured."/> | |
| <property name="notifyHigh" type="boolean" display="Notify High" label="gauge" description="If true, the gauge will fire a notification when the high threshold is exceeded (gauge monitor only)."/> | |
| <property name="notifyLow" type="boolean" display="Notify Low" label="gauge" description="If true, the gauge will fire a notification when the low threshold is exceeded (gauge monitor only)."/> | |
| <property name="notifyMatch" type="boolean" display="Notify Match" label="consumer,string" description="If true, will fire a notification when the string attribute matches the string to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured."/> | |
| <property name="objectDomain" type="string" display="Object Domain" required="true" description="The domain for the mbean you're connecting to"/> | |
| <property name="objectName" type="string" display="Object Name" description="The name key for the mbean you're connecting to. This value is mutually exclusive with the object properties that get passed."/> | |
| <property name="objectProperties" type="map(string,string)" display="Object Properties" label="advanced" description="Properties for the object name. These values will be used if the objectName param is not set"/> | |
| <property name="observedAttribute" type="string" display="Observed Attribute" description="The attribute to observe for the monitor bean or consumer."/> | |
| <property name="offset" type="int" display="Offset" label="counter" description="The amount to increment the threshold after it's been exceeded (counter monitor only)."/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Credentials for making a remote connection"/> | |
| <property name="reconnectDelay" type="int" display="Reconnect Delay" label="advanced" description="The number of seconds to wait before attempting to retry establishment of the initial connection or attempt to reconnect a lost connection"/> | |
| <property name="reconnectOnConnectionFailure" type="boolean" display="Reconnect On Connection Failure" label="advanced" description="If true the consumer will attempt to reconnect to the JMX server when any connection failure occurs. The consumer will attempt to re-establish the JMX connection every 'x' seconds until the connection is made-- where 'x' is the configured reconnectionDelay"/> | |
| <property name="serverURL" type="string" display="Server URL" kind="path" description="Server url comes from the remaining endpoint. Use platform to connect to local JVM."/> | |
| <property name="stringToCompare" type="string" display="String To Compare" label="consumer,string" description="Value for attribute to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured."/> | |
| <property name="testConnectionOnStartup" type="boolean" display="Test Connection On Startup" label="advanced" description="If true the consumer will throw an exception if unable to establish the JMX connection upon startup. If false, the consumer will attempt to establish the JMX connection every 'x' seconds until the connection is made -- where 'x' is the configured reconnectionDelay"/> | |
| <property name="thresholdHigh" type="double" display="Threshold High" label="gauge" description="Value for the gauge's high threshold (gauge monitor only)."/> | |
| <property name="thresholdLow" type="double" display="Threshold Low" label="gauge" description="Value for the gauge's low threshold (gauge monitor only)."/> | |
| <property name="user" type="string" display="User" label="security" secret="true" description="Credentials for making a remote connection"/> | |
| </endpoint> | |
| <endpoint name="jolt" display="JOLT" label="transformation" extends="model:endpoint" javaType="org.apache.camel.component.jolt.JoltComponent" maven="org.apache.camel:camel-jolt:3.0.0-SNAPSHOT" producerOnly="true" since="2.16.0" description="The jolt component allows you to process a JSON messages using an JOLT specification (such as JSON-JSON transformation)."> | |
| <property name="contentCache" type="boolean" display="Content Cache" description="Sets whether to use resource content cache or not"/> | |
| <property name="inputType" type="enum:JoltInputOutputType(Hydrated,JsonString)" display="Input Type" description="Specifies if the input is hydrated JSON or a JSON String."/> | |
| <property name="outputType" type="enum:JoltInputOutputType(Hydrated,JsonString)" display="Output Type" description="Specifies if the output should be hydrated JSON or a JSON String."/> | |
| <property name="resourceUri" type="string" display="Resource Uri" required="true" kind="path" description="Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."/> | |
| <property name="transformDsl" type="enum:JoltTransformType(Chainr,Shiftr,Defaultr,Removr,Sortr)" display="Transform Dsl" description="Specifies the Transform DSL of the endpoint resource. If none is specified Chainr will be used."/> | |
| </endpoint> | |
| <endpoint name="jooq" display="JOOQ" label="database" extends="model:scheduled" javaType="org.apache.camel.component.jooq.JooqComponent" maven="org.apache.camel:camel-jooq:3.0.0-SNAPSHOT" since="3.0.0" description="The jooq component enables you to store and retrieve entities from databases using JOOQ"> | |
| <property name="consumeDelete" type="boolean" display="Consume Delete" label="consumer" description="Delete entity after it is consumed"/> | |
| <property name="entityType" type="class" display="Entity Type" label="common" kind="path" description="JOOQ entity class"/> | |
| <property name="operation" type="enum:JooqOperation(EXECUTE,FETCH,NONE)" display="Operation" label="producer" description="Type of operation to execute on query"/> | |
| <property name="query" type="string" display="Query" label="producer" description="To execute plain SQL query"/> | |
| </endpoint> | |
| <endpoint name="jpa" display="JPA" label="database,sql" extends="model:scheduled" javaType="org.apache.camel.component.jpa.JpaComponent" maven="org.apache.camel:camel-jpa:3.0.0-SNAPSHOT" since="1.0.0" description="The jpa component enables you to store and retrieve Java objects from databases using JPA."> | |
| <property name="consumeDelete" type="boolean" display="Consume Delete" label="consumer" description="If true, the entity is deleted after it is consumed; if false, the entity is not deleted."/> | |
| <property name="consumeLockEntity" type="boolean" display="Consume Lock Entity" label="consumer" description="Specifies whether or not to set an exclusive lock on each entity bean while processing the results from polling."/> | |
| <property name="deleteHandler" type="java:org.apache.camel.component.jpa.DeleteHandler<java.lang.Object>" display="Delete Handler" label="consumer" description="To use a custom DeleteHandler to delete the row after the consumer is done processing the exchange"/> | |
| <property name="entityManagerProperties" type="map(string,object)" display="Entity Manager Properties" label="advanced" description="Additional properties for the entity manager to use."/> | |
| <property name="entityType" type="class" display="Entity Type" required="true" kind="path" description="The JPA annotated class to use as entity."/> | |
| <property name="flushOnSend" type="boolean" display="Flush On Send" label="producer" description="Flushes the EntityManager after the entity bean has been persisted."/> | |
| <property name="joinTransaction" type="boolean" display="Join Transaction" description="The camel-jpa component will join transaction by default. You can use this option to turn this off, for example if you use LOCAL_RESOURCE and join transaction doesn't work with your JPA provider. This option can also be set globally on the JpaComponent, instead of having to set it on all endpoints."/> | |
| <property name="lockModeType" type="enum:javax.persistence.LockModeType(READ,WRITE,OPTIMISTIC,OPTIMISTIC_FORCE_INCREMENT,PESSIMISTIC_READ,PESSIMISTIC_WRITE,PESSIMISTIC_FORCE_INCREMENT,NONE)" display="Lock Mode Type" label="consumer" description="To configure the lock mode on the consumer."/> | |
| <property name="maxMessagesPerPoll" type="int" display="Max Messages Per Poll" label="consumer" description="An integer value to define the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to avoid polling many thousands of messages when starting up the server. Set a value of 0 or negative to disable."/> | |
| <property name="maximumResults" type="int" display="Maximum Results" description="Set the maximum number of results to retrieve on the Query."/> | |
| <property name="namedQuery" type="string" display="Named Query" description="To use a named query."/> | |
| <property name="nativeQuery" type="string" display="Native Query" description="To use a custom native query. You may want to use the option resultClass also when using native queries."/> | |
| <property name="parameters" type="map(string,object)" display="Parameters" description="This key/value mapping is used for building the query parameters. It is expected to be of the generic type java.util.Map where the keys are the named parameters of a given JPA query and the values are their corresponding effective values you want to select for. When it's used for producer, Simple expression can be used as a parameter value. It allows you to retrieve parameter values from the message body, header and etc."/> | |
| <property name="persistenceUnit" type="string" display="Persistence Unit" required="true" description="The JPA persistence unit used by default."/> | |
| <property name="preDeleteHandler" type="java:org.apache.camel.component.jpa.DeleteHandler<java.lang.Object>" display="Pre Delete Handler" label="consumer" description="To use a custom Pre-DeleteHandler to delete the row after the consumer has read the entity."/> | |
| <property name="query" type="string" display="Query" description="To use a custom query."/> | |
| <property name="remove" type="boolean" display="Remove" label="producer" description="Indicates to use entityManager.remove(entity)."/> | |
| <property name="resultClass" type="class" display="Result Class" description="Defines the type of the returned payload (we will call entityManager.createNativeQuery(nativeQuery, resultClass) instead of entityManager.createNativeQuery(nativeQuery)). Without this option, we will return an object array. Only has an affect when using in conjunction with native query when consuming data."/> | |
| <property name="sharedEntityManager" type="boolean" display="Shared Entity Manager" description="Whether to use Spring's SharedEntityManager for the consumer/producer. Note in most cases joinTransaction should be set to false as this is not an EXTENDED EntityManager."/> | |
| <property name="skipLockedEntity" type="boolean" display="Skip Locked Entity" label="consumer" description="To configure whether to use NOWAIT on lock and silently skip the entity."/> | |
| <property name="transacted" type="boolean" display="Transacted" label="consumer" description="Whether to run the consumer in transacted mode, by which all messages will either commit or rollback, when the entire batch has been processed. The default behavior (false) is to commit all the previously successfully processed messages, and only rollback the last failed message."/> | |
| <property name="useExecuteUpdate" type="boolean" display="Use Execute Update" label="producer" description="To configure whether to use executeUpdate() when producer executes a query. When you use INSERT, UPDATE or DELETE statement as a named query, you need to specify this option to 'true'."/> | |
| <property name="usePassedInEntityManager" type="boolean" display="Use Passed In Entity Manager" label="producer" description="If set to true, then Camel will use the EntityManager from the header JpaConstants.ENTITY_MANAGER instead of the configured entity manager on the component/endpoint. This allows end users to control which entity manager will be in use."/> | |
| <property name="usePersist" type="boolean" display="Use Persist" label="producer" description="Indicates to use entityManager.persist(entity) instead of entityManager.merge(entity). Note: entityManager.persist(entity) doesn't work for detached entities (where the EntityManager has to execute an UPDATE instead of an INSERT query)!"/> | |
| </endpoint> | |
| <endpoint name="json-validator" display="JSON Schema Validator" label="validation" extends="model:endpoint" javaType="org.apache.camel.component.jsonvalidator.JsonValidatorComponent" maven="org.apache.camel:camel-json-validator:3.0.0-SNAPSHOT" producerOnly="true" since="2.20.0" description="Validates the payload of a message using NetworkNT JSON Schema library."> | |
| <property name="contentCache" type="boolean" display="Content Cache" description="Sets whether to use resource content cache or not"/> | |
| <property name="errorHandler" type="java:org.apache.camel.component.jsonvalidator.JsonValidatorErrorHandler" display="Error Handler" label="advanced" description="To use a custom ValidatorErrorHandler. The default error handler captures the errors and throws an exception."/> | |
| <property name="failOnNullBody" type="boolean" display="Fail On Null Body" description="Whether to fail if no body exists."/> | |
| <property name="failOnNullHeader" type="boolean" display="Fail On Null Header" description="Whether to fail if no header exists when validating against a header."/> | |
| <property name="headerName" type="string" display="Header Name" description="To validate against a header instead of the message body."/> | |
| <property name="resourceUri" type="string" display="Resource Uri" required="true" kind="path" description="Path to the resource. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod."/> | |
| <property name="schemaLoader" type="java:org.apache.camel.component.jsonvalidator.JsonSchemaLoader" display="Schema Loader" label="advanced" description="To use a custom schema loader allowing for adding custom format validation. The default implementation will create a schema loader with draft v4 support."/> | |
| </endpoint> | |
| <endpoint name="jt400" display="JT400" label="messaging" extends="model:scheduled" javaType="org.apache.camel.component.jt400.Jt400Component" maven="org.apache.camel:camel-jt400:3.0.0-SNAPSHOT" since="1.5.0" description="The jt400 component allows you to exchanges messages with an AS/400 system using data queues or program call."> | |
| <property name="ccsid" type="int" display="Ccsid" description="Sets the CCSID to use for the connection with the AS/400 system."/> | |
| <property name="format" type="java:org.apache.camel.component.jt400.Jt400Configuration.Format" display="Format" description="Sets the data format for sending messages."/> | |
| <property name="guiAvailable" type="boolean" display="Gui Available" description="Sets whether AS/400 prompting is enabled in the environment running Camel."/> | |
| <property name="keyed" type="boolean" display="Keyed" description="Whether to use keyed or non-keyed data queues."/> | |
| <property name="objectPath" type="string" display="Object Path" required="true" kind="path" description="Returns the fully qualified integrated file system path name of the target object of this endpoint."/> | |
| <property name="outputFieldsIdxArray" type="int[]" display="Output Fields Idx Array" description="Specifies which fields (program parameters) are output parameters."/> | |
| <property name="outputFieldsLengthArray" type="int[]" display="Output Fields Length Array" description="Specifies the fields (program parameters) length as in the AS/400 program definition."/> | |
| <property name="password" type="string" display="Password" required="true" kind="path" secret="true" description="Returns the password of the AS/400 user."/> | |
| <property name="procedureName" type="string" display="Procedure Name" label="procedureName" description="Procedure name from a service program to call"/> | |
| <property name="readTimeout" type="int" display="Read Timeout" label="consumer" description="Timeout in millis the consumer will wait while trying to read a new message of the data queue."/> | |
| <property name="searchKey" type="string" display="Search Key" description="Search key for keyed data queues."/> | |
| <property name="searchType" type="java:org.apache.camel.component.jt400.Jt400Configuration.SearchType" display="Search Type" description="Search type such as EQ for equal etc."/> | |
| <property name="secured" type="boolean" display="Secured" label="security" description="Whether connections to AS/400 are secured with SSL."/> | |
| <property name="systemName" type="string" display="System Name" required="true" kind="path" description="Returns the name of the AS/400 system."/> | |
| <property name="type" type="enum:Jt400Type(DTAQ,PGM,SRVPGM)" display="Type" required="true" kind="path" description="Whether to work with data queues or remote program call"/> | |
| <property name="userID" type="string" display="User ID" required="true" kind="path" secret="true" description="Returns the ID of the AS/400 user."/> | |
| </endpoint> | |
| <endpoint name="kafka" display="Kafka" label="messaging" extends="model:endpoint" javaType="org.apache.camel.component.kafka.KafkaComponent" maven="org.apache.camel:camel-kafka:3.0.0-SNAPSHOT" since="2.13.0" description="The kafka component allows messages to be sent to (or consumed from) Apache Kafka brokers."> | |
| <property name="allowManualCommit" type="boolean" display="Allow Manual Commit" label="consumer" description="Whether to allow doing manual commits via KafkaManualCommit. If this option is enabled then an instance of KafkaManualCommit is stored on the Exchange message header, which allows end users to access this API and perform manual offset commits via the Kafka consumer."/> | |
| <property name="autoCommitEnable" type="boolean" display="Auto Commit Enable" label="consumer" description="If true, periodically commit to ZooKeeper the offset of messages already fetched by the consumer. This committed offset will be used when the process fails as the position from which the new consumer will begin."/> | |
| <property name="autoCommitIntervalMs" type="int" display="Auto Commit Interval Ms" label="consumer" description="The frequency in ms that the consumer offsets are committed to zookeeper."/> | |
| <property name="autoCommitOnStop" type="string" display="Auto Commit On Stop" label="consumer" description="Whether to perform an explicit auto commit when the consumer stops to ensure the broker has a commit from the last consumed message. This requires the option autoCommitEnable is turned on. The possible values are: sync, async, or none. And sync is the default value."/> | |
| <property name="autoOffsetReset" type="string" display="Auto Offset Reset" label="consumer" description="What to do when there is no initial offset in ZooKeeper or if an offset is out of range: earliest : automatically reset the offset to the earliest offset latest : automatically reset the offset to the latest offset fail: throw exception to the consumer"/> | |
| <property name="breakOnFirstError" type="boolean" display="Break On First Error" label="consumer" description="This options controls what happens when a consumer is processing an exchange and it fails. If the option is false then the consumer continues to the next message and processes it. If the option is true then the consumer breaks out, and will seek back to offset of the message that caused a failure, and then re-attempt to process this message. However this can lead to endless processing of the same message if its bound to fail every time, eg a poison message. Therefore its recommended to deal with that for example by using Camel's error handler."/> | |
| <property name="bridgeEndpoint" type="boolean" display="Bridge Endpoint" label="producer" description="If the option is true, then KafkaProducer will ignore the KafkaConstants.TOPIC header setting of the inbound message."/> | |
| <property name="brokers" type="string" display="Brokers" label="common" description="URL of the Kafka brokers to use. The format is host1:port1,host2:port2, and the list can be a subset of brokers or a VIP pointing to a subset of brokers. This option is known as bootstrap.servers in the Kafka documentation."/> | |
| <property name="bufferMemorySize" type="int" display="Buffer Memory Size" label="producer" description="The total bytes of memory the producer can use to buffer records waiting to be sent to the server. If records are sent faster than they can be delivered to the server the producer will either block or throw an exception based on the preference specified by block.on.buffer.full.This setting should correspond roughly to the total memory the producer will use, but is not a hard bound since not all memory the producer uses is used for buffering. Some additional memory will be used for compression (if compression is enabled) as well as for maintaining in-flight requests."/> | |
| <property name="checkCrcs" type="boolean" display="Check Crcs" label="consumer" description="Automatically check the CRC32 of the records consumed. This ensures no on-the-wire or on-disk corruption to the messages occurred. This check adds some overhead, so it may be disabled in cases seeking extreme performance."/> | |
| <property name="circularTopicDetection" type="boolean" display="Circular Topic Detection" label="producer" description="If the option is true, then KafkaProducer will detect if the message is attempted to be sent back to the same topic it may come from, if the message was original from a kafka consumer. If the KafkaConstants.TOPIC header is the same as the original kafka consumer topic, then the header setting is ignored, and the topic of the producer endpoint is used. In other words this avoids sending the same message back to where it came from. This option is not in use if the option bridgeEndpoint is set to true."/> | |
| <property name="clientId" type="string" display="Client Id" label="common" description="The client id is a user-specified string sent in each request to help trace calls. It should logically identify the application making the request."/> | |
| <property name="compressionCodec" type="string" display="Compression Codec" label="producer" description="This parameter allows you to specify the compression codec for all data generated by this producer. Valid values are none, gzip and snappy."/> | |
| <property name="connectionMaxIdleMs" type="int" display="Connection Max Idle Ms" label="producer" description="Close idle connections after the number of milliseconds specified by this config."/> | |
| <property name="consumerRequestTimeoutMs" type="int" display="Consumer Request Timeout Ms" label="consumer" description="The configuration controls the maximum amount of time the client will wait for the response of a request. If the response is not received before the timeout elapses the client will resend the request if necessary or fail the request if retries are exhausted."/> | |
| <property name="consumerStreams" type="int" display="Consumer Streams" label="consumer" description="Number of concurrent consumers on the consumer"/> | |
| <property name="consumersCount" type="int" display="Consumers Count" label="consumer" description="The number of consumers that connect to kafka server"/> | |
| <property name="enableIdempotence" type="boolean" display="Enable Idempotence" label="producer" description="If set to 'true' the producer will ensure that exactly one copy of each message is written in the stream. If 'false', producer retries may write duplicates of the retried message in the stream. If set to true this option will require max.in.flight.requests.per.connection to be set to 1 and retries cannot be zero and additionally acks must be set to 'all'."/> | |
| <property name="fetchMaxBytes" type="int" display="Fetch Max Bytes" label="consumer" description="The maximum amount of data the server should return for a fetch request This is not an absolute maximum, if the first message in the first non-empty partition of the fetch is larger than this value, the message will still be returned to ensure that the consumer can make progress. The maximum message size accepted by the broker is defined via message.max.bytes (broker config) or max.message.bytes (topic config). Note that the consumer performs multiple fetches in parallel."/> | |
| <property name="fetchMinBytes" type="int" display="Fetch Min Bytes" label="consumer" description="The minimum amount of data the server should return for a fetch request. If insufficient data is available the request will wait for that much data to accumulate before answering the request."/> | |
| <property name="fetchWaitMaxMs" type="int" display="Fetch Wait Max Ms" label="consumer" description="The maximum amount of time the server will block before answering the fetch request if there isn't sufficient data to immediately satisfy fetch.min.bytes"/> | |
| <property name="groupId" type="string" display="Group Id" label="consumer" description="A string that uniquely identifies the group of consumer processes to which this consumer belongs. By setting the same group id multiple processes indicate that they are all part of the same consumer group. This option is required for consumers."/> | |
| <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="heartbeatIntervalMs" type="int" display="Heartbeat Interval Ms" label="consumer" description="The expected time between heartbeats to the consumer coordinator when using Kafka's group management facilities. Heartbeats are used to ensure that the consumer's session stays active and to facilitate rebalancing when new consumers join or leave the group. The value must be set lower than session.timeout.ms, but typically should be set no higher than 1/3 of that value. It can be adjusted even lower to control the expected time for normal rebalances."/> | |
| <property name="interceptorClasses" type="string" display="Interceptor Classes" label="common,monitoring" description="Sets interceptors for producer or consumers. Producer interceptors have to be classes implementing org.apache.kafka.clients.producer.ProducerInterceptor Consumer interceptors have to be classes implementing org.apache.kafka.clients.consumer.ConsumerInterceptor Note that if you use Producer interceptor on a consumer it will throw a class cast exception in runtime"/> | |
| <property name="kafkaHeaderDeserializer" type="java:org.apache.camel.component.kafka.serde.KafkaHeaderDeserializer" display="Kafka Header Deserializer" label="consumer" description="Sets custom KafkaHeaderDeserializer for deserialization kafka headers values to camel headers values."/> | |
| <property name="kafkaHeaderSerializer" type="java:org.apache.camel.component.kafka.serde.KafkaHeaderSerializer" display="Kafka Header Serializer" label="producer" description="Sets custom KafkaHeaderDeserializer for serialization camel headers values to kafka headers values."/> | |
| <property name="kerberosBeforeReloginMinTime" type="int" display="Kerberos Before Relogin Min Time" label="common,security" description="Login thread sleep time between refresh attempts."/> | |
| <property name="kerberosInitCmd" type="string" display="Kerberos Init Cmd" label="common,security" description="Kerberos kinit command path. Default is /usr/bin/kinit"/> | |
| <property name="kerberosPrincipalToLocalRules" type="string" display="Kerberos Principal To Local Rules" label="common,security" description="A list of rules for mapping from principal names to short names (typically operating system usernames). The rules are evaluated in order and the first rule that matches a principal name is used to map it to a short name. Any later rules in the list are ignored. By default, principal names of the form {username}/{hostname}{REALM} are mapped to {username}. For more details on the format please see the security authorization and acls documentation.. Multiple values can be separated by comma"/> | |
| <property name="kerberosRenewJitter" type="double" display="Kerberos Renew Jitter" label="common,security" description="Percentage of random jitter added to the renewal time."/> | |
| <property name="kerberosRenewWindowFactor" type="double" display="Kerberos Renew Window Factor" label="common,security" description="Login thread will sleep until the specified window factor of time from last refresh to ticket's expiry has been reached, at which time it will try to renew the ticket."/> | |
| <property name="key" type="string" display="Key" label="producer" description="The record key (or null if no key is specified). If this option has been configured then it take precedence over header KafkaConstants#KEY"/> | |
| <property name="keyDeserializer" type="string" display="Key Deserializer" label="consumer" description="Deserializer class for key that implements the Deserializer interface."/> | |
| <property name="keySerializerClass" type="string" display="Key Serializer Class" label="producer" description="The serializer class for keys (defaults to the same as for messages if nothing is given)."/> | |
| <property name="lingerMs" type="int" display="Linger Ms" label="producer" description="The producer groups together any records that arrive in between request transmissions into a single batched request. Normally this occurs only under load when records arrive faster than they can be sent out. However in some circumstances the client may want to reduce the number of requests even under moderate load. This setting accomplishes this by adding a small amount of artificial delaythat is, rather than immediately sending out a record the producer will wait for up to the given delay to allow other records to be sent so that the sends can be batched together. This can be thought of as analogous to Nagle's algorithm in TCP. This setting gives the upper bound on the delay for batching: once we get batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if we have fewer than this many bytes accumulated for this partition we will 'linger' for the specified time waiting for more records to show up. This setting defaults to 0 (i.e. no delay). Setting linger.ms=5, for example, would have the effect of reducing the number of requests sent but would add up to 5ms of latency to records sent in the absense of load."/> | |
| <property name="maxBlockMs" type="int" display="Max Block Ms" label="producer" description="The configuration controls how long sending to kafka will block. These methods can be blocked for multiple reasons. For e.g: buffer full, metadata unavailable.This configuration imposes maximum limit on the total time spent in fetching metadata, serialization of key and value, partitioning and allocation of buffer memory when doing a send(). In case of partitionsFor(), this configuration imposes a maximum time threshold on waiting for metadata"/> | |
| <property name="maxInFlightRequest" type="int" display="Max In Flight Request" label="producer" description="The maximum number of unacknowledged requests the client will send on a single connection before blocking. Note that if this setting is set to be greater than 1 and there are failed sends, there is a risk of message re-ordering due to retries (i.e., if retries are enabled)."/> | |
| <property name="maxPartitionFetchBytes" type="int" display="Max Partition Fetch Bytes" label="consumer" description="The maximum amount of data per-partition the server will return. The maximum total memory used for a request will be #partitions max.partition.fetch.bytes. This size must be at least as large as the maximum message size the server allows or else it is possible for the producer to send messages larger than the consumer can fetch. If that happens, the consumer can get stuck trying to fetch a large message on a certain partition."/> | |
| <property name="maxPollIntervalMs" type="long" display="Max Poll Interval Ms" label="consumer" description="The maximum delay between invocations of poll() when using consumer group management. This places an upper bound on the amount of time that the consumer can be idle before fetching more records. If poll() is not called before expiration of this timeout, then the consumer is considered failed and the group will rebalance in order to reassign the partitions to another member."/> | |
| <property name="maxPollRecords" type="int" display="Max Poll Records" label="consumer" description="The maximum number of records returned in a single call to poll()"/> | |
| <property name="maxRequestSize" type="int" display="Max Request Size" label="producer" description="The maximum size of a request. This is also effectively a cap on the maximum record size. Note that the server has its own cap on record size which may be different from this. This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests."/> | |
| <property name="metadataMaxAgeMs" type="int" display="Metadata Max Age Ms" label="producer" description="The period of time in milliseconds after which we force a refresh of metadata even if we haven't seen any partition leadership changes to proactively discover any new brokers or partitions."/> | |
| <property name="metricReporters" type="string" display="Metric Reporters" label="producer" description="A list of classes to use as metrics reporters. Implementing the MetricReporter interface allows plugging in classes that will be notified of new metric creation. The JmxReporter is always included to register JMX statistics."/> | |
| <property name="metricsSampleWindowMs" type="int" display="Metrics Sample Window Ms" label="producer" description="The number of samples maintained to compute metrics."/> | |
| <property name="noOfMetricsSample" type="int" display="No Of Metrics Sample" label="producer" description="The number of samples maintained to compute metrics."/> | |
| <property name="offsetRepository" type="java:org.apache.camel.spi.StateRepository<java.lang.String,java.lang.String>" display="Offset Repository" label="consumer" description="The offset repository to use in order to locally store the offset of each partition of the topic. Defining one will disable the autocommit."/> | |
| <property name="partitionAssignor" type="string" display="Partition Assignor" label="consumer" description="The class name of the partition assignment strategy that the client will use to distribute partition ownership amongst consumer instances when group management is used"/> | |
| <property name="partitionKey" type="int" display="Partition Key" label="producer" description="The partition to which the record will be sent (or null if no partition was specified). If this option has been configured then it take precedence over header KafkaConstants#PARTITION_KEY"/> | |
| <property name="partitioner" type="string" display="Partitioner" label="producer" description="The partitioner class for partitioning messages amongst sub-topics. The default partitioner is based on the hash of the key."/> | |
| <property name="pollTimeoutMs" type="long" display="Poll Timeout Ms" label="consumer" description="The timeout used when polling the KafkaConsumer."/> | |
| <property name="producerBatchSize" type="int" display="Producer Batch Size" label="producer" description="The producer will attempt to batch records together into fewer requests whenever multiple records are being sent to the same partition. This helps performance on both the client and the server. This configuration controls the default batch size in bytes. No attempt will be made to batch records larger than this size.Requests sent to brokers will contain multiple batches, one for each partition with data available to be sent.A small batch size will make batching less common and may reduce throughput (a batch size of zero will disable batching entirely). A very large batch size may use memory a bit more wastefully as we will always allocate a buffer of the specified batch size in anticipation of additional records."/> | |
| <property name="queueBufferingMaxMessages" type="int" display="Queue Buffering Max Messages" label="producer" description="The maximum number of unsent messages that can be queued up the producer when using async mode before either the producer must be blocked or data must be dropped."/> | |
| <property name="receiveBufferBytes" type="int" display="Receive Buffer Bytes" label="producer" description="The size of the TCP receive buffer (SO_RCVBUF) to use when reading data."/> | |
| <property name="reconnectBackoffMaxMs" type="int" display="Reconnect Backoff Max Ms" label="common" description="The maximum amount of time in milliseconds to wait when reconnecting to a broker that has repeatedly failed to connect. If provided, the backoff per host will increase exponentially for each consecutive connection failure, up to this maximum. After calculating the backoff increase, 20% random jitter is added to avoid connection storms."/> | |
| <property name="reconnectBackoffMs" type="int" display="Reconnect Backoff Ms" label="producer" description="The amount of time to wait before attempting to reconnect to a given host. This avoids repeatedly connecting to a host in a tight loop. This backoff applies to all requests sent by the consumer to the broker."/> | |
| <property name="recordMetadata" type="boolean" display="Record Metadata" label="producer" description="Whether the producer should store the RecordMetadata results from sending to Kafka. The results are stored in a List containing the RecordMetadata metadata's. The list is stored on a header with the key KafkaConstants#KAFKA_RECORDMETA"/> | |
| <property name="requestRequiredAcks" type="string" display="Request Required Acks" label="producer" description="The number of acknowledgments the producer requires the leader to have received before considering a request complete. This controls the durability of records that are sent. The following settings are common: acks=0 If set to zero then the producer will not wait for any acknowledgment from the server at all. The record will be immediately added to the socket buffer and considered sent. No guarantee can be made that the server has received the record in this case, and the retries configuration will not take effect (as the client won't generally know of any failures). The offset given back for each record will always be set to -1. acks=1 This will mean the leader will write the record to its local log but will respond without awaiting full acknowledgement from all followers. In this case should the leader fail immediately after acknowledging the record but before the followers have replicated it then the record will be lost. acks=all This means the leader will wait for the full set of in-sync replicas to acknowledge the record. This guarantees that the record will not be lost as long as at least one in-sync replica remains alive. This is the strongest available guarantee."/> | |
| <property name="requestTimeoutMs" type="int" display="Request Timeout Ms" label="producer" description="The amount of time the broker will wait trying to meet the request.required.acks requirement before sending back an error to the client."/> | |
| <property name="retries" type="int" display="Retries" label="producer" description="Setting a value greater than zero will cause the client to resend any record whose send fails with a potentially transient error. Note that this retry is no different than if the client resent the record upon receiving the error. Allowing retries will potentially change the ordering of records because if two records are sent to a single partition, and the first fails and is retried but the second succeeds, then the second record may appear first."/> | |
| <property name="retryBackoffMs" type="int" display="Retry Backoff Ms" label="producer" description="Before each retry, the producer refreshes the metadata of relevant topics to see if a new leader has been elected. Since leader election takes a bit of time, this property specifies the amount of time that the producer waits before refreshing the metadata."/> | |
| <property name="saslJaasConfig" type="string" display="Sasl Jaas Config" label="common,security" secret="true" description="Expose the kafka sasl.jaas.config parameter Example: org.apache.kafka.common.security.plain.PlainLoginModule required username=USERNAME password=PASSWORD;"/> | |
| <property name="saslKerberosServiceName" type="string" display="Sasl Kerberos Service Name" label="common,security" description="The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config."/> | |
| <property name="saslMechanism" type="string" display="Sasl Mechanism" label="common,security" description="The Simple Authentication and Security Layer (SASL) Mechanism used. For the valid values see a href= http://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtmlhttp://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml"/> | |
| <property name="schemaRegistryURL" type="string" display="Schema Registry URL" label="confluent" description="URL of the Confluent Platform schema registry servers to use. The format is host1:port1,host2:port2. This is known as schema.registry.url in the Confluent Platform documentation. This option is only available in the Confluent Platform (not standard Apache Kafka)"/> | |
| <property name="securityProtocol" type="string" display="Security Protocol" label="common,security" description="Protocol used to communicate with brokers. SASL_PLAINTEXT, PLAINTEXT and SSL are supported"/> | |
| <property name="seekTo" type="string" display="Seek To" label="consumer" description="Set if KafkaConsumer will read from beginning or end on startup: beginning : read from beginning end : read from end This is replacing the earlier property seekToBeginning"/> | |
| <property name="sendBufferBytes" type="int" display="Send Buffer Bytes" label="producer" description="Socket write buffer size"/> | |
| <property name="serializerClass" type="string" display="Serializer Class" label="producer" description="The serializer class for messages."/> | |
| <property name="sessionTimeoutMs" type="int" display="Session Timeout Ms" label="consumer" description="The timeout used to detect failures when using Kafka's group management facilities."/> | |
| <property name="specificAvroReader" type="boolean" display="Specific Avro Reader" label="confluent,consumer" description="This enables the use of a specific Avro reader for use with the Confluent Platform schema registry and the io.confluent.kafka.serializers.KafkaAvroDeserializer. This option is only available in the Confluent Platform (not standard Apache Kafka)"/> | |
| <property name="sslCipherSuites" type="string" display="Ssl Cipher Suites" label="common,security" description="A list of cipher suites. This is a named combination of authentication, encryption, MAC and key exchange algorithm used to negotiate the security settings for a network connection using TLS or SSL network protocol.By default all the available cipher suites are supported."/> | |
| <property name="sslContextParameters" type="java:org.apache.camel.support.jsse.SSLContextParameters" display="Ssl Context Parameters" label="common,security" description="SSL configuration using a Camel SSLContextParameters object. If configured it's applied before the other SSL endpoint parameters."/> | |
| <property name="sslEnabledProtocols" type="string" display="Ssl Enabled Protocols" label="common,security" description="The list of protocols enabled for SSL connections. TLSv1.2, TLSv1.1 and TLSv1 are enabled by default."/> | |
| <property name="sslEndpointAlgorithm" type="string" display="Ssl Endpoint Algorithm" label="common,security" description="The endpoint identification algorithm to validate server hostname using server certificate."/> | |
| <property name="sslKeyPassword" type="string" display="Ssl Key Password" label="producer,security" secret="true" description="The password of the private key in the key store file. This is optional for client."/> | |
| <property name="sslKeymanagerAlgorithm" type="string" display="Ssl Keymanager Algorithm" label="common,security" description="The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine."/> | |
| <property name="sslKeystoreLocation" type="string" display="Ssl Keystore Location" label="producer,security" description="The location of the key store file. This is optional for client and can be used for two-way authentication for client."/> | |
| <property name="sslKeystorePassword" type="string" display="Ssl Keystore Password" label="producer,security" secret="true" description="The store password for the key store file.This is optional for client and only needed if ssl.keystore.location is configured."/> | |
| <property name="sslKeystoreType" type="string" display="Ssl Keystore Type" label="common,security" description="The file format of the key store file. This is optional for client. Default value is JKS"/> | |
| <property name="sslProtocol" type="string" display="Ssl Protocol" label="common,security" description="The SSL protocol used to generate the SSLContext. Default setting is TLS, which is fine for most cases. Allowed values in recent JVMs are TLS, TLSv1.1 and TLSv1.2. SSL, SSLv2 and SSLv3 may be supported in older JVMs, but their usage is discouraged due to known security vulnerabilities."/> | |
| <property name="sslProvider" type="string" display="Ssl Provider" label="common,security" description="The name of the security provider used for SSL connections. Default value is the default security provider of the JVM."/> | |
| <property name="sslTrustmanagerAlgorithm" type="string" display="Ssl Trustmanager Algorithm" label="common,security" description="The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine."/> | |
| <property name="sslTruststoreLocation" type="string" display="Ssl Truststore Location" label="producer,security" description="The location of the trust store file."/> | |
| <property name="sslTruststorePassword" type="string" display="Ssl Truststore Password" label="producer,security" secret="true" description="The password for the trust store file."/> | |
| <property name="sslTruststoreType" type="string" display="Ssl Truststore Type" label="common,security" description="The file format of the trust store file. Default value is JKS."/> | |
| <property name="topic" type="string" display="Topic" label="common" required="true" kind="path" description="Name of the topic to use. On the consumer you can use comma to separate multiple topics. A producer can only send a message to a single topic."/> | |
| <property name="topicIsPattern" type="boolean" display="Topic Is Pattern" label="consumer" description="Whether the topic is a pattern (regular expression). This can be used to subscribe to dynamic number of topics matching the pattern."/> | |
| <property name="valueDeserializer" type="string" display="Value Deserializer" label="consumer" description="Deserializer class for value that implements the Deserializer interface."/> | |
| <property name="workerPool" type="java:java.util.concurrent.ExecutorService" display="Worker Pool" label="producer" description="To use a custom worker pool for continue routing Exchange after kafka server has acknowledge the message that was sent to it from KafkaProducer using asynchronous non-blocking processing."/> | |
| <property name="workerPoolCoreSize" type="int" display="Worker Pool Core Size" label="producer" description="Number of core threads for the worker pool for continue routing Exchange after kafka server has acknowledge the message that was sent to it from KafkaProducer using asynchronous non-blocking processing."/> | |
| <property name="workerPoolMaxSize" type="int" display="Worker Pool Max Size" label="producer" description="Maximum number of threads for the worker pool for continue routing Exchange after kafka server has acknowledge the message that was sent to it from KafkaProducer using asynchronous non-blocking processing."/> | |
| </endpoint> | |
| <endpoint name="kubernetes-config-maps" display="Kubernetes ConfigMap" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.kubernetes.config_maps.KubernetesConfigMapsComponent" maven="org.apache.camel:camel-kubernetes:3.0.0-SNAPSHOT" producerOnly="true" since="2.17.0" description="The Kubernetes Configmaps component provides a producer to execute kubernetes configmap operations."> | |
| <property name="apiVersion" type="string" display="Api Version" description="The Kubernetes API Version to use"/> | |
| <property name="caCertData" type="string" display="Ca Cert Data" label="security" secret="true" description="The CA Cert Data"/> | |
| <property name="caCertFile" type="string" display="Ca Cert File" label="security" secret="true" description="The CA Cert File"/> | |
| <property name="clientCertData" type="string" display="Client Cert Data" label="security" secret="true" description="The Client Cert Data"/> | |
| <property name="clientCertFile" type="string" display="Client Cert File" label="security" secret="true" description="The Client Cert File"/> | |
| <property name="clientKeyAlgo" type="string" display="Client Key Algo" label="security" secret="true" description="The Key Algorithm used by the client"/> | |
| <property name="clientKeyData" type="string" display="Client Key Data" label="security" secret="true" description="The Client Key data"/> | |
| <property name="clientKeyFile" type="string" display="Client Key File" label="security" secret="true" description="The Client Key file"/> | |
| <property name="clientKeyPassphrase" type="string" display="Client Key Passphrase" label="security" secret="true" description="The Client Key Passphrase"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="Connection timeout in milliseconds to use when making requests to the Kubernetes API server."/> | |
| <property name="dnsDomain" type="string" display="Dns Domain" description="The dns domain, used for ServiceCall EIP"/> | |
| <property name="kubernetesClient" type="java:io.fabric8.kubernetes.client.KubernetesClient" display="Kubernetes Client" description="Default KubernetesClient to use if provided"/> | |
| <property name="masterUrl" type="string" display="Master Url" required="true" kind="path" description="Kubernetes Master url"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" label="security" secret="true" description="The Auth Token"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="Producer operation to do on Kubernetes"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to connect to Kubernetes"/> | |
| <property name="portName" type="string" display="Port Name" description="The port name, used for ServiceCall EIP"/> | |
| <property name="portProtocol" type="string" display="Port Protocol" description="The port protocol, used for ServiceCall EIP"/> | |
| <property name="trustCerts" type="boolean" display="Trust Certs" label="security" secret="true" description="Define if the certs we used are trusted anyway or not"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to connect to Kubernetes"/> | |
| </endpoint> | |
| <endpoint name="kubernetes-deployments" display="Kubernetes Deployments" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.kubernetes.deployments.KubernetesDeploymentsComponent" maven="org.apache.camel:camel-kubernetes:3.0.0-SNAPSHOT" since="2.20.0" description="The Kubernetes Nodes component provides a producer to execute kubernetes node operations and a consumer to consume node events."> | |
| <property name="apiVersion" type="string" display="Api Version" description="The Kubernetes API Version to use"/> | |
| <property name="caCertData" type="string" display="Ca Cert Data" label="security" secret="true" description="The CA Cert Data"/> | |
| <property name="caCertFile" type="string" display="Ca Cert File" label="security" secret="true" description="The CA Cert File"/> | |
| <property name="clientCertData" type="string" display="Client Cert Data" label="security" secret="true" description="The Client Cert Data"/> | |
| <property name="clientCertFile" type="string" display="Client Cert File" label="security" secret="true" description="The Client Cert File"/> | |
| <property name="clientKeyAlgo" type="string" display="Client Key Algo" label="security" secret="true" description="The Key Algorithm used by the client"/> | |
| <property name="clientKeyData" type="string" display="Client Key Data" label="security" secret="true" description="The Client Key data"/> | |
| <property name="clientKeyFile" type="string" display="Client Key File" label="security" secret="true" description="The Client Key file"/> | |
| <property name="clientKeyPassphrase" type="string" display="Client Key Passphrase" label="security" secret="true" description="The Client Key Passphrase"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="Connection timeout in milliseconds to use when making requests to the Kubernetes API server."/> | |
| <property name="dnsDomain" type="string" display="Dns Domain" description="The dns domain, used for ServiceCall EIP"/> | |
| <property name="kubernetesClient" type="java:io.fabric8.kubernetes.client.KubernetesClient" display="Kubernetes Client" description="Default KubernetesClient to use if provided"/> | |
| <property name="labelKey" type="string" display="Label Key" label="consumer" description="The Consumer Label key when watching at some resources"/> | |
| <property name="labelValue" type="string" display="Label Value" label="consumer" description="The Consumer Label value when watching at some resources"/> | |
| <property name="masterUrl" type="string" display="Master Url" required="true" kind="path" description="Kubernetes Master url"/> | |
| <property name="namespace" type="string" display="Namespace" label="consumer" description="The namespace"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" label="security" secret="true" description="The Auth Token"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="Producer operation to do on Kubernetes"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to connect to Kubernetes"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="The Consumer pool size"/> | |
| <property name="portName" type="string" display="Port Name" description="The port name, used for ServiceCall EIP"/> | |
| <property name="portProtocol" type="string" display="Port Protocol" description="The port protocol, used for ServiceCall EIP"/> | |
| <property name="resourceName" type="string" display="Resource Name" label="consumer" description="The Consumer Resource Name we would like to watch"/> | |
| <property name="trustCerts" type="boolean" display="Trust Certs" label="security" secret="true" description="Define if the certs we used are trusted anyway or not"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to connect to Kubernetes"/> | |
| </endpoint> | |
| <endpoint name="kubernetes-hpa" display="Kubernetes HPA" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.kubernetes.hpa.KubernetesHPAComponent" maven="org.apache.camel:camel-kubernetes:3.0.0-SNAPSHOT" since="2.23.0" description="The Kubernetes HPA component provides a producer to execute kubernetes hpa operations and a consumer to consume HPA events."> | |
| <property name="apiVersion" type="string" display="Api Version" description="The Kubernetes API Version to use"/> | |
| <property name="caCertData" type="string" display="Ca Cert Data" label="security" secret="true" description="The CA Cert Data"/> | |
| <property name="caCertFile" type="string" display="Ca Cert File" label="security" secret="true" description="The CA Cert File"/> | |
| <property name="clientCertData" type="string" display="Client Cert Data" label="security" secret="true" description="The Client Cert Data"/> | |
| <property name="clientCertFile" type="string" display="Client Cert File" label="security" secret="true" description="The Client Cert File"/> | |
| <property name="clientKeyAlgo" type="string" display="Client Key Algo" label="security" secret="true" description="The Key Algorithm used by the client"/> | |
| <property name="clientKeyData" type="string" display="Client Key Data" label="security" secret="true" description="The Client Key data"/> | |
| <property name="clientKeyFile" type="string" display="Client Key File" label="security" secret="true" description="The Client Key file"/> | |
| <property name="clientKeyPassphrase" type="string" display="Client Key Passphrase" label="security" secret="true" description="The Client Key Passphrase"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="Connection timeout in milliseconds to use when making requests to the Kubernetes API server."/> | |
| <property name="dnsDomain" type="string" display="Dns Domain" description="The dns domain, used for ServiceCall EIP"/> | |
| <property name="kubernetesClient" type="java:io.fabric8.kubernetes.client.KubernetesClient" display="Kubernetes Client" description="Default KubernetesClient to use if provided"/> | |
| <property name="labelKey" type="string" display="Label Key" label="consumer" description="The Consumer Label key when watching at some resources"/> | |
| <property name="labelValue" type="string" display="Label Value" label="consumer" description="The Consumer Label value when watching at some resources"/> | |
| <property name="masterUrl" type="string" display="Master Url" required="true" kind="path" description="Kubernetes Master url"/> | |
| <property name="namespace" type="string" display="Namespace" label="consumer" description="The namespace"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" label="security" secret="true" description="The Auth Token"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="Producer operation to do on Kubernetes"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to connect to Kubernetes"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="The Consumer pool size"/> | |
| <property name="portName" type="string" display="Port Name" description="The port name, used for ServiceCall EIP"/> | |
| <property name="portProtocol" type="string" display="Port Protocol" description="The port protocol, used for ServiceCall EIP"/> | |
| <property name="resourceName" type="string" display="Resource Name" label="consumer" description="The Consumer Resource Name we would like to watch"/> | |
| <property name="trustCerts" type="boolean" display="Trust Certs" label="security" secret="true" description="Define if the certs we used are trusted anyway or not"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to connect to Kubernetes"/> | |
| </endpoint> | |
| <endpoint name="kubernetes-job" display="Kubernetes Job" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.kubernetes.job.KubernetesJobComponent" maven="org.apache.camel:camel-kubernetes:3.0.0-SNAPSHOT" since="2.23.0" description="The Kubernetes Jobs component provides a producer to execute kubernetes job operations"> | |
| <property name="apiVersion" type="string" display="Api Version" description="The Kubernetes API Version to use"/> | |
| <property name="caCertData" type="string" display="Ca Cert Data" label="security" secret="true" description="The CA Cert Data"/> | |
| <property name="caCertFile" type="string" display="Ca Cert File" label="security" secret="true" description="The CA Cert File"/> | |
| <property name="clientCertData" type="string" display="Client Cert Data" label="security" secret="true" description="The Client Cert Data"/> | |
| <property name="clientCertFile" type="string" display="Client Cert File" label="security" secret="true" description="The Client Cert File"/> | |
| <property name="clientKeyAlgo" type="string" display="Client Key Algo" label="security" secret="true" description="The Key Algorithm used by the client"/> | |
| <property name="clientKeyData" type="string" display="Client Key Data" label="security" secret="true" description="The Client Key data"/> | |
| <property name="clientKeyFile" type="string" display="Client Key File" label="security" secret="true" description="The Client Key file"/> | |
| <property name="clientKeyPassphrase" type="string" display="Client Key Passphrase" label="security" secret="true" description="The Client Key Passphrase"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="Connection timeout in milliseconds to use when making requests to the Kubernetes API server."/> | |
| <property name="dnsDomain" type="string" display="Dns Domain" description="The dns domain, used for ServiceCall EIP"/> | |
| <property name="kubernetesClient" type="java:io.fabric8.kubernetes.client.KubernetesClient" display="Kubernetes Client" description="Default KubernetesClient to use if provided"/> | |
| <property name="labelKey" type="string" display="Label Key" label="consumer" description="The Consumer Label key when watching at some resources"/> | |
| <property name="labelValue" type="string" display="Label Value" label="consumer" description="The Consumer Label value when watching at some resources"/> | |
| <property name="masterUrl" type="string" display="Master Url" required="true" kind="path" description="Kubernetes Master url"/> | |
| <property name="namespace" type="string" display="Namespace" label="consumer" description="The namespace"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" label="security" secret="true" description="The Auth Token"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="Producer operation to do on Kubernetes"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to connect to Kubernetes"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="The Consumer pool size"/> | |
| <property name="portName" type="string" display="Port Name" description="The port name, used for ServiceCall EIP"/> | |
| <property name="portProtocol" type="string" display="Port Protocol" description="The port protocol, used for ServiceCall EIP"/> | |
| <property name="resourceName" type="string" display="Resource Name" label="consumer" description="The Consumer Resource Name we would like to watch"/> | |
| <property name="trustCerts" type="boolean" display="Trust Certs" label="security" secret="true" description="Define if the certs we used are trusted anyway or not"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to connect to Kubernetes"/> | |
| </endpoint> | |
| <endpoint name="kubernetes-namespaces" display="Kubernetes Namespaces" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.kubernetes.namespaces.KubernetesNamespacesComponent" maven="org.apache.camel:camel-kubernetes:3.0.0-SNAPSHOT" since="2.17.0" description="The Kubernetes Namespaces component provides a producer to execute kubernetes namespace operations and a consumer to consume namespace events."> | |
| <property name="apiVersion" type="string" display="Api Version" description="The Kubernetes API Version to use"/> | |
| <property name="caCertData" type="string" display="Ca Cert Data" label="security" secret="true" description="The CA Cert Data"/> | |
| <property name="caCertFile" type="string" display="Ca Cert File" label="security" secret="true" description="The CA Cert File"/> | |
| <property name="clientCertData" type="string" display="Client Cert Data" label="security" secret="true" description="The Client Cert Data"/> | |
| <property name="clientCertFile" type="string" display="Client Cert File" label="security" secret="true" description="The Client Cert File"/> | |
| <property name="clientKeyAlgo" type="string" display="Client Key Algo" label="security" secret="true" description="The Key Algorithm used by the client"/> | |
| <property name="clientKeyData" type="string" display="Client Key Data" label="security" secret="true" description="The Client Key data"/> | |
| <property name="clientKeyFile" type="string" display="Client Key File" label="security" secret="true" description="The Client Key file"/> | |
| <property name="clientKeyPassphrase" type="string" display="Client Key Passphrase" label="security" secret="true" description="The Client Key Passphrase"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="Connection timeout in milliseconds to use when making requests to the Kubernetes API server."/> | |
| <property name="dnsDomain" type="string" display="Dns Domain" description="The dns domain, used for ServiceCall EIP"/> | |
| <property name="kubernetesClient" type="java:io.fabric8.kubernetes.client.KubernetesClient" display="Kubernetes Client" description="Default KubernetesClient to use if provided"/> | |
| <property name="labelKey" type="string" display="Label Key" label="consumer" description="The Consumer Label key when watching at some resources"/> | |
| <property name="labelValue" type="string" display="Label Value" label="consumer" description="The Consumer Label value when watching at some resources"/> | |
| <property name="masterUrl" type="string" display="Master Url" required="true" kind="path" description="Kubernetes Master url"/> | |
| <property name="namespace" type="string" display="Namespace" label="consumer" description="The namespace"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" label="security" secret="true" description="The Auth Token"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="Producer operation to do on Kubernetes"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to connect to Kubernetes"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="The Consumer pool size"/> | |
| <property name="portName" type="string" display="Port Name" description="The port name, used for ServiceCall EIP"/> | |
| <property name="portProtocol" type="string" display="Port Protocol" description="The port protocol, used for ServiceCall EIP"/> | |
| <property name="resourceName" type="string" display="Resource Name" label="consumer" description="The Consumer Resource Name we would like to watch"/> | |
| <property name="trustCerts" type="boolean" display="Trust Certs" label="security" secret="true" description="Define if the certs we used are trusted anyway or not"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to connect to Kubernetes"/> | |
| </endpoint> | |
| <endpoint name="kubernetes-nodes" display="Kubernetes Nodes" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.kubernetes.nodes.KubernetesNodesComponent" maven="org.apache.camel:camel-kubernetes:3.0.0-SNAPSHOT" since="2.17.0" description="The Kubernetes Nodes component provides a producer to execute kubernetes node operations and a consumer to consume node events."> | |
| <property name="apiVersion" type="string" display="Api Version" description="The Kubernetes API Version to use"/> | |
| <property name="caCertData" type="string" display="Ca Cert Data" label="security" secret="true" description="The CA Cert Data"/> | |
| <property name="caCertFile" type="string" display="Ca Cert File" label="security" secret="true" description="The CA Cert File"/> | |
| <property name="clientCertData" type="string" display="Client Cert Data" label="security" secret="true" description="The Client Cert Data"/> | |
| <property name="clientCertFile" type="string" display="Client Cert File" label="security" secret="true" description="The Client Cert File"/> | |
| <property name="clientKeyAlgo" type="string" display="Client Key Algo" label="security" secret="true" description="The Key Algorithm used by the client"/> | |
| <property name="clientKeyData" type="string" display="Client Key Data" label="security" secret="true" description="The Client Key data"/> | |
| <property name="clientKeyFile" type="string" display="Client Key File" label="security" secret="true" description="The Client Key file"/> | |
| <property name="clientKeyPassphrase" type="string" display="Client Key Passphrase" label="security" secret="true" description="The Client Key Passphrase"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="Connection timeout in milliseconds to use when making requests to the Kubernetes API server."/> | |
| <property name="dnsDomain" type="string" display="Dns Domain" description="The dns domain, used for ServiceCall EIP"/> | |
| <property name="kubernetesClient" type="java:io.fabric8.kubernetes.client.KubernetesClient" display="Kubernetes Client" description="Default KubernetesClient to use if provided"/> | |
| <property name="labelKey" type="string" display="Label Key" label="consumer" description="The Consumer Label key when watching at some resources"/> | |
| <property name="labelValue" type="string" display="Label Value" label="consumer" description="The Consumer Label value when watching at some resources"/> | |
| <property name="masterUrl" type="string" display="Master Url" required="true" kind="path" description="Kubernetes Master url"/> | |
| <property name="namespace" type="string" display="Namespace" label="consumer" description="The namespace"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" label="security" secret="true" description="The Auth Token"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="Producer operation to do on Kubernetes"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to connect to Kubernetes"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="The Consumer pool size"/> | |
| <property name="portName" type="string" display="Port Name" description="The port name, used for ServiceCall EIP"/> | |
| <property name="portProtocol" type="string" display="Port Protocol" description="The port protocol, used for ServiceCall EIP"/> | |
| <property name="resourceName" type="string" display="Resource Name" label="consumer" description="The Consumer Resource Name we would like to watch"/> | |
| <property name="trustCerts" type="boolean" display="Trust Certs" label="security" secret="true" description="Define if the certs we used are trusted anyway or not"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to connect to Kubernetes"/> | |
| </endpoint> | |
| <endpoint name="kubernetes-persistent-volumes" display="Kubernetes Persistent Volume" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.kubernetes.persistent_volumes.KubernetesPersistentVolumesComponent" maven="org.apache.camel:camel-kubernetes:3.0.0-SNAPSHOT" producerOnly="true" since="2.17.0" description="The Kubernetes Persistent Volumes component provides a producer to execute kubernetes persistent volume operations."> | |
| <property name="apiVersion" type="string" display="Api Version" description="The Kubernetes API Version to use"/> | |
| <property name="caCertData" type="string" display="Ca Cert Data" label="security" secret="true" description="The CA Cert Data"/> | |
| <property name="caCertFile" type="string" display="Ca Cert File" label="security" secret="true" description="The CA Cert File"/> | |
| <property name="clientCertData" type="string" display="Client Cert Data" label="security" secret="true" description="The Client Cert Data"/> | |
| <property name="clientCertFile" type="string" display="Client Cert File" label="security" secret="true" description="The Client Cert File"/> | |
| <property name="clientKeyAlgo" type="string" display="Client Key Algo" label="security" secret="true" description="The Key Algorithm used by the client"/> | |
| <property name="clientKeyData" type="string" display="Client Key Data" label="security" secret="true" description="The Client Key data"/> | |
| <property name="clientKeyFile" type="string" display="Client Key File" label="security" secret="true" description="The Client Key file"/> | |
| <property name="clientKeyPassphrase" type="string" display="Client Key Passphrase" label="security" secret="true" description="The Client Key Passphrase"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="Connection timeout in milliseconds to use when making requests to the Kubernetes API server."/> | |
| <property name="dnsDomain" type="string" display="Dns Domain" description="The dns domain, used for ServiceCall EIP"/> | |
| <property name="kubernetesClient" type="java:io.fabric8.kubernetes.client.KubernetesClient" display="Kubernetes Client" description="Default KubernetesClient to use if provided"/> | |
| <property name="masterUrl" type="string" display="Master Url" required="true" kind="path" description="Kubernetes Master url"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" label="security" secret="true" description="The Auth Token"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="Producer operation to do on Kubernetes"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to connect to Kubernetes"/> | |
| <property name="portName" type="string" display="Port Name" description="The port name, used for ServiceCall EIP"/> | |
| <property name="portProtocol" type="string" display="Port Protocol" description="The port protocol, used for ServiceCall EIP"/> | |
| <property name="trustCerts" type="boolean" display="Trust Certs" label="security" secret="true" description="Define if the certs we used are trusted anyway or not"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to connect to Kubernetes"/> | |
| </endpoint> | |
| <endpoint name="kubernetes-persistent-volumes-claims" display="Kubernetes Persistent Volume Claim" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.kubernetes.persistent_volumes_claims.KubernetesPersistentVolumesClaimsComponent" maven="org.apache.camel:camel-kubernetes:3.0.0-SNAPSHOT" producerOnly="true" since="2.17.0" description="The Kubernetes Persistent Volumes Claims component provides a producer to execute kubernetes persistent volume claim operations."> | |
| <property name="apiVersion" type="string" display="Api Version" description="The Kubernetes API Version to use"/> | |
| <property name="caCertData" type="string" display="Ca Cert Data" label="security" secret="true" description="The CA Cert Data"/> | |
| <property name="caCertFile" type="string" display="Ca Cert File" label="security" secret="true" description="The CA Cert File"/> | |
| <property name="clientCertData" type="string" display="Client Cert Data" label="security" secret="true" description="The Client Cert Data"/> | |
| <property name="clientCertFile" type="string" display="Client Cert File" label="security" secret="true" description="The Client Cert File"/> | |
| <property name="clientKeyAlgo" type="string" display="Client Key Algo" label="security" secret="true" description="The Key Algorithm used by the client"/> | |
| <property name="clientKeyData" type="string" display="Client Key Data" label="security" secret="true" description="The Client Key data"/> | |
| <property name="clientKeyFile" type="string" display="Client Key File" label="security" secret="true" description="The Client Key file"/> | |
| <property name="clientKeyPassphrase" type="string" display="Client Key Passphrase" label="security" secret="true" description="The Client Key Passphrase"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="Connection timeout in milliseconds to use when making requests to the Kubernetes API server."/> | |
| <property name="dnsDomain" type="string" display="Dns Domain" description="The dns domain, used for ServiceCall EIP"/> | |
| <property name="kubernetesClient" type="java:io.fabric8.kubernetes.client.KubernetesClient" display="Kubernetes Client" description="Default KubernetesClient to use if provided"/> | |
| <property name="masterUrl" type="string" display="Master Url" required="true" kind="path" description="Kubernetes Master url"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" label="security" secret="true" description="The Auth Token"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="Producer operation to do on Kubernetes"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to connect to Kubernetes"/> | |
| <property name="portName" type="string" display="Port Name" description="The port name, used for ServiceCall EIP"/> | |
| <property name="portProtocol" type="string" display="Port Protocol" description="The port protocol, used for ServiceCall EIP"/> | |
| <property name="trustCerts" type="boolean" display="Trust Certs" label="security" secret="true" description="Define if the certs we used are trusted anyway or not"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to connect to Kubernetes"/> | |
| </endpoint> | |
| <endpoint name="kubernetes-pods" display="Kubernetes Pods" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.kubernetes.pods.KubernetesPodsComponent" maven="org.apache.camel:camel-kubernetes:3.0.0-SNAPSHOT" since="2.17.0" description="The Kubernetes Pods component provides a producer to execute kubernetes pod operations and a consumer to consume pod events."> | |
| <property name="apiVersion" type="string" display="Api Version" description="The Kubernetes API Version to use"/> | |
| <property name="caCertData" type="string" display="Ca Cert Data" label="security" secret="true" description="The CA Cert Data"/> | |
| <property name="caCertFile" type="string" display="Ca Cert File" label="security" secret="true" description="The CA Cert File"/> | |
| <property name="clientCertData" type="string" display="Client Cert Data" label="security" secret="true" description="The Client Cert Data"/> | |
| <property name="clientCertFile" type="string" display="Client Cert File" label="security" secret="true" description="The Client Cert File"/> | |
| <property name="clientKeyAlgo" type="string" display="Client Key Algo" label="security" secret="true" description="The Key Algorithm used by the client"/> | |
| <property name="clientKeyData" type="string" display="Client Key Data" label="security" secret="true" description="The Client Key data"/> | |
| <property name="clientKeyFile" type="string" display="Client Key File" label="security" secret="true" description="The Client Key file"/> | |
| <property name="clientKeyPassphrase" type="string" display="Client Key Passphrase" label="security" secret="true" description="The Client Key Passphrase"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="Connection timeout in milliseconds to use when making requests to the Kubernetes API server."/> | |
| <property name="dnsDomain" type="string" display="Dns Domain" description="The dns domain, used for ServiceCall EIP"/> | |
| <property name="kubernetesClient" type="java:io.fabric8.kubernetes.client.KubernetesClient" display="Kubernetes Client" description="Default KubernetesClient to use if provided"/> | |
| <property name="labelKey" type="string" display="Label Key" label="consumer" description="The Consumer Label key when watching at some resources"/> | |
| <property name="labelValue" type="string" display="Label Value" label="consumer" description="The Consumer Label value when watching at some resources"/> | |
| <property name="masterUrl" type="string" display="Master Url" required="true" kind="path" description="Kubernetes Master url"/> | |
| <property name="namespace" type="string" display="Namespace" label="consumer" description="The namespace"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" label="security" secret="true" description="The Auth Token"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="Producer operation to do on Kubernetes"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to connect to Kubernetes"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="The Consumer pool size"/> | |
| <property name="portName" type="string" display="Port Name" description="The port name, used for ServiceCall EIP"/> | |
| <property name="portProtocol" type="string" display="Port Protocol" description="The port protocol, used for ServiceCall EIP"/> | |
| <property name="resourceName" type="string" display="Resource Name" label="consumer" description="The Consumer Resource Name we would like to watch"/> | |
| <property name="trustCerts" type="boolean" display="Trust Certs" label="security" secret="true" description="Define if the certs we used are trusted anyway or not"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to connect to Kubernetes"/> | |
| </endpoint> | |
| <endpoint name="kubernetes-replication-controllers" display="Kubernetes Replication Controller" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.kubernetes.replication_controllers.KubernetesReplicationControllersComponent" maven="org.apache.camel:camel-kubernetes:3.0.0-SNAPSHOT" since="2.17.0" description="The Kubernetes Replication Controllers component provides a producer to execute kubernetes replication controller operations and a consumer to consume replication controller events."> | |
| <property name="apiVersion" type="string" display="Api Version" description="The Kubernetes API Version to use"/> | |
| <property name="caCertData" type="string" display="Ca Cert Data" label="security" secret="true" description="The CA Cert Data"/> | |
| <property name="caCertFile" type="string" display="Ca Cert File" label="security" secret="true" description="The CA Cert File"/> | |
| <property name="clientCertData" type="string" display="Client Cert Data" label="security" secret="true" description="The Client Cert Data"/> | |
| <property name="clientCertFile" type="string" display="Client Cert File" label="security" secret="true" description="The Client Cert File"/> | |
| <property name="clientKeyAlgo" type="string" display="Client Key Algo" label="security" secret="true" description="The Key Algorithm used by the client"/> | |
| <property name="clientKeyData" type="string" display="Client Key Data" label="security" secret="true" description="The Client Key data"/> | |
| <property name="clientKeyFile" type="string" display="Client Key File" label="security" secret="true" description="The Client Key file"/> | |
| <property name="clientKeyPassphrase" type="string" display="Client Key Passphrase" label="security" secret="true" description="The Client Key Passphrase"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="Connection timeout in milliseconds to use when making requests to the Kubernetes API server."/> | |
| <property name="dnsDomain" type="string" display="Dns Domain" description="The dns domain, used for ServiceCall EIP"/> | |
| <property name="kubernetesClient" type="java:io.fabric8.kubernetes.client.KubernetesClient" display="Kubernetes Client" description="Default KubernetesClient to use if provided"/> | |
| <property name="labelKey" type="string" display="Label Key" label="consumer" description="The Consumer Label key when watching at some resources"/> | |
| <property name="labelValue" type="string" display="Label Value" label="consumer" description="The Consumer Label value when watching at some resources"/> | |
| <property name="masterUrl" type="string" display="Master Url" required="true" kind="path" description="Kubernetes Master url"/> | |
| <property name="namespace" type="string" display="Namespace" label="consumer" description="The namespace"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" label="security" secret="true" description="The Auth Token"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="Producer operation to do on Kubernetes"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to connect to Kubernetes"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="The Consumer pool size"/> | |
| <property name="portName" type="string" display="Port Name" description="The port name, used for ServiceCall EIP"/> | |
| <property name="portProtocol" type="string" display="Port Protocol" description="The port protocol, used for ServiceCall EIP"/> | |
| <property name="resourceName" type="string" display="Resource Name" label="consumer" description="The Consumer Resource Name we would like to watch"/> | |
| <property name="trustCerts" type="boolean" display="Trust Certs" label="security" secret="true" description="Define if the certs we used are trusted anyway or not"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to connect to Kubernetes"/> | |
| </endpoint> | |
| <endpoint name="kubernetes-resources-quota" display="Kubernetes Resources Quota" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.kubernetes.resources_quota.KubernetesResourcesQuotaComponent" maven="org.apache.camel:camel-kubernetes:3.0.0-SNAPSHOT" producerOnly="true" since="2.17.0" description="The Kubernetes Resources Quota component provides a producer to execute kubernetes resources quota operations."> | |
| <property name="apiVersion" type="string" display="Api Version" description="The Kubernetes API Version to use"/> | |
| <property name="caCertData" type="string" display="Ca Cert Data" label="security" secret="true" description="The CA Cert Data"/> | |
| <property name="caCertFile" type="string" display="Ca Cert File" label="security" secret="true" description="The CA Cert File"/> | |
| <property name="clientCertData" type="string" display="Client Cert Data" label="security" secret="true" description="The Client Cert Data"/> | |
| <property name="clientCertFile" type="string" display="Client Cert File" label="security" secret="true" description="The Client Cert File"/> | |
| <property name="clientKeyAlgo" type="string" display="Client Key Algo" label="security" secret="true" description="The Key Algorithm used by the client"/> | |
| <property name="clientKeyData" type="string" display="Client Key Data" label="security" secret="true" description="The Client Key data"/> | |
| <property name="clientKeyFile" type="string" display="Client Key File" label="security" secret="true" description="The Client Key file"/> | |
| <property name="clientKeyPassphrase" type="string" display="Client Key Passphrase" label="security" secret="true" description="The Client Key Passphrase"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="Connection timeout in milliseconds to use when making requests to the Kubernetes API server."/> | |
| <property name="dnsDomain" type="string" display="Dns Domain" description="The dns domain, used for ServiceCall EIP"/> | |
| <property name="kubernetesClient" type="java:io.fabric8.kubernetes.client.KubernetesClient" display="Kubernetes Client" description="Default KubernetesClient to use if provided"/> | |
| <property name="masterUrl" type="string" display="Master Url" required="true" kind="path" description="Kubernetes Master url"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" label="security" secret="true" description="The Auth Token"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="Producer operation to do on Kubernetes"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to connect to Kubernetes"/> | |
| <property name="portName" type="string" display="Port Name" description="The port name, used for ServiceCall EIP"/> | |
| <property name="portProtocol" type="string" display="Port Protocol" description="The port protocol, used for ServiceCall EIP"/> | |
| <property name="trustCerts" type="boolean" display="Trust Certs" label="security" secret="true" description="Define if the certs we used are trusted anyway or not"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to connect to Kubernetes"/> | |
| </endpoint> | |
| <endpoint name="kubernetes-secrets" display="Kubernetes Secrets" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.kubernetes.secrets.KubernetesSecretsComponent" maven="org.apache.camel:camel-kubernetes:3.0.0-SNAPSHOT" producerOnly="true" since="2.17.0" description="The Kubernetes Secrets component provides a producer to execute kubernetes secret operations."> | |
| <property name="apiVersion" type="string" display="Api Version" description="The Kubernetes API Version to use"/> | |
| <property name="caCertData" type="string" display="Ca Cert Data" label="security" secret="true" description="The CA Cert Data"/> | |
| <property name="caCertFile" type="string" display="Ca Cert File" label="security" secret="true" description="The CA Cert File"/> | |
| <property name="clientCertData" type="string" display="Client Cert Data" label="security" secret="true" description="The Client Cert Data"/> | |
| <property name="clientCertFile" type="string" display="Client Cert File" label="security" secret="true" description="The Client Cert File"/> | |
| <property name="clientKeyAlgo" type="string" display="Client Key Algo" label="security" secret="true" description="The Key Algorithm used by the client"/> | |
| <property name="clientKeyData" type="string" display="Client Key Data" label="security" secret="true" description="The Client Key data"/> | |
| <property name="clientKeyFile" type="string" display="Client Key File" label="security" secret="true" description="The Client Key file"/> | |
| <property name="clientKeyPassphrase" type="string" display="Client Key Passphrase" label="security" secret="true" description="The Client Key Passphrase"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="Connection timeout in milliseconds to use when making requests to the Kubernetes API server."/> | |
| <property name="dnsDomain" type="string" display="Dns Domain" description="The dns domain, used for ServiceCall EIP"/> | |
| <property name="kubernetesClient" type="java:io.fabric8.kubernetes.client.KubernetesClient" display="Kubernetes Client" description="Default KubernetesClient to use if provided"/> | |
| <property name="masterUrl" type="string" display="Master Url" required="true" kind="path" description="Kubernetes Master url"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" label="security" secret="true" description="The Auth Token"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="Producer operation to do on Kubernetes"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to connect to Kubernetes"/> | |
| <property name="portName" type="string" display="Port Name" description="The port name, used for ServiceCall EIP"/> | |
| <property name="portProtocol" type="string" display="Port Protocol" description="The port protocol, used for ServiceCall EIP"/> | |
| <property name="trustCerts" type="boolean" display="Trust Certs" label="security" secret="true" description="Define if the certs we used are trusted anyway or not"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to connect to Kubernetes"/> | |
| </endpoint> | |
| <endpoint name="kubernetes-service-accounts" display="Kubernetes Service Account" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.kubernetes.service_accounts.KubernetesServiceAccountsComponent" maven="org.apache.camel:camel-kubernetes:3.0.0-SNAPSHOT" producerOnly="true" since="2.17.0" description="The Kubernetes Service Accounts component provides a producer to execute service account operations."> | |
| <property name="apiVersion" type="string" display="Api Version" description="The Kubernetes API Version to use"/> | |
| <property name="caCertData" type="string" display="Ca Cert Data" label="security" secret="true" description="The CA Cert Data"/> | |
| <property name="caCertFile" type="string" display="Ca Cert File" label="security" secret="true" description="The CA Cert File"/> | |
| <property name="clientCertData" type="string" display="Client Cert Data" label="security" secret="true" description="The Client Cert Data"/> | |
| <property name="clientCertFile" type="string" display="Client Cert File" label="security" secret="true" description="The Client Cert File"/> | |
| <property name="clientKeyAlgo" type="string" display="Client Key Algo" label="security" secret="true" description="The Key Algorithm used by the client"/> | |
| <property name="clientKeyData" type="string" display="Client Key Data" label="security" secret="true" description="The Client Key data"/> | |
| <property name="clientKeyFile" type="string" display="Client Key File" label="security" secret="true" description="The Client Key file"/> | |
| <property name="clientKeyPassphrase" type="string" display="Client Key Passphrase" label="security" secret="true" description="The Client Key Passphrase"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="Connection timeout in milliseconds to use when making requests to the Kubernetes API server."/> | |
| <property name="dnsDomain" type="string" display="Dns Domain" description="The dns domain, used for ServiceCall EIP"/> | |
| <property name="kubernetesClient" type="java:io.fabric8.kubernetes.client.KubernetesClient" display="Kubernetes Client" description="Default KubernetesClient to use if provided"/> | |
| <property name="masterUrl" type="string" display="Master Url" required="true" kind="path" description="Kubernetes Master url"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" label="security" secret="true" description="The Auth Token"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="Producer operation to do on Kubernetes"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to connect to Kubernetes"/> | |
| <property name="portName" type="string" display="Port Name" description="The port name, used for ServiceCall EIP"/> | |
| <property name="portProtocol" type="string" display="Port Protocol" description="The port protocol, used for ServiceCall EIP"/> | |
| <property name="trustCerts" type="boolean" display="Trust Certs" label="security" secret="true" description="Define if the certs we used are trusted anyway or not"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to connect to Kubernetes"/> | |
| </endpoint> | |
| <endpoint name="kubernetes-services" display="Kubernetes Services" label="container,cloud,paas" extends="model:endpoint" javaType="org.apache.camel.component.kubernetes.services.KubernetesServicesComponent" maven="org.apache.camel:camel-kubernetes:3.0.0-SNAPSHOT" since="2.17.0" description="The Kubernetes Service Accounts component provides a producer to execute service operations and a consumer to consume service events."> | |
| <property name="apiVersion" type="string" display="Api Version" description="The Kubernetes API Version to use"/> | |
| <property name="caCertData" type="string" display="Ca Cert Data" label="security" secret="true" description="The CA Cert Data"/> | |
| <property name="caCertFile" type="string" display="Ca Cert File" label="security" secret="true" description="The CA Cert File"/> | |
| <property name="clientCertData" type="string" display="Client Cert Data" label="security" secret="true" description="The Client Cert Data"/> | |
| <property name="clientCertFile" type="string" display="Client Cert File" label="security" secret="true" description="The Client Cert File"/> | |
| <property name="clientKeyAlgo" type="string" display="Client Key Algo" label="security" secret="true" description="The Key Algorithm used by the client"/> | |
| <property name="clientKeyData" type="string" display="Client Key Data" label="security" secret="true" description="The Client Key data"/> | |
| <property name="clientKeyFile" type="string" display="Client Key File" label="security" secret="true" description="The Client Key file"/> | |
| <property name="clientKeyPassphrase" type="string" display="Client Key Passphrase" label="security" secret="true" description="The Client Key Passphrase"/> | |
| <property name="connectionTimeout" type="int" display="Connection Timeout" label="advanced" description="Connection timeout in milliseconds to use when making requests to the Kubernetes API server."/> | |
| <property name="dnsDomain" type="string" display="Dns Domain" description="The dns domain, used for ServiceCall EIP"/> | |
| <property name="kubernetesClient" type="java:io.fabric8.kubernetes.client.KubernetesClient" display="Kubernetes Client" description="Default KubernetesClient to use if provided"/> | |
| <property name="labelKey" type="string" display="Label Key" label="consumer" description="The Consumer Label key when watching at some resources"/> | |
| <property name="labelValue" type="string" display="Label Value" label="consumer" description="The Consumer Label value when watching at some resources"/> | |
| <property name="masterUrl" type="string" display="Master Url" required="true" kind="path" description="Kubernetes Master url"/> | |
| <property name="namespace" type="string" display="Namespace" label="consumer" description="The namespace"/> | |
| <property name="oauthToken" type="string" display="Oauth Token" label="security" secret="true" description="The Auth Token"/> | |
| <property name="operation" type="string" display="Operation" label="producer" description="Producer operation to do on Kubernetes"/> | |
| <property name="password" type="string" display="Password" label="security" secret="true" description="Password to connect to Kubernetes"/> | |
| <property name="poolSize" type="int" display="Pool Size" label="consumer" description="The Consumer pool size"/> | |
| <property name="portName" type="string" display="Port Name" description="The port name, used for ServiceCall EIP"/> | |
| <property name="portProtocol" type="string" display="Port Protocol" description="The port protocol, used for ServiceCall EIP"/> | |
| <property name="resourceName" type="string" display="Resource Name" label="consumer" description="The Consumer Resource Name we would like to watch"/> | |
| <property name="trustCerts" type="boolean" display="Trust Certs" label="security" secret="true" description="Define if the certs we used are trusted anyway or not"/> | |
| <property name="username" type="string" display="Username" label="security" secret="true" description="Username to connect to Kubernetes"/> | |
| </endpoint> | |
| <endpoint name="language" display="Language" label="core,script" extends="model:endpoint" javaType="org.apache.camel.component.language.LanguageComponent" maven="org.apache.camel:camel-language:3.0.0-SNAPSHOT" producerOnly="true" since="2.5.0" description="The language component allows you to send a message to an endpoint which executes a script by any of the supported Languages in Camel."> | |
| <property name="binary" type="boolean" display="Binary" description="Whether the script is binary content or text content. By default the script is read as text content (eg java.lang.String)"/> | |
| <property name="cacheScript" type="boolean" display="Cache Script" description="Whether to cache the compiled script and reuse Notice reusing the script can cause side effects from processing one Camel org.apache.camel.Exchange to the next org.apache.camel.Exchange."/> | |
| <property name="contentCache" type="boolean" display="Content Cache" description="Sets whether to use resource content cache or not"/> | |
| <property name="languageName" type="string" display="Language Name" required="true" kind="path" description="Sets the name of the language to use"/> | |
| <property name="resourceUri" type="string" display="Resource Uri" kind="path" description="Path to the resource, or a reference to lookup a bean in the Registry to use as the resource"/> | |
| <property name="script" type="string" display="Script" description="Sets the script to execute"/> | |
| <property name="transform" type="boolean" display="Transform" description="Whether or not the result of the script should be used as message body. This options is default true."/> | |
| </endpoint> | |
| <endpoint name="ldap" display="LDAP" label="ldap" extends="model:endpoint" javaType="org.apache.camel.component.ldap.LdapComponent" maven="org.apache.camel:camel-ldap:3.0.0-SNAPSHOT" producerOnly="true" since="1.5.0" description="The ldap component allows you to perform searches in LDAP servers using filters as the message payload."> | |
| <property name="base" type="string" display="Base" description="The base DN for searches."/> | |
| <property name="dirContextName" type="string" display="Dir Context Name" required="true" kind="path" description="Name of either a javax.naming.directory.DirContext, or java.util.Hashtable, or Map bean to lookup in the registry. If the bean is either a Hashtable or Map then a new javax.naming.directory.DirContext instance is created for each use. If the bean is a javax.naming.directory.DirContext then the bean is used as given. The latter may not be possible in all situations where the javax.naming.directory.DirContext must not be shared, and in those situations it can be better to use java.util.Hashtable or Map instead."/> | |
| <property name="pageSize" type="int" display="Page Size" description="When specified the ldap module uses paging to retrieve all results (most LDAP Servers throw an exception when trying to retrieve more than 1000 entries in one query). To be able to use this a LdapContext (subclass of DirContext) has to be passed in as ldapServerBean (otherwise an exception is thrown)"/> | |
| <property name="returnedAttributes" type="string" display="Returned Attributes" description="Comma-separated list of attributes that should be set in each entry of the result"/> | |
| <property name="scope" type="string" display="Scope" description="Specifies how deeply to search the tree of entries, starting at the base DN."/> | |
| </endpoint> | |
| <endpoint name="ldif" display="LDIF" label="ldap" extends="model:endpoint" javaType="org.apache.camel.component.ldif.LdifComponent" maven="org.apache.camel:camel-ldif:3.0.0-SNAPSHOT" producerOnly="true" since="2.20.0" description="The ldif component allows you to do updates on an LDAP server from a LDIF body content."> | |
| <property name="ldapConnectionName" type="string" display="Ldap Connection Name" required="true" kind="path" description="The name of the LdapConnection bean to pull from the registry. Note that this must be of scope prototype to avoid it being shared among threads or using a connection that has timed out."/> | |
| </endpoint> | |
| <endpoint name="linkedin" display="Linkedin" label="api,cloud,social" extends="model:endpoint" javaType="org.apache.camel.component.linkedin.LinkedInComponent" maven="org.apache.camel:camel-linkedin:3.0.0-SNAPSHOT" lenient="true" since="2.14.0" description="The linkedin component is used for retrieving LinkedIn user profiles, connections, companies, groups, posts, etc."> | |
| <property name="accessToken" type="string" display="Access Token" description="LinkedIn access token to avoid username and password login procedure. LinkedIn responds to login forms by using a CAPTCHA. This makes it impossible for a standalone, headless process to log in to LinkedIn by specifying a username and password. To work around this, obtain a LinkedIn access token and provide the token as the setting of the accessToken parameter. Obtaining a LinkedIn access token is a multi-step procedure. You must configure your LinkedIn application, obtain a LinkedIn authorization code, and exchange that code for the LinkedIn access token. For details, see: https://developer.linkedin.com/docs/oauth2 The default behavior is that the access token expires after 60 days. To change this, specify a value for the expiryTime paramter. If the access token expires, the LinkedIn component tries to log in to LinkedIn by providing a username and password, which results in a CAPTCHA so the login fails. The LinkedIn component cannot refresh the access token. You must manually obtain a new access token each time an access token expires. When you update the access token you must restart the application so that it uses the new token."/> | |
| <property name="apiName" type="enum:LinkedInApiName(comments,companies,groups,jobs,people,posts,search)" display="Api Name" required="true" kind="path" description="What kind of operation to perform"/> | |
| <property name="clientId" type="string" display="Client Id" description="LinkedIn application client ID"/> | |
| <property name="clientSecret" type="string" display="Client Secret" description="LinkedIn application client secret"/> | |
| <property name="expiryTime" type="long" display="Expiry Time" description="A number of milliseconds since the UNIX Epoch. The default is 60 days. A LinkedIn access token expires when this amount of time elapses after the token is in use."/> | |
| <property name="httpParams" type="map(string,object)" display="Http Params" description="Custom HTTP parameters, for example, proxy host and port. Use constants from AllClientPNames."/> | |
| <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="lazyAuth" type="boolean" display="Lazy Auth" description="Flag to enable/disable lazy OAuth, default is true. When enabled, OAuth token retrieval or generation is not done until the first REST call."/> | |
| <property name="methodName" type="string" display="Method Name" required="true" kind="path" description="What sub operation to use for the selected operation"/> | |
| <property name="redirectUri" type="string" display="Redirect Uri" description="Application redirect URI, although the component never redirects to this page to avoid having to have a functioning redirect server. For testing, one could use https://localhost."/> | |
| <property name="scopes" type="java:org.apache.camel.component.linkedin.api.OAuthScope[]" display="Scopes" description="List of LinkedIn scopes as specified at https://developer.linkedin.com/documents/authentication#granting"/> | |
| <property name="secureStorage" type="java:org.apache.camel.component.linkedin.api.OAuthSecureStorage" display="Secure Storage" description="Callback interface for providing an OAuth token or to store the token generated by the component. The callback should return null on the first call and then save the created token in the saveToken() callback. If the callback returns null the first time, a userPassword MUST be provided."/> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment