You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2017/03/17 16:24:09 UTC
[01/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Repository: camel
Updated Branches:
refs/heads/master e43230a01 -> db81a114e
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc
index 1e3bab5..aa617d1 100644
--- a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc
+++ b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc
@@ -229,15 +229,12 @@ The XML Security component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| signerConfiguration | | XmlSignerConfiguration | To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints.
-
-| verifierConfiguration | | XmlVerifierConfiguration | To use a shared XmlVerifierConfiguration configuration to use as base for configuring endpoints.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **signerConfiguration** (advanced) | To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints. | | XmlSignerConfiguration
+| **verifierConfiguration** (advanced) | To use a shared XmlVerifierConfiguration configuration to use as base for configuring endpoints. | | XmlVerifier Configuration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -258,88 +255,53 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| command | | XmlCommand | *Required* Whether to sign or verify.
-| name | | String | *Required* The name part in the URI can be chosen by the user to distinguish between different signer/verifier endpoints within the camel context.
+| Name | Description | Default | Type
+| **command** | *Required* Whether to sign or verify. | | XmlCommand
+| **name** | *Required* The name part in the URI can be chosen by the user to distinguish between different signer/verifier endpoints within the camel context. | | String
|=======================================================================
#### Query Parameters (35 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| baseUri | | String | You can set a base URI which is used in the URI dereferencing. Relative URIs are then concatenated with the base URI.
-
-| clearHeaders | true | Boolean | Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true.
-
-| cryptoContextProperties | | Map | Sets the crypto context properties. See link XMLCryptoContextsetProperty(String Object). Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value link BooleanTRUE for the XML validation. If you want to switch these features off you must set the property value to link BooleanFALSE. org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference
-
-| disallowDoctypeDecl | true | Boolean | Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is link BooleanTRUE.
-
-| omitXmlDeclaration | false | Boolean | Indicator whether the XML declaration in the outgoing message body should be omitted. Default value is false. Can be overwritten by the header link XmlSignatureConstantsHEADER_OMIT_XML_DECLARATION.
-
-| outputXmlEncoding | | String | The character encoding of the resulting signed XML document. If null then the encoding of the original XML document is used.
-
-| schemaResourceUri | | String | Classpath to the XML Schema. Must be specified in the detached XML Signature case for determining the ID attributes might be set in the enveloped and enveloping case. If set then the XML document is validated with the specified XML schema. The schema resource URI can be overwritten by the header link XmlSignatureConstantsHEADER_SCHEMA_RESOURCE_URI.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| uriDereferencer | | URIDereferencer | If you want to restrict the remote access via reference URIs you can set an own dereferencer. Optional parameter. If not set the provider default dereferencer is used which can resolve URI fragments HTTP file and XPpointer URIs. Attention: The implementation is provider dependent!
- 4+^s| sign
-| addKeyInfoReference | true | Boolean | In order to protect the KeyInfo element from tampering you can add a reference to the signed info element so that it is protected via the signature value. The default value is true. Only relevant when a KeyInfo is returned by KeyAccessor. and link KeyInfogetId() is not null.
-
-| canonicalizationMethod | http://www.w3.org/TR/2001/REC-xml-c14n-20010315 | AlgorithmMethod | Canonicalization method used to canonicalize the SignedInfo element before the digest is calculated. You can use the helper methods XmlSignatureHelper.getCanonicalizationMethod(String algorithm) or getCanonicalizationMethod(String algorithm List inclusiveNamespacePrefixes) to create a canonicalization method.
-
-| contentObjectId | | String | Sets the content object Id attribute value. By default a UUID is generated. If you set the null value then a new UUID will be generated. Only used in the enveloping case.
-
-| contentReferenceType | | String | Type of the content reference. The default value is null. This value can be overwritten by the header link XmlSignatureConstantsHEADER_CONTENT_REFERENCE_TYPE.
-
-| contentReferenceUri | | String | Reference URI for the content to be signed. Only used in the enveloped case. If the reference URI contains an ID attribute value then the resource schema URI ( link setSchemaResourceUri(String)) must also be set because the schema validator will then find out which attributes are ID attributes. Will be ignored in the enveloping or detached case.
-
-| digestAlgorithm | | String | Digest algorithm URI. Optional parameter. This digest algorithm is used for calculating the digest of the input message. If this digest algorithm is not specified then the digest algorithm is calculated from the signature algorithm. Example: http://www.w3.org/2001/04/xmlencsha256
-
-| keyAccessor | | KeyAccessor | For the signing process a private key is necessary. You specify a key accessor bean which provides this private key. The key accessor bean must implement the KeyAccessor interface. The package org.apache.camel.component.xmlsecurity.api contains the default implementation class DefaultKeyAccessor which reads the private key from a Java keystore.
-
-| parentLocalName | | String | Local name of the parent element to which the XML signature element will be added. Only relevant for enveloped XML signature. Alternatively you can also use link setParentXpath(XPathFilterParameterSpec). Default value is null. The value must be null for enveloping and detached XML signature. This parameter or the parameter link setParentXpath(XPathFilterParameterSpec) for enveloped signature and the parameter link setXpathsToIdAttributes(List) for detached signature must not be set in the same configuration. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown.
-
-| parentNamespace | | String | Namespace of the parent element to which the XML signature element will be added.
-
-| parentXpath | | XPathFilterParameterSpec | Sets the XPath to find the parent node in the enveloped case. Either you specify the parent node via this method or the local name and namespace of the parent with the methods link setParentLocalName(String) and link setParentNamespace(String). Default value is null. The value must be null for enveloping and detached XML signature. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown.
-
-| plainText | false | Boolean | Indicator whether the message body contains plain text. The default value is false indicating that the message body contains XML. The value can be overwritten by the header link XmlSignatureConstantsHEADER_MESSAGE_IS_PLAIN_TEXT.
-
-| plainTextEncoding | UTF-8 | String | Encoding of the plain text. Only relevant if the message body is plain text (see parameter link plainText. Default value is UTF-8.
-
-| prefixForXmlSignatureNamespace | ds | String | Namespace prefix for the XML signature namespace http://www.w3.org/2000/09/xmldsig. Default value is ds. If null or an empty value is set then no prefix is used for the XML signature namespace. See best practice http://www.w3.org/TR/xmldsig-bestpractices/signing-xml- without-namespaces
-
-| properties | | XmlSignatureProperties | For adding additional References and Objects to the XML signature which contain additional properties you can provide a bean which implements the XmlSignatureProperties interface.
-
-| signatureAlgorithm | http://www.w3.org/2000/09/xmldsig#rsa-sha1 | String | Signature algorithm. Default value is http://www.w3.org/2000/09/xmldsigrsa-sha1.
-
-| signatureId | | String | Sets the signature Id. If this parameter is not set (null value) then a unique ID is generated for the signature ID (default). If this parameter is set to (empty string) then no Id attribute is created in the signature element.
-
-| transformMethods | | List | Transforms which are executed on the message body before the digest is calculated. By default C14n is added and in the case of enveloped signature (see option parentLocalName) also http://www.w3.org/2000/09/xmldsigenveloped-signature is added at position 0 of the list. Use methods in XmlSignatureHelper to create the transform methods.
-
-| xpathsToIdAttributes | | List | Define the elements which are signed in the detached case via XPATH expressions to ID attributes (attributes of type ID). For each element found via the XPATH expression a detached signature is created whose reference URI contains the corresponding attribute value (preceded by ''). The signature becomes the last sibling of the signed element. Elements with deeper hierarchy level are signed first. You can also set the XPATH list dynamically via the header link XmlSignatureConstantsHEADER_XPATHS_TO_ID_ATTRIBUTES. The parameter link setParentLocalName(String) or link setParentXpath(XPathFilterParameterSpec) for enveloped signature and this parameter for detached signature must not be set in the same configuration.
- 4+^s| verify
-| keySelector | | KeySelector | Provides the key for validating the XML signature.
-
-| outputNodeSearch | | String | Sets the output node search value for determining the node from the XML signature document which shall be set to the output message body. The class of the value depends on the type of the output node search. The output node search is forwarded to XmlSignature2Message.
-
-| outputNodeSearchType | Default | String | Determines the search type for determining the output node which is serialized into the output message bodyF. See link setOutputNodeSearch(Object). The supported default search types you can find in DefaultXmlSignature2Message.
-
-| removeSignatureElements | false | Boolean | Indicator whether the XML signature elements (elements with local name Signature and namesapce http://www.w3.org/2000/09/xmldsig) shall be removed from the document set to the output message. Normally this is only necessary if the XML signature is enveloped. The default value is link BooleanFALSE. This parameter is forwarded to XmlSignature2Message. This indicator has no effect if the output node search is of type link DefaultXmlSignature2MessageOUTPUT_NODE_SEARCH_TYPE_DEFAULT.F
-
-| secureValidation | true | Boolean | Enables secure validation. If true then secure validation is enabled.
-
-| validationFailedHandler | | ValidationFailedHandler | Handles the different validation failed situations. The default implementation throws specific exceptions for the different situations (All exceptions have the package name org.apache.camel.component.xmlsecurity.api and are a sub-class of XmlSignatureInvalidException. If the signature value validation fails a XmlSignatureInvalidValueException is thrown. If a reference validation fails a XmlSignatureInvalidContentHashException is thrown. For more detailed information see the JavaDoc.
-
-| xmlSignature2Message | | XmlSignature2Message | Bean which maps the XML signature to the output-message after the validation. How this mapping should be done can be configured by the options outputNodeSearchType outputNodeSearch and removeSignatureElements. The default implementation offers three possibilities which are related to the three output node search types Default ElementName and XPath. The default implementation determines a node which is then serialized and set to the body of the output message If the search type is ElementName then the output node (which must be in this case an element) is determined by the local name and namespace defined in the search value (see option outputNodeSearch). If the search type is XPath then the output node is determined by the XPath specified in the search value (in this case the output node can be of type Element TextNode or Document). If the output node search type is Default then the following rules apply: In the enveloped XML signat
ure case (there is a reference with URI= and transform http://www.w3.org/2000/09/xmldsigenveloped-signature) the incoming XML document without the Signature element is set to the output message body. In the non-enveloped XML signature case the message body is determined from a referenced Object; this is explained in more detail in chapter Output Node Determination in Enveloping XML Signature Case.
-
-| xmlSignatureChecker | | XmlSignatureChecker | This interface allows the application to check the XML signature before the validation is executed. This step is recommended in http://www.w3.org/TR/xmldsig-bestpractices/check-what-is-signed
+| Name | Description | Default | Type
+| **baseUri** (common) | You can set a base URI which is used in the URI dereferencing. Relative URIs are then concatenated with the base URI. | | String
+| **clearHeaders** (common) | Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true. | true | Boolean
+| **cryptoContextProperties** (common) | Sets the crypto context properties. See link XMLCryptoContextsetProperty(String Object). Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value link BooleanTRUE for the XML validation. If you want to switch these features off you must set the property value to link BooleanFALSE. org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference | | Map
+| **disallowDoctypeDecl** (common) | Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is link BooleanTRUE. | true | Boolean
+| **omitXmlDeclaration** (common) | Indicator whether the XML declaration in the outgoing message body should be omitted. Default value is false. Can be overwritten by the header link XmlSignatureConstantsHEADER_OMIT_XML_DECLARATION. | false | Boolean
+| **outputXmlEncoding** (common) | The character encoding of the resulting signed XML document. If null then the encoding of the original XML document is used. | | String
+| **schemaResourceUri** (common) | Classpath to the XML Schema. Must be specified in the detached XML Signature case for determining the ID attributes might be set in the enveloped and enveloping case. If set then the XML document is validated with the specified XML schema. The schema resource URI can be overwritten by the header link XmlSignatureConstantsHEADER_SCHEMA_RESOURCE_URI. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **uriDereferencer** (advanced) | If you want to restrict the remote access via reference URIs you can set an own dereferencer. Optional parameter. If not set the provider default dereferencer is used which can resolve URI fragments HTTP file and XPpointer URIs. Attention: The implementation is provider dependent! | | URIDereferencer
+| **addKeyInfoReference** (sign) | In order to protect the KeyInfo element from tampering you can add a reference to the signed info element so that it is protected via the signature value. The default value is true. Only relevant when a KeyInfo is returned by KeyAccessor. and link KeyInfogetId() is not null. | true | Boolean
+| **canonicalizationMethod** (sign) | Canonicalization method used to canonicalize the SignedInfo element before the digest is calculated. You can use the helper methods XmlSignatureHelper.getCanonicalizationMethod(String algorithm) or getCanonicalizationMethod(String algorithm List inclusiveNamespacePrefixes) to create a canonicalization method. | http://www.w3.org/TR/2001/REC-xml-c14n-20010315 | AlgorithmMethod
+| **contentObjectId** (sign) | Sets the content object Id attribute value. By default a UUID is generated. If you set the null value then a new UUID will be generated. Only used in the enveloping case. | | String
+| **contentReferenceType** (sign) | Type of the content reference. The default value is null. This value can be overwritten by the header link XmlSignatureConstantsHEADER_CONTENT_REFERENCE_TYPE. | | String
+| **contentReferenceUri** (sign) | Reference URI for the content to be signed. Only used in the enveloped case. If the reference URI contains an ID attribute value then the resource schema URI ( link setSchemaResourceUri(String)) must also be set because the schema validator will then find out which attributes are ID attributes. Will be ignored in the enveloping or detached case. | | String
+| **digestAlgorithm** (sign) | Digest algorithm URI. Optional parameter. This digest algorithm is used for calculating the digest of the input message. If this digest algorithm is not specified then the digest algorithm is calculated from the signature algorithm. Example: http://www.w3.org/2001/04/xmlencsha256 | | String
+| **keyAccessor** (sign) | For the signing process a private key is necessary. You specify a key accessor bean which provides this private key. The key accessor bean must implement the KeyAccessor interface. The package org.apache.camel.component.xmlsecurity.api contains the default implementation class DefaultKeyAccessor which reads the private key from a Java keystore. | | KeyAccessor
+| **parentLocalName** (sign) | Local name of the parent element to which the XML signature element will be added. Only relevant for enveloped XML signature. Alternatively you can also use link setParentXpath(XPathFilterParameterSpec). Default value is null. The value must be null for enveloping and detached XML signature. This parameter or the parameter link setParentXpath(XPathFilterParameterSpec) for enveloped signature and the parameter link setXpathsToIdAttributes(List) for detached signature must not be set in the same configuration. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown. | | String
+| **parentNamespace** (sign) | Namespace of the parent element to which the XML signature element will be added. | | String
+| **parentXpath** (sign) | Sets the XPath to find the parent node in the enveloped case. Either you specify the parent node via this method or the local name and namespace of the parent with the methods link setParentLocalName(String) and link setParentNamespace(String). Default value is null. The value must be null for enveloping and detached XML signature. If the parameters parentXpath and parentLocalName are specified in the same configuration then an exception is thrown. | | XPathFilterParameter Spec
+| **plainText** (sign) | Indicator whether the message body contains plain text. The default value is false indicating that the message body contains XML. The value can be overwritten by the header link XmlSignatureConstantsHEADER_MESSAGE_IS_PLAIN_TEXT. | false | Boolean
+| **plainTextEncoding** (sign) | Encoding of the plain text. Only relevant if the message body is plain text (see parameter link plainText. Default value is UTF-8. | UTF-8 | String
+| **prefixForXmlSignature Namespace** (sign) | Namespace prefix for the XML signature namespace http://www.w3.org/2000/09/xmldsig. Default value is ds. If null or an empty value is set then no prefix is used for the XML signature namespace. See best practice http://www.w3.org/TR/xmldsig-bestpractices/signing-xml- without-namespaces | ds | String
+| **properties** (sign) | For adding additional References and Objects to the XML signature which contain additional properties you can provide a bean which implements the XmlSignatureProperties interface. | | XmlSignatureProperties
+| **signatureAlgorithm** (sign) | Signature algorithm. Default value is http://www.w3.org/2000/09/xmldsigrsa-sha1. | http://www.w3.org/2000/09/xmldsig#rsa-sha1 | String
+| **signatureId** (sign) | Sets the signature Id. If this parameter is not set (null value) then a unique ID is generated for the signature ID (default). If this parameter is set to (empty string) then no Id attribute is created in the signature element. | | String
+| **transformMethods** (sign) | Transforms which are executed on the message body before the digest is calculated. By default C14n is added and in the case of enveloped signature (see option parentLocalName) also http://www.w3.org/2000/09/xmldsigenveloped-signature is added at position 0 of the list. Use methods in XmlSignatureHelper to create the transform methods. | | List
+| **xpathsToIdAttributes** (sign) | Define the elements which are signed in the detached case via XPATH expressions to ID attributes (attributes of type ID). For each element found via the XPATH expression a detached signature is created whose reference URI contains the corresponding attribute value (preceded by ''). The signature becomes the last sibling of the signed element. Elements with deeper hierarchy level are signed first. You can also set the XPATH list dynamically via the header link XmlSignatureConstantsHEADER_XPATHS_TO_ID_ATTRIBUTES. The parameter link setParentLocalName(String) or link setParentXpath(XPathFilterParameterSpec) for enveloped signature and this parameter for detached signature must not be set in the same configuration. | | List
+| **keySelector** (verify) | Provides the key for validating the XML signature. | | KeySelector
+| **outputNodeSearch** (verify) | Sets the output node search value for determining the node from the XML signature document which shall be set to the output message body. The class of the value depends on the type of the output node search. The output node search is forwarded to XmlSignature2Message. | | String
+| **outputNodeSearchType** (verify) | Determines the search type for determining the output node which is serialized into the output message bodyF. See link setOutputNodeSearch(Object). The supported default search types you can find in DefaultXmlSignature2Message. | Default | String
+| **removeSignatureElements** (verify) | Indicator whether the XML signature elements (elements with local name Signature and namesapce http://www.w3.org/2000/09/xmldsig) shall be removed from the document set to the output message. Normally this is only necessary if the XML signature is enveloped. The default value is link BooleanFALSE. This parameter is forwarded to XmlSignature2Message. This indicator has no effect if the output node search is of type link DefaultXmlSignature2MessageOUTPUT_NODE_SEARCH_TYPE_DEFAULT.F | false | Boolean
+| **secureValidation** (verify) | Enables secure validation. If true then secure validation is enabled. | true | Boolean
+| **validationFailedHandler** (verify) | Handles the different validation failed situations. The default implementation throws specific exceptions for the different situations (All exceptions have the package name org.apache.camel.component.xmlsecurity.api and are a sub-class of XmlSignatureInvalidException. If the signature value validation fails a XmlSignatureInvalidValueException is thrown. If a reference validation fails a XmlSignatureInvalidContentHashException is thrown. For more detailed information see the JavaDoc. | | ValidationFailedHandler
+| **xmlSignature2Message** (verify) | Bean which maps the XML signature to the output-message after the validation. How this mapping should be done can be configured by the options outputNodeSearchType outputNodeSearch and removeSignatureElements. The default implementation offers three possibilities which are related to the three output node search types Default ElementName and XPath. The default implementation determines a node which is then serialized and set to the body of the output message If the search type is ElementName then the output node (which must be in this case an element) is determined by the local name and namespace defined in the search value (see option outputNodeSearch). If the search type is XPath then the output node is determined by the XPath specified in the search value (in this case the output node can be of type Element TextNode or Document). If the output node search type is Default then the following rules apply: In the enveloped XML signature case (the
re is a reference with URI= and transform http://www.w3.org/2000/09/xmldsigenveloped-signature) the incoming XML document without the Signature element is set to the output message body. In the non-enveloped XML signature case the message body is determined from a referenced Object; this is explained in more detail in chapter Output Node Determination in Enveloping XML Signature Case. | | XmlSignature2Message
+| **xmlSignatureChecker** (verify) | This interface allows the application to check the XML signature before the validation is executed. This step is recommended in http://www.w3.org/TR/xmldsig-bestpractices/check-what-is-signed | | XmlSignatureChecker
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-xmpp/src/main/docs/xmpp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-xmpp/src/main/docs/xmpp-component.adoc b/components/camel-xmpp/src/main/docs/xmpp-component.adoc
index 6ec9458..bdb42cc 100644
--- a/components/camel-xmpp/src/main/docs/xmpp-component.adoc
+++ b/components/camel-xmpp/src/main/docs/xmpp-component.adoc
@@ -51,55 +51,37 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* Hostname for the chat server
-| port | | int | *Required* Port number for the chat server
-| participant | | String | JID (Jabber ID) of person to receive messages. room parameter has precedence over participant.
+| Name | Description | Default | Type
+| **host** | *Required* Hostname for the chat server | | String
+| **port** | *Required* Port number for the chat server | | int
+| **participant** | JID (Jabber ID) of person to receive messages. room parameter has precedence over participant. | | String
|=======================================================================
#### Query Parameters (18 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| login | true | boolean | Whether to login the user.
-
-| nickname | | String | Use nickname when joining room. If room is specified and nickname is not user will be used for the nickname.
-
-| pubsub | false | boolean | Accept pubsub packets on input default is false
-
-| room | | String | If this option is specified the component will connect to MUC (Multi User Chat). Usually the domain name for MUC is different from the login domain. For example if you are supermanjabber.org and want to join the krypton room then the room URL is kryptonconference.jabber.org. Note the conference part. It is not a requirement to provide the full room JID. If the room parameter does not contain the symbol the domain part will be discovered and added by Camel
-
-| serviceName | | String | The name of the service you are connecting to. For Google Talk this would be gmail.com.
-
-| testConnectionOnStartup | true | boolean | Specifies whether to test the connection on startup. This is used to ensure that the XMPP client has a valid connection to the XMPP server when the route starts. Camel throws an exception on startup if a connection cannot be established. When this option is set to false Camel will attempt to establish a lazy connection when needed by a producer and will poll for a consumer connection until the connection is established. Default is true.
- 4+^s| common (advanced)
-| createAccount | false | boolean | If true an attempt to create an account will be made. Default is false.
-
-| resource | Camel | String | XMPP resource. The default is Camel.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| connectionPollDelay | 10 | int | The amount of time in seconds between polls (in seconds) to verify the health of the XMPP connection or between attempts to establish an initial consumer connection. Camel will try to re-establish a connection if it has become inactive. Default is 10 seconds.
-
-| doc | false | boolean | Set a doc header on the IN message containing a Document form of the incoming packet; default is true if presence or pubsub are true otherwise false
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| connectionConfig | | ConnectionConfiguration | To use an existing connection configuration
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| security
-| password | | String | Password for login
-
-| user | | String | User name (without server name). If not specified anonymous login will be attempted.
+| Name | Description | Default | Type
+| **login** (common) | Whether to login the user. | true | boolean
+| **nickname** (common) | Use nickname when joining room. If room is specified and nickname is not user will be used for the nickname. | | String
+| **pubsub** (common) | Accept pubsub packets on input default is false | false | boolean
+| **room** (common) | If this option is specified the component will connect to MUC (Multi User Chat). Usually the domain name for MUC is different from the login domain. For example if you are supermanjabber.org and want to join the krypton room then the room URL is kryptonconference.jabber.org. Note the conference part. It is not a requirement to provide the full room JID. If the room parameter does not contain the symbol the domain part will be discovered and added by Camel | | String
+| **serviceName** (common) | The name of the service you are connecting to. For Google Talk this would be gmail.com. | | String
+| **testConnectionOnStartup** (common) | Specifies whether to test the connection on startup. This is used to ensure that the XMPP client has a valid connection to the XMPP server when the route starts. Camel throws an exception on startup if a connection cannot be established. When this option is set to false Camel will attempt to establish a lazy connection when needed by a producer and will poll for a consumer connection until the connection is established. Default is true. | true | boolean
+| **createAccount** (common) | If true an attempt to create an account will be made. Default is false. | false | boolean
+| **resource** (common) | XMPP resource. The default is Camel. | Camel | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **connectionPollDelay** (consumer) | The amount of time in seconds between polls (in seconds) to verify the health of the XMPP connection or between attempts to establish an initial consumer connection. Camel will try to re-establish a connection if it has become inactive. Default is 10 seconds. | 10 | int
+| **doc** (consumer) | Set a doc header on the IN message containing a Document form of the incoming packet; default is true if presence or pubsub are true otherwise false | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **connectionConfig** (advanced) | To use an existing connection configuration | | ConnectionConfiguration
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **headerFilterStrategy** (filter) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **password** (security) | Password for login | | String
+| **user** (security) | User name (without server name). If not specified anonymous login will be attempted. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-yammer/src/main/docs/yammer-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-yammer/src/main/docs/yammer-component.adoc b/components/camel-yammer/src/main/docs/yammer-component.adoc
index 8133145..1ee132c 100644
--- a/components/camel-yammer/src/main/docs/yammer-component.adoc
+++ b/components/camel-yammer/src/main/docs/yammer-component.adoc
@@ -45,19 +45,14 @@ The Yammer component supports 5 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| security
-| consumerKey | | String | The consumer key
-
-| consumerSecret | | String | The consumer secret
-
-| accessToken | | String | The access token
- 4+^s| advanced
-| config | | YammerConfiguration | To use a shared yammer configuration
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **consumerKey** (security) | The consumer key | | String
+| **consumerSecret** (security) | The consumer secret | | String
+| **accessToken** (security) | The access token | | String
+| **config** (advanced) | To use a shared yammer configuration | | YammerConfiguration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -79,73 +74,45 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| function | | YammerFunctionType | *Required* The function to use
+| Name | Description | Default | Type
+| **function** | *Required* The function to use | | YammerFunctionType
|=======================================================================
#### Query Parameters (28 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| useJson | false | boolean | Set to true if you want to use raw JSON rather than converting to POJOs.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| delay | 5000 | long | Delay between polling in millis
-
-| limit | -1 | int | Return only the specified number of messages. Works for threaded=true and threaded=extended.
-
-| newerThan | -1 | int | Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you're looking at messages and the most recent message returned is 3516 you can make a request with the parameter newerThan=3516 to ensure that you do not get duplicate copies of messages already on your page.
-
-| olderThan | -1 | int | Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example if you're currently viewing 20 messages and the oldest is number 2912 you could append olderThan=2912 to your request to get the 20 messages prior to those you're seeing.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| threaded | | String | threaded=true will only return the first message in each thread. This parameter is intended for apps which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages as they are viewed in the default view on the Yammer web interface.
-
-| userId | | String | The user id
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| security
-| accessToken | | String | *Required* The access token
-
-| consumerKey | | String | *Required* The consumer key
-
-| consumerSecret | | String | *Required* The consumer secret
+| Name | Description | Default | Type
+| **useJson** (common) | Set to true if you want to use raw JSON rather than converting to POJOs. | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **delay** (consumer) | Delay between polling in millis | 5000 | long
+| **limit** (consumer) | Return only the specified number of messages. Works for threaded=true and threaded=extended. | -1 | int
+| **newerThan** (consumer) | Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you're looking at messages and the most recent message returned is 3516 you can make a request with the parameter newerThan=3516 to ensure that you do not get duplicate copies of messages already on your page. | -1 | int
+| **olderThan** (consumer) | Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example if you're currently viewing 20 messages and the oldest is number 2912 you could append olderThan=2912 to your request to get the 20 messages prior to those you're seeing. | -1 | int
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **threaded** (consumer) | threaded=true will only return the first message in each thread. This parameter is intended for apps which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages as they are viewed in the default view on the Yammer web interface. | | String
+| **userId** (consumer) | The user id | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **accessToken** (security) | *Required* The access token | | String
+| **consumerKey** (security) | *Required* The consumer key | | String
+| **consumerSecret** (security) | *Required* The consumer secret | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc b/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc
index 24e9923..b2f1fbe 100644
--- a/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc
+++ b/components/camel-zookeeper-master/src/main/docs/zookeeper-master-component.adoc
@@ -37,23 +37,16 @@ The ZooKeeper Master component supports 7 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| containerIdFactory | | ContainerIdFactory | To use a custom ContainerIdFactory for creating container ids.
-
-| zkRoot | /camel/zookeepermaster/clusters/master | String | The root path to use in zookeeper where information is stored which nodes are master/slave etc. Will by default use: /camel/zookeepermaster/clusters/master
- 4+^s| advanced
-| curator | | CuratorFramework | To use a custom configured CuratorFramework as connection to zookeeper ensemble.
- 4+^s| consumer
-| maximumConnectionTimeout | 10000 | int | Timeout in millis to use when connecting to the zookeeper ensemble
-
-| zooKeeperUrl | localhost:2181 | String | The url for the zookeeper ensemble
- 4+^s| security
-| zooKeeperPassword | | String | The password to use when connecting to the zookeeper ensemble
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **containerIdFactory** (consumer) | To use a custom ContainerIdFactory for creating container ids. | | ContainerIdFactory
+| **zkRoot** (consumer) | The root path to use in zookeeper where information is stored which nodes are master/slave etc. Will by default use: /camel/zookeepermaster/clusters/master | /camel/zookeepermaster/clusters/master | String
+| **curator** (advanced) | To use a custom configured CuratorFramework as connection to zookeeper ensemble. | | CuratorFramework
+| **maximumConnection Timeout** (consumer) | Timeout in millis to use when connecting to the zookeeper ensemble | 10000 | int
+| **zooKeeperUrl** (consumer) | The url for the zookeeper ensemble | localhost:2181 | String
+| **zooKeeperPassword** (security) | The password to use when connecting to the zookeeper ensemble | | String
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -66,26 +59,22 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| groupName | | String | *Required* The name of the cluster group to use
-| consumerEndpointUri | | String | *Required* The consumer endpoint to use in master/slave mode
+| Name | Description | Default | Type
+| **groupName** | *Required* The name of the cluster group to use | | String
+| **consumerEndpointUri** | *Required* The consumer endpoint to use in master/slave mode | | String
|=======================================================================
#### Query Parameters (4 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
index 8a6d74b..ffce3cd 100644
--- a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
+++ b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc
@@ -45,13 +45,11 @@ The ZooKeeper component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | ZooKeeperConfiguration | To use a shared ZooKeeperConfiguration
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use a shared ZooKeeperConfiguration | | ZooKeeperConfiguration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -64,42 +62,30 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| serverUrls | | String | *Required* The zookeeper server hosts (multiple servers can be separated by comma)
-| path | | String | *Required* The node in the ZooKeeper server (aka znode)
+| Name | Description | Default | Type
+| **serverUrls** | *Required* The zookeeper server hosts (multiple servers can be separated by comma) | | String
+| **path** | *Required* The node in the ZooKeeper server (aka znode) | | String
|=======================================================================
#### Query Parameters (12 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| awaitExistence | true | boolean | Not in use
-
-| listChildren | false | boolean | Whether the children of the node should be listed
-
-| timeout | 5000 | int | The time interval to wait on connection before timing out.
- 4+^s| consumer
-| backoff | 5000 | long | The time interval to backoff for after an error before retrying.
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| repeat | false | boolean | Should changes to the znode be 'watched' and repeatedly processed.
-
-| sendEmptyMessageOnDelete | true | boolean | Upon the delete of a znode should an empty message be send to the consumer
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| create | false | boolean | Should the endpoint create the node if it does not currently exist.
-
-| createMode | EPHEMERAL | String | The create mode that should be used for the newly created node
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **awaitExistence** (common) | Not in use | true | boolean
+| **listChildren** (common) | Whether the children of the node should be listed | false | boolean
+| **timeout** (common) | The time interval to wait on connection before timing out. | 5000 | int
+| **backoff** (consumer) | The time interval to backoff for after an error before retrying. | 5000 | long
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **repeat** (consumer) | Should changes to the znode be 'watched' and repeatedly processed. | false | boolean
+| **sendEmptyMessageOnDelete** (consumer) | Upon the delete of a znode should an empty message be send to the consumer | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **create** (producer) | Should the endpoint create the node if it does not currently exist. | false | boolean
+| **createMode** (producer) | The create mode that should be used for the newly created node | EPHEMERAL | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/platforms/spring-boot/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java
----------------------------------------------------------------------
diff --git a/platforms/spring-boot/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java
index 878b5ef..f30c727 100644
--- a/platforms/spring-boot/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-amqp-starter/src/main/java/org/apache/camel/component/amqp/springboot/AMQPComponentConfiguration.java
@@ -30,7 +30,6 @@ import org.apache.camel.spi.HeaderFilterStrategy;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.DeprecatedConfigurationProperty;
import org.springframework.boot.context.properties.NestedConfigurationProperty;
-import org.springframework.context.ApplicationContext;
import org.springframework.core.task.TaskExecutor;
import org.springframework.jms.core.JmsOperations;
import org.springframework.jms.support.converter.MessageConverter;
@@ -527,10 +526,6 @@ public class AMQPComponentConfiguration {
@NestedConfigurationProperty
private JmsKeyFormatStrategy jmsKeyFormatStrategy;
/**
- * Sets the Spring ApplicationContext to use
- */
- private ApplicationContext applicationContext;
- /**
* To use a custom QueueBrowseStrategy when browsing queues
*/
@NestedConfigurationProperty
@@ -1132,14 +1127,6 @@ public class AMQPComponentConfiguration {
this.jmsKeyFormatStrategy = jmsKeyFormatStrategy;
}
- public ApplicationContext getApplicationContext() {
- return applicationContext;
- }
-
- public void setApplicationContext(ApplicationContext applicationContext) {
- this.applicationContext = applicationContext;
- }
-
public QueueBrowseStrategy getQueueBrowseStrategy() {
return queueBrowseStrategy;
}
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/platforms/spring-boot/components-starter/camel-spring-starter/src/main/java/org/apache/camel/component/event/springboot/EventComponentAutoConfiguration.java
----------------------------------------------------------------------
diff --git a/platforms/spring-boot/components-starter/camel-spring-starter/src/main/java/org/apache/camel/component/event/springboot/EventComponentAutoConfiguration.java b/platforms/spring-boot/components-starter/camel-spring-starter/src/main/java/org/apache/camel/component/event/springboot/EventComponentAutoConfiguration.java
index 817e9f7..62b26a0 100644
--- a/platforms/spring-boot/components-starter/camel-spring-starter/src/main/java/org/apache/camel/component/event/springboot/EventComponentAutoConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-spring-starter/src/main/java/org/apache/camel/component/event/springboot/EventComponentAutoConfiguration.java
@@ -16,11 +16,8 @@
*/
package org.apache.camel.component.event.springboot;
-import java.util.HashMap;
-import java.util.Map;
import org.apache.camel.CamelContext;
import org.apache.camel.component.event.EventComponent;
-import org.apache.camel.util.IntrospectionSupport;
import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.boot.autoconfigure.condition.ConditionMessage;
import org.springframework.boot.autoconfigure.condition.ConditionOutcome;
@@ -29,7 +26,6 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.SpringBootCondition;
import org.springframework.boot.bind.RelaxedPropertyResolver;
-import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.context.annotation.Conditional;
@@ -44,42 +40,16 @@ import org.springframework.core.type.AnnotatedTypeMetadata;
@ConditionalOnBean(type = "org.apache.camel.spring.boot.CamelAutoConfiguration")
@Conditional(EventComponentAutoConfiguration.Condition.class)
@AutoConfigureAfter(name = "org.apache.camel.spring.boot.CamelAutoConfiguration")
-@EnableConfigurationProperties(EventComponentConfiguration.class)
public class EventComponentAutoConfiguration {
@Lazy
@Bean(name = "spring-event-component")
@ConditionalOnClass(CamelContext.class)
@ConditionalOnMissingBean(EventComponent.class)
- public EventComponent configureEventComponent(CamelContext camelContext,
- EventComponentConfiguration configuration) throws Exception {
+ public EventComponent configureEventComponent(CamelContext camelContext)
+ throws Exception {
EventComponent component = new EventComponent();
component.setCamelContext(camelContext);
- Map<String, Object> parameters = new HashMap<>();
- IntrospectionSupport.getProperties(configuration, parameters, null,
- false);
- for (Map.Entry<String, Object> entry : parameters.entrySet()) {
- Object value = entry.getValue();
- Class<?> paramClass = value.getClass();
- if (paramClass.getName().endsWith("NestedConfiguration")) {
- Class nestedClass = null;
- try {
- nestedClass = (Class) paramClass.getDeclaredField(
- "CAMEL_NESTED_CLASS").get(null);
- HashMap<String, Object> nestedParameters = new HashMap<>();
- IntrospectionSupport.getProperties(value, nestedParameters,
- null, false);
- Object nestedProperty = nestedClass.newInstance();
- IntrospectionSupport.setProperties(camelContext,
- camelContext.getTypeConverter(), nestedProperty,
- nestedParameters);
- entry.setValue(nestedProperty);
- } catch (NoSuchFieldException e) {
- }
- }
- }
- IntrospectionSupport.setProperties(camelContext,
- camelContext.getTypeConverter(), component, parameters);
return component;
}
[05/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-sjms/src/main/docs/sjms-batch-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc
index 2a2cf47..cf8f2b2 100644
--- a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc
+++ b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc
@@ -114,19 +114,14 @@ The Simple JMS Batch component supports 5 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| connectionFactory | | ConnectionFactory | A ConnectionFactory is required to enable the SjmsBatchComponent.
-
-| asyncStartListener | false | boolean | Whether to startup the consumer 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.
-
-| recoveryInterval | 5000 | int | 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.
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **connectionFactory** (advanced) | A ConnectionFactory is required to enable the SjmsBatchComponent. | | ConnectionFactory
+| **asyncStartListener** (advanced) | Whether to startup the consumer 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. | false | boolean
+| **recoveryInterval** (advanced) | 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. | 5000 | int
+| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -147,61 +142,39 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| destinationName | | String | *Required* The destination name. Only queues are supported names may be prefixed by 'queue:'.
+| Name | Description | Default | Type
+| **destinationName** | *Required* The destination name. Only queues are supported names may be prefixed by 'queue:'. | | String
|=======================================================================
#### Query Parameters (22 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| aggregationStrategy | | AggregationStrategy | *Required* The aggregation strategy to use which merges all the batched messages into a single message
-
-| allowNullBody | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown.
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| completionInterval | 1000 | int | The completion interval in millis which causes batches to be completed in a scheduled fixed rate every interval. The batch may be empty if the timeout triggered and there was no messages in the batch. Notice you cannot use both completion timeout and completion interval at the same time only one can be configured.
-
-| completionPredicate | | String | The completion predicate which causes batches to be completed when the predicate evaluates as true. The predicate can also be configured using the simple language using the string syntax. You may want to set the option eagerCheckCompletion to true to let the predicate match the incoming message as otherwise it matches the aggregated message.
-
-| completionSize | 200 | int | The number of messages consumed at which the batch will be completed
-
-| completionTimeout | 500 | int | The timeout in millis from receipt of the first first message when the batch will be completed. The batch may be empty if the timeout triggered and there was no messages in the batch. Notice you cannot use both completion timeout and completion interval at the same time only one can be configured.
-
-| consumerCount | 1 | int | The number of JMS sessions to consume from
-
-| eagerCheckCompletion | false | boolean | Use eager completion checking which means that the completionPredicate will use the incoming Exchange. As opposed to without eager completion checking the completionPredicate will use the aggregated Exchange.
-
-| includeAllJMSXProperties | false | boolean | 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.
-
-| mapJmsMessage | true | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details.
-
-| pollDuration | 1000 | int | The duration in milliseconds of each poll for messages. completionTimeOut will be used if it is shorter and a batch has started.
-
-| sendEmptyMessageWhenIdle | false | boolean | If using completion timeout or interval then the batch may be empty if the timeout triggered and there was no messages in the batch. If this option is true and the batch is empty then an empty message is added to the batch so an empty message is routed.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| asyncStartListener | false | boolean | Whether to startup the consumer 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.
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-
-| jmsKeyFormatStrategy | | JmsKeyFormatStrategy | 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.
-
-| messageCreatedStrategy | | MessageCreatedStrategy | 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.
-
-| recoveryInterval | 5000 | int | 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.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| timeoutCheckerExecutorService | | ScheduledExecutorService | If using the completionInterval option a background thread is created to trigger the completion interval. Set this option to provide a custom thread pool to be used rather than creating a new thread for every consumer.
+| Name | Description | Default | Type
+| **aggregationStrategy** (consumer) | *Required* The aggregation strategy to use which merges all the batched messages into a single message | | AggregationStrategy
+| **allowNullBody** (consumer) | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. | true | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **completionInterval** (consumer) | The completion interval in millis which causes batches to be completed in a scheduled fixed rate every interval. The batch may be empty if the timeout triggered and there was no messages in the batch. Notice you cannot use both completion timeout and completion interval at the same time only one can be configured. | 1000 | int
+| **completionPredicate** (consumer) | The completion predicate which causes batches to be completed when the predicate evaluates as true. The predicate can also be configured using the simple language using the string syntax. You may want to set the option eagerCheckCompletion to true to let the predicate match the incoming message as otherwise it matches the aggregated message. | | String
+| **completionSize** (consumer) | The number of messages consumed at which the batch will be completed | 200 | int
+| **completionTimeout** (consumer) | The timeout in millis from receipt of the first first message when the batch will be completed. The batch may be empty if the timeout triggered and there was no messages in the batch. Notice you cannot use both completion timeout and completion interval at the same time only one can be configured. | 500 | int
+| **consumerCount** (consumer) | The number of JMS sessions to consume from | 1 | int
+| **eagerCheckCompletion** (consumer) | Use eager completion checking which means that the completionPredicate will use the incoming Exchange. As opposed to without eager completion checking the completionPredicate will use the aggregated Exchange. | false | boolean
+| **includeAllJMSXProperties** (consumer) | 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. | false | boolean
+| **mapJmsMessage** (consumer) | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details. | true | boolean
+| **pollDuration** (consumer) | The duration in milliseconds of each poll for messages. completionTimeOut will be used if it is shorter and a batch has started. | 1000 | int
+| **sendEmptyMessageWhenIdle** (consumer) | If using completion timeout or interval then the batch may be empty if the timeout triggered and there was no messages in the batch. If this option is true and the batch is empty then an empty message is added to the batch so an empty message is routed. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **asyncStartListener** (advanced) | Whether to startup the consumer 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. | false | boolean
+| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **jmsKeyFormatStrategy** (advanced) | 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. | | JmsKeyFormatStrategy
+| **messageCreatedStrategy** (advanced) | 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. | | MessageCreatedStrategy
+| **recoveryInterval** (advanced) | 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. | 5000 | int
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **timeoutCheckerExecutor Service** (advanced) | If using the completionInterval option a background thread is created to trigger the completion interval. Set this option to provide a custom thread pool to be used rather than creating a new thread for every consumer. | | ScheduledExecutor Service
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-sjms/src/main/docs/sjms-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sjms/src/main/docs/sjms-component.adoc b/components/camel-sjms/src/main/docs/sjms-component.adoc
index 71f7a62..2c5ad51 100644
--- a/components/camel-sjms/src/main/docs/sjms-component.adoc
+++ b/components/camel-sjms/src/main/docs/sjms-component.adoc
@@ -87,39 +87,24 @@ The Simple JMS component supports 15 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| connectionFactory | | ConnectionFactory | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource.
-
-| connectionResource | | ConnectionResource | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details.
- 4+^s| common
-| connectionCount | 1 | Integer | The maximum number of connections available to endpoints started under this component
- 4+^s| advanced
-| jmsKeyFormatStrategy | | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). 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.
- 4+^s| transaction
-| transactionCommitStrategy | | TransactionCommitStrategy | To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch.
- 4+^s| advanced
-| destinationCreationStrategy | | DestinationCreationStrategy | To use a custom DestinationCreationStrategy.
-
-| timedTaskManager | | TimedTaskManager | To use a custom TimedTaskManager
-
-| messageCreatedStrategy | | MessageCreatedStrategy | 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.
-
-| connectionTestOnBorrow | true | boolean | When using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource then should each javax.jms.Connection be tested (calling start) before returned from the pool.
- 4+^s| security
-| connectionUsername | | String | The username to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource.
-
-| connectionPassword | | String | The password to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource.
- 4+^s| advanced
-| connectionClientId | | String | The client ID to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource.
-
-| connectionMaxWait | 5000 | long | The max wait time in millis to block and wait on free connection when the pool is exhausted when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource.
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **connectionFactory** (advanced) | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource. | | ConnectionFactory
+| **connectionResource** (advanced) | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details. | | ConnectionResource
+| **connectionCount** (common) | The maximum number of connections available to endpoints started under this component | 1 | Integer
+| **jmsKeyFormatStrategy** (advanced) | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). 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. | | JmsKeyFormatStrategy
+| **transactionCommit Strategy** (transaction) | To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch. | | TransactionCommit Strategy
+| **destinationCreation Strategy** (advanced) | To use a custom DestinationCreationStrategy. | | DestinationCreation Strategy
+| **timedTaskManager** (advanced) | To use a custom TimedTaskManager | | TimedTaskManager
+| **messageCreatedStrategy** (advanced) | 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. | | MessageCreatedStrategy
+| **connectionTestOnBorrow** (advanced) | When using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource then should each javax.jms.Connection be tested (calling start) before returned from the pool. | true | boolean
+| **connectionUsername** (security) | The username to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String
+| **connectionPassword** (security) | The password to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String
+| **connectionClientId** (advanced) | The client ID to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String
+| **connectionMaxWait** (advanced) | The max wait time in millis to block and wait on free connection when the pool is exhausted when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | 5000 | long
+| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -139,86 +124,52 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| destinationType | queue | String | The kind of destination to use
-| destinationName | | String | *Required* DestinationName is a JMS queue or topic name. By default the destinationName is interpreted as a queue name.
+| Name | Description | Default | Type
+| **destinationType** | The kind of destination to use | queue | String
+| **destinationName** | *Required* DestinationName is a JMS queue or topic name. By default the destinationName is interpreted as a queue name. | | String
|=======================================================================
#### Query Parameters (34 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| acknowledgementMode | AUTO_ACKNOWLEDGE | SessionAcknowledgementType | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| consumerCount | 1 | int | Sets the number of consumer listeners used for this endpoint.
-
-| durableSubscriptionId | | String | Sets the durable subscription Id required for durable topics.
-
-| synchronous | true | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| messageSelector | | String | Sets the JMS Message selector syntax.
- 4+^s| producer
-| namedReplyTo | | String | Sets the reply to destination name used for InOut producer endpoints.
-
-| persistent | true | boolean | Flag used to enable/disable message persistence.
-
-| producerCount | 1 | int | Sets the number of producers used for this endpoint.
-
-| ttl | -1 | long | Flag used to adjust the Time To Live value of produced messages.
- 4+^s| producer (advanced)
-| allowNullBody | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown.
-
-| prefillPool | true | boolean | Whether to prefill the producer connection pool on startup or create connections lazy when needed.
-
-| responseTimeOut | 5000 | long | Sets the amount of time we should wait before timing out a InOut response.
- 4+^s| advanced
-| asyncStartListener | false | boolean | Whether to startup the consumer 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.
-
-| asyncStopListener | false | boolean | Whether to stop the consumer message listener asynchronously when stopping a route.
-
-| connectionCount | | Integer | The maximum number of connections available to this endpoint
-
-| connectionFactory | | ConnectionFactory | Initializes the connectionFactory for the endpoint which takes precedence over the component's connectionFactory if any
-
-| connectionResource | | ConnectionResource | Initializes the connectionResource for the endpoint which takes precedence over the component's connectionResource if any
-
-| destinationCreationStrategy | | DestinationCreationStrategy | To use a custom DestinationCreationStrategy.
-
-| exceptionListener | | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-
-| includeAllJMSXProperties | false | boolean | 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.
-
-| jmsKeyFormatStrategy | | JmsKeyFormatStrategy | 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.
-
-| mapJmsMessage | true | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details.
-
-| messageCreatedStrategy | | MessageCreatedStrategy | 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.
- 4+^s| logging
-| errorHandlerLoggingLevel | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
-
-| errorHandlerLogStackTrace | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
- 4+^s| transaction
-| transacted | false | boolean | Specifies whether to use transacted mode
-
-| transactionBatchCount | -1 | int | If transacted sets the number of messages to process before committing a transaction.
-
-| transactionBatchTimeout | 5000 | long | Sets timeout (in millis) for batch transactions the value should be 1000 or higher.
-
-| transactionCommitStrategy | | TransactionCommitStrategy | Sets the commit strategy.
- 4+^s| transaction (advanced)
-| sharedJMSSession | true | boolean | Specifies whether to share JMS session with other SJMS endpoints. Turn this off if your route is accessing to multiple JMS providers. If you need transaction against multiple JMS providers use jms component to leverage XA transaction.
+| Name | Description | Default | Type
+| **acknowledgementMode** (common) | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE | AUTO_ ACKNOWLEDGE | SessionAcknowledgement Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **consumerCount** (consumer) | Sets the number of consumer listeners used for this endpoint. | 1 | int
+| **durableSubscriptionId** (consumer) | Sets the durable subscription Id required for durable topics. | | String
+| **synchronous** (consumer) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **messageSelector** (consumer) | Sets the JMS Message selector syntax. | | String
+| **namedReplyTo** (producer) | Sets the reply to destination name used for InOut producer endpoints. | | String
+| **persistent** (producer) | Flag used to enable/disable message persistence. | true | boolean
+| **producerCount** (producer) | Sets the number of producers used for this endpoint. | 1 | int
+| **ttl** (producer) | Flag used to adjust the Time To Live value of produced messages. | -1 | long
+| **allowNullBody** (producer) | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. | true | boolean
+| **prefillPool** (producer) | Whether to prefill the producer connection pool on startup or create connections lazy when needed. | true | boolean
+| **responseTimeOut** (producer) | Sets the amount of time we should wait before timing out a InOut response. | 5000 | long
+| **asyncStartListener** (advanced) | Whether to startup the consumer 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. | false | boolean
+| **asyncStopListener** (advanced) | Whether to stop the consumer message listener asynchronously when stopping a route. | false | boolean
+| **connectionCount** (advanced) | The maximum number of connections available to this endpoint | | Integer
+| **connectionFactory** (advanced) | Initializes the connectionFactory for the endpoint which takes precedence over the component's connectionFactory if any | | ConnectionFactory
+| **connectionResource** (advanced) | Initializes the connectionResource for the endpoint which takes precedence over the component's connectionResource if any | | ConnectionResource
+| **destinationCreationStrategy** (advanced) | To use a custom DestinationCreationStrategy. | | DestinationCreation Strategy
+| **exceptionListener** (advanced) | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. | | ExceptionListener
+| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **includeAllJMSXProperties** (advanced) | 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. | false | boolean
+| **jmsKeyFormatStrategy** (advanced) | 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. | | JmsKeyFormatStrategy
+| **mapJmsMessage** (advanced) | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details. | true | boolean
+| **messageCreatedStrategy** (advanced) | 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. | | MessageCreatedStrategy
+| **errorHandlerLoggingLevel** (logging) | Allows to configure the default errorHandler logging level for logging uncaught exceptions. | WARN | LoggingLevel
+| **errorHandlerLogStackTrace** (logging) | Allows to control whether stacktraces should be logged or not by the default errorHandler. | true | boolean
+| **transacted** (transaction) | Specifies whether to use transacted mode | false | boolean
+| **transactionBatchCount** (transaction) | If transacted sets the number of messages to process before committing a transaction. | -1 | int
+| **transactionBatchTimeout** (transaction) | Sets timeout (in millis) for batch transactions the value should be 1000 or higher. | 5000 | long
+| **transactionCommitStrategy** (transaction) | Sets the commit strategy. | | TransactionCommit Strategy
+| **sharedJMSSession** (transaction) | Specifies whether to share JMS session with other SJMS endpoints. Turn this off if your route is accessing to multiple JMS providers. If you need transaction against multiple JMS providers use jms component to leverage XA transaction. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-sjms2/src/main/docs/sjms2-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sjms2/src/main/docs/sjms2-component.adoc b/components/camel-sjms2/src/main/docs/sjms2-component.adoc
index 57145d3..c9da69a 100644
--- a/components/camel-sjms2/src/main/docs/sjms2-component.adoc
+++ b/components/camel-sjms2/src/main/docs/sjms2-component.adoc
@@ -87,39 +87,24 @@ The Simple JMS2 component supports 15 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| connectionFactory | | ConnectionFactory | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource.
-
-| connectionResource | | ConnectionResource | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details.
- 4+^s| common
-| connectionCount | 1 | Integer | The maximum number of connections available to endpoints started under this component
- 4+^s| advanced
-| jmsKeyFormatStrategy | | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). 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.
- 4+^s| transaction
-| transactionCommitStrategy | | TransactionCommitStrategy | To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch.
- 4+^s| advanced
-| destinationCreationStrategy | | DestinationCreationStrategy | To use a custom DestinationCreationStrategy.
-
-| timedTaskManager | | TimedTaskManager | To use a custom TimedTaskManager
-
-| messageCreatedStrategy | | MessageCreatedStrategy | 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.
-
-| connectionTestOnBorrow | true | boolean | When using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource then should each javax.jms.Connection be tested (calling start) before returned from the pool.
- 4+^s| security
-| connectionUsername | | String | The username to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource.
-
-| connectionPassword | | String | The password to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource.
- 4+^s| advanced
-| connectionClientId | | String | The client ID to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource.
-
-| connectionMaxWait | 5000 | long | The max wait time in millis to block and wait on free connection when the pool is exhausted when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource.
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **connectionFactory** (advanced) | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource. | | ConnectionFactory
+| **connectionResource** (advanced) | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details. | | ConnectionResource
+| **connectionCount** (common) | The maximum number of connections available to endpoints started under this component | 1 | Integer
+| **jmsKeyFormatStrategy** (advanced) | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). 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. | | JmsKeyFormatStrategy
+| **transactionCommit Strategy** (transaction) | To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch. | | TransactionCommit Strategy
+| **destinationCreation Strategy** (advanced) | To use a custom DestinationCreationStrategy. | | DestinationCreation Strategy
+| **timedTaskManager** (advanced) | To use a custom TimedTaskManager | | TimedTaskManager
+| **messageCreatedStrategy** (advanced) | 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. | | MessageCreatedStrategy
+| **connectionTestOnBorrow** (advanced) | When using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource then should each javax.jms.Connection be tested (calling start) before returned from the pool. | true | boolean
+| **connectionUsername** (security) | The username to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String
+| **connectionPassword** (security) | The password to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String
+| **connectionClientId** (advanced) | The client ID to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | | String
+| **connectionMaxWait** (advanced) | The max wait time in millis to block and wait on free connection when the pool is exhausted when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. | 5000 | long
+| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -139,92 +124,55 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| destinationType | queue | String | The kind of destination to use
-| destinationName | | String | *Required* DestinationName is a JMS queue or topic name. By default the destinationName is interpreted as a queue name.
+| Name | Description | Default | Type
+| **destinationType** | The kind of destination to use | queue | String
+| **destinationName** | *Required* DestinationName is a JMS queue or topic name. By default the destinationName is interpreted as a queue name. | | String
|=======================================================================
#### Query Parameters (37 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| acknowledgementMode | AUTO_ACKNOWLEDGE | SessionAcknowledgementType | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| consumerCount | 1 | int | Sets the number of consumer listeners used for this endpoint.
-
-| durable | false | boolean | Sets topic consumer to durable.
-
-| durableSubscriptionId | | String | Sets the durable subscription Id required for durable topics.
-
-| shared | false | boolean | Sets the consumer to shared.
-
-| subscriptionId | | String | Sets the subscription Id required for durable or shared topics.
-
-| synchronous | true | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| messageSelector | | String | Sets the JMS Message selector syntax.
- 4+^s| producer
-| namedReplyTo | | String | Sets the reply to destination name used for InOut producer endpoints.
-
-| persistent | true | boolean | Flag used to enable/disable message persistence.
-
-| producerCount | 1 | int | Sets the number of producers used for this endpoint.
-
-| ttl | -1 | long | Flag used to adjust the Time To Live value of produced messages.
- 4+^s| producer (advanced)
-| allowNullBody | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown.
-
-| prefillPool | true | boolean | Whether to prefill the producer connection pool on startup or create connections lazy when needed.
-
-| responseTimeOut | 5000 | long | Sets the amount of time we should wait before timing out a InOut response.
- 4+^s| advanced
-| asyncStartListener | false | boolean | Whether to startup the consumer 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.
-
-| asyncStopListener | false | boolean | Whether to stop the consumer message listener asynchronously when stopping a route.
-
-| connectionCount | | Integer | The maximum number of connections available to this endpoint
-
-| connectionFactory | | ConnectionFactory | Initializes the connectionFactory for the endpoint which takes precedence over the component's connectionFactory if any
-
-| connectionResource | | ConnectionResource | Initializes the connectionResource for the endpoint which takes precedence over the component's connectionResource if any
-
-| destinationCreationStrategy | | DestinationCreationStrategy | To use a custom DestinationCreationStrategy.
-
-| exceptionListener | | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-
-| includeAllJMSXProperties | false | boolean | 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.
-
-| jmsKeyFormatStrategy | | JmsKeyFormatStrategy | 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.
-
-| mapJmsMessage | true | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details.
-
-| messageCreatedStrategy | | MessageCreatedStrategy | 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.
- 4+^s| logging
-| errorHandlerLoggingLevel | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
-
-| errorHandlerLogStackTrace | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
- 4+^s| transaction
-| transacted | false | boolean | Specifies whether to use transacted mode
-
-| transactionBatchCount | -1 | int | If transacted sets the number of messages to process before committing a transaction.
-
-| transactionBatchTimeout | 5000 | long | Sets timeout (in millis) for batch transactions the value should be 1000 or higher.
-
-| transactionCommitStrategy | | TransactionCommitStrategy | Sets the commit strategy.
- 4+^s| transaction (advanced)
-| sharedJMSSession | true | boolean | Specifies whether to share JMS session with other SJMS endpoints. Turn this off if your route is accessing to multiple JMS providers. If you need transaction against multiple JMS providers use jms component to leverage XA transaction.
+| Name | Description | Default | Type
+| **acknowledgementMode** (common) | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE | AUTO_ ACKNOWLEDGE | SessionAcknowledgement Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **consumerCount** (consumer) | Sets the number of consumer listeners used for this endpoint. | 1 | int
+| **durable** (consumer) | Sets topic consumer to durable. | false | boolean
+| **durableSubscriptionId** (consumer) | Sets the durable subscription Id required for durable topics. | | String
+| **shared** (consumer) | Sets the consumer to shared. | false | boolean
+| **subscriptionId** (consumer) | Sets the subscription Id required for durable or shared topics. | | String
+| **synchronous** (consumer) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **messageSelector** (consumer) | Sets the JMS Message selector syntax. | | String
+| **namedReplyTo** (producer) | Sets the reply to destination name used for InOut producer endpoints. | | String
+| **persistent** (producer) | Flag used to enable/disable message persistence. | true | boolean
+| **producerCount** (producer) | Sets the number of producers used for this endpoint. | 1 | int
+| **ttl** (producer) | Flag used to adjust the Time To Live value of produced messages. | -1 | long
+| **allowNullBody** (producer) | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. | true | boolean
+| **prefillPool** (producer) | Whether to prefill the producer connection pool on startup or create connections lazy when needed. | true | boolean
+| **responseTimeOut** (producer) | Sets the amount of time we should wait before timing out a InOut response. | 5000 | long
+| **asyncStartListener** (advanced) | Whether to startup the consumer 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. | false | boolean
+| **asyncStopListener** (advanced) | Whether to stop the consumer message listener asynchronously when stopping a route. | false | boolean
+| **connectionCount** (advanced) | The maximum number of connections available to this endpoint | | Integer
+| **connectionFactory** (advanced) | Initializes the connectionFactory for the endpoint which takes precedence over the component's connectionFactory if any | | ConnectionFactory
+| **connectionResource** (advanced) | Initializes the connectionResource for the endpoint which takes precedence over the component's connectionResource if any | | ConnectionResource
+| **destinationCreationStrategy** (advanced) | To use a custom DestinationCreationStrategy. | | DestinationCreation Strategy
+| **exceptionListener** (advanced) | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. | | ExceptionListener
+| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **includeAllJMSXProperties** (advanced) | 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. | false | boolean
+| **jmsKeyFormatStrategy** (advanced) | 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. | | JmsKeyFormatStrategy
+| **mapJmsMessage** (advanced) | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details. | true | boolean
+| **messageCreatedStrategy** (advanced) | 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. | | MessageCreatedStrategy
+| **errorHandlerLoggingLevel** (logging) | Allows to configure the default errorHandler logging level for logging uncaught exceptions. | WARN | LoggingLevel
+| **errorHandlerLogStackTrace** (logging) | Allows to control whether stacktraces should be logged or not by the default errorHandler. | true | boolean
+| **transacted** (transaction) | Specifies whether to use transacted mode | false | boolean
+| **transactionBatchCount** (transaction) | If transacted sets the number of messages to process before committing a transaction. | -1 | int
+| **transactionBatchTimeout** (transaction) | Sets timeout (in millis) for batch transactions the value should be 1000 or higher. | 5000 | long
+| **transactionCommitStrategy** (transaction) | Sets the commit strategy. | | TransactionCommit Strategy
+| **sharedJMSSession** (transaction) | Specifies whether to share JMS session with other SJMS endpoints. Turn this off if your route is accessing to multiple JMS providers. If you need transaction against multiple JMS providers use jms component to leverage XA transaction. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-slack/src/main/docs/slack-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-slack/src/main/docs/slack-component.adoc b/components/camel-slack/src/main/docs/slack-component.adoc
index 2a644b6..0302eb5 100644
--- a/components/camel-slack/src/main/docs/slack-component.adoc
+++ b/components/camel-slack/src/main/docs/slack-component.adoc
@@ -46,13 +46,11 @@ The Slack component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| producer
-| webhookUrl | | String | The incoming webhook URL
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **webhookUrl** (producer) | The incoming webhook URL | | String
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -68,27 +66,22 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| channel | | String | *Required* The channel name (syntax name) or slackuser (syntax userName) to send a message directly to an user.
+| Name | Description | Default | Type
+| **channel** | *Required* The channel name (syntax name) or slackuser (syntax userName) to send a message directly to an user. | | String
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| iconEmoji | | String | Use a Slack emoji as an avatar
-
-| iconUrl | | String | The avatar that the component will use when sending message to a channel or user.
-
-| username | | String | This is the username that the bot will have when sending messages to a channel or user.
-
-| webhookUrl | | String | The incoming webhook URL
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **iconEmoji** (producer) | Use a Slack emoji as an avatar | | String
+| **iconUrl** (producer) | The avatar that the component will use when sending message to a channel or user. | | String
+| **username** (producer) | This is the username that the bot will have when sending messages to a channel or user. | | String
+| **webhookUrl** (producer) | The incoming webhook URL | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-smpp/src/main/docs/smpp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-smpp/src/main/docs/smpp-component.adoc b/components/camel-smpp/src/main/docs/smpp-component.adoc
index 6eefea7..bc166a7 100644
--- a/components/camel-smpp/src/main/docs/smpp-component.adoc
+++ b/components/camel-smpp/src/main/docs/smpp-component.adoc
@@ -171,13 +171,11 @@ The SMPP component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | SmppConfiguration | To use the shared SmppConfiguration as configuration.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use the shared SmppConfiguration as configuration. | | SmppConfiguration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -195,94 +193,56 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | localhost | String | Hostname for the SMSC server to use.
-| port | 2775 | Integer | Port number for the SMSC server to use.
+| Name | Description | Default | Type
+| **host** | Hostname for the SMSC server to use. | localhost | String
+| **port** | Port number for the SMSC server to use. | 2775 | Integer
|=======================================================================
#### Query Parameters (38 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| initialReconnectDelay | 5000 | long | Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC after the connection was lost.
-
-| maxReconnect | 2147483647 | int | Defines the maximum number of attempts to reconnect to the SMSC if SMSC returns a negative bind response
-
-| reconnectDelay | 5000 | long | Defines the interval in milliseconds between the reconnect attempts if the connection to the SMSC was lost and the previous was not succeed.
-
-| splittingPolicy | ALLOW | SmppSplittingPolicy | You can specify a policy for handling long messages: ALLOW - the default long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered. REJECT - if a message would need to be split it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long.
-
-| systemType | cp | String | This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max. 13 characters).
- 4+^s| consumer
-| addressRange | | String | You can specify the address range for the SmppConsumer as defined in section 5.2.7 of the SMPP 3.4 specification. The SmppConsumer will receive messages only from SMSC's which target an address (MSISDN or IP address) within this range.
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| destAddr | 1717 | String | Defines the destination SME address. For mobile terminated messages this is the directory number of the recipient MS. Only for SubmitSm SubmitMulti CancelSm and DataSm.
-
-| destAddrNpi | | byte | Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm SubmitMulti CancelSm and DataSm. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)
-
-| destAddrTon | | byte | Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm SubmitMulti CancelSm and DataSm. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated
-
-| lazySessionCreation | false | boolean | Sessions can be lazily created to avoid exceptions if the SMSC is not available when the Camel producer is started. Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present Camel will use these data to connect to the SMSC.
-
-| numberingPlanIndicator | | byte | Defines the numeric plan indicator (NPI) to be used in the SME. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)
-
-| priorityFlag | | byte | Allows the originating SME to assign a priority level to the short message. Only for SubmitSm and SubmitMulti. Four Priority Levels are supported: 0: Level 0 (lowest) priority 1: Level 1 priority 2: Level 2 priority 3: Level 3 (highest) priority
-
-| protocolId | | byte | The protocol id
-
-| registeredDelivery | | byte | Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined: 0: No SMSC delivery receipt requested. 1: SMSC delivery receipt requested where final delivery outcome is success or failure. 2: SMSC delivery receipt requested where the final delivery outcome is delivery failure.
-
-| replaceIfPresentFlag | | byte | Used to request the SMSC to replace a previously submitted message that is still pending delivery. The SMSC will replace an existing message provided that the source address destination address and service type match the same fields in the new message. The following replace if present flag values are defined: 0: Don't replace 1: Replace
-
-| serviceType | CMT | String | The service type parameter can be used to indicate the SMS Application service associated with the message. The following generic service_types are defined: CMT: Cellular Messaging CPT: Cellular Paging VMN: Voice Mail Notification VMA: Voice Mail Alerting WAP: Wireless Application Protocol USSD: Unstructured Supplementary Services Data
-
-| sourceAddr | 1616 | String | Defines the address of SME (Short Message Entity) which originated this message.
-
-| sourceAddrNpi | | byte | Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum)
-
-| sourceAddrTon | | byte | Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated
-
-| typeOfNumber | | byte | Defines the type of number (TON) to be used in the SME. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated
- 4+^s| advanced
-| enquireLinkTimer | 5000 | Integer | Defines the interval in milliseconds between the confidence checks. The confidence check is used to test the communication path between an ESME and an SMSC.
-
-| sessionStateListener | | SessionStateListener | You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| transactionTimer | 10000 | Integer | Defines the maximum period of inactivity allowed after a transaction after which an SMPP entity may assume that the session is no longer active. This timer may be active on either communicating SMPP entity (i.e. SMSC or ESME).
- 4+^s| codec
-| alphabet | | byte | Defines encoding of data according the SMPP 3.4 specification section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2 Alphabet
-
-| dataCoding | | byte | Defines the data coding according the SMPP 3.4 specification section 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2 (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990)
-
-| encoding | ISO-8859-1 | String | Defines the encoding scheme of the short message user data. Only for SubmitSm ReplaceSm and SubmitMulti.
- 4+^s| proxy
-| httpProxyHost | | String | If you need to tunnel SMPP through a HTTP proxy set this attribute to the hostname or ip address of your HTTP proxy.
-
-| httpProxyPassword | | String | If your HTTP proxy requires basic authentication set this attribute to the password required for your HTTP proxy.
-
-| httpProxyPort | 3128 | Integer | If you need to tunnel SMPP through a HTTP proxy set this attribute to the port of your HTTP proxy.
-
-| httpProxyUsername | | String | If your HTTP proxy requires basic authentication set this attribute to the username required for your HTTP proxy.
-
-| proxyHeaders | | Map | These headers will be passed to the proxy server while establishing the connection.
- 4+^s| security
-| password | | String | The password for connecting to SMSC server.
-
-| systemId | smppclient | String | The system id (username) for connecting to SMSC server.
-
-| usingSSL | false | boolean | Whether using SSL with the smpps protocol
+| Name | Description | Default | Type
+| **initialReconnectDelay** (common) | Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC after the connection was lost. | 5000 | long
+| **maxReconnect** (common) | Defines the maximum number of attempts to reconnect to the SMSC if SMSC returns a negative bind response | 2147483647 | int
+| **reconnectDelay** (common) | Defines the interval in milliseconds between the reconnect attempts if the connection to the SMSC was lost and the previous was not succeed. | 5000 | long
+| **splittingPolicy** (common) | You can specify a policy for handling long messages: ALLOW - the default long messages are split to 140 bytes per message TRUNCATE - long messages are split and only the first fragment will be sent to the SMSC. Some carriers drop subsequent fragments so this reduces load on the SMPP connection sending parts of a message that will never be delivered. REJECT - if a message would need to be split it is rejected with an SMPP NegativeResponseException and the reason code signifying the message is too long. | ALLOW | SmppSplittingPolicy
+| **systemType** (common) | This parameter is used to categorize the type of ESME (External Short Message Entity) that is binding to the SMSC (max. 13 characters). | cp | String
+| **addressRange** (consumer) | You can specify the address range for the SmppConsumer as defined in section 5.2.7 of the SMPP 3.4 specification. The SmppConsumer will receive messages only from SMSC's which target an address (MSISDN or IP address) within this range. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **destAddr** (producer) | Defines the destination SME address. For mobile terminated messages this is the directory number of the recipient MS. Only for SubmitSm SubmitMulti CancelSm and DataSm. | 1717 | String
+| **destAddrNpi** (producer) | Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm SubmitMulti CancelSm and DataSm. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum) | | byte
+| **destAddrTon** (producer) | Defines the type of number (TON) to be used in the SME destination address parameters. Only for SubmitSm SubmitMulti CancelSm and DataSm. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated | | byte
+| **lazySessionCreation** (producer) | Sessions can be lazily created to avoid exceptions if the SMSC is not available when the Camel producer is started. Camel will check the in message headers 'CamelSmppSystemId' and 'CamelSmppPassword' of the first exchange. If they are present Camel will use these data to connect to the SMSC. | false | boolean
+| **numberingPlanIndicator** (producer) | Defines the numeric plan indicator (NPI) to be used in the SME. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum) | | byte
+| **priorityFlag** (producer) | Allows the originating SME to assign a priority level to the short message. Only for SubmitSm and SubmitMulti. Four Priority Levels are supported: 0: Level 0 (lowest) priority 1: Level 1 priority 2: Level 2 priority 3: Level 3 (highest) priority | | byte
+| **protocolId** (producer) | The protocol id | | byte
+| **registeredDelivery** (producer) | Is used to request an SMSC delivery receipt and/or SME originated acknowledgements. The following values are defined: 0: No SMSC delivery receipt requested. 1: SMSC delivery receipt requested where final delivery outcome is success or failure. 2: SMSC delivery receipt requested where the final delivery outcome is delivery failure. | | byte
+| **replaceIfPresentFlag** (producer) | Used to request the SMSC to replace a previously submitted message that is still pending delivery. The SMSC will replace an existing message provided that the source address destination address and service type match the same fields in the new message. The following replace if present flag values are defined: 0: Don't replace 1: Replace | | byte
+| **serviceType** (producer) | The service type parameter can be used to indicate the SMS Application service associated with the message. The following generic service_types are defined: CMT: Cellular Messaging CPT: Cellular Paging VMN: Voice Mail Notification VMA: Voice Mail Alerting WAP: Wireless Application Protocol USSD: Unstructured Supplementary Services Data | CMT | String
+| **sourceAddr** (producer) | Defines the address of SME (Short Message Entity) which originated this message. | 1616 | String
+| **sourceAddrNpi** (producer) | Defines the numeric plan indicator (NPI) to be used in the SME originator address parameters. The following NPI values are defined: 0: Unknown 1: ISDN (E163/E164) 2: Data (X.121) 3: Telex (F.69) 6: Land Mobile (E.212) 8: National 9: Private 10: ERMES 13: Internet (IP) 18: WAP Client Id (to be defined by WAP Forum) | | byte
+| **sourceAddrTon** (producer) | Defines the type of number (TON) to be used in the SME originator address parameters. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated | | byte
+| **typeOfNumber** (producer) | Defines the type of number (TON) to be used in the SME. The following TON values are defined: 0: Unknown 1: International 2: National 3: Network Specific 4: Subscriber Number 5: Alphanumeric 6: Abbreviated | | byte
+| **enquireLinkTimer** (advanced) | Defines the interval in milliseconds between the confidence checks. The confidence check is used to test the communication path between an ESME and an SMSC. | 5000 | Integer
+| **sessionStateListener** (advanced) | You can refer to a org.jsmpp.session.SessionStateListener in the Registry to receive callbacks when the session state changed. | | SessionStateListener
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **transactionTimer** (advanced) | Defines the maximum period of inactivity allowed after a transaction after which an SMPP entity may assume that the session is no longer active. This timer may be active on either communicating SMPP entity (i.e. SMSC or ESME). | 10000 | Integer
+| **alphabet** (codec) | Defines encoding of data according the SMPP 3.4 specification section 5.2.19. 0: SMSC Default Alphabet 4: 8 bit Alphabet 8: UCS2 Alphabet | | byte
+| **dataCoding** (codec) | Defines the data coding according the SMPP 3.4 specification section 5.2.19. Example data encodings are: 0: SMSC Default Alphabet 3: Latin 1 (ISO-8859-1) 4: Octet unspecified (8-bit binary) 8: UCS2 (ISO/IEC-10646) 13: Extended Kanji JIS(X 0212-1990) | | byte
+| **encoding** (codec) | Defines the encoding scheme of the short message user data. Only for SubmitSm ReplaceSm and SubmitMulti. | ISO-8859-1 | String
+| **httpProxyHost** (proxy) | If you need to tunnel SMPP through a HTTP proxy set this attribute to the hostname or ip address of your HTTP proxy. | | String
+| **httpProxyPassword** (proxy) | If your HTTP proxy requires basic authentication set this attribute to the password required for your HTTP proxy. | | String
+| **httpProxyPort** (proxy) | If you need to tunnel SMPP through a HTTP proxy set this attribute to the port of your HTTP proxy. | 3128 | Integer
+| **httpProxyUsername** (proxy) | If your HTTP proxy requires basic authentication set this attribute to the username required for your HTTP proxy. | | String
+| **proxyHeaders** (proxy) | These headers will be passed to the proxy server while establishing the connection. | | Map
+| **password** (security) | The password for connecting to SMSC server. | | String
+| **systemId** (security) | The system id (username) for connecting to SMSC server. | smppclient | String
+| **usingSSL** (security) | Whether using SSL with the smpps protocol | false | boolean
|=======================================================================
// endpoint options: END
[11/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-mllp/src/main/docs/mllp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mllp/src/main/docs/mllp-component.adoc b/components/camel-mllp/src/main/docs/mllp-component.adoc
index 39493a2..7324dd1 100644
--- a/components/camel-mllp/src/main/docs/mllp-component.adoc
+++ b/components/camel-mllp/src/main/docs/mllp-component.adoc
@@ -59,62 +59,40 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| hostname | | String | *Required* Hostname or IP for connection for the TCP connection. The default value is null which means any local IP address
-| port | | int | *Required* Port number for the TCP connection
+| Name | Description | Default | Type
+| **hostname** | *Required* Hostname or IP for connection for the TCP connection. The default value is null which means any local IP address | | String
+| **port** | *Required* Port number for the TCP connection | | int
|=======================================================================
#### Query Parameters (22 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| autoAck | true | boolean | Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only
-
-| bufferWrites | true | boolean | Enable/Disable the validation of HL7 Payloads If enabled MLLP Payloads are buffered and written to the external system in a single write(byte) operation. If disabled the MLLP payload will not be buffered and three write operations will be used. The first operation will write the MLLP start-of-block character 0x0b (ASCII VT) the second operation will write the HL7 payload and the third operation will writh the MLLP end-of-block character and the MLLP end-of-data character 0x1c 0x0d (ASCII FS CR).
-
-| hl7Headers | true | boolean | Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only
-
-| keepAlive | true | boolean | Enable/disable the SO_KEEPALIVE socket option.
-
-| reuseAddress | false | boolean | Enable/disable the SO_REUSEADDR socket option.
-
-| tcpNoDelay | true | boolean | Enable/disable the TCP_NODELAY socket option.
-
-| validatePayload | false | boolean | Enable/Disable the validation of HL7 Payloads If enabled HL7 Payloads received from external systems will be validated (see Hl7Util.generateInvalidPayloadExceptionMessage for details on the validation). If and invalid payload is detected a MllpInvalidMessageException (for consumers) or a MllpInvalidAcknowledgementException will be thrown.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| backlog | 5 | int | The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full the connection is refused.
-
-| receiveBufferSize | | Integer | Sets the SO_RCVBUF option to the specified value (in bytes)
-
-| sendBufferSize | | Integer | Sets the SO_SNDBUF option to the specified value (in bytes)
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| codec
-| charsetName | | String | Set the CamelCharsetName property on the exchange
- 4+^s| timeout
-| acceptTimeout | 60000 | int | Timeout (in milliseconds) while waiting for a TCP connection TCP Server Only
-
-| bindRetryInterval | 5000 | int | TCP Server Only - The number of milliseconds to wait between bind attempts
-
-| bindTimeout | 30000 | int | TCP Server Only - The number of milliseconds to retry binding to a server port
-
-| connectTimeout | 30000 | int | Timeout (in milliseconds) for establishing for a TCP connection TCP Client only
-
-| maxReceiveTimeouts | -1 | int | The maximum number of timeouts (specified by receiveTimeout) allowed before the TCP Connection will be reset.
-
-| readTimeout | 500 | int | The SO_TIMEOUT value (in milliseconds) used after the start of an MLLP frame has been received
-
-| receiveTimeout | 10000 | int | The SO_TIMEOUT value (in milliseconds) used when waiting for the start of an MLLP frame
+| Name | Description | Default | Type
+| **autoAck** (common) | Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only | true | boolean
+| **bufferWrites** (common) | Enable/Disable the validation of HL7 Payloads If enabled MLLP Payloads are buffered and written to the external system in a single write(byte) operation. If disabled the MLLP payload will not be buffered and three write operations will be used. The first operation will write the MLLP start-of-block character 0x0b (ASCII VT) the second operation will write the HL7 payload and the third operation will writh the MLLP end-of-block character and the MLLP end-of-data character 0x1c 0x0d (ASCII FS CR). | true | boolean
+| **hl7Headers** (common) | Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only | true | boolean
+| **keepAlive** (common) | Enable/disable the SO_KEEPALIVE socket option. | true | boolean
+| **reuseAddress** (common) | Enable/disable the SO_REUSEADDR socket option. | false | boolean
+| **tcpNoDelay** (common) | Enable/disable the TCP_NODELAY socket option. | true | boolean
+| **validatePayload** (common) | Enable/Disable the validation of HL7 Payloads If enabled HL7 Payloads received from external systems will be validated (see Hl7Util.generateInvalidPayloadExceptionMessage for details on the validation). If and invalid payload is detected a MllpInvalidMessageException (for consumers) or a MllpInvalidAcknowledgementException will be thrown. | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **backlog** (advanced) | The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full the connection is refused. | 5 | int
+| **receiveBufferSize** (advanced) | Sets the SO_RCVBUF option to the specified value (in bytes) | | Integer
+| **sendBufferSize** (advanced) | Sets the SO_SNDBUF option to the specified value (in bytes) | | Integer
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **charsetName** (codec) | Set the CamelCharsetName property on the exchange | | String
+| **acceptTimeout** (timeout) | Timeout (in milliseconds) while waiting for a TCP connection TCP Server Only | 60000 | int
+| **bindRetryInterval** (timeout) | TCP Server Only - The number of milliseconds to wait between bind attempts | 5000 | int
+| **bindTimeout** (timeout) | TCP Server Only - The number of milliseconds to retry binding to a server port | 30000 | int
+| **connectTimeout** (timeout) | Timeout (in milliseconds) for establishing for a TCP connection TCP Client only | 30000 | int
+| **maxReceiveTimeouts** (timeout) | The maximum number of timeouts (specified by receiveTimeout) allowed before the TCP Connection will be reset. | -1 | int
+| **readTimeout** (timeout) | The SO_TIMEOUT value (in milliseconds) used after the start of an MLLP frame has been received | 500 | int
+| **receiveTimeout** (timeout) | The SO_TIMEOUT value (in milliseconds) used when waiting for the start of an MLLP frame | 10000 | int
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc b/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc
index 44b7d80..7918b48 100644
--- a/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc
+++ b/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc
@@ -41,51 +41,34 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| connectionBean | | String | *Required* Name of com.mongodb.Mongo to use.
+| Name | Description | Default | Type
+| **connectionBean** | *Required* Name of com.mongodb.Mongo to use. | | String
|=======================================================================
#### Query Parameters (17 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bucket | fs | String | Sets the name of the GridFS bucket within the database. Default is fs.
-
-| database | | String | *Required* Sets the name of the MongoDB database to target
-
-| readPreference | | ReadPreference | Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The link com.mongodb.ReadPreferencevalueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest primary or secondary etc.
-
-| writeConcern | | WriteConcern | Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the link WriteConcernvalueOf(String) method.
-
-| writeConcernRef | | WriteConcern | Set the WriteConcern for write operations on MongoDB passing in the bean ref to a custom WriteConcern which exists in the Registry. You can also use standard WriteConcerns by passing in their key. See the link setWriteConcern(String) setWriteConcern method.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| delay | 500 | long | Sets the delay between polls within the Consumer. Default is 500ms
-
-| fileAttributeName | camel-processed | String | If the QueryType uses a FileAttribute this sets the name of the attribute that is used. Default is camel-processed.
-
-| initialDelay | 1000 | long | Sets the initialDelay before the consumer will start polling. Default is 1000ms
-
-| persistentTSCollection | camel-timestamps | String | If the QueryType uses a persistent timestamp this sets the name of the collection within the DB to store the timestamp.
-
-| persistentTSObject | camel-timestamp | String | If the QueryType uses a persistent timestamp this is the ID of the object in the collection to store the timestamp.
-
-| query | | String | Additional query parameters (in JSON) that are used to configure the query used for finding files in the GridFsConsumer
-
-| queryStrategy | TimeStamp | QueryStrategy | Sets the QueryStrategy that is used for polling for new files. Default is Timestamp
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| operation | | String | Sets the operation this endpoint will execute against GridRS.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **bucket** (common) | Sets the name of the GridFS bucket within the database. Default is fs. | fs | String
+| **database** (common) | *Required* Sets the name of the MongoDB database to target | | String
+| **readPreference** (common) | Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The link com.mongodb.ReadPreferencevalueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest primary or secondary etc. | | ReadPreference
+| **writeConcern** (common) | Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the link WriteConcernvalueOf(String) method. | | WriteConcern
+| **writeConcernRef** (common) | Set the WriteConcern for write operations on MongoDB passing in the bean ref to a custom WriteConcern which exists in the Registry. You can also use standard WriteConcerns by passing in their key. See the link setWriteConcern(String) setWriteConcern method. | | WriteConcern
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **delay** (consumer) | Sets the delay between polls within the Consumer. Default is 500ms | 500 | long
+| **fileAttributeName** (consumer) | If the QueryType uses a FileAttribute this sets the name of the attribute that is used. Default is camel-processed. | camel-processed | String
+| **initialDelay** (consumer) | Sets the initialDelay before the consumer will start polling. Default is 1000ms | 1000 | long
+| **persistentTSCollection** (consumer) | If the QueryType uses a persistent timestamp this sets the name of the collection within the DB to store the timestamp. | camel-timestamps | String
+| **persistentTSObject** (consumer) | If the QueryType uses a persistent timestamp this is the ID of the object in the collection to store the timestamp. | camel-timestamp | String
+| **query** (consumer) | Additional query parameters (in JSON) that are used to configure the query used for finding files in the GridFsConsumer | | String
+| **queryStrategy** (consumer) | Sets the QueryStrategy that is used for polling for new files. Default is Timestamp | TimeStamp | QueryStrategy
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **operation** (producer) | Sets the operation this endpoint will execute against GridRS. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-mongodb/src/main/docs/mongodb-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mongodb/src/main/docs/mongodb-component.adoc b/components/camel-mongodb/src/main/docs/mongodb-component.adoc
index f19cbe2..38e8eeb 100644
--- a/components/camel-mongodb/src/main/docs/mongodb-component.adoc
+++ b/components/camel-mongodb/src/main/docs/mongodb-component.adoc
@@ -68,63 +68,40 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| connectionBean | | String | *Required* Name of com.mongodb.Mongo to use.
+| Name | Description | Default | Type
+| **connectionBean** | *Required* Name of com.mongodb.Mongo to use. | | String
|=======================================================================
#### Query Parameters (23 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| collection | | String | Sets the name of the MongoDB collection to bind to this endpoint
-
-| collectionIndex | | String | Sets the collection index (JSON FORMAT : field1 : order1 field2 : order2)
-
-| createCollection | true | boolean | Create collection during initialisation if it doesn't exist. Default is true.
-
-| database | | String | Sets the name of the MongoDB database to target
-
-| operation | | MongoDbOperation | Sets the operation this endpoint will execute against MongoDB. For possible values see MongoDbOperation.
-
-| outputType | | MongoDbOutputType | Convert the output of the producer to the selected type : DBObjectList DBObject or DBCursor. DBObjectList or DBObject applies to findAll. DBCursor applies to all other operations.
-
-| writeConcern | ACKNOWLEDGED | WriteConcern | Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the link WriteConcernvalueOf(String) method.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| cursorRegenerationDelay | 1000 | long | MongoDB tailable cursors will block until new data arrives. If no new data is inserted after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor and if the attempt fails how long before the next attempt is made. Default value is 1000ms.
-
-| dynamicity | false | boolean | Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit.
-
-| readPreference | | ReadPreference | Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The link ReadPreferencevalueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest primary or secondary etc.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| writeResultAsHeader | false | boolean | In write operations it determines whether instead of returning WriteResult as the body of the OUT message we transfer the IN message to the OUT and attach the WriteResult as a header.
- 4+^s| tail
-| persistentId | | String | One tail tracking collection can host many trackers for several tailable consumers. To keep them separate each tracker should have its own unique persistentId.
-
-| persistentTailTracking | false | boolean | Enable persistent tail tracking which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up the endpoint will recover the cursor from the point where it last stopped slurping records.
-
-| persistRecords | -1 | int | Sets the number of tailed records after which the tail tracking data is persisted to MongoDB.
-
-| tailTrackCollection | | String | Collection where tail tracking information will be persisted. If not specified link MongoDbTailTrackingConfigDEFAULT_COLLECTION will be used by default.
-
-| tailTrackDb | | String | Indicates what database the tail tracking mechanism will persist to. If not specified the current database will be picked by default. Dynamicity will not be taken into account even if enabled i.e. the tail tracking database will not vary past endpoint initialisation.
-
-| tailTrackField | | String | Field where the last tracked value will be placed. If not specified link MongoDbTailTrackingConfigDEFAULT_FIELD will be used by default.
-
-| tailTrackIncreasingField | | String | Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField lastValue (possibly recovered from persistent tail tracking). Can be of type Integer Date String etc. NOTE: No support for dot notation at the current time so the field should be at the top level of the document.
-
-| tailTrackingStrategy | LITERAL | MongoDBTailTrackingEnum | Sets the strategy used to extract the increasing field value and to create the query to position the tail cursor.
+| Name | Description | Default | Type
+| **collection** (common) | Sets the name of the MongoDB collection to bind to this endpoint | | String
+| **collectionIndex** (common) | Sets the collection index (JSON FORMAT : field1 : order1 field2 : order2) | | String
+| **createCollection** (common) | Create collection during initialisation if it doesn't exist. Default is true. | true | boolean
+| **database** (common) | Sets the name of the MongoDB database to target | | String
+| **operation** (common) | Sets the operation this endpoint will execute against MongoDB. For possible values see MongoDbOperation. | | MongoDbOperation
+| **outputType** (common) | Convert the output of the producer to the selected type : DBObjectList DBObject or DBCursor. DBObjectList or DBObject applies to findAll. DBCursor applies to all other operations. | | MongoDbOutputType
+| **writeConcern** (common) | Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the link WriteConcernvalueOf(String) method. | ACKNOWLEDGED | WriteConcern
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **cursorRegenerationDelay** (advanced) | MongoDB tailable cursors will block until new data arrives. If no new data is inserted after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor and if the attempt fails how long before the next attempt is made. Default value is 1000ms. | 1000 | long
+| **dynamicity** (advanced) | Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit. | false | boolean
+| **readPreference** (advanced) | Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The link ReadPreferencevalueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest primary or secondary etc. | | ReadPreference
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **writeResultAsHeader** (advanced) | In write operations it determines whether instead of returning WriteResult as the body of the OUT message we transfer the IN message to the OUT and attach the WriteResult as a header. | false | boolean
+| **persistentId** (tail) | One tail tracking collection can host many trackers for several tailable consumers. To keep them separate each tracker should have its own unique persistentId. | | String
+| **persistentTailTracking** (tail) | Enable persistent tail tracking which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up the endpoint will recover the cursor from the point where it last stopped slurping records. | false | boolean
+| **persistRecords** (tail) | Sets the number of tailed records after which the tail tracking data is persisted to MongoDB. | -1 | int
+| **tailTrackCollection** (tail) | Collection where tail tracking information will be persisted. If not specified link MongoDbTailTrackingConfigDEFAULT_COLLECTION will be used by default. | | String
+| **tailTrackDb** (tail) | Indicates what database the tail tracking mechanism will persist to. If not specified the current database will be picked by default. Dynamicity will not be taken into account even if enabled i.e. the tail tracking database will not vary past endpoint initialisation. | | String
+| **tailTrackField** (tail) | Field where the last tracked value will be placed. If not specified link MongoDbTailTrackingConfigDEFAULT_FIELD will be used by default. | | String
+| **tailTrackIncreasingField** (tail) | Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField lastValue (possibly recovered from persistent tail tracking). Can be of type Integer Date String etc. NOTE: No support for dot notation at the current time so the field should be at the top level of the document. | | String
+| **tailTrackingStrategy** (tail) | Sets the strategy used to extract the increasing field value and to create the query to position the tail cursor. | LITERAL | MongoDBTailTracking Enum
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc b/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc
index 021a5b2..982ec9a 100644
--- a/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc
+++ b/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc
@@ -70,55 +70,36 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| connectionBean | | String | *Required* Name of com.mongodb.Mongo to use.
+| Name | Description | Default | Type
+| **connectionBean** | *Required* Name of com.mongodb.Mongo to use. | | String
|=======================================================================
#### Query Parameters (19 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| collection | | String | Sets the name of the MongoDB collection to bind to this endpoint
-
-| collectionIndex | | String | Sets the collection index (JSON FORMAT : field1 : order1 field2 : order2)
-
-| createCollection | true | boolean | Create collection during initialisation if it doesn't exist. Default is true.
-
-| database | | String | Sets the name of the MongoDB database to target
-
-| operation | | MongoDbOperation | Sets the operation this endpoint will execute against MongoDB. For possible values see MongoDbOperation.
-
-| outputType | | MongoDbOutputType | Convert the output of the producer to the selected type : DocumentList Document or MongoIterable. DocumentList or Document applies to findAll. MongoIterable applies to all other operations.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| cursorRegenerationDelay | 1000 | long | MongoDB tailable cursors will block until new data arrives. If no new data is inserted after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor and if the attempt fails how long before the next attempt is made. Default value is 1000ms.
-
-| dynamicity | false | boolean | Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| writeResultAsHeader | false | boolean | In write operations it determines whether instead of returning WriteResult as the body of the OUT message we transfer the IN message to the OUT and attach the WriteResult as a header.
- 4+^s| tail
-| persistentId | | String | One tail tracking collection can host many trackers for several tailable consumers. To keep them separate each tracker should have its own unique persistentId.
-
-| persistentTailTracking | false | boolean | Enable persistent tail tracking which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up the endpoint will recover the cursor from the point where it last stopped slurping records.
-
-| tailTrackCollection | | String | Collection where tail tracking information will be persisted. If not specified link MongoDbTailTrackingConfigDEFAULT_COLLECTION will be used by default.
-
-| tailTrackDb | | String | Indicates what database the tail tracking mechanism will persist to. If not specified the current database will be picked by default. Dynamicity will not be taken into account even if enabled i.e. the tail tracking database will not vary past endpoint initialisation.
-
-| tailTrackField | | String | Field where the last tracked value will be placed. If not specified link MongoDbTailTrackingConfigDEFAULT_FIELD will be used by default.
-
-| tailTrackIncreasingField | | String | Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField lastValue (possibly recovered from persistent tail tracking). Can be of type Integer Date String etc. NOTE: No support for dot notation at the current time so the field should be at the top level of the document.
+| Name | Description | Default | Type
+| **collection** (common) | Sets the name of the MongoDB collection to bind to this endpoint | | String
+| **collectionIndex** (common) | Sets the collection index (JSON FORMAT : field1 : order1 field2 : order2) | | String
+| **createCollection** (common) | Create collection during initialisation if it doesn't exist. Default is true. | true | boolean
+| **database** (common) | Sets the name of the MongoDB database to target | | String
+| **operation** (common) | Sets the operation this endpoint will execute against MongoDB. For possible values see MongoDbOperation. | | MongoDbOperation
+| **outputType** (common) | Convert the output of the producer to the selected type : DocumentList Document or MongoIterable. DocumentList or Document applies to findAll. MongoIterable applies to all other operations. | | MongoDbOutputType
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **cursorRegenerationDelay** (advanced) | MongoDB tailable cursors will block until new data arrives. If no new data is inserted after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor and if the attempt fails how long before the next attempt is made. Default value is 1000ms. | 1000 | long
+| **dynamicity** (advanced) | Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit. | false | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **writeResultAsHeader** (advanced) | In write operations it determines whether instead of returning WriteResult as the body of the OUT message we transfer the IN message to the OUT and attach the WriteResult as a header. | false | boolean
+| **persistentId** (tail) | One tail tracking collection can host many trackers for several tailable consumers. To keep them separate each tracker should have its own unique persistentId. | | String
+| **persistentTailTracking** (tail) | Enable persistent tail tracking which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up the endpoint will recover the cursor from the point where it last stopped slurping records. | false | boolean
+| **tailTrackCollection** (tail) | Collection where tail tracking information will be persisted. If not specified link MongoDbTailTrackingConfigDEFAULT_COLLECTION will be used by default. | | String
+| **tailTrackDb** (tail) | Indicates what database the tail tracking mechanism will persist to. If not specified the current database will be picked by default. Dynamicity will not be taken into account even if enabled i.e. the tail tracking database will not vary past endpoint initialisation. | | String
+| **tailTrackField** (tail) | Field where the last tracked value will be placed. If not specified link MongoDbTailTrackingConfigDEFAULT_FIELD will be used by default. | | String
+| **tailTrackIncreasingField** (tail) | Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField lastValue (possibly recovered from persistent tail tracking). Can be of type Integer Date String etc. NOTE: No support for dot notation at the current time so the field should be at the top level of the document. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-mqtt/src/main/docs/mqtt-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mqtt/src/main/docs/mqtt-component.adoc b/components/camel-mqtt/src/main/docs/mqtt-component.adoc
index 5bfaa88..d8242d1 100644
--- a/components/camel-mqtt/src/main/docs/mqtt-component.adoc
+++ b/components/camel-mqtt/src/main/docs/mqtt-component.adoc
@@ -39,17 +39,13 @@ The MQTT component supports 4 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| host | | String | The URI of the MQTT broker to connect too - this component also supports SSL - e.g. ssl://127.0.0.1:8883
- 4+^s| security
-| userName | | String | Username to be used for authentication against the MQTT broker
-
-| password | | String | Password to be used for authentication against the MQTT broker
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **host** (common) | The URI of the MQTT broker to connect too - this component also supports SSL - e.g. ssl://127.0.0.1:8883 | | String
+| **userName** (security) | Username to be used for authentication against the MQTT broker | | String
+| **password** (security) | Password to be used for authentication against the MQTT broker | | String
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -67,95 +63,56 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* A logical name to use which is not the topic name.
+| Name | Description | Default | Type
+| **name** | *Required* A logical name to use which is not the topic name. | | String
|=======================================================================
#### Query Parameters (39 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| blockingExecutor | | Executor | SSL connections perform blocking operations against internal thread pool unless you call the setBlockingExecutor method to configure that executor they will use instead.
-
-| byDefaultRetain | false | boolean | The default retain policy to be used on messages sent to the MQTT broker
-
-| cleanSession | false | boolean | Set to false if you want the MQTT server to persist topic subscriptions and ack positions across client sessions. Defaults to true.
-
-| clientId | | String | Use to set the client Id of the session. This is what an MQTT server uses to identify a session where setCleanSession(false); is being used. The id must be 23 characters or less. Defaults to auto generated id (based on your socket address port and timestamp).
-
-| connectAttemptsMax | -1 | long | The maximum number of reconnect attempts before an error is reported back to the client on the first attempt by the client to connect to a server. Set to -1 to use unlimited attempts. Defaults to -1.
-
-| connectWaitInSeconds | 10 | int | Delay in seconds the Component will wait for a connection to be established to the MQTT broker
-
-| disconnectWaitInSeconds | 5 | int | The number of seconds the Component will wait for a valid disconnect on stop() from the MQTT broker
-
-| dispatchQueue | | DispatchQueue | A HawtDispatch dispatch queue is used to synchronize access to the connection. If an explicit queue is not configured via the setDispatchQueue method then a new queue will be created for the connection. Setting an explicit queue might be handy if you want multiple connection to share the same queue for synchronization.
-
-| host | tcp://127.0.0.1:1883 | URI | The URI of the MQTT broker to connect too - this component also supports SSL - e.g. ssl://127.0.0.1:8883
-
-| keepAlive | | short | Configures the Keep Alive timer in seconds. Defines the maximum time interval between messages received from a client. It enables the server to detect that the network connection to a client has dropped without having to wait for the long TCP/IP timeout.
-
-| localAddress | | URI | The local InetAddress and port to use
-
-| maxReadRate | | int | Sets the maximum bytes per second that this transport will receive data at. This setting throttles reads so that the rate is not exceeded. Defaults to 0 which disables throttling.
-
-| maxWriteRate | | int | Sets the maximum bytes per second that this transport will send data at. This setting throttles writes so that the rate is not exceeded. Defaults to 0 which disables throttling.
-
-| mqttQosPropertyName | MQTTQos | String | The property name to look for on an Exchange for an individual published message. If this is set (one of AtMostOnce AtLeastOnce or ExactlyOnce ) - then that QoS will be set on the message sent to the MQTT message broker.
-
-| mqttRetainPropertyName | MQTTRetain | String | The property name to look for on an Exchange for an individual published message. If this is set (expects a Boolean value) - then the retain property will be set on the message sent to the MQTT message broker.
-
-| mqttTopicPropertyName | MQTTTopicPropertyName | String | These a properties that are looked for in an Exchange - to publish to
-
-| publishTopicName | camel/mqtt/test | String | The default Topic to publish messages on
-
-| qualityOfService | AtLeastOnce | String | Quality of service level to use for topics.
-
-| receiveBufferSize | 65536 | int | Sets the size of the internal socket receive buffer. Defaults to 65536 (64k)
-
-| reconnectAttemptsMax | -1 | long | The maximum number of reconnect attempts before an error is reported back to the client after a server connection had previously been established. Set to -1 to use unlimited attempts. Defaults to -1.
-
-| reconnectBackOffMultiplier | 2.0 | double | The Exponential backoff be used between reconnect attempts. Set to 1 to disable exponential backoff. Defaults to 2.
-
-| reconnectDelay | 10 | long | How long to wait in ms before the first reconnect attempt. Defaults to 10.
-
-| reconnectDelayMax | 30000 | long | The maximum amount of time in ms to wait between reconnect attempts. Defaults to 30000.
-
-| sendBufferSize | 65536 | int | Sets the size of the internal socket send buffer. Defaults to 65536 (64k)
-
-| sendWaitInSeconds | 5 | int | The maximum time the Component will wait for a receipt from the MQTT broker to acknowledge a published message before throwing an exception
-
-| sslContext | | SSLContext | To configure security using SSLContext configuration
-
-| subscribeTopicName | | String | These are set on the Endpoint - together with properties inherited from MQTT
-
-| subscribeTopicNames | | String | A comma-delimited list of Topics to subscribe to for messages. Note that each item of this list can contain MQTT wildcards ( and/or ) in order to subscribe to topics matching a certain pattern within a hierarchy. For example is a wildcard for all topics at a level within the hierarchy so if a broker has topics topics/one and topics/two then topics/ can be used to subscribe to both. A caveat to consider here is that if the broker adds topics/three the route would also begin to receive messages from that topic.
-
-| trafficClass | 8 | int | Sets traffic class or type-of-service octet in the IP header for packets sent from the transport. Defaults to 8 which means the traffic should be optimized for throughput.
-
-| version | 3.1 | String | Set to 3.1.1 to use MQTT version 3.1.1. Otherwise defaults to the 3.1 protocol version.
-
-| willMessage | | String | The Will message to send. Defaults to a zero length message.
-
-| willQos | AtMostOnce | QoS | Sets the quality of service to use for the Will message. Defaults to AT_MOST_ONCE.
-
-| willRetain | | QoS | Set to true if you want the Will to be published with the retain option.
-
-| willTopic | | String | If set the server will publish the client's Will message to the specified topics if the client has an unexpected disconnection.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer (advanced)
-| lazySessionCreation | true | boolean | Sessions can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **blockingExecutor** (common) | SSL connections perform blocking operations against internal thread pool unless you call the setBlockingExecutor method to configure that executor they will use instead. | | Executor
+| **byDefaultRetain** (common) | The default retain policy to be used on messages sent to the MQTT broker | false | boolean
+| **cleanSession** (common) | Set to false if you want the MQTT server to persist topic subscriptions and ack positions across client sessions. Defaults to true. | false | boolean
+| **clientId** (common) | Use to set the client Id of the session. This is what an MQTT server uses to identify a session where setCleanSession(false); is being used. The id must be 23 characters or less. Defaults to auto generated id (based on your socket address port and timestamp). | | String
+| **connectAttemptsMax** (common) | The maximum number of reconnect attempts before an error is reported back to the client on the first attempt by the client to connect to a server. Set to -1 to use unlimited attempts. Defaults to -1. | -1 | long
+| **connectWaitInSeconds** (common) | Delay in seconds the Component will wait for a connection to be established to the MQTT broker | 10 | int
+| **disconnectWaitInSeconds** (common) | The number of seconds the Component will wait for a valid disconnect on stop() from the MQTT broker | 5 | int
+| **dispatchQueue** (common) | A HawtDispatch dispatch queue is used to synchronize access to the connection. If an explicit queue is not configured via the setDispatchQueue method then a new queue will be created for the connection. Setting an explicit queue might be handy if you want multiple connection to share the same queue for synchronization. | | DispatchQueue
+| **host** (common) | The URI of the MQTT broker to connect too - this component also supports SSL - e.g. ssl://127.0.0.1:8883 | tcp://127.0.0.1:1883 | URI
+| **keepAlive** (common) | Configures the Keep Alive timer in seconds. Defines the maximum time interval between messages received from a client. It enables the server to detect that the network connection to a client has dropped without having to wait for the long TCP/IP timeout. | | short
+| **localAddress** (common) | The local InetAddress and port to use | | URI
+| **maxReadRate** (common) | Sets the maximum bytes per second that this transport will receive data at. This setting throttles reads so that the rate is not exceeded. Defaults to 0 which disables throttling. | | int
+| **maxWriteRate** (common) | Sets the maximum bytes per second that this transport will send data at. This setting throttles writes so that the rate is not exceeded. Defaults to 0 which disables throttling. | | int
+| **mqttQosPropertyName** (common) | The property name to look for on an Exchange for an individual published message. If this is set (one of AtMostOnce AtLeastOnce or ExactlyOnce ) - then that QoS will be set on the message sent to the MQTT message broker. | MQTTQos | String
+| **mqttRetainPropertyName** (common) | The property name to look for on an Exchange for an individual published message. If this is set (expects a Boolean value) - then the retain property will be set on the message sent to the MQTT message broker. | MQTTRetain | String
+| **mqttTopicPropertyName** (common) | These a properties that are looked for in an Exchange - to publish to | MQTTTopicPropertyName | String
+| **publishTopicName** (common) | The default Topic to publish messages on | camel/mqtt/test | String
+| **qualityOfService** (common) | Quality of service level to use for topics. | AtLeastOnce | String
+| **receiveBufferSize** (common) | Sets the size of the internal socket receive buffer. Defaults to 65536 (64k) | 65536 | int
+| **reconnectAttemptsMax** (common) | The maximum number of reconnect attempts before an error is reported back to the client after a server connection had previously been established. Set to -1 to use unlimited attempts. Defaults to -1. | -1 | long
+| **reconnectBackOffMultiplier** (common) | The Exponential backoff be used between reconnect attempts. Set to 1 to disable exponential backoff. Defaults to 2. | 2.0 | double
+| **reconnectDelay** (common) | How long to wait in ms before the first reconnect attempt. Defaults to 10. | 10 | long
+| **reconnectDelayMax** (common) | The maximum amount of time in ms to wait between reconnect attempts. Defaults to 30000. | 30000 | long
+| **sendBufferSize** (common) | Sets the size of the internal socket send buffer. Defaults to 65536 (64k) | 65536 | int
+| **sendWaitInSeconds** (common) | The maximum time the Component will wait for a receipt from the MQTT broker to acknowledge a published message before throwing an exception | 5 | int
+| **sslContext** (common) | To configure security using SSLContext configuration | | SSLContext
+| **subscribeTopicName** (common) | These are set on the Endpoint - together with properties inherited from MQTT | | String
+| **subscribeTopicNames** (common) | A comma-delimited list of Topics to subscribe to for messages. Note that each item of this list can contain MQTT wildcards ( and/or ) in order to subscribe to topics matching a certain pattern within a hierarchy. For example is a wildcard for all topics at a level within the hierarchy so if a broker has topics topics/one and topics/two then topics/ can be used to subscribe to both. A caveat to consider here is that if the broker adds topics/three the route would also begin to receive messages from that topic. | | String
+| **trafficClass** (common) | Sets traffic class or type-of-service octet in the IP header for packets sent from the transport. Defaults to 8 which means the traffic should be optimized for throughput. | 8 | int
+| **version** (common) | Set to 3.1.1 to use MQTT version 3.1.1. Otherwise defaults to the 3.1 protocol version. | 3.1 | String
+| **willMessage** (common) | The Will message to send. Defaults to a zero length message. | | String
+| **willQos** (common) | Sets the quality of service to use for the Will message. Defaults to AT_MOST_ONCE. | AtMostOnce | QoS
+| **willRetain** (common) | Set to true if you want the Will to be published with the retain option. | | QoS
+| **willTopic** (common) | If set the server will publish the client's Will message to the specified topics if the client has an unexpected disconnection. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **lazySessionCreation** (producer) | Sessions can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-msv/src/main/docs/msv-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-msv/src/main/docs/msv-component.adoc b/components/camel-msv/src/main/docs/msv-component.adoc
index 9c5bccd..b4f3869 100644
--- a/components/camel-msv/src/main/docs/msv-component.adoc
+++ b/components/camel-msv/src/main/docs/msv-component.adoc
@@ -55,15 +55,12 @@ The MSV component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| schemaFactory | | SchemaFactory | To use the javax.xml.validation.SchemaFactory.
-
-| resourceResolverFactory | | ValidatorResourceResolverFactory | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **schemaFactory** (advanced) | To use the javax.xml.validation.SchemaFactory. | | SchemaFactory
+| **resourceResolverFactory** (advanced) | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI | | ValidatorResource ResolverFactory
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -81,39 +78,28 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| resourceUri | | String | *Required* URL to a local resource on the classpath or a reference to lookup a bean in the Registry or a full URL to a remote resource or resource on the file system which contains the XSD to validate against.
+| Name | Description | Default | Type
+| **resourceUri** | *Required* URL to a local resource on the classpath or a reference to lookup a bean in the Registry or a full URL to a remote resource or resource on the file system which contains the XSD to validate against. | | String
|=======================================================================
#### Query Parameters (11 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| failOnNullBody | true | boolean | Whether to fail if no body exists.
-
-| failOnNullHeader | true | boolean | Whether to fail if no header exists when validating against a header.
-
-| headerName | | String | To validate against a header instead of the message body.
- 4+^s| advanced
-| errorHandler | | ValidatorErrorHandler | To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler. The default error handler captures the errors and throws an exception.
-
-| resourceResolver | | LSResourceResolver | To use a custom LSResourceResolver. Do not use together with resourceResolverFactory
-
-| resourceResolverFactory | | ValidatorResourceResolverFactory | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI. The default resource resolver factory resturns a resource resolver which can read files from the class path and file system. Do not use together with resourceResolver.
-
-| schemaFactory | | SchemaFactory | To use a custom javax.xml.validation.SchemaFactory
-
-| schemaLanguage | http://www.w3.org/2001/XMLSchema | String | Configures the W3C XML Schema Namespace URI.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| useDom | false | boolean | Whether DOMSource/DOMResult or SaxSource/SaxResult should be used by the validator.
-
-| useSharedSchema | true | boolean | Whether the Schema instance should be shared or not. This option is introduced to work around a JDK 1.6.x bug. Xerces should not have this issue.
+| Name | Description | Default | Type
+| **failOnNullBody** (producer) | Whether to fail if no body exists. | true | boolean
+| **failOnNullHeader** (producer) | Whether to fail if no header exists when validating against a header. | true | boolean
+| **headerName** (producer) | To validate against a header instead of the message body. | | String
+| **errorHandler** (advanced) | To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler. The default error handler captures the errors and throws an exception. | | ValidatorErrorHandler
+| **resourceResolver** (advanced) | To use a custom LSResourceResolver. Do not use together with resourceResolverFactory | | LSResourceResolver
+| **resourceResolverFactory** (advanced) | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI. The default resource resolver factory resturns a resource resolver which can read files from the class path and file system. Do not use together with resourceResolver. | | ValidatorResource ResolverFactory
+| **schemaFactory** (advanced) | To use a custom javax.xml.validation.SchemaFactory | | SchemaFactory
+| **schemaLanguage** (advanced) | Configures the W3C XML Schema Namespace URI. | http://www.w3.org/2001/XMLSchema | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **useDom** (advanced) | Whether DOMSource/DOMResult or SaxSource/SaxResult should be used by the validator. | false | boolean
+| **useSharedSchema** (advanced) | Whether the Schema instance should be shared or not. This option is introduced to work around a JDK 1.6.x bug. Xerces should not have this issue. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-mustache/src/main/docs/mustache-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mustache/src/main/docs/mustache-component.adoc b/components/camel-mustache/src/main/docs/mustache-component.adoc
index 2e86083..19b5dde 100644
--- a/components/camel-mustache/src/main/docs/mustache-component.adoc
+++ b/components/camel-mustache/src/main/docs/mustache-component.adoc
@@ -44,13 +44,11 @@ The Mustache component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| mustacheFactory | | MustacheFactory | To use a custom MustacheFactory
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **mustacheFactory** (advanced) | To use a custom MustacheFactory | | MustacheFactory
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -70,27 +68,22 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| resourceUri | | String | *Required* 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.
+| Name | Description | Default | Type
+| **resourceUri** | *Required* 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. | | String
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| contentCache | false | boolean | Sets whether to use resource content cache or not
-
-| encoding | | String | Character encoding of the resource content.
-
-| endDelimiter | }} | String | Characters used to mark template code end.
-
-| startDelimiter | {{ | String | Characters used to mark template code beginning.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean
+| **encoding** (producer) | Character encoding of the resource content. | | String
+| **endDelimiter** (producer) | Characters used to mark template code end. | }} | String
+| **startDelimiter** (producer) | Characters used to mark template code beginning. | {{ | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-mvel/src/main/docs/mvel-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mvel/src/main/docs/mvel-component.adoc b/components/camel-mvel/src/main/docs/mvel-component.adoc
index 71e93b0..21959d4 100644
--- a/components/camel-mvel/src/main/docs/mvel-component.adoc
+++ b/components/camel-mvel/src/main/docs/mvel-component.adoc
@@ -52,23 +52,20 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| resourceUri | | String | *Required* 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.
+| Name | Description | Default | Type
+| **resourceUri** | *Required* 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. | | String
|=======================================================================
#### Query Parameters (3 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| contentCache | false | boolean | Sets whether to use resource content cache or not
-
-| encoding | | String | Character encoding of the resource content.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean
+| **encoding** (producer) | Character encoding of the resource content. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-mybatis/src/main/docs/mybatis-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mybatis/src/main/docs/mybatis-component.adoc b/components/camel-mybatis/src/main/docs/mybatis-component.adoc
index 5c15dda..d3a0947 100644
--- a/components/camel-mybatis/src/main/docs/mybatis-component.adoc
+++ b/components/camel-mybatis/src/main/docs/mybatis-component.adoc
@@ -48,15 +48,12 @@ The MyBatis component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| sqlSessionFactory | | SqlSessionFactory | To use the SqlSessionFactory
- 4+^s| common
-| configurationUri | SqlMapConfig.xml | String | Location of MyBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **sqlSessionFactory** (advanced) | To use the SqlSessionFactory | | SqlSessionFactory
+| **configurationUri** (common) | Location of MyBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath | SqlMapConfig.xml | String
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -74,75 +71,46 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| statement | | String | *Required* The statement name in the MyBatis XML mapping file which maps to the query insert update or delete operation you wish to evaluate.
+| Name | Description | Default | Type
+| **statement** | *Required* The statement name in the MyBatis XML mapping file which maps to the query insert update or delete operation you wish to evaluate. | | String
|=======================================================================
#### Query Parameters (29 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| outputHeader | | String | 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. Setting outputHeader will also omit populating the default CamelMyBatisResult header since it would be the same as outputHeader all the time.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| inputHeader | | String | User the header value for input parameters instead of the message body. By default inputHeader == null and the input parameters are taken from the message body. If outputHeader is set the value is used and query parameters will be taken from the header instead of the body.
-
-| maxMessagesPerPoll | 0 | int | This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges. This integer defines the maximum messages to deliver in single exchange. 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 disable it.
-
-| onConsume | | String | Statement to run after data has been processed in the route
-
-| routeEmptyResultSet | false | boolean | Whether allow empty resultset to be routed to the next hop
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| transacted | false | boolean | Enables or disables transaction. If enabled then if processing an exchange failed then the consumer break out processing any further exchanges to cause a rollback eager
-
-| useIterator | true | boolean | Process resultset individually or as a list
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
-
-| processingStrategy | | MyBatisProcessingStrategy | To use a custom MyBatisProcessingStrategy
- 4+^s| producer
-| executorType | SIMPLE | ExecutorType | The executor type to be used while executing statements. simple - executor does nothing special. reuse - executor reuses prepared statements. batch - executor reuses statements and batches updates.
-
-| statementType | | StatementType | Mandatory to specify for the producer to control which kind of operation to invoke.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **outputHeader** (common) | 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. Setting outputHeader will also omit populating the default CamelMyBatisResult header since it would be the same as outputHeader all the time. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **inputHeader** (consumer) | User the header value for input parameters instead of the message body. By default inputHeader == null and the input parameters are taken from the message body. If outputHeader is set the value is used and query parameters will be taken from the header instead of the body. | | String
+| **maxMessagesPerPoll** (consumer) | This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges. This integer defines the maximum messages to deliver in single exchange. 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 disable it. | 0 | int
+| **onConsume** (consumer) | Statement to run after data has been processed in the route | | String
+| **routeEmptyResultSet** (consumer) | Whether allow empty resultset to be routed to the next hop | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **transacted** (consumer) | Enables or disables transaction. If enabled then if processing an exchange failed then the consumer break out processing any further exchanges to cause a rollback eager | false | boolean
+| **useIterator** (consumer) | Process resultset individually or as a list | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **processingStrategy** (consumer) | To use a custom MyBatisProcessingStrategy | | MyBatisProcessing Strategy
+| **executorType** (producer) | The executor type to be used while executing statements. simple - executor does nothing special. reuse - executor reuses prepared statements. batch - executor reuses statements and batches updates. | SIMPLE | ExecutorType
+| **statementType** (producer) | Mandatory to specify for the producer to control which kind of operation to invoke. | | StatementType
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
[10/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-nagios/src/main/docs/nagios-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-nagios/src/main/docs/nagios-component.adoc b/components/camel-nagios/src/main/docs/nagios-component.adoc
index d36c76e..9bc6501 100644
--- a/components/camel-nagios/src/main/docs/nagios-component.adoc
+++ b/components/camel-nagios/src/main/docs/nagios-component.adoc
@@ -42,13 +42,11 @@ The Nagios component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | NagiosConfiguration | To use a shared NagiosConfiguration
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use a shared NagiosConfiguration | | NagiosConfiguration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -67,30 +65,24 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* This is the address of the Nagios host where checks should be send.
-| port | | int | *Required* The port number of the host.
+| Name | Description | Default | Type
+| **host** | *Required* This is the address of the Nagios host where checks should be send. | | String
+| **port** | *Required* The port number of the host. | | int
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| connectionTimeout | 5000 | int | Connection timeout in millis.
-
-| sendSync | true | boolean | Whether or not to use synchronous when sending a passive check. Setting it to false will allow Camel to continue routing the message and the passive check message will be send asynchronously.
-
-| timeout | 5000 | int | Sending timeout in millis.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| encryptionMethod | | NagiosEncryptionMethod | To specify an encryption method.
-
-| password | | String | Password to be authenticated when sending checks to Nagios.
+| Name | Description | Default | Type
+| **connectionTimeout** (producer) | Connection timeout in millis. | 5000 | int
+| **sendSync** (producer) | Whether or not to use synchronous when sending a passive check. Setting it to false will allow Camel to continue routing the message and the passive check message will be send asynchronously. | true | boolean
+| **timeout** (producer) | Sending timeout in millis. | 5000 | int
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **encryptionMethod** (security) | To specify an encryption method. | | NagiosEncryptionMethod
+| **password** (security) | Password to be authenticated when sending checks to Nagios. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-nats/src/main/docs/nats-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-nats/src/main/docs/nats-component.adoc b/components/camel-nats/src/main/docs/nats-component.adoc
index 9852eca..82e366e 100644
--- a/components/camel-nats/src/main/docs/nats-component.adoc
+++ b/components/camel-nats/src/main/docs/nats-component.adoc
@@ -46,61 +46,39 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| servers | | String | *Required* URLs to one or more NAT servers. Use comma to separate URLs when specifying multiple servers.
+| Name | Description | Default | Type
+| **servers** | *Required* URLs to one or more NAT servers. Use comma to separate URLs when specifying multiple servers. | | String
|=======================================================================
#### Query Parameters (22 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| flushConnection | false | boolean | Define if we want to flush connection or not
-
-| flushTimeout | 1000 | int | Set the flush timeout
-
-| maxReconnectAttempts | 3 | int | Max reconnection attempts
-
-| noRandomizeServers | false | boolean | Whether or not randomizing the order of servers for the connection attempts
-
-| pedantic | false | boolean | Whether or not running in pedantic mode (this affects performace)
-
-| pingInterval | 4000 | int | Ping interval to be aware if connection is still alive (in milliseconds)
-
-| reconnect | true | boolean | Whether or not using reconnection feature
-
-| reconnectTimeWait | 2000 | int | Waiting time before attempts reconnection (in milliseconds)
-
-| topic | | String | *Required* The name of topic we want to use
-
-| verbose | false | boolean | Whether or not running in verbose mode
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| maxMessages | | String | Stop receiving messages from a topic we are subscribing to after maxMessages
-
-| poolSize | 10 | int | Consumer pool size
-
-| queueName | | String | The Queue name if we are using nats for a queue configuration
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| replySubject | | String | the subject to which subscribers should send response
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| secure | false | boolean | Set secure option indicating TLS is required
-
-| ssl | false | boolean | Whether or not using SSL
-
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
-
-| tlsDebug | false | boolean | TLS Debug it will add additional console output
+| Name | Description | Default | Type
+| **flushConnection** (common) | Define if we want to flush connection or not | false | boolean
+| **flushTimeout** (common) | Set the flush timeout | 1000 | int
+| **maxReconnectAttempts** (common) | Max reconnection attempts | 3 | int
+| **noRandomizeServers** (common) | Whether or not randomizing the order of servers for the connection attempts | false | boolean
+| **pedantic** (common) | Whether or not running in pedantic mode (this affects performace) | false | boolean
+| **pingInterval** (common) | Ping interval to be aware if connection is still alive (in milliseconds) | 4000 | int
+| **reconnect** (common) | Whether or not using reconnection feature | true | boolean
+| **reconnectTimeWait** (common) | Waiting time before attempts reconnection (in milliseconds) | 2000 | int
+| **topic** (common) | *Required* The name of topic we want to use | | String
+| **verbose** (common) | Whether or not running in verbose mode | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **maxMessages** (consumer) | Stop receiving messages from a topic we are subscribing to after maxMessages | | String
+| **poolSize** (consumer) | Consumer pool size | 10 | int
+| **queueName** (consumer) | The Queue name if we are using nats for a queue configuration | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **replySubject** (producer) | the subject to which subscribers should send response | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **secure** (security) | Set secure option indicating TLS is required | false | boolean
+| **ssl** (security) | Whether or not using SSL | false | boolean
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
+| **tlsDebug** (security) | TLS Debug it will add additional console output | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-netty-http/src/main/docs/netty-http-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-netty-http/src/main/docs/netty-http-component.adoc b/components/camel-netty-http/src/main/docs/netty-http-component.adoc
index 9d1f650..6becdcd 100644
--- a/components/camel-netty-http/src/main/docs/netty-http-component.adoc
+++ b/components/camel-netty-http/src/main/docs/netty-http-component.adoc
@@ -80,21 +80,15 @@ The Netty HTTP component supports 6 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| nettyHttpBinding | | NettyHttpBinding | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API.
- 4+^s| common
-| configuration | | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints.
- 4+^s| advanced
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.
- 4+^s| security
-| securityConfiguration | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources.
- 4+^s| advanced
-| maximumPoolSize | 16 | int | The core pool size for the ordered thread pool if its in use. The default value is 16.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **nettyHttpBinding** (advanced) | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. | | NettyHttpBinding
+| **configuration** (common) | To use the NettyConfiguration as configuration when creating endpoints. | | NettyHttpConfiguration
+| **headerFilterStrategy** (advanced) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. | | HeaderFilterStrategy
+| **securityConfiguration** (security) | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. | | NettyHttpSecurity Configuration
+| **maximumPoolSize** (advanced) | The core pool size for the ordered thread pool if its in use. The default value is 16. | 16 | int
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -114,176 +108,98 @@ with the following path and query parameters:
#### Path Parameters (4 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| protocol | | String | *Required* The protocol to use which is either http or https
-| host | | String | *Required* The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer.
-| port | | int | The host port number
-| path | | String | Resource path
+| Name | Description | Default | Type
+| **protocol** | *Required* The protocol to use which is either http or https | | String
+| **host** | *Required* The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. | | String
+| **port** | The host port number | | int
+| **path** | Resource path | | String
|=======================================================================
#### Query Parameters (78 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeEndpoint | false | boolean | If the option is true the producer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange).
-
-| disconnect | false | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer.
-
-| keepAlive | true | boolean | Setting to ensure socket is not closed due to inactivity
-
-| reuseAddress | true | boolean | Setting to facilitate socket multiplexing
-
-| sync | true | boolean | Setting to set endpoint as one-way or request-response
-
-| tcpNoDelay | true | boolean | Setting to improve TCP protocol performance
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| matchOnUriPrefix | false | boolean | Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found.
-
-| send503whenSuspended | true | boolean | Whether to send back HTTP status code 503 when the consumer has been suspended. If the option is false then the Netty Acceptor is unbound when the consumer is suspended so clients cannot connect anymore.
- 4+^s| consumer (advanced)
-| backlog | | int | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting.
-
-| bossCount | 1 | int | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty
-
-| bossPool | | BossPool | To use a explicit org.jboss.netty.channel.socket.nio.BossPool as the boss thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own boss pool with 1 core thread.
-
-| channelGroup | | ChannelGroup | To use a explicit ChannelGroup.
-
-| chunkedMaxContentLength | 1048576 | int | Value in bytes the max content length per chunked frame received on the Netty HTTP server.
-
-| compression | false | boolean | Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers.
-
-| disableStreamCache | false | boolean | Determines whether or not the raw input stream from Netty HttpRequestgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty 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. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Netty raw stream.
-
-| disconnectOnNoReply | true | boolean | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| httpMethodRestrict | | String | To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma.
-
-| mapHeaders | true | boolean | If this option is enabled then during binding from Netty to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.netty.http.NettyHttpMessage message with the method getHttpRequest() that returns the Netty HTTP request org.jboss.netty.handler.codec.http.HttpRequest instance.
-
-| maxChannelMemorySize | 10485760 | long | The maximum total size of the queued events per channel when using orderedThreadPoolExecutor. Specify 0 to disable.
-
-| maxHeaderSize | 8192 | int | The maximum length of all headers. If the sum of the length of each header exceeds this value a TooLongFrameException will be raised.
-
-| maxTotalMemorySize | 209715200 | long | The maximum total size of the queued events for this pool when using orderedThreadPoolExecutor. Specify 0 to disable.
-
-| nettyServerBootstrapFactory | | NettyServerBootstrapFactory | To use a custom NettyServerBootstrapFactory
-
-| nettySharedHttpServer | | NettySharedHttpServer | To use a shared Netty HTTP server. See Netty HTTP Server Example for more details.
-
-| noReplyLogLevel | WARN | LoggingLevel | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back.
-
-| orderedThreadPoolExecutor | true | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. See details at the netty javadoc of org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor for more details.
-
-| serverClosedChannelExceptionCaughtLogLevel | DEBUG | LoggingLevel | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server.
-
-| serverExceptionCaughtLogLevel | WARN | LoggingLevel | If the server (NettyConsumer) catches an exception then its logged using this logging level.
-
-| serverPipelineFactory | | ServerPipelineFactory | To use a custom ServerPipelineFactory
-
-| traceEnabled | false | boolean | Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off.
-
-| urlDecodeHeaders | false | boolean | If this option is enabled then during binding from Netty to Camel Message then the header values will be URL decoded (eg 20 will be a space character. Notice this option is used by the default org.apache.camel.component.netty.http.NettyHttpBinding and therefore if you implement a custom org.apache.camel.component.netty.http.NettyHttpBinding then you would need to decode the headers accordingly to this option.
-
-| workerCount | | int | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty
-
-| workerPool | | WorkerPool | To use a explicit org.jboss.netty.channel.socket.nio.WorkerPool as the worker thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own worker pool with 2 x cpu count core threads.
- 4+^s| producer
-| connectTimeout | 10000 | long | Time to wait for a socket connection to be available. Value is in millis.
-
-| requestTimeout | | long | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout.
-
-| throwExceptionOnFailure | true | boolean | 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.
- 4+^s| producer (advanced)
-| clientPipelineFactory | | ClientPipelineFactory | To use a custom ClientPipelineFactory
-
-| lazyChannelCreation | true | boolean | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started.
-
-| okStatusCodeRange | 200-299 | String | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. The default range is 200-299
-
-| producerPoolEnabled | true | boolean | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply.
-
-| producerPoolMaxActive | -1 | int | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit.
-
-| producerPoolMaxIdle | 100 | int | Sets the cap on the number of idle instances in the pool.
-
-| producerPoolMinEvictableIdle | 300000 | long | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor.
-
-| producerPoolMinIdle | | int | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects.
-
-| useChannelBuffer | false | boolean | If the useChannelBuffer is true netty producer will turn the message body into ChannelBuffer before sending it out.
-
-| useRelativePath | false | boolean | Sets whether to use a relative path in HTTP requests. Some third party backend systems such as IBM Datapower do not support absolute URIs in HTTP POSTs and setting this option to true can work around this problem.
- 4+^s| advanced
-| bootstrapConfiguration | | NettyServerBootstrapConfiguration | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint.
-
-| configuration | | NettyHttpConfiguration | To use a custom configured NettyHttpConfiguration for configuring this endpoint.
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.
-
-| nettyHttpBinding | | NettyHttpBinding | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API.
-
-| options | | Map | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used.
-
-| receiveBufferSize | 65536 | long | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes.
-
-| receiveBufferSizePredictor | | int | Configures the buffer size predictor. See details at Jetty documentation and this mail thread.
-
-| sendBufferSize | 65536 | long | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| transferException | false | boolean | 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.
-
-| transferExchange | false | boolean | Only used for TCP. You can transfer the exchange over the wire instead of just the body. 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.
- 4+^s| codec
-| decoder | | ChannelHandler | To use a single decoder. This options is deprecated use encoders instead.
-
-| decoders | | String | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup.
-
-| encoder | | ChannelHandler | To use a single encoder. This options is deprecated use encoders instead.
-
-| encoders | | String | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup.
- 4+^s| security
-| enabledProtocols | TLSv1,TLSv1.1,TLSv1.2 | String | Which protocols to enable when using SSL
-
-| keyStoreFile | | File | Client side certificate keystore to be used for encryption
-
-| keyStoreFormat | JKS | String | Keystore format to be used for payload encryption. Defaults to JKS if not set
-
-| keyStoreResource | | String | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems.
-
-| needClientAuth | false | boolean | Configures whether the server needs client authentication when using SSL.
-
-| passphrase | | String | Password setting to use in order to encrypt/decrypt payloads sent using SSH
-
-| securityConfiguration | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources.
-
-| securityOptions | | Map | To configure NettyHttpSecurityConfiguration using key/value pairs from the map
-
-| securityProvider | SunX509 | String | Security provider to be used for payload encryption. Defaults to SunX509 if not set.
-
-| ssl | false | boolean | Setting to specify whether SSL encryption is applied to this endpoint
-
-| sslClientCertHeaders | false | boolean | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range.
-
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
-
-| sslHandler | | SslHandler | Reference to a class that could be used to return an SSL Handler
-
-| trustStoreFile | | File | Server side certificate keystore to be used for encryption
-
-| trustStoreResource | | String | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems.
+| Name | Description | Default | Type
+| **bridgeEndpoint** (common) | If the option is true the producer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange). | false | boolean
+| **disconnect** (common) | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | false | boolean
+| **keepAlive** (common) | Setting to ensure socket is not closed due to inactivity | true | boolean
+| **reuseAddress** (common) | Setting to facilitate socket multiplexing | true | boolean
+| **sync** (common) | Setting to set endpoint as one-way or request-response | true | boolean
+| **tcpNoDelay** (common) | Setting to improve TCP protocol performance | true | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **matchOnUriPrefix** (consumer) | Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. | false | boolean
+| **send503whenSuspended** (consumer) | Whether to send back HTTP status code 503 when the consumer has been suspended. If the option is false then the Netty Acceptor is unbound when the consumer is suspended so clients cannot connect anymore. | true | boolean
+| **backlog** (consumer) | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting. | | int
+| **bossCount** (consumer) | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty | 1 | int
+| **bossPool** (consumer) | To use a explicit org.jboss.netty.channel.socket.nio.BossPool as the boss thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own boss pool with 1 core thread. | | BossPool
+| **channelGroup** (consumer) | To use a explicit ChannelGroup. | | ChannelGroup
+| **chunkedMaxContentLength** (consumer) | Value in bytes the max content length per chunked frame received on the Netty HTTP server. | 1048576 | int
+| **compression** (consumer) | Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers. | false | boolean
+| **disableStreamCache** (consumer) | Determines whether or not the raw input stream from Netty HttpRequestgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty 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. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Netty raw stream. | false | boolean
+| **disconnectOnNoReply** (consumer) | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **httpMethodRestrict** (consumer) | To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma. | | String
+| **mapHeaders** (consumer) | If this option is enabled then during binding from Netty to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.netty.http.NettyHttpMessage message with the method getHttpRequest() that returns the Netty HTTP request org.jboss.netty.handler.codec.http.HttpRequest instance. | true | boolean
+| **maxChannelMemorySize** (consumer) | The maximum total size of the queued events per channel when using orderedThreadPoolExecutor. Specify 0 to disable. | 10485760 | long
+| **maxHeaderSize** (consumer) | The maximum length of all headers. If the sum of the length of each header exceeds this value a TooLongFrameException will be raised. | 8192 | int
+| **maxTotalMemorySize** (consumer) | The maximum total size of the queued events for this pool when using orderedThreadPoolExecutor. Specify 0 to disable. | 209715200 | long
+| **nettyServerBootstrapFactory** (consumer) | To use a custom NettyServerBootstrapFactory | | NettyServerBootstrap Factory
+| **nettySharedHttpServer** (consumer) | To use a shared Netty HTTP server. See Netty HTTP Server Example for more details. | | NettySharedHttpServer
+| **noReplyLogLevel** (consumer) | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. | WARN | LoggingLevel
+| **orderedThreadPoolExecutor** (consumer) | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. See details at the netty javadoc of org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor for more details. | true | boolean
+| **serverClosedChannel ExceptionCaughtLogLevel** (consumer) | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. | DEBUG | LoggingLevel
+| **serverExceptionCaughtLog Level** (consumer) | If the server (NettyConsumer) catches an exception then its logged using this logging level. | WARN | LoggingLevel
+| **serverPipelineFactory** (consumer) | To use a custom ServerPipelineFactory | | ServerPipelineFactory
+| **traceEnabled** (consumer) | Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off. | false | boolean
+| **urlDecodeHeaders** (consumer) | If this option is enabled then during binding from Netty to Camel Message then the header values will be URL decoded (eg 20 will be a space character. Notice this option is used by the default org.apache.camel.component.netty.http.NettyHttpBinding and therefore if you implement a custom org.apache.camel.component.netty.http.NettyHttpBinding then you would need to decode the headers accordingly to this option. | false | boolean
+| **workerCount** (consumer) | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty | | int
+| **workerPool** (consumer) | To use a explicit org.jboss.netty.channel.socket.nio.WorkerPool as the worker thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own worker pool with 2 x cpu count core threads. | | WorkerPool
+| **connectTimeout** (producer) | Time to wait for a socket connection to be available. Value is in millis. | 10000 | long
+| **requestTimeout** (producer) | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. | | long
+| **throwExceptionOnFailure** (producer) | 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. | true | boolean
+| **clientPipelineFactory** (producer) | To use a custom ClientPipelineFactory | | ClientPipelineFactory
+| **lazyChannelCreation** (producer) | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. | true | boolean
+| **okStatusCodeRange** (producer) | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. The default range is 200-299 | 200-299 | String
+| **producerPoolEnabled** (producer) | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply. | true | boolean
+| **producerPoolMaxActive** (producer) | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit. | -1 | int
+| **producerPoolMaxIdle** (producer) | Sets the cap on the number of idle instances in the pool. | 100 | int
+| **producerPoolMinEvictable Idle** (producer) | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. | 300000 | long
+| **producerPoolMinIdle** (producer) | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. | | int
+| **useChannelBuffer** (producer) | If the useChannelBuffer is true netty producer will turn the message body into ChannelBuffer before sending it out. | false | boolean
+| **useRelativePath** (producer) | Sets whether to use a relative path in HTTP requests. Some third party backend systems such as IBM Datapower do not support absolute URIs in HTTP POSTs and setting this option to true can work around this problem. | false | boolean
+| **bootstrapConfiguration** (advanced) | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. | | NettyServerBootstrap Configuration
+| **configuration** (advanced) | To use a custom configured NettyHttpConfiguration for configuring this endpoint. | | NettyHttpConfiguration
+| **headerFilterStrategy** (advanced) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. | | HeaderFilterStrategy
+| **nettyHttpBinding** (advanced) | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. | | NettyHttpBinding
+| **options** (advanced) | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. | | Map
+| **receiveBufferSize** (advanced) | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. | 65536 | long
+| **receiveBufferSizePredictor** (advanced) | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. | | int
+| **sendBufferSize** (advanced) | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. | 65536 | long
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **transferException** (advanced) | 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. | false | boolean
+| **transferExchange** (advanced) | Only used for TCP. You can transfer the exchange over the wire instead of just the body. 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. | false | boolean
+| **decoder** (codec) | To use a single decoder. This options is deprecated use encoders instead. | | ChannelHandler
+| **decoders** (codec) | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. | | String
+| **encoder** (codec) | To use a single encoder. This options is deprecated use encoders instead. | | ChannelHandler
+| **encoders** (codec) | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. | | String
+| **enabledProtocols** (security) | Which protocols to enable when using SSL | TLSv1,TLSv1.1,TLSv1.2 | String
+| **keyStoreFile** (security) | Client side certificate keystore to be used for encryption | | File
+| **keyStoreFormat** (security) | Keystore format to be used for payload encryption. Defaults to JKS if not set | JKS | String
+| **keyStoreResource** (security) | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. | | String
+| **needClientAuth** (security) | Configures whether the server needs client authentication when using SSL. | false | boolean
+| **passphrase** (security) | Password setting to use in order to encrypt/decrypt payloads sent using SSH | | String
+| **securityConfiguration** (security) | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. | | NettyHttpSecurity Configuration
+| **securityOptions** (security) | To configure NettyHttpSecurityConfiguration using key/value pairs from the map | | Map
+| **securityProvider** (security) | Security provider to be used for payload encryption. Defaults to SunX509 if not set. | SunX509 | String
+| **ssl** (security) | Setting to specify whether SSL encryption is applied to this endpoint | false | boolean
+| **sslClientCertHeaders** (security) | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range. | false | boolean
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
+| **sslHandler** (security) | Reference to a class that could be used to return an SSL Handler | | SslHandler
+| **trustStoreFile** (security) | Server side certificate keystore to be used for encryption | | File
+| **trustStoreResource** (security) | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-netty/src/main/docs/netty-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-netty/src/main/docs/netty-component.adoc b/components/camel-netty/src/main/docs/netty-component.adoc
index 24cbfa2..66a0275 100644
--- a/components/camel-netty/src/main/docs/netty-component.adoc
+++ b/components/camel-netty/src/main/docs/netty-component.adoc
@@ -60,15 +60,12 @@ The Netty component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints.
-
-| maximumPoolSize | 16 | int | The core pool size for the ordered thread pool if its in use. The default value is 16.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use the NettyConfiguration as configuration when creating endpoints. | | NettyConfiguration
+| **maximumPoolSize** (advanced) | The core pool size for the ordered thread pool if its in use. The default value is 16. | 16 | int
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -88,153 +85,86 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| protocol | | String | *Required* The protocol to use which can be tcp or udp.
-| host | | String | *Required* The hostname. For the consumer the hostname is localhost or 0.0.0.0 For the producer the hostname is the remote host to connect to
-| port | | int | *Required* The host port number
+| Name | Description | Default | Type
+| **protocol** | *Required* The protocol to use which can be tcp or udp. | | String
+| **host** | *Required* The hostname. For the consumer the hostname is localhost or 0.0.0.0 For the producer the hostname is the remote host to connect to | | String
+| **port** | *Required* The host port number | | int
|=======================================================================
#### Query Parameters (67 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| disconnect | false | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer.
-
-| keepAlive | true | boolean | Setting to ensure socket is not closed due to inactivity
-
-| reuseAddress | true | boolean | Setting to facilitate socket multiplexing
-
-| sync | true | boolean | Setting to set endpoint as one-way or request-response
-
-| tcpNoDelay | true | boolean | Setting to improve TCP protocol performance
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| broadcast | false | boolean | Setting to choose Multicast over UDP
-
-| clientMode | false | boolean | If the clientMode is true netty consumer will connect the address as a TCP client.
- 4+^s| consumer (advanced)
-| backlog | | int | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting.
-
-| bossCount | 1 | int | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty
-
-| bossPool | | BossPool | To use a explicit org.jboss.netty.channel.socket.nio.BossPool as the boss thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own boss pool with 1 core thread.
-
-| channelGroup | | ChannelGroup | To use a explicit ChannelGroup.
-
-| disconnectOnNoReply | true | boolean | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| maxChannelMemorySize | 10485760 | long | The maximum total size of the queued events per channel when using orderedThreadPoolExecutor. Specify 0 to disable.
-
-| maxTotalMemorySize | 209715200 | long | The maximum total size of the queued events for this pool when using orderedThreadPoolExecutor. Specify 0 to disable.
-
-| nettyServerBootstrapFactory | | NettyServerBootstrapFactory | To use a custom NettyServerBootstrapFactory
-
-| networkInterface | | String | When using UDP then this option can be used to specify a network interface by its name such as eth0 to join a multicast group.
-
-| noReplyLogLevel | WARN | LoggingLevel | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back.
-
-| orderedThreadPoolExecutor | true | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. See details at the netty javadoc of org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor for more details.
-
-| serverClosedChannelExceptionCaughtLogLevel | DEBUG | LoggingLevel | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server.
-
-| serverExceptionCaughtLogLevel | WARN | LoggingLevel | If the server (NettyConsumer) catches an exception then its logged using this logging level.
-
-| serverPipelineFactory | | ServerPipelineFactory | To use a custom ServerPipelineFactory
-
-| workerCount | | int | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty
-
-| workerPool | | WorkerPool | To use a explicit org.jboss.netty.channel.socket.nio.WorkerPool as the worker thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own worker pool with 2 x cpu count core threads.
- 4+^s| producer
-| connectTimeout | 10000 | long | Time to wait for a socket connection to be available. Value is in millis.
-
-| requestTimeout | | long | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout.
- 4+^s| producer (advanced)
-| clientPipelineFactory | | ClientPipelineFactory | To use a custom ClientPipelineFactory
-
-| lazyChannelCreation | true | boolean | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started.
-
-| producerPoolEnabled | true | boolean | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply.
-
-| producerPoolMaxActive | -1 | int | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit.
-
-| producerPoolMaxIdle | 100 | int | Sets the cap on the number of idle instances in the pool.
-
-| producerPoolMinEvictableIdle | 300000 | long | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor.
-
-| producerPoolMinIdle | | int | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects.
-
-| udpConnectionlessSending | false | boolean | This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port.
-
-| useChannelBuffer | false | boolean | If the useChannelBuffer is true netty producer will turn the message body into ChannelBuffer before sending it out.
- 4+^s| advanced
-| bootstrapConfiguration | | NettyServerBootstrapConfiguration | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint.
-
-| options | | Map | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used.
-
-| receiveBufferSize | 65536 | long | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes.
-
-| receiveBufferSizePredictor | | int | Configures the buffer size predictor. See details at Jetty documentation and this mail thread.
-
-| sendBufferSize | 65536 | long | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| transferExchange | false | boolean | Only used for TCP. You can transfer the exchange over the wire instead of just the body. 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.
- 4+^s| codec
-| allowDefaultCodec | true | boolean | The netty component installs a default codec if both encoder/deocder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain.
-
-| autoAppendDelimiter | true | boolean | Whether or not to auto append missing end delimiter when sending using the textline codec.
-
-| decoder | | ChannelHandler | A custom ChannelHandler class that can be used to perform special marshalling of inbound payloads. Must override org.jboss.netty.channel.ChannelUpStreamHandler.
-
-| decoderMaxLineLength | 1024 | int | The max line length to use for the textline codec.
-
-| decoders | | String | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup.
-
-| delimiter | LINE | TextLineDelimiter | The delimiter to use for the textline codec. Possible values are LINE and NULL.
-
-| encoder | | ChannelHandler | A custom ChannelHandler class that can be used to perform special marshalling of outbound payloads. Must override org.jboss.netty.channel.ChannelDownStreamHandler.
-
-| encoders | | String | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup.
-
-| encoding | | String | The encoding (a charset name) to use for the textline codec. If not provided Camel will use the JVM default Charset.
-
-| textline | false | boolean | Only used for TCP. If no codec is specified you can use this flag to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP.
- 4+^s| security
-| enabledProtocols | TLSv1,TLSv1.1,TLSv1.2 | String | Which protocols to enable when using SSL
-
-| keyStoreFile | | File | Client side certificate keystore to be used for encryption
-
-| keyStoreFormat | JKS | String | Keystore format to be used for payload encryption. Defaults to JKS if not set
-
-| keyStoreResource | | String | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems.
-
-| needClientAuth | false | boolean | Configures whether the server needs client authentication when using SSL.
-
-| passphrase | | String | Password setting to use in order to encrypt/decrypt payloads sent using SSH
-
-| securityProvider | SunX509 | String | Security provider to be used for payload encryption. Defaults to SunX509 if not set.
-
-| ssl | false | boolean | Setting to specify whether SSL encryption is applied to this endpoint
-
-| sslClientCertHeaders | false | boolean | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range.
-
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
-
-| sslHandler | | SslHandler | Reference to a class that could be used to return an SSL Handler
-
-| trustStoreFile | | File | Server side certificate keystore to be used for encryption
-
-| trustStoreResource | | String | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems.
+| Name | Description | Default | Type
+| **disconnect** (common) | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | false | boolean
+| **keepAlive** (common) | Setting to ensure socket is not closed due to inactivity | true | boolean
+| **reuseAddress** (common) | Setting to facilitate socket multiplexing | true | boolean
+| **sync** (common) | Setting to set endpoint as one-way or request-response | true | boolean
+| **tcpNoDelay** (common) | Setting to improve TCP protocol performance | true | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **broadcast** (consumer) | Setting to choose Multicast over UDP | false | boolean
+| **clientMode** (consumer) | If the clientMode is true netty consumer will connect the address as a TCP client. | false | boolean
+| **backlog** (consumer) | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting. | | int
+| **bossCount** (consumer) | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty | 1 | int
+| **bossPool** (consumer) | To use a explicit org.jboss.netty.channel.socket.nio.BossPool as the boss thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own boss pool with 1 core thread. | | BossPool
+| **channelGroup** (consumer) | To use a explicit ChannelGroup. | | ChannelGroup
+| **disconnectOnNoReply** (consumer) | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **maxChannelMemorySize** (consumer) | The maximum total size of the queued events per channel when using orderedThreadPoolExecutor. Specify 0 to disable. | 10485760 | long
+| **maxTotalMemorySize** (consumer) | The maximum total size of the queued events for this pool when using orderedThreadPoolExecutor. Specify 0 to disable. | 209715200 | long
+| **nettyServerBootstrapFactory** (consumer) | To use a custom NettyServerBootstrapFactory | | NettyServerBootstrap Factory
+| **networkInterface** (consumer) | When using UDP then this option can be used to specify a network interface by its name such as eth0 to join a multicast group. | | String
+| **noReplyLogLevel** (consumer) | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. | WARN | LoggingLevel
+| **orderedThreadPoolExecutor** (consumer) | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. See details at the netty javadoc of org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor for more details. | true | boolean
+| **serverClosedChannel ExceptionCaughtLogLevel** (consumer) | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. | DEBUG | LoggingLevel
+| **serverExceptionCaughtLog Level** (consumer) | If the server (NettyConsumer) catches an exception then its logged using this logging level. | WARN | LoggingLevel
+| **serverPipelineFactory** (consumer) | To use a custom ServerPipelineFactory | | ServerPipelineFactory
+| **workerCount** (consumer) | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty | | int
+| **workerPool** (consumer) | To use a explicit org.jboss.netty.channel.socket.nio.WorkerPool as the worker thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own worker pool with 2 x cpu count core threads. | | WorkerPool
+| **connectTimeout** (producer) | Time to wait for a socket connection to be available. Value is in millis. | 10000 | long
+| **requestTimeout** (producer) | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. | | long
+| **clientPipelineFactory** (producer) | To use a custom ClientPipelineFactory | | ClientPipelineFactory
+| **lazyChannelCreation** (producer) | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. | true | boolean
+| **producerPoolEnabled** (producer) | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply. | true | boolean
+| **producerPoolMaxActive** (producer) | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit. | -1 | int
+| **producerPoolMaxIdle** (producer) | Sets the cap on the number of idle instances in the pool. | 100 | int
+| **producerPoolMinEvictable Idle** (producer) | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. | 300000 | long
+| **producerPoolMinIdle** (producer) | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. | | int
+| **udpConnectionlessSending** (producer) | This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port. | false | boolean
+| **useChannelBuffer** (producer) | If the useChannelBuffer is true netty producer will turn the message body into ChannelBuffer before sending it out. | false | boolean
+| **bootstrapConfiguration** (advanced) | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. | | NettyServerBootstrap Configuration
+| **options** (advanced) | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. | | Map
+| **receiveBufferSize** (advanced) | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. | 65536 | long
+| **receiveBufferSizePredictor** (advanced) | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. | | int
+| **sendBufferSize** (advanced) | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. | 65536 | long
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **transferExchange** (advanced) | Only used for TCP. You can transfer the exchange over the wire instead of just the body. 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. | false | boolean
+| **allowDefaultCodec** (codec) | The netty component installs a default codec if both encoder/deocder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. | true | boolean
+| **autoAppendDelimiter** (codec) | Whether or not to auto append missing end delimiter when sending using the textline codec. | true | boolean
+| **decoder** (codec) | A custom ChannelHandler class that can be used to perform special marshalling of inbound payloads. Must override org.jboss.netty.channel.ChannelUpStreamHandler. | | ChannelHandler
+| **decoderMaxLineLength** (codec) | The max line length to use for the textline codec. | 1024 | int
+| **decoders** (codec) | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. | | String
+| **delimiter** (codec) | The delimiter to use for the textline codec. Possible values are LINE and NULL. | LINE | TextLineDelimiter
+| **encoder** (codec) | A custom ChannelHandler class that can be used to perform special marshalling of outbound payloads. Must override org.jboss.netty.channel.ChannelDownStreamHandler. | | ChannelHandler
+| **encoders** (codec) | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. | | String
+| **encoding** (codec) | The encoding (a charset name) to use for the textline codec. If not provided Camel will use the JVM default Charset. | | String
+| **textline** (codec) | Only used for TCP. If no codec is specified you can use this flag to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP. | false | boolean
+| **enabledProtocols** (security) | Which protocols to enable when using SSL | TLSv1,TLSv1.1,TLSv1.2 | String
+| **keyStoreFile** (security) | Client side certificate keystore to be used for encryption | | File
+| **keyStoreFormat** (security) | Keystore format to be used for payload encryption. Defaults to JKS if not set | JKS | String
+| **keyStoreResource** (security) | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. | | String
+| **needClientAuth** (security) | Configures whether the server needs client authentication when using SSL. | false | boolean
+| **passphrase** (security) | Password setting to use in order to encrypt/decrypt payloads sent using SSH | | String
+| **securityProvider** (security) | Security provider to be used for payload encryption. Defaults to SunX509 if not set. | SunX509 | String
+| **ssl** (security) | Setting to specify whether SSL encryption is applied to this endpoint | false | boolean
+| **sslClientCertHeaders** (security) | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range. | false | boolean
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
+| **sslHandler** (security) | Reference to a class that could be used to return an SSL Handler | | SslHandler
+| **trustStoreFile** (security) | Server side certificate keystore to be used for encryption | | File
+| **trustStoreResource** (security) | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. | | String
|=======================================================================
// endpoint options: END
[19/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ftp/src/main/docs/ftps-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ftp/src/main/docs/ftps-component.adoc b/components/camel-ftp/src/main/docs/ftps-component.adoc
index 8e4d75c..a307922 100644
--- a/components/camel-ftp/src/main/docs/ftps-component.adoc
+++ b/components/camel-ftp/src/main/docs/ftps-component.adoc
@@ -38,238 +38,128 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* Hostname of the FTP server
-| port | | int | Port of the FTP server
-| directoryName | | String | The starting directory
+| Name | Description | Default | Type
+| **host** | *Required* Hostname of the FTP server | | String
+| **port** | Port of the FTP server | | int
+| **directoryName** | The starting directory | | String
|=======================================================================
#### Query Parameters (110 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| binary | false | boolean | Specifies the file transfer mode BINARY or ASCII. Default is ASCII (false).
-
-| charset | | String | 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.
-
-| disconnect | false | boolean | 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.
-
-| doneFileName | | String | 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.
-
-| fileName | | String | 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 s
tore CamelFileName and have to restore it afterwards.
-
-| passiveMode | false | boolean | Sets passive mode connections. Default is active mode connections.
-
-| separator | UNIX | PathSeparator | 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
- 4+^s| common (advanced)
-| fastExistsCheck | false | boolean | 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.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| delete | false | boolean | If true the file will be deleted after it is processed successfully.
-
-| moveFailed | | String | 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.
-
-| noop | false | boolean | 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.
-
-| preMove | | String | 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.
-
-| recursive | false | boolean | If a directory will look for files in all the sub-directories as well.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| streamDownload | false | boolean | 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.
- 4+^s| consumer (advanced)
-| directoryMustExist | false | boolean | Similar to startingDirectoryMustExist but this applies during polling recursive sub directories.
-
-| download | false | boolean | 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.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| ignoreFileNotFoundOrPermissionError | false | boolean | Whether to ignore when trying to download a file which does not exist or due to permission error. By default when a file does not exists or insufficient permission then an exception is thrown. Setting this option to true allows to ignore that instead.
-
-| inProgressRepository | | String> | 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.
-
-| localWorkDirectory | | String | 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.
-
-| onCompletionExceptionHandler | | ExceptionHandler | 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.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
-
-| processStrategy | | GenericFileProcessStrategy<T> | 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.
-
-| receiveBufferSize | 32768 | int | The receive (download) buffer size Used only by FTPClient
-
-| startingDirectoryMustExist | false | boolean | 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.
-
-| useList | true | boolean | 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.
- 4+^s| producer
-| fileExist | Override | GenericFileExist | 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 Camel 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.
-
-| flatten | false | boolean | 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.
-
-| moveExisting | | String | 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.
-
-| tempFileName | | String | 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.
-
-| tempPrefix | | String | 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.
- 4+^s| producer (advanced)
-| allowNullBody | false | boolean | 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.
-
-| chmod | | String | Allows you to set chmod on the stored file. For example chmod=640.
-
-| disconnectOnBatchComplete | false | boolean | 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.
-
-| eagerDeleteTargetFile | true | boolean | 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.
-
-| keepLastModified | false | boolean | 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.
-
-| sendNoop | true | boolean | 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.
- 4+^s| advanced
-| activePortRange | | String | 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.
-
-| autoCreate | true | boolean | 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.
-
-| bufferSize | 131072 | int | Write buffer sized in bytes.
-
-| connectTimeout | 10000 | int | Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH
-
-| ftpClient | | FTPClient | To use a custom instance of FTPClient
-
-| ftpClientConfig | | FTPClientConfig | To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use.
-
-| ftpClientConfigParameters | | Map | Used by FtpComponent to provide additional parameters for the FTPClientConfig
-
-| ftpClientParameters | | Map | Used by FtpComponent to provide additional parameters for the FTPClient
-
-| maximumReconnectAttempts | | int | Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior.
-
-| reconnectDelay | | long | Delay in millis Camel will wait before performing a reconnect attempt.
-
-| siteCommand | | String | Sets optional site command(s) to be executed after successful login. Multiple site commands can be separated using a new line character (\n).
-
-| soTimeout | 300000 | int | Sets the so timeout Used only by FTPClient
-
-| stepwise | true | boolean | 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.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| throwExceptionOnConnectFailed | false | boolean | 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.
-
-| timeout | 30000 | int | Sets the data timeout for waiting for reply Used only by FTPClient
- 4+^s| filter
-| antExclude | | String | 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.
-
-| antFilterCaseSensitive | true | boolean | Sets case sensitive flag on ant fiter
-
-| antInclude | | String | Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format.
-
-| eagerMaxMessagesPerPoll | true | boolean | 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.
-
-| exclude | | String | 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
-
-| filter | | GenericFileFilter<T> | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method.
-
-| filterDirectory | | String | 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
-
-| filterFile | | String | Filters the file based on Simple language. For example to filter on file size you can use $file:size 5000
-
-| idempotent | false | Boolean | 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.
-
-| idempotentKey | | String | 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
-
-| idempotentRepository | | String> | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true.
-
-| include | | String | 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
-
-| maxDepth | 2147483647 | int | The maximum depth to traverse when recursively processing a directory.
-
-| maxMessagesPerPoll | | int | 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.
-
-| minDepth | | int | 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.
-
-| move | | String | 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.
- 4+^s| lock
-| exclusiveReadLockStrategy | | GenericFileExclusiveReadLockStrategy<T> | Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation.
-
-| readLock | | String | 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 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 wher
e 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.
-
-| readLockCheckInterval | 1000 | long | 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.
-
-| readLockDeleteOrphanLockFiles | true | boolean | 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.
-
-| readLockLoggingLevel | WARN | LoggingLevel | Logging level used when a read lock could not be acquired. By default a WARN 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 rename.
-
-| readLockMarkerFile | true | boolean | 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.
-
-| readLockMinAge | 0 | long | This option applied only for readLock=change. This option 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.
-
-| readLockMinLength | 1 | long | This option applied only for readLock=changed. This option 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.
-
-| readLockRemoveOnCommit | false | boolean | This option applied only for readLock=idempotent. This option 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.
-
-| readLockRemoveOnRollback | true | boolean | This option applied only for readLock=idempotent. This option 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).
-
-| readLockTimeout | 10000 | long | 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.
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| sort
-| shuffle | false | boolean | To shuffle the list of files (sort in random order)
-
-| sortBy | | String | 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.
-
-| sorter | | GenericFile<T>> | Pluggable sorter as a java.util.Comparator class.
- 4+^s| security
-| account | | String | Account to use for login
-
-| disableSecureDataChannelDefaults | false | boolean | 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
-
-| execPbsz | | Long | When using secure data channel you can set the exec protection buffer size
-
-| execProt | | String | The exec protection level PROT command. C - Clear S - Safe(SSL protocol only) E - Confidential(SSL protocol only) P - Private
-
-| ftpClientKeyStoreParameters | | Map | Set the key store parameters
-
-| ftpClientTrustStoreParameters | | Map | Set the trust store parameters
-
-| isImplicit | false | boolean | Set the security mode(Implicit/Explicit). true - Implicit Mode / False - Explicit Mode
-
-| password | | String | Password to use for login
-
-| securityProtocol | TLS | String | Set the underlying security protocol.
-
-| sslContextParameters | | SSLContextParameters | Gets the JSSE configuration that overrides any settings in link FtpsEndpointftpClientKeyStoreParameters link ftpClientTrustStoreParameters and link FtpsConfigurationgetSecurityProtocol().
-
-| username | | String | Username to use for login
+| Name | Description | Default | Type
+| **binary** (common) | Specifies the file transfer mode BINARY or ASCII. Default is ASCII (false). | false | boolean
+| **charset** (common) | 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. | | String
+| **disconnect** (common) | 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. | false | boolean
+| **doneFileName** (common) | 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. | | String
+| **fileName** (common) | 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. | | String
+| **passiveMode** (common) | Sets passive mode connections. Default is active mode connections. | false | boolean
+| **separator** (common) | 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 | UNIX | PathSeparator
+| **fastExistsCheck** (common) | 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. | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **delete** (consumer) | If true the file will be deleted after it is processed successfully. | false | boolean
+| **moveFailed** (consumer) | 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. | | String
+| **noop** (consumer) | 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. | false | boolean
+| **preMove** (consumer) | 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. | | String
+| **recursive** (consumer) | If a directory will look for files in all the sub-directories as well. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **streamDownload** (consumer) | 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. | false | boolean
+| **directoryMustExist** (consumer) | Similar to startingDirectoryMustExist but this applies during polling recursive sub directories. | false | boolean
+| **download** (consumer) | 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. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **ignoreFileNotFoundOr PermissionError** (consumer) | Whether to ignore when trying to download a file which does not exist or due to permission error. By default when a file does not exists or insufficient permission then an exception is thrown. Setting this option to true allows to ignore that instead. | false | boolean
+| **inProgressRepository** (consumer) | 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. | | String>
+| **localWorkDirectory** (consumer) | 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. | | String
+| **onCompletionException Handler** (consumer) | 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. | | ExceptionHandler
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **processStrategy** (consumer) | 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. | | GenericFileProcess Strategy<T>
+| **receiveBufferSize** (consumer) | The receive (download) buffer size Used only by FTPClient | 32768 | int
+| **startingDirectoryMustExist** (consumer) | 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. | false | boolean
+| **useList** (consumer) | 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. | true | boolean
+| **fileExist** (producer) | 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 Camel 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. | Override | Ge
nericFileExist
+| **flatten** (producer) | 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. | false | boolean
+| **moveExisting** (producer) | 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. | | String
+| **tempFileName** (producer) | 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. | | String
+| **tempPrefix** (producer) | 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. | | String
+| **allowNullBody** (producer) | 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. | false | boolean
+| **chmod** (producer) | Allows you to set chmod on the stored file. For example chmod=640. | | String
+| **disconnectOnBatchComplete** (producer) | 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. | false | boolean
+| **eagerDeleteTargetFile** (producer) | 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. | true | boolean
+| **keepLastModified** (producer) | 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. | false | boolean
+| **sendNoop** (producer) | 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. | true | boolean
+| **activePortRange** (advanced) | 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. | | String
+| **autoCreate** (advanced) | 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. | true | boolean
+| **bufferSize** (advanced) | Write buffer sized in bytes. | 131072 | int
+| **connectTimeout** (advanced) | Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH | 10000 | int
+| **ftpClient** (advanced) | To use a custom instance of FTPClient | | FTPClient
+| **ftpClientConfig** (advanced) | To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use. | | FTPClientConfig
+| **ftpClientConfigParameters** (advanced) | Used by FtpComponent to provide additional parameters for the FTPClientConfig | | Map
+| **ftpClientParameters** (advanced) | Used by FtpComponent to provide additional parameters for the FTPClient | | Map
+| **maximumReconnectAttempts** (advanced) | Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. | | int
+| **reconnectDelay** (advanced) | Delay in millis Camel will wait before performing a reconnect attempt. | | long
+| **siteCommand** (advanced) | Sets optional site command(s) to be executed after successful login. Multiple site commands can be separated using a new line character (\n). | | String
+| **soTimeout** (advanced) | Sets the so timeout Used only by FTPClient | 300000 | int
+| **stepwise** (advanced) | 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. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **throwExceptionOnConnect Failed** (advanced) | 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. | false | boolean
+| **timeout** (advanced) | Sets the data timeout for waiting for reply Used only by FTPClient | 30000 | int
+| **antExclude** (filter) | 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. | | String
+| **antFilterCaseSensitive** (filter) | Sets case sensitive flag on ant fiter | true | boolean
+| **antInclude** (filter) | Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format. | | String
+| **eagerMaxMessagesPerPoll** (filter) | 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. | true | boolean
+| **exclude** (filter) | 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 | | String
+| **filter** (filter) | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. | | GenericFileFilter<T>
+| **filterDirectory** (filter) | 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 | | String
+| **filterFile** (filter) | Filters the file based on Simple language. For example to filter on file size you can use $file:size 5000 | | String
+| **idempotent** (filter) | 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. | false | Boolean
+| **idempotentKey** (filter) | 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 | | String
+| **idempotentRepository** (filter) | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. | | String>
+| **include** (filter) | 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 | | String
+| **maxDepth** (filter) | The maximum depth to traverse when recursively processing a directory. | 2147483647 | int
+| **maxMessagesPerPoll** (filter) | 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. | | int
+| **minDepth** (filter) | 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. | | int
+| **move** (filter) | 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. | | String
+| **exclusiveReadLockStrategy** (lock) | Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation. | | GenericFileExclusive ReadLockStrategy<T>
+| **readLock** (lock) | 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 the FTP component. This approach should be avoided when accessing a r
emote 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. | | String
+| **readLockCheckInterval** (lock) | 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. | 1000 | long
+| **readLockDeleteOrphanLock Files** (lock) | 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. | true | boolean
+| **readLockLoggingLevel** (lock) | Logging level used when a read lock could not be acquired. By default a WARN 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 rename. | WARN | LoggingLevel
+| **readLockMarkerFile** (lock) | 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. | true | boolean
+| **readLockMinAge** (lock) | This option applied only for readLock=change. This option 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. | 0 | long
+| **readLockMinLength** (lock) | This option applied only for readLock=changed. This option 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. | 1 | long
+| **readLockRemoveOnCommit** (lock) | This option applied only for readLock=idempotent. This option 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. | false | boolean
+| **readLockRemoveOnRollback** (lock) | This option applied only for readLock=idempotent. This option 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). | true | boolean
+| **readLockTimeout** (lock) | 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. | 10000 | long
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **shuffle** (sort) | To shuffle the list of files (sort in random order) | false | boolean
+| **sortBy** (sort) | 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. | | String
+| **sorter** (sort) | Pluggable sorter as a java.util.Comparator class. | | GenericFile<T>>
+| **account** (security) | Account to use for login | | String
+| **disableSecureDataChannel Defaults** (security) | 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 | false | boolean
+| **execPbsz** (security) | When using secure data channel you can set the exec protection buffer size | | Long
+| **execProt** (security) | The exec protection level PROT command. C - Clear S - Safe(SSL protocol only) E - Confidential(SSL protocol only) P - Private | | String
+| **ftpClientKeyStore Parameters** (security) | Set the key store parameters | | Map
+| **ftpClientTrustStore Parameters** (security) | Set the trust store parameters | | Map
+| **isImplicit** (security) | Set the security mode(Implicit/Explicit). true - Implicit Mode / False - Explicit Mode | false | boolean
+| **password** (security) | Password to use for login | | String
+| **securityProtocol** (security) | Set the underlying security protocol. | TLS | String
+| **sslContextParameters** (security) | Gets the JSSE configuration that overrides any settings in link FtpsEndpointftpClientKeyStoreParameters link ftpClientTrustStoreParameters and link FtpsConfigurationgetSecurityProtocol(). | | SSLContextParameters
+| **username** (security) | Username to use for login | | String
|=======================================================================
// endpoint options: END
[15/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-influxdb/src/main/docs/influxdb-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-influxdb/src/main/docs/influxdb-component.adoc b/components/camel-influxdb/src/main/docs/influxdb-component.adoc
index e20c777..dff543d 100644
--- a/components/camel-influxdb/src/main/docs/influxdb-component.adoc
+++ b/components/camel-influxdb/src/main/docs/influxdb-component.adoc
@@ -56,29 +56,23 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| connectionBean | | String | *Required* Connection to the influx database of class InfluxDB.class
+| Name | Description | Default | Type
+| **connectionBean** | *Required* Connection to the influx database of class InfluxDB.class | | String
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| batch | false | boolean | Define if this operation is a batch operation or not
-
-| databaseName | | String | The name of the database where the time series will be stored
-
-| operation | insert | String | Define if this operation is an insert or a query
-
-| query | | String | Define the query in case of operation query
-
-| retentionPolicy | default | String | The string that defines the retention policy to the data created by the endpoint
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **batch** (producer) | Define if this operation is a batch operation or not | false | boolean
+| **databaseName** (producer) | The name of the database where the time series will be stored | | String
+| **operation** (producer) | Define if this operation is an insert or a query | insert | String
+| **query** (producer) | Define the query in case of operation query | | String
+| **retentionPolicy** (producer) | The string that defines the retention policy to the data created by the endpoint | default | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-irc/src/main/docs/irc-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-irc/src/main/docs/irc-component.adoc b/components/camel-irc/src/main/docs/irc-component.adoc
index 08dc8a8..36e8b1a 100644
--- a/components/camel-irc/src/main/docs/irc-component.adoc
+++ b/components/camel-irc/src/main/docs/irc-component.adoc
@@ -52,66 +52,42 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| hostname | | String | *Required* Hostname for the IRC chat server
-| port | | int | Port number for the IRC chat server. If no port is configured then a default port of either 6667 6668 or 6669 is used.
+| Name | Description | Default | Type
+| **hostname** | *Required* Hostname for the IRC chat server | | String
+| **port** | Port number for the IRC chat server. If no port is configured then a default port of either 6667 6668 or 6669 is used. | | int
|=======================================================================
#### Query Parameters (24 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| autoRejoin | true | boolean | Whether to auto re-join when being kicked
-
-| namesOnJoin | false | boolean | Sends NAMES command to channel after joining it. link onReply has to be true in order to process the result which will have the header value irc.num = '353'.
-
-| nickname | | String | The nickname used in chat.
-
-| persistent | true | boolean | Use persistent messages.
-
-| realname | | String | The IRC user's actual name.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| colors | true | boolean | Whether or not the server supports color codes.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| filter
-| onJoin | true | boolean | Handle user join events.
-
-| onKick | true | boolean | Handle kick events.
-
-| onMode | true | boolean | Handle mode change events.
-
-| onNick | true | boolean | Handle nickname change events.
-
-| onPart | true | boolean | Handle user part events.
-
-| onPrivmsg | true | boolean | Handle private message events.
-
-| onQuit | true | boolean | Handle user quit events.
-
-| onReply | false | boolean | Whether or not to handle general responses to commands or informational messages.
-
-| onTopic | true | boolean | Handle topic change events.
- 4+^s| security
-| nickPassword | | String | Your IRC server nickname password.
-
-| password | | String | The IRC server password.
-
-| sslContextParameters | | SSLContextParameters | Used for configuring security using SSL. Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. Note that this setting overrides the trustManager option.
-
-| trustManager | | SSLTrustManager | The trust manager used to verify the SSL server's certificate.
-
-| username | | String | The IRC server user name.
+| Name | Description | Default | Type
+| **autoRejoin** (common) | Whether to auto re-join when being kicked | true | boolean
+| **namesOnJoin** (common) | Sends NAMES command to channel after joining it. link onReply has to be true in order to process the result which will have the header value irc.num = '353'. | false | boolean
+| **nickname** (common) | The nickname used in chat. | | String
+| **persistent** (common) | Use persistent messages. | true | boolean
+| **realname** (common) | The IRC user's actual name. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **colors** (advanced) | Whether or not the server supports color codes. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **onJoin** (filter) | Handle user join events. | true | boolean
+| **onKick** (filter) | Handle kick events. | true | boolean
+| **onMode** (filter) | Handle mode change events. | true | boolean
+| **onNick** (filter) | Handle nickname change events. | true | boolean
+| **onPart** (filter) | Handle user part events. | true | boolean
+| **onPrivmsg** (filter) | Handle private message events. | true | boolean
+| **onQuit** (filter) | Handle user quit events. | true | boolean
+| **onReply** (filter) | Whether or not to handle general responses to commands or informational messages. | false | boolean
+| **onTopic** (filter) | Handle topic change events. | true | boolean
+| **nickPassword** (security) | Your IRC server nickname password. | | String
+| **password** (security) | The IRC server password. | | String
+| **sslContextParameters** (security) | Used for configuring security using SSL. Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. Note that this setting overrides the trustManager option. | | SSLContextParameters
+| **trustManager** (security) | The trust manager used to verify the SSL server's certificate. | | SSLTrustManager
+| **username** (security) | The IRC server user name. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ironmq/src/main/docs/ironmq-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ironmq/src/main/docs/ironmq-component.adoc b/components/camel-ironmq/src/main/docs/ironmq-component.adoc
index af4029b..0a3c6a7 100644
--- a/components/camel-ironmq/src/main/docs/ironmq-component.adoc
+++ b/components/camel-ironmq/src/main/docs/ironmq-component.adoc
@@ -48,77 +48,47 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| queueName | | String | *Required* The name of the IronMQ queue
+| Name | Description | Default | Type
+| **queueName** | *Required* The name of the IronMQ queue | | String
|=======================================================================
#### Query Parameters (30 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| client | | Client | Reference to a io.iron.ironmq.Client in the Registry.
-
-| ironMQCloud | https://mq-aws-us-east-1-1.iron.io | String | 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)
-
-| preserveHeaders | false | boolean | 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.
-
-| projectId | | String | IronMQ projectId
-
-| token | | String | IronMQ token
- 4+^s| consumer
-| batchDelete | false | boolean | 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.
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| concurrentConsumers | 1 | int | The number of concurrent consumers.
-
-| maxMessagesPerPoll | 1 | int | Number of messages to poll pr. call. Maximum is 100.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| timeout | 60 | int | After timeout (in seconds) item will be placed back onto the queue.
-
-| wait | | int | Time in seconds to wait for a message to become available. This enables long polling. Default is 0 (does not wait) maximum is 30.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| producer
-| visibilityDelay | | int | The item will not be available on the queue until this many seconds have passed. Default is 0 seconds.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **client** (common) | Reference to a io.iron.ironmq.Client in the Registry. | | Client
+| **ironMQCloud** (common) | 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) | https://mq-aws-us-east-1-1.iron.io | String
+| **preserveHeaders** (common) | 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. | false | boolean
+| **projectId** (common) | IronMQ projectId | | String
+| **token** (common) | IronMQ token | | String
+| **batchDelete** (consumer) | 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. | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **concurrentConsumers** (consumer) | The number of concurrent consumers. | 1 | int
+| **maxMessagesPerPoll** (consumer) | Number of messages to poll pr. call. Maximum is 100. | 1 | int
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **timeout** (consumer) | After timeout (in seconds) item will be placed back onto the queue. | 60 | int
+| **wait** (consumer) | Time in seconds to wait for a message to become available. This enables long polling. Default is 0 (does not wait) maximum is 30. | | int
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **visibilityDelay** (producer) | The item will not be available on the queue until this many seconds have passed. Default is 0 seconds. | | int
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-javaspace/src/main/docs/javaspace-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-javaspace/src/main/docs/javaspace-component.adoc b/components/camel-javaspace/src/main/docs/javaspace-component.adoc
index 215fb2b..b9e8faf 100644
--- a/components/camel-javaspace/src/main/docs/javaspace-component.adoc
+++ b/components/camel-javaspace/src/main/docs/javaspace-component.adoc
@@ -63,37 +63,27 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| url | | String | *Required* The URL to the JavaSpace server
+| Name | Description | Default | Type
+| **url** | *Required* The URL to the JavaSpace server | | String
|=======================================================================
#### Query Parameters (10 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| spaceName | | String | *Required* Specifies the JavaSpace name.
-
-| transactional | false | boolean | If true sending and receiving entries is performed within a transaction.
-
-| transactionTimeout | | long | Specifies the transaction timeout in millis. By default there is no timeout.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| concurrentConsumers | 1 | int | Specifies the number of concurrent consumers getting entries from the JavaSpace.
-
-| templateId | | String | If present this option specifies the Spring bean ID of the template to use for reading/taking entries.
-
-| verb | take | String | Specifies the verb for getting JavaSpace entries.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **spaceName** (common) | *Required* Specifies the JavaSpace name. | | String
+| **transactional** (common) | If true sending and receiving entries is performed within a transaction. | false | boolean
+| **transactionTimeout** (common) | Specifies the transaction timeout in millis. By default there is no timeout. | | long
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **concurrentConsumers** (consumer) | Specifies the number of concurrent consumers getting entries from the JavaSpace. | 1 | int
+| **templateId** (consumer) | If present this option specifies the Spring bean ID of the template to use for reading/taking entries. | | String
+| **verb** (consumer) | Specifies the verb for getting JavaSpace entries. | take | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jbpm/src/main/docs/jbpm-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jbpm/src/main/docs/jbpm-component.adoc b/components/camel-jbpm/src/main/docs/jbpm-component.adoc
index 258fd7d..0e723a9 100644
--- a/components/camel-jbpm/src/main/docs/jbpm-component.adoc
+++ b/components/camel-jbpm/src/main/docs/jbpm-component.adoc
@@ -46,67 +46,42 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| connectionURL | | URL | *Required* The URL to the jBPM server.
+| Name | Description | Default | Type
+| **connectionURL** | *Required* The URL to the jBPM server. | | URL
|=======================================================================
#### Query Parameters (25 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| attachmentId | | Long | attachId to use when retrieving attachments
-
-| contentId | | Long | contentId to use when retrieving attachments
-
-| deploymentId | | String | *Required* The id of the deployment
-
-| event | | Object | the data associated with this event when signalEvent operation is performed
-
-| eventType | | String | the type of event to use when signalEvent operation is performed
-
-| identifier | | String | identifier the global identifier
-
-| language | | String | The language to use when filtering user tasks
-
-| maxNumber | | Integer | the maximum number of rules that should be fired
-
-| operation | startProcess | String | The operation to perform
-
-| processId | | String | the id of the process that should be acted upon
-
-| processInstanceId | | Long | the id of the process instance
-
-| targetUserId | | String | The targetUserId used when delegating a task
-
-| task | | Task | The task instance to use with task operations
-
-| taskId | | Long | the id of the task
-
-| timeout | | Integer | A timeout value
-
-| userId | | String | userId to use with task operations
-
-| value | | Object | the value to assign to the global identifier
-
-| workItemId | | Long | the id of the work item
- 4+^s| advanced
-| entities | | List | The potentialOwners when nominateTask operation is performed
-
-| extraJaxbClasses | | Class[] | To load additional classes when working with XML
-
-| parameters | | Map | the variables that should be set for various operations
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| filter
-| statuses | | List | The list of status to use when filtering tasks
- 4+^s| security
-| password | | String | Password for authentication
-
-| userName | | String | Username for authentication
+| Name | Description | Default | Type
+| **attachmentId** (producer) | attachId to use when retrieving attachments | | Long
+| **contentId** (producer) | contentId to use when retrieving attachments | | Long
+| **deploymentId** (producer) | *Required* The id of the deployment | | String
+| **event** (producer) | the data associated with this event when signalEvent operation is performed | | Object
+| **eventType** (producer) | the type of event to use when signalEvent operation is performed | | String
+| **identifier** (producer) | identifier the global identifier | | String
+| **language** (producer) | The language to use when filtering user tasks | | String
+| **maxNumber** (producer) | the maximum number of rules that should be fired | | Integer
+| **operation** (producer) | The operation to perform | startProcess | String
+| **processId** (producer) | the id of the process that should be acted upon | | String
+| **processInstanceId** (producer) | the id of the process instance | | Long
+| **targetUserId** (producer) | The targetUserId used when delegating a task | | String
+| **task** (producer) | The task instance to use with task operations | | Task
+| **taskId** (producer) | the id of the task | | Long
+| **timeout** (producer) | A timeout value | | Integer
+| **userId** (producer) | userId to use with task operations | | String
+| **value** (producer) | the value to assign to the global identifier | | Object
+| **workItemId** (producer) | the id of the work item | | Long
+| **entities** (advanced) | The potentialOwners when nominateTask operation is performed | | List
+| **extraJaxbClasses** (advanced) | To load additional classes when working with XML | | Class[]
+| **parameters** (advanced) | the variables that should be set for various operations | | Map
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **statuses** (filter) | The list of status to use when filtering tasks | | List
+| **password** (security) | Password for authentication | | String
+| **userName** (security) | Username for authentication | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jcache/src/main/docs/jcache-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jcache/src/main/docs/jcache-component.adoc b/components/camel-jcache/src/main/docs/jcache-component.adoc
index d9a2483..750c7ec 100644
--- a/components/camel-jcache/src/main/docs/jcache-component.adoc
+++ b/components/camel-jcache/src/main/docs/jcache-component.adoc
@@ -22,61 +22,39 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| cacheName | | String | *Required* The name of the cache
+| Name | Description | Default | Type
+| **cacheName** | *Required* The name of the cache | | String
|=======================================================================
#### Query Parameters (22 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| cacheConfiguration | | Configuration | A Configuration for the Cache
-
-| cacheConfigurationProperties | | Properties | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager
-
-| cachingProvider | | String | The fully qualified class name of the javax.cache.spi.CachingProvider
-
-| configurationUri | | String | An implementation specific URI for the CacheManager
-
-| managementEnabled | false | boolean | Whether management gathering is enabled
-
-| readThrough | false | boolean | If read-through caching should be used
-
-| statisticsEnabled | false | boolean | Whether statistics gathering is enabled
-
-| storeByValue | true | boolean | If cache should use store-by-value or store-by-reference semantics
-
-| writeThrough | false | boolean | If write-through caching should be used
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| filteredEvents | | List | Events a consumer should filter. If using filteredEvents option then eventFilters one will be ignored
-
-| oldValueRequired | false | boolean | if the old value is required for events
-
-| synchronous | false | boolean | if the the event listener should block the thread causing the event
- 4+^s| consumer (advanced)
-| eventFilters | | List | The CacheEntryEventFilter. If using eventFilters option then filteredEvents one will be ignored
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| action | | String | To configure using a cache operation by default. If an operation in the message header then the operation from the header takes precedence.
- 4+^s| advanced
-| cacheLoaderFactory | | CacheLoader> | The CacheLoader factory
-
-| cacheWriterFactory | | CacheWriter> | The CacheWriter factory
-
-| createCacheIfNotExists | true | boolean | Configure if a cache need to be created if it does exist or can't be pre-configured.
-
-| expiryPolicyFactory | | ExpiryPolicy> | The ExpiryPolicy factory
-
-| lookupProviders | false | boolean | Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi.
+| Name | Description | Default | Type
+| **cacheConfiguration** (common) | A Configuration for the Cache | | Configuration
+| **cacheConfigurationProperties** (common) | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager | | Properties
+| **cachingProvider** (common) | The fully qualified class name of the javax.cache.spi.CachingProvider | | String
+| **configurationUri** (common) | An implementation specific URI for the CacheManager | | String
+| **managementEnabled** (common) | Whether management gathering is enabled | false | boolean
+| **readThrough** (common) | If read-through caching should be used | false | boolean
+| **statisticsEnabled** (common) | Whether statistics gathering is enabled | false | boolean
+| **storeByValue** (common) | If cache should use store-by-value or store-by-reference semantics | true | boolean
+| **writeThrough** (common) | If write-through caching should be used | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **filteredEvents** (consumer) | Events a consumer should filter. If using filteredEvents option then eventFilters one will be ignored | | List
+| **oldValueRequired** (consumer) | if the old value is required for events | false | boolean
+| **synchronous** (consumer) | if the the event listener should block the thread causing the event | false | boolean
+| **eventFilters** (consumer) | The CacheEntryEventFilter. If using eventFilters option then filteredEvents one will be ignored | | List
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **action** (producer) | To configure using a cache operation by default. If an operation in the message header then the operation from the header takes precedence. | | String
+| **cacheLoaderFactory** (advanced) | The CacheLoader factory | | CacheLoader>
+| **cacheWriterFactory** (advanced) | The CacheWriter factory | | CacheWriter>
+| **createCacheIfNotExists** (advanced) | Configure if a cache need to be created if it does exist or can't be pre-configured. | true | boolean
+| **expiryPolicyFactory** (advanced) | The ExpiryPolicy factory | | ExpiryPolicy>
+| **lookupProviders** (advanced) | Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi. | false | boolean
|=======================================================================
// endpoint options: END
@@ -92,18 +70,13 @@ The JCache component supports 5 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| cachingProvider | | String | The fully qualified class name of the javax.cache.spi.CachingProvider
-
-| cacheConfiguration | | Configuration | A Configuration for the Cache
-
-| cacheConfigurationProperties | | Properties | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager
-
-| configurationUri | | String | An implementation specific URI for the CacheManager
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **cachingProvider** (common) | The fully qualified class name of the javax.cache.spi.CachingProvider | | String
+| **cacheConfiguration** (common) | A Configuration for the Cache | | Configuration
+| **cacheConfiguration Properties** (common) | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager | | Properties
+| **configurationUri** (common) | An implementation specific URI for the CacheManager | | String
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jclouds/src/main/docs/jclouds-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jclouds/src/main/docs/jclouds-component.adoc b/components/camel-jclouds/src/main/docs/jclouds-component.adoc
index f5296e3..a2d3304 100644
--- a/components/camel-jclouds/src/main/docs/jclouds-component.adoc
+++ b/components/camel-jclouds/src/main/docs/jclouds-component.adoc
@@ -106,15 +106,12 @@ The JClouds component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| blobStores | | List | To use the given BlobStore which must be configured when using blobstore.
-
-| computeServices | | List | To use the given ComputeService which must be configured when use compute.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **blobStores** (common) | To use the given BlobStore which must be configured when using blobstore. | | List
+| **computeServices** (common) | To use the given ComputeService which must be configured when use compute. | | List
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -132,48 +129,33 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| command | | JcloudsCommand | *Required* What command to execute such as blobstore or compute.
-| providerId | | String | *Required* The name of the cloud provider that provides the target service (e.g. aws-s3 or aws_ec2).
+| Name | Description | Default | Type
+| **command** | *Required* What command to execute such as blobstore or compute. | | JcloudsCommand
+| **providerId** | *Required* The name of the cloud provider that provides the target service (e.g. aws-s3 or aws_ec2). | | String
|=======================================================================
#### Query Parameters (15 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| blobstore
-| blobName | | String | The name of the blob.
-
-| container | | String | The name of the blob container.
-
-| directory | | String | An optional directory name to use
- 4+^s| compute
-| group | | String | The group that will be assigned to the newly created node. Values depend on the actual cloud provider.
-
-| hardwareId | | String | The hardware that will be used for creating a node. Values depend on the actual cloud provider.
-
-| imageId | | String | The imageId that will be used for creating a node. Values depend on the actual cloud provider.
-
-| locationId | | String | The location that will be used for creating a node. Values depend on the actual cloud provider.
-
-| nodeId | | String | The id of the node that will run the script or destroyed.
-
-| nodeState | | String | To filter by node status to only select running nodes etc.
-
-| operation | | String | Specifies the type of operation that will be performed to the blobstore.
-
-| user | | String | The user on the target node that will run the script.
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **blobName** (blobstore) | The name of the blob. | | String
+| **container** (blobstore) | The name of the blob container. | | String
+| **directory** (blobstore) | An optional directory name to use | | String
+| **group** (compute) | The group that will be assigned to the newly created node. Values depend on the actual cloud provider. | | String
+| **hardwareId** (compute) | The hardware that will be used for creating a node. Values depend on the actual cloud provider. | | String
+| **imageId** (compute) | The imageId that will be used for creating a node. Values depend on the actual cloud provider. | | String
+| **locationId** (compute) | The location that will be used for creating a node. Values depend on the actual cloud provider. | | String
+| **nodeId** (compute) | The id of the node that will run the script or destroyed. | | String
+| **nodeState** (compute) | To filter by node status to only select running nodes etc. | | String
+| **operation** (compute) | Specifies the type of operation that will be performed to the blobstore. | | String
+| **user** (compute) | The user on the target node that will run the script. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jcr/src/main/docs/jcr-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jcr/src/main/docs/jcr-component.adoc b/components/camel-jcr/src/main/docs/jcr-component.adoc
index 76adb76..81c33b2 100644
--- a/components/camel-jcr/src/main/docs/jcr-component.adoc
+++ b/components/camel-jcr/src/main/docs/jcr-component.adoc
@@ -56,46 +56,32 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* Name of the javax.jcr.Repository to lookup from the Camel registry to be used.
-| base | | String | Get the base node when accessing the repository
+| Name | Description | Default | Type
+| **host** | *Required* Name of the javax.jcr.Repository to lookup from the Camel registry to be used. | | String
+| **base** | Get the base node when accessing the repository | | String
|=======================================================================
#### Query Parameters (14 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| deep | false | boolean | When isDeep is true events whose associated parent node is at absPath or within its subgraph are received.
-
-| eventTypes | | int | 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.).
-
-| nodeTypeNames | | String | 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.
-
-| noLocal | false | boolean | If noLocal is true then events generated by the session through which the listener was registered are ignored. Otherwise they are not ignored.
-
-| password | | String | Password for login
-
-| sessionLiveCheckInterval | 60000 | long | Interval in milliseconds to wait before each session live checking The default value is 60000 ms.
-
-| sessionLiveCheckIntervalOnStart | 3000 | long | Interval in milliseconds to wait before the first session live checking. The default value is 3000 ms.
-
-| username | | String | Username for login
-
-| uuids | | String | 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.
-
-| workspaceName | | String | The workspace to access. If it's not specified then the default one will be used
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **deep** (common) | When isDeep is true events whose associated parent node is at absPath or within its subgraph are received. | false | boolean
+| **eventTypes** (common) | 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.). | | int
+| **nodeTypeNames** (common) | 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. | | String
+| **noLocal** (common) | If noLocal is true then events generated by the session through which the listener was registered are ignored. Otherwise they are not ignored. | false | boolean
+| **password** (common) | Password for login | | String
+| **sessionLiveCheckInterval** (common) | Interval in milliseconds to wait before each session live checking The default value is 60000 ms. | 60000 | long
+| **sessionLiveCheckIntervalOn Start** (common) | Interval in milliseconds to wait before the first session live checking. The default value is 3000 ms. | 3000 | long
+| **username** (common) | Username for login | | String
+| **uuids** (common) | 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. | | String
+| **workspaceName** (common) | The workspace to access. If it's not specified then the default one will be used | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jdbc/src/main/docs/jdbc-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jdbc/src/main/docs/jdbc-component.adoc b/components/camel-jdbc/src/main/docs/jdbc-component.adoc
index a14f67d..5ea2ecf 100644
--- a/components/camel-jdbc/src/main/docs/jdbc-component.adoc
+++ b/components/camel-jdbc/src/main/docs/jdbc-component.adoc
@@ -46,13 +46,11 @@ The JDBC component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| producer
-| dataSource | | DataSource | To use the DataSource instance instead of looking up the data source by name from the registry.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **dataSource** (producer) | To use the DataSource instance instead of looking up the data source by name from the registry. | | DataSource
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -70,43 +68,30 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| dataSourceName | | String | *Required* Name of DataSource to lookup in the Registry.
+| Name | Description | Default | Type
+| **dataSourceName** | *Required* Name of DataSource to lookup in the Registry. | | String
|=======================================================================
#### Query Parameters (13 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| allowNamedParameters | true | boolean | Whether to allow using named parameters in the queries.
-
-| outputClass | | String | Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList.
-
-| outputType | SelectList | JdbcOutputType | Determines the output the producer should use.
-
-| parameters | | Map | Optional parameters to the java.sql.Statement. For example to set maxRows fetchSize etc.
-
-| readSize | | int | The default maximum number of rows that can be read by a polling query. The default value is 0.
-
-| resetAutoCommit | true | boolean | 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.
-
-| transacted | false | boolean | Whether transactions are in use.
-
-| useGetBytesForBlob | false | boolean | 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.
-
-| useHeadersAsParameters | false | boolean | 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.
-
-| useJDBC4ColumnNameAndLabelSemantics | true | boolean | 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.
- 4+^s| advanced
-| beanRowMapper | | BeanRowMapper | 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.
-
-| prepareStatementStrategy | | JdbcPrepareStatementStrategy | Allows to plugin to use a custom org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy to control preparation of the query and prepared statement.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **allowNamedParameters** (producer) | Whether to allow using named parameters in the queries. | true | boolean
+| **outputClass** (producer) | Specify the full package and class name to use as conversion when outputType=SelectOne or SelectList. | | String
+| **outputType** (producer) | Determines the output the producer should use. | SelectList | JdbcOutputType
+| **parameters** (producer) | Optional parameters to the java.sql.Statement. For example to set maxRows fetchSize etc. | | Map
+| **readSize** (producer) | The default maximum number of rows that can be read by a polling query. The default value is 0. | | int
+| **resetAutoCommit** (producer) | 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. | true | boolean
+| **transacted** (producer) | Whether transactions are in use. | false | boolean
+| **useGetBytesForBlob** (producer) | 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. | false | boolean
+| **useHeadersAsParameters** (producer) | 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. | false | boolean
+| **useJDBC4ColumnNameAnd LabelSemantics** (producer) | 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. | true | boolean
+| **beanRowMapper** (advanced) | 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. | | BeanRowMapper
+| **prepareStatementStrategy** (advanced) | Allows to plugin to use a custom org.apache.camel.component.jdbc.JdbcPrepareStatementStrategy to control preparation of the query and prepared statement. | | JdbcPrepareStatement Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
[02/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-twitter/src/main/docs/twitter-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-twitter/src/main/docs/twitter-component.adoc b/components/camel-twitter/src/main/docs/twitter-component.adoc
index fb9be54..e05ab1c 100644
--- a/components/camel-twitter/src/main/docs/twitter-component.adoc
+++ b/components/camel-twitter/src/main/docs/twitter-component.adoc
@@ -47,27 +47,18 @@ The Twitter component supports 9 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| security
-| accessToken | | String | The access token
-
-| accessTokenSecret | | String | The access token secret
-
-| consumerKey | | String | The consumer key
-
-| consumerSecret | | String | The consumer secret
- 4+^s| proxy
-| httpProxyHost | | String | The http proxy host which can be used for the camel-twitter.
-
-| httpProxyUser | | String | The http proxy user which can be used for the camel-twitter.
-
-| httpProxyPassword | | String | The http proxy password which can be used for the camel-twitter.
-
-| httpProxyPort | | int | The http proxy port which can be used for the camel-twitter.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **accessToken** (security) | The access token | | String
+| **accessTokenSecret** (security) | The access token secret | | String
+| **consumerKey** (security) | The consumer key | | String
+| **consumerSecret** (security) | The consumer secret | | String
+| **httpProxyHost** (proxy) | The http proxy host which can be used for the camel-twitter. | | String
+| **httpProxyUser** (proxy) | The http proxy user which can be used for the camel-twitter. | | String
+| **httpProxyPassword** (proxy) | The http proxy password which can be used for the camel-twitter. | | String
+| **httpProxyPort** (proxy) | The http proxy port which can be used for the camel-twitter. | | int
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -147,101 +138,59 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| kind | | String | *Required* What polling mode to use direct polling or event based. The event mode is only supported when the endpoint kind is event based.
+| Name | Description | Default | Type
+| **kind** | *Required* What polling mode to use direct polling or event based. The event mode is only supported when the endpoint kind is event based. | | String
|=======================================================================
#### Query Parameters (42 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| user | | String | Username used for user timeline consumption direct message production etc.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| type | polling | EndpointType | Endpoint type to use. Only streaming supports event type.
- 4+^s| consumer (advanced)
-| distanceMetric | km | String | Used by the non-stream geography search to search by radius using the configured metrics. The unit can either be mi for miles or km for kilometers. You need to configure all the following options: longitude latitude radius and distanceMetric.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| latitude | | Double | Used by the non-stream geography search to search by latitude. You need to configure all the following options: longitude latitude radius and distanceMetric.
-
-| locations | | String | Bounding boxes created by pairs of lat/lons. Can be used for streaming/filter. A pair is defined as latlon. And multiple paris can be separated by semi colon.
-
-| longitude | | Double | Used by the non-stream geography search to search by longitude. You need to configure all the following options: longitude latitude radius and distanceMetric.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
-
-| radius | | Double | Used by the non-stream geography search to search by radius. You need to configure all the following options: longitude latitude radius and distanceMetric.
-
-| twitterStream | | TwitterStream | To use a custom instance of TwitterStream
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| filter
-| count | | Integer | Limiting number of results per page.
-
-| filterOld | true | boolean | Filter out old tweets that has previously been polled. This state is stored in memory only and based on last tweet id.
-
-| keywords | | String | Can be used for search and streaming/filter. Multiple values can be separated with comma.
-
-| lang | | String | The lang string ISO_639-1 which will be used for searching
-
-| numberOfPages | 1 | Integer | The number of pages result which you want camel-twitter to consume.
-
-| sinceId | 1 | long | The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running.
-
-| userIds | | String | To filter by user ids for streaming/filter. Multiple values can be separated by comma.
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 60000 | long | Milliseconds before the next poll.
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| proxy
-| httpProxyHost | | String | The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead.
-
-| httpProxyPassword | | String | The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead.
-
-| httpProxyPort | | Integer | The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead.
-
-| httpProxyUser | | String | The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead.
- 4+^s| security
-| accessToken | | String | The access token. Can also be configured on the TwitterComponent level instead.
-
-| accessTokenSecret | | String | The access secret. Can also be configured on the TwitterComponent level instead.
-
-| consumerKey | | String | The consumer key. Can also be configured on the TwitterComponent level instead.
-
-| consumerSecret | | String | The consumer secret. Can also be configured on the TwitterComponent level instead.
+| Name | Description | Default | Type
+| **user** (common) | Username used for user timeline consumption direct message production etc. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **type** (consumer) | Endpoint type to use. Only streaming supports event type. | polling | EndpointType
+| **distanceMetric** (consumer) | Used by the non-stream geography search to search by radius using the configured metrics. The unit can either be mi for miles or km for kilometers. You need to configure all the following options: longitude latitude radius and distanceMetric. | km | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **latitude** (consumer) | Used by the non-stream geography search to search by latitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double
+| **locations** (consumer) | Bounding boxes created by pairs of lat/lons. Can be used for streaming/filter. A pair is defined as latlon. And multiple paris can be separated by semi colon. | | String
+| **longitude** (consumer) | Used by the non-stream geography search to search by longitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **radius** (consumer) | Used by the non-stream geography search to search by radius. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double
+| **twitterStream** (consumer) | To use a custom instance of TwitterStream | | TwitterStream
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **count** (filter) | Limiting number of results per page. | | Integer
+| **filterOld** (filter) | Filter out old tweets that has previously been polled. This state is stored in memory only and based on last tweet id. | true | boolean
+| **keywords** (filter) | Can be used for search and streaming/filter. Multiple values can be separated with comma. | | String
+| **lang** (filter) | The lang string ISO_639-1 which will be used for searching | | String
+| **numberOfPages** (filter) | The number of pages result which you want camel-twitter to consume. | 1 | Integer
+| **sinceId** (filter) | The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running. | 1 | long
+| **userIds** (filter) | To filter by user ids for streaming/filter. Multiple values can be separated by comma. | | String
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. | 60000 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **httpProxyHost** (proxy) | The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String
+| **httpProxyPassword** (proxy) | The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String
+| **httpProxyPort** (proxy) | The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | Integer
+| **httpProxyUser** (proxy) | The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String
+| **accessToken** (security) | The access token. Can also be configured on the TwitterComponent level instead. | | String
+| **accessTokenSecret** (security) | The access secret. Can also be configured on the TwitterComponent level instead. | | String
+| **consumerKey** (security) | The consumer key. Can also be configured on the TwitterComponent level instead. | | String
+| **consumerSecret** (security) | The consumer secret. Can also be configured on the TwitterComponent level instead. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-undertow/src/main/docs/undertow-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-undertow/src/main/docs/undertow-component.adoc b/components/camel-undertow/src/main/docs/undertow-component.adoc
index baf7c50..d85d7c2 100644
--- a/components/camel-undertow/src/main/docs/undertow-component.adoc
+++ b/components/camel-undertow/src/main/docs/undertow-component.adoc
@@ -42,15 +42,12 @@ The Undertow component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| undertowHttpBinding | | UndertowHttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
- 4+^s| security
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **undertowHttpBinding** (advanced) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | UndertowHttpBinding
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -69,51 +66,34 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| httpURI | | URI | *Required* The url of the HTTP endpoint to use.
+| Name | Description | Default | Type
+| **httpURI** | *Required* The url of the HTTP endpoint to use. | | URI
|=======================================================================
#### Query Parameters (17 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| httpMethodRestrict | | String | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma.
-
-| matchOnUriPrefix | true | Boolean | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.
-
-| optionsEnabled | false | boolean | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session
-
-| keepAlive | true | Boolean | Setting to ensure socket is not closed due to inactivity
-
-| options | | Map | Sets additional channel options. The options that can be used are defined in org.xnio.Options. To configure from endpoint uri then prefix each option with option. such as option.close-abort=true&option.send-buffer=8192
-
-| reuseAddresses | true | Boolean | Setting to facilitate socket multiplexing
-
-| tcpNoDelay | true | Boolean | Setting to improve TCP protocol performance
-
-| throwExceptionOnFailure | true | Boolean | 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 producer send all the fault response back.
-
-| transferException | false | Boolean | 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.
- 4+^s| advanced
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| undertowHttpBinding | | UndertowHttpBinding | To use a custom UndertowHttpBinding to control the mapping between Camel message and undertow.
- 4+^s| security
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **httpMethodRestrict** (consumer) | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. | | String
+| **matchOnUriPrefix** (consumer) | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | true | Boolean
+| **optionsEnabled** (consumer) | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler
+| **keepAlive** (producer) | Setting to ensure socket is not closed due to inactivity | true | Boolean
+| **options** (producer) | Sets additional channel options. The options that can be used are defined in org.xnio.Options. To configure from endpoint uri then prefix each option with option. such as option.close-abort=true&option.send-buffer=8192 | | Map
+| **reuseAddresses** (producer) | Setting to facilitate socket multiplexing | true | Boolean
+| **tcpNoDelay** (producer) | Setting to improve TCP protocol performance | true | Boolean
+| **throwExceptionOnFailure** (producer) | 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 producer send all the fault response back. | true | Boolean
+| **transferException** (producer) | 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. | false | Boolean
+| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **undertowHttpBinding** (advanced) | To use a custom UndertowHttpBinding to control the mapping between Camel message and undertow. | | UndertowHttpBinding
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-velocity/src/main/docs/velocity-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-velocity/src/main/docs/velocity-component.adoc b/components/camel-velocity/src/main/docs/velocity-component.adoc
index 6107b7d..31a4a72 100644
--- a/components/camel-velocity/src/main/docs/velocity-component.adoc
+++ b/components/camel-velocity/src/main/docs/velocity-component.adoc
@@ -43,13 +43,11 @@ The Velocity component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| velocityEngine | | VelocityEngine | To use the VelocityEngine otherwise a new engine is created
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **velocityEngine** (advanced) | To use the VelocityEngine otherwise a new engine is created | | VelocityEngine
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -65,27 +63,22 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| resourceUri | | String | *Required* 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.
+| Name | Description | Default | Type
+| **resourceUri** | *Required* 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. | | String
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| contentCache | false | boolean | Sets whether to use resource content cache or not
-
-| encoding | | String | Character encoding of the resource content.
-
-| loaderCache | true | boolean | Enables / disables the velocity resource loader cache which is enabled by default
-
-| propertiesFile | | String | The URI of the properties file which is used for VelocityEngine initialization.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean
+| **encoding** (producer) | Character encoding of the resource content. | | String
+| **loaderCache** (producer) | Enables / disables the velocity resource loader cache which is enabled by default | true | boolean
+| **propertiesFile** (producer) | The URI of the properties file which is used for VelocityEngine initialization. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-vertx/src/main/docs/vertx-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-vertx/src/main/docs/vertx-component.adoc b/components/camel-vertx/src/main/docs/vertx-component.adoc
index 04122df..3034c5b 100644
--- a/components/camel-vertx/src/main/docs/vertx-component.adoc
+++ b/components/camel-vertx/src/main/docs/vertx-component.adoc
@@ -40,23 +40,16 @@ The Vert.x component supports 7 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| vertxFactory | | VertxFactory | To use a custom VertxFactory implementation
- 4+^s| common
-| host | | String | Hostname for creating an embedded clustered EventBus
-
-| port | | int | Port for creating an embedded clustered EventBus
-
-| vertxOptions | | VertxOptions | Options to use for creating vertx
-
-| vertx | | Vertx | To use the given vertx EventBus instead of creating a new embedded EventBus
-
-| timeout | 60 | int | Timeout in seconds to wait for clustered Vertx EventBus to be ready. The default value is 60.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **vertxFactory** (advanced) | To use a custom VertxFactory implementation | | VertxFactory
+| **host** (common) | Hostname for creating an embedded clustered EventBus | | String
+| **port** (common) | Port for creating an embedded clustered EventBus | | int
+| **vertxOptions** (common) | Options to use for creating vertx | | VertxOptions
+| **vertx** (common) | To use the given vertx EventBus instead of creating a new embedded EventBus | | Vertx
+| **timeout** (common) | Timeout in seconds to wait for clustered Vertx EventBus to be ready. The default value is 60. | 60 | int
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -72,27 +65,22 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| address | | String | *Required* Sets the event bus address used to communicate
+| Name | Description | Default | Type
+| **address** | *Required* Sets the event bus address used to communicate | | String
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| pubSub | | Boolean | Whether to use publish/subscribe instead of point to point when sending to a vertx endpoint.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **pubSub** (common) | Whether to use publish/subscribe instead of point to point when sending to a vertx endpoint. | | Boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-weather/src/main/docs/weather-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-weather/src/main/docs/weather-component.adoc b/components/camel-weather/src/main/docs/weather-component.adoc
index 157376c..baaac09 100644
--- a/components/camel-weather/src/main/docs/weather-component.adoc
+++ b/components/camel-weather/src/main/docs/weather-component.adoc
@@ -55,103 +55,60 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* The name value is not used.
+| Name | Description | Default | Type
+| **name** | *Required* The name value is not used. | | String
|=======================================================================
#### Query Parameters (43 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| appid | | String | *Required* APPID ID used to authenticate the user connected to the API Server
-
-| headerName | | String | To store the weather result in this header instead of the message body. This is useable if you want to keep current message body as-is.
-
-| language | en | WeatherLanguage | Language of the response.
-
-| mode | JSON | WeatherMode | The output format of the weather data.
-
-| period | | String | If null the current weather will be returned else use values of 5 7 14 days. Only the numeric value for the forecast period is actually parsed so spelling capitalisation of the time period is up to you (its ignored)
-
-| units | | WeatherUnits | The units for temperature measurement.
-
-| weatherApi | | WeatherApi | The API to be use (current forecast/3 hour forecast daily station)
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| advanced
-| httpConnectionManager | | HttpConnectionManager | To use a custom HttpConnectionManager to manage connections
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| filter
-| cnt | | Integer | Number of results to be found
-
-| ids | | String | List of id's of city/stations. You can separate multiple ids by comma.
-
-| lat | | String | Latitude of location. You can use lat and lon options instead of location. For boxed queries this is the bottom latitude.
-
-| location | | String | If null Camel will try and determine your current location using the geolocation of your ip address else specify the citycountry. For well known city names Open Weather Map will determine the best fit but multiple results may be returned. Hence specifying and country as well will return more accurate data. If you specify current as the location then the component will try to get the current latitude and longitude and use that to get the weather details. You can use lat and lon options instead of location.
-
-| lon | | String | Longitude of location. You can use lat and lon options instead of location. For boxed queries this is the left longtitude.
-
-| rightLon | | String | For boxed queries this is the right longtitude. Needs to be used in combination with topLat and zoom.
-
-| topLat | | String | For boxed queries this is the top latitude. Needs to be used in combination with rightLon and zoom.
-
-| zip | | String | Zip-code e.g. 94040us
-
-| zoom | | Integer | For boxed queries this is the zoom. Needs to be used in combination with rightLon and topLat.
- 4+^s| proxy
-| proxyAuthDomain | | String | Domain for proxy NTLM authentication
-
-| proxyAuthHost | | String | Optional host for proxy NTLM authentication
-
-| proxyAuthMethod | | String | Authentication method for proxy either as Basic Digest or NTLM.
-
-| proxyAuthPassword | | String | Password for proxy authentication
-
-| proxyAuthUsername | | String | Username for proxy authentication
-
-| proxyHost | | String | The proxy host name
-
-| proxyPort | | Integer | The proxy port number
+| Name | Description | Default | Type
+| **appid** (common) | *Required* APPID ID used to authenticate the user connected to the API Server | | String
+| **headerName** (common) | To store the weather result in this header instead of the message body. This is useable if you want to keep current message body as-is. | | String
+| **language** (common) | Language of the response. | en | WeatherLanguage
+| **mode** (common) | The output format of the weather data. | JSON | WeatherMode
+| **period** (common) | If null the current weather will be returned else use values of 5 7 14 days. Only the numeric value for the forecast period is actually parsed so spelling capitalisation of the time period is up to you (its ignored) | | String
+| **units** (common) | The units for temperature measurement. | | WeatherUnits
+| **weatherApi** (common) | The API to be use (current forecast/3 hour forecast daily station) | | WeatherApi
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **httpConnectionManager** (advanced) | To use a custom HttpConnectionManager to manage connections | | HttpConnectionManager
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **cnt** (filter) | Number of results to be found | | Integer
+| **ids** (filter) | List of id's of city/stations. You can separate multiple ids by comma. | | String
+| **lat** (filter) | Latitude of location. You can use lat and lon options instead of location. For boxed queries this is the bottom latitude. | | String
+| **location** (filter) | If null Camel will try and determine your current location using the geolocation of your ip address else specify the citycountry. For well known city names Open Weather Map will determine the best fit but multiple results may be returned. Hence specifying and country as well will return more accurate data. If you specify current as the location then the component will try to get the current latitude and longitude and use that to get the weather details. You can use lat and lon options instead of location. | | String
+| **lon** (filter) | Longitude of location. You can use lat and lon options instead of location. For boxed queries this is the left longtitude. | | String
+| **rightLon** (filter) | For boxed queries this is the right longtitude. Needs to be used in combination with topLat and zoom. | | String
+| **topLat** (filter) | For boxed queries this is the top latitude. Needs to be used in combination with rightLon and zoom. | | String
+| **zip** (filter) | Zip-code e.g. 94040us | | String
+| **zoom** (filter) | For boxed queries this is the zoom. Needs to be used in combination with rightLon and topLat. | | Integer
+| **proxyAuthDomain** (proxy) | Domain for proxy NTLM authentication | | String
+| **proxyAuthHost** (proxy) | Optional host for proxy NTLM authentication | | String
+| **proxyAuthMethod** (proxy) | Authentication method for proxy either as Basic Digest or NTLM. | | String
+| **proxyAuthPassword** (proxy) | Password for proxy authentication | | String
+| **proxyAuthUsername** (proxy) | Username for proxy authentication | | String
+| **proxyHost** (proxy) | The proxy host name | | String
+| **proxyPort** (proxy) | The proxy port number | | Integer
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-websocket/src/main/docs/websocket-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-websocket/src/main/docs/websocket-component.adoc b/components/camel-websocket/src/main/docs/websocket-component.adoc
index 53e84ba..ff4d857 100644
--- a/components/camel-websocket/src/main/docs/websocket-component.adoc
+++ b/components/camel-websocket/src/main/docs/websocket-component.adoc
@@ -36,35 +36,22 @@ The Jetty Websocket component supports 13 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| staticResources | | String | Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath if you prefix with classpath: otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:. or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use.
- 4+^s| common
-| host | 0.0.0.0 | String | The hostname. The default value is 0.0.0.0
-
-| port | 9292 | Integer | The port number. The default value is 9292
- 4+^s| security
-| sslKeyPassword | | String | The password for the keystore when using SSL.
-
-| sslPassword | | String | The password when using SSL.
-
-| sslKeystore | | String | The path to the keystore.
- 4+^s| advanced
-| enableJmx | false | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.
-
-| minThreads | | Integer | To set a value for minimum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for minThreads is 1.
-
-| maxThreads | | Integer | To set a value for maximum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for maxThreads is 1 2 noCores.
-
-| threadPool | | ThreadPool | To use a custom thread pool for the server. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9.
- 4+^s| security
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
- 4+^s| common
-| socketFactory | | Map | To configure a map which contains custom WebSocketFactory for sub protocols. The key in the map is the sub protocol. The default key is reserved for the default implementation.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **staticResources** (consumer) | Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath if you prefix with classpath: otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:. or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use. | | String
+| **host** (common) | The hostname. The default value is 0.0.0.0 | 0.0.0.0 | String
+| **port** (common) | The port number. The default value is 9292 | 9292 | Integer
+| **sslKeyPassword** (security) | The password for the keystore when using SSL. | | String
+| **sslPassword** (security) | The password when using SSL. | | String
+| **sslKeystore** (security) | The path to the keystore. | | String
+| **enableJmx** (advanced) | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. | false | boolean
+| **minThreads** (advanced) | To set a value for minimum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for minThreads is 1. | | Integer
+| **maxThreads** (advanced) | To set a value for maximum number of threads in server thread pool. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. The default values for maxThreads is 1 2 noCores. | | Integer
+| **threadPool** (advanced) | To use a custom thread pool for the server. MaxThreads/minThreads or threadPool fields are required due to switch to Jetty9. | | ThreadPool
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
+| **socketFactory** (common) | To configure a map which contains custom WebSocketFactory for sub protocols. The key in the map is the sub protocol. The default key is reserved for the default implementation. | | Map
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -86,55 +73,37 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | 0.0.0.0 | String | The hostname. The default value is 0.0.0.0. Setting this option on the component will use the component configured value as default.
-| port | 9292 | Integer | The port number. The default value is 9292. Setting this option on the component will use the component configured value as default.
-| resourceUri | | String | *Required* Name of the websocket channel to use
+| Name | Description | Default | Type
+| **host** | The hostname. The default value is 0.0.0.0. Setting this option on the component will use the component configured value as default. | 0.0.0.0 | String
+| **port** | The port number. The default value is 9292. Setting this option on the component will use the component configured value as default. | 9292 | Integer
+| **resourceUri** | *Required* Name of the websocket channel to use | | String
|=======================================================================
#### Query Parameters (18 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| maxBinaryMessageSize | -1 | Integer | Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing. (Default is -1 - or unlimited)
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| sessionSupport | false | boolean | Whether to enable session support which enables HttpSession for each http request.
-
-| staticResources | | String | Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath if you prefix with classpath: otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:. or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| sendTimeout | 30000 | Integer | Timeout in millis when sending to a websocket channel. The default timeout is 30000 (30 seconds).
-
-| sendToAll | | Boolean | To send to all websocket subscribers. Can be used to configure on endpoint level instead of having to use the WebsocketConstants.SEND_TO_ALL header on the message.
- 4+^s| advanced
-| bufferSize | 8192 | Integer | Set the buffer size of the websocketServlet which is also the max frame byte size (default 8192)
-
-| maxIdleTime | 300000 | Integer | Set the time in ms that the websocket created by the websocketServlet may be idle before closing. (default is 300000)
-
-| maxTextMessageSize | | Integer | Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing.
-
-| minVersion | 13 | Integer | Can be used to set the minimum protocol version accepted for the websocketServlet. (Default 13 - the RFC6455 version)
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| cors
-| allowedOrigins | | String | The CORS allowed origins. Use to allow all.
-
-| crossOriginFilterOn | false | boolean | Whether to enable CORS
-
-| filterPath | | String | Context path for filtering CORS
- 4+^s| monitoring
-| enableJmx | false | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.
- 4+^s| security
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
+| Name | Description | Default | Type
+| **maxBinaryMessageSize** (common) | Can be used to set the size in bytes that the websocket created by the websocketServlet may be accept before closing. (Default is -1 - or unlimited) | -1 | Integer
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **sessionSupport** (consumer) | Whether to enable session support which enables HttpSession for each http request. | false | boolean
+| **staticResources** (consumer) | Set a resource path for static resources (such as .html files etc). The resources can be loaded from classpath if you prefix with classpath: otherwise the resources is loaded from file system or from JAR files. For example to load from root classpath use classpath:. or classpath:WEB-INF/static If not configured (eg null) then no static resource is in use. | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **sendTimeout** (producer) | Timeout in millis when sending to a websocket channel. The default timeout is 30000 (30 seconds). | 30000 | Integer
+| **sendToAll** (producer) | To send to all websocket subscribers. Can be used to configure on endpoint level instead of having to use the WebsocketConstants.SEND_TO_ALL header on the message. | | Boolean
+| **bufferSize** (advanced) | Set the buffer size of the websocketServlet which is also the max frame byte size (default 8192) | 8192 | Integer
+| **maxIdleTime** (advanced) | Set the time in ms that the websocket created by the websocketServlet may be idle before closing. (default is 300000) | 300000 | Integer
+| **maxTextMessageSize** (advanced) | Can be used to set the size in characters that the websocket created by the websocketServlet may be accept before closing. | | Integer
+| **minVersion** (advanced) | Can be used to set the minimum protocol version accepted for the websocketServlet. (Default 13 - the RFC6455 version) | 13 | Integer
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **allowedOrigins** (cors) | The CORS allowed origins. Use to allow all. | | String
+| **crossOriginFilterOn** (cors) | Whether to enable CORS | false | boolean
+| **filterPath** (cors) | Context path for filtering CORS | | String
+| **enableJmx** (monitoring) | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. | false | boolean
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc b/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc
index 30bf428..da1f1dc 100644
--- a/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc
+++ b/components/camel-xmlrpc/src/main/docs/xmlrpc-component.adoc
@@ -109,53 +109,35 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| address | | String | *Required* The server url
+| Name | Description | Default | Type
+| **address** | *Required* The server url | | String
|=======================================================================
#### Query Parameters (18 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| basicEncoding | | String | Sets the encoding for basic authentication null means UTF-8 is chosen.
-
-| connectionTimeout | | int | Set the connection timeout in milliseconds 0 is to disable it
-
-| contentLengthOptional | false | boolean | Whether a Content-Length header may be omitted. The XML-RPC specification demands that such a header be present.
-
-| defaultMethodName | | String | The method name which would be used for the xmlrpc requests by default if the Message header CamelXmlRpcMethodName is not set.
-
-| enabledForExceptions | false | boolean | Whether the response should contain a faultCause element in case of errors. The faultCause is an exception which the server has trapped and written into a byte stream as a serializable object.
-
-| enabledForExtensions | false | boolean | Whether extensions are enabled. By default the client or server is strictly compliant to the XML-RPC specification and extensions are disabled.
-
-| encoding | | String | Sets the requests encoding null means UTF-8 is chosen.
-
-| gzipCompressing | false | boolean | Whether gzip compression is being used for transmitting the request.
-
-| gzipRequesting | false | boolean | Whether gzip compression is being used for transmitting the request.
-
-| replyTimeout | | int | Set the reply timeout in milliseconds 0 is to disable it.
- 4+^s| advanced
-| clientConfig | | XmlRpcClientConfigImpl | To use the given XmlRpcClientConfigImpl as configuration for the client.
-
-| clientConfigurer | | XmlRpcClientConfigurer | To use a custom XmlRpcClientConfigurer to configure the client
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| timeZone | | TimeZone | The timezone which is used to interpret date/time. Defaults to link TimeZonegetDefault().
-
-| userAgent | | String | The http user agent header to set when doing xmlrpc requests
-
-| xmlRpcServer | | XmlRpcRequestProcessor | To use a custom XmlRpcRequestProcessor as server.
- 4+^s| security
-| basicPassword | | String | The password for basic authentication.
-
-| basicUserName | | String | The user name for basic authentication.
+| Name | Description | Default | Type
+| **basicEncoding** (producer) | Sets the encoding for basic authentication null means UTF-8 is chosen. | | String
+| **connectionTimeout** (producer) | Set the connection timeout in milliseconds 0 is to disable it | | int
+| **contentLengthOptional** (producer) | Whether a Content-Length header may be omitted. The XML-RPC specification demands that such a header be present. | false | boolean
+| **defaultMethodName** (producer) | The method name which would be used for the xmlrpc requests by default if the Message header CamelXmlRpcMethodName is not set. | | String
+| **enabledForExceptions** (producer) | Whether the response should contain a faultCause element in case of errors. The faultCause is an exception which the server has trapped and written into a byte stream as a serializable object. | false | boolean
+| **enabledForExtensions** (producer) | Whether extensions are enabled. By default the client or server is strictly compliant to the XML-RPC specification and extensions are disabled. | false | boolean
+| **encoding** (producer) | Sets the requests encoding null means UTF-8 is chosen. | | String
+| **gzipCompressing** (producer) | Whether gzip compression is being used for transmitting the request. | false | boolean
+| **gzipRequesting** (producer) | Whether gzip compression is being used for transmitting the request. | false | boolean
+| **replyTimeout** (producer) | Set the reply timeout in milliseconds 0 is to disable it. | | int
+| **clientConfig** (advanced) | To use the given XmlRpcClientConfigImpl as configuration for the client. | | XmlRpcClientConfig Impl
+| **clientConfigurer** (advanced) | To use a custom XmlRpcClientConfigurer to configure the client | | XmlRpcClientConfigurer
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **timeZone** (advanced) | The timezone which is used to interpret date/time. Defaults to link TimeZonegetDefault(). | | TimeZone
+| **userAgent** (advanced) | The http user agent header to set when doing xmlrpc requests | | String
+| **xmlRpcServer** (advanced) | To use a custom XmlRpcRequestProcessor as server. | | XmlRpcRequestProcessor
+| **basicPassword** (security) | The password for basic authentication. | | String
+| **basicUserName** (security) | The user name for basic authentication. | | String
|=======================================================================
// endpoint options: END
[06/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
index 46583bc..5fd49d5 100644
--- a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
+++ b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc
@@ -431,59 +431,34 @@ The Salesforce component supports 25 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| security
-| loginConfig | | SalesforceLoginConfig | To use the shared SalesforceLoginConfig as login configuration
-
-| loginUrl | https://login.salesforce.com | String | Salesforce login URL defaults to https://login.salesforce.com
-
-| clientId | | String | Salesforce connected application Consumer Key
-
-| clientSecret | | String | Salesforce connected application Consumer Secret
-
-| keystore | | KeyStoreParameters | KeyStoreParameters to use in OAuth 2.0 JWT Bearer Token Flow.
-
-| refreshToken | | String | Salesforce connected application Consumer token
-
-| userName | | String | Salesforce account user name
-
-| password | | String | Salesforce account password
-
-| lazyLogin | false | boolean | Flag to enable/disable lazy OAuth default is false. When enabled OAuth token retrieval or generation is not done until the first API call
- 4+^s| advanced
-| config | | SalesforceEndpointConfig | To use the shared SalesforceEndpointConfig as endpoint configuration
-
-| httpClientProperties | | Map | Used for configuring HTTP client properties as key/value pairs
- 4+^s| security
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
- 4+^s| proxy
-| httpProxyHost | | String | To configure HTTP proxy host
-
-| httpProxyPort | | Integer | To configure HTTP proxy port
- 4+^s| security
-| httpProxyUsername | | String | To configure HTTP proxy username
-
-| httpProxyPassword | | String | To configure HTTP proxy password
- 4+^s| proxy
-| isHttpProxySocks4 | false | boolean | Enable for Socks4 proxy false by default
- 4+^s| security
-| isHttpProxySecure | false | boolean | Enable for TLS connections true by default
- 4+^s| proxy
-| httpProxyIncludedAddresses | | Set | HTTP proxy included addresses
-
-| httpProxyExcludedAddresses | | Set | HTTP proxy excluded addresses
- 4+^s| security
-| httpProxyAuthUri | | String | HTTP proxy authentication URI
-
-| httpProxyRealm | | String | HTTP proxy authentication realm
-
-| httpProxyUseDigestAuth | false | boolean | Use HTTP proxy Digest authentication false by default
- 4+^s| common
-| packages | | String[] | Package names to scan for DTO classes (multiple packages can be separated by comma).
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **loginConfig** (security) | To use the shared SalesforceLoginConfig as login configuration | | SalesforceLoginConfig
+| **loginUrl** (security) | Salesforce login URL defaults to https://login.salesforce.com | https://login.salesforce.com | String
+| **clientId** (security) | Salesforce connected application Consumer Key | | String
+| **clientSecret** (security) | Salesforce connected application Consumer Secret | | String
+| **keystore** (security) | KeyStoreParameters to use in OAuth 2.0 JWT Bearer Token Flow. | | KeyStoreParameters
+| **refreshToken** (security) | Salesforce connected application Consumer token | | String
+| **userName** (security) | Salesforce account user name | | String
+| **password** (security) | Salesforce account password | | String
+| **lazyLogin** (security) | Flag to enable/disable lazy OAuth default is false. When enabled OAuth token retrieval or generation is not done until the first API call | false | boolean
+| **config** (advanced) | To use the shared SalesforceEndpointConfig as endpoint configuration | | SalesforceEndpoint Config
+| **httpClientProperties** (advanced) | Used for configuring HTTP client properties as key/value pairs | | Map
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
+| **httpProxyHost** (proxy) | To configure HTTP proxy host | | String
+| **httpProxyPort** (proxy) | To configure HTTP proxy port | | Integer
+| **httpProxyUsername** (security) | To configure HTTP proxy username | | String
+| **httpProxyPassword** (security) | To configure HTTP proxy password | | String
+| **isHttpProxySocks4** (proxy) | Enable for Socks4 proxy false by default | false | boolean
+| **isHttpProxySecure** (security) | Enable for TLS connections true by default | false | boolean
+| **httpProxyIncluded Addresses** (proxy) | HTTP proxy included addresses | | Set
+| **httpProxyExcluded Addresses** (proxy) | HTTP proxy excluded addresses | | Set
+| **httpProxyAuthUri** (security) | HTTP proxy authentication URI | | String
+| **httpProxyRealm** (security) | HTTP proxy authentication realm | | String
+| **httpProxyUseDigest Auth** (security) | Use HTTP proxy Digest authentication false by default | false | boolean
+| **packages** (common) | Package names to scan for DTO classes (multiple packages can be separated by comma). | | String[]
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -505,100 +480,59 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| operationName | | OperationName | The operation to use
-| topicName | | String | The name of the topic to use
+| Name | Description | Default | Type
+| **operationName** | The operation to use | | OperationName
+| **topicName** | The name of the topic to use | | String
|=======================================================================
#### Query Parameters (41 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| apexMethod | | String | APEX method name
-
-| apexQueryParams | | Map | Query params for APEX method
-
-| apexUrl | | String | APEX method URL
-
-| apiVersion | | String | Salesforce API version defaults to SalesforceEndpointConfig.DEFAULT_VERSION
-
-| backoffIncrement | | long | Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
-
-| batchId | | String | Bulk API Batch ID
-
-| contentType | | ContentType | Bulk API content type one of XML CSV ZIP_XML ZIP_CSV
-
-| defaultReplayId | | Long | Default replayId setting if no value is found in link initialReplayIdMap
-
-| format | | PayloadFormat | Payload format to use for Salesforce API calls either JSON or XML defaults to JSON
-
-| httpClient | | SalesforceHttpClient | Custom Jetty Http Client to use to connect to Salesforce.
-
-| includeDetails | | Boolean | Include details in Salesforce1 Analytics report defaults to false.
-
-| initialReplayIdMap | | Map | Replay IDs to start from per channel name.
-
-| instanceId | | String | Salesforce1 Analytics report execution instance ID
-
-| jobId | | String | Bulk API Job ID
-
-| limit | | Integer | Limit on number of returned records. Applicable to some of the API check the Salesforce documentation.
-
-| maxBackoff | | long | Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect.
-
-| notifyForFields | | NotifyForFieldsEnum | Notify for fields options are ALL REFERENCED SELECT WHERE
-
-| notifyForOperationCreate | | Boolean | Notify for create operation defaults to false (API version = 29.0)
-
-| notifyForOperationDelete | | Boolean | Notify for delete operation defaults to false (API version = 29.0)
-
-| notifyForOperations | | NotifyForOperationsEnum | Notify for operations options are ALL CREATE EXTENDED UPDATE (API version 29.0)
-
-| notifyForOperationUndelete | | Boolean | Notify for un-delete operation defaults to false (API version = 29.0)
-
-| notifyForOperationUpdate | | Boolean | Notify for update operation defaults to false (API version = 29.0)
-
-| objectMapper | | ObjectMapper | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects.
-
-| reportId | | String | Salesforce1 Analytics report Id
-
-| reportMetadata | | ReportMetadata | Salesforce1 Analytics report metadata for filtering
-
-| resultId | | String | Bulk API Result ID
-
-| sObjectBlobFieldName | | String | SObject blob field name
-
-| sObjectClass | | String | Fully qualified SObject class name usually generated using camel-salesforce-maven-plugin
-
-| sObjectFields | | String | SObject fields to retrieve
-
-| sObjectId | | String | SObject ID if required by API
-
-| sObjectIdName | | String | SObject external ID field name
-
-| sObjectIdValue | | String | SObject external ID field value
-
-| sObjectName | | String | SObject name if required or supported by API
-
-| sObjectQuery | | String | Salesforce SOQL query string
-
-| sObjectSearch | | String | Salesforce SOSL search string
-
-| updateTopic | false | boolean | Whether to update an existing Push Topic when using the Streaming API defaults to false
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| replayId | | Long | The replayId value to use when subscribing
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **apexMethod** (common) | APEX method name | | String
+| **apexQueryParams** (common) | Query params for APEX method | | Map
+| **apexUrl** (common) | APEX method URL | | String
+| **apiVersion** (common) | Salesforce API version defaults to SalesforceEndpointConfig.DEFAULT_VERSION | | String
+| **backoffIncrement** (common) | Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. | | long
+| **batchId** (common) | Bulk API Batch ID | | String
+| **contentType** (common) | Bulk API content type one of XML CSV ZIP_XML ZIP_CSV | | ContentType
+| **defaultReplayId** (common) | Default replayId setting if no value is found in link initialReplayIdMap | | Long
+| **format** (common) | Payload format to use for Salesforce API calls either JSON or XML defaults to JSON | | PayloadFormat
+| **httpClient** (common) | Custom Jetty Http Client to use to connect to Salesforce. | | SalesforceHttpClient
+| **includeDetails** (common) | Include details in Salesforce1 Analytics report defaults to false. | | Boolean
+| **initialReplayIdMap** (common) | Replay IDs to start from per channel name. | | Map
+| **instanceId** (common) | Salesforce1 Analytics report execution instance ID | | String
+| **jobId** (common) | Bulk API Job ID | | String
+| **limit** (common) | Limit on number of returned records. Applicable to some of the API check the Salesforce documentation. | | Integer
+| **maxBackoff** (common) | Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. | | long
+| **notifyForFields** (common) | Notify for fields options are ALL REFERENCED SELECT WHERE | | NotifyForFieldsEnum
+| **notifyForOperationCreate** (common) | Notify for create operation defaults to false (API version = 29.0) | | Boolean
+| **notifyForOperationDelete** (common) | Notify for delete operation defaults to false (API version = 29.0) | | Boolean
+| **notifyForOperations** (common) | Notify for operations options are ALL CREATE EXTENDED UPDATE (API version 29.0) | | NotifyForOperations Enum
+| **notifyForOperationUndelete** (common) | Notify for un-delete operation defaults to false (API version = 29.0) | | Boolean
+| **notifyForOperationUpdate** (common) | Notify for update operation defaults to false (API version = 29.0) | | Boolean
+| **objectMapper** (common) | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. | | ObjectMapper
+| **reportId** (common) | Salesforce1 Analytics report Id | | String
+| **reportMetadata** (common) | Salesforce1 Analytics report metadata for filtering | | ReportMetadata
+| **resultId** (common) | Bulk API Result ID | | String
+| **sObjectBlobFieldName** (common) | SObject blob field name | | String
+| **sObjectClass** (common) | Fully qualified SObject class name usually generated using camel-salesforce-maven-plugin | | String
+| **sObjectFields** (common) | SObject fields to retrieve | | String
+| **sObjectId** (common) | SObject ID if required by API | | String
+| **sObjectIdName** (common) | SObject external ID field name | | String
+| **sObjectIdValue** (common) | SObject external ID field value | | String
+| **sObjectName** (common) | SObject name if required or supported by API | | String
+| **sObjectQuery** (common) | Salesforce SOQL query string | | String
+| **sObjectSearch** (common) | Salesforce SOSL search string | | String
+| **updateTopic** (common) | Whether to update an existing Push Topic when using the Streaming API defaults to false | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **replayId** (consumer) | The replayId value to use when subscribing | | Long
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc b/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc
index 5f93151..6620ed8 100644
--- a/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc
+++ b/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc
@@ -61,29 +61,23 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| url | | String | *Required* Url to the SAP net-weaver gateway server.
+| Name | Description | Default | Type
+| **url** | *Required* Url to the SAP net-weaver gateway server. | | String
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| flatternMap | true | boolean | If the JSON Map contains only a single entry then flattern by storing that single entry value as the message body.
-
-| json | true | boolean | Whether to return data in JSON format. If this option is false then XML is returned in Atom format.
-
-| jsonAsMap | true | boolean | To transform the JSON from a String to a Map in the message body.
-
-| password | | String | *Required* Password for account.
-
-| username | | String | *Required* Username for account.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **flatternMap** (producer) | If the JSON Map contains only a single entry then flattern by storing that single entry value as the message body. | true | boolean
+| **json** (producer) | Whether to return data in JSON format. If this option is false then XML is returned in Atom format. | true | boolean
+| **jsonAsMap** (producer) | To transform the JSON from a String to a Map in the message body. | true | boolean
+| **password** (producer) | *Required* Password for account. | | String
+| **username** (producer) | *Required* Username for account. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-saxon/src/main/docs/xquery-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-saxon/src/main/docs/xquery-component.adoc b/components/camel-saxon/src/main/docs/xquery-component.adoc
index 7d7f838..6fba30e 100644
--- a/components/camel-saxon/src/main/docs/xquery-component.adoc
+++ b/components/camel-saxon/src/main/docs/xquery-component.adoc
@@ -19,17 +19,13 @@ The XQuery component supports 4 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| moduleURIResolver | | ModuleURIResolver | To use the custom ModuleURIResolver
-
-| configuration | | Configuration | To use a custom Saxon configuration
-
-| configurationProperties | | Map | To set custom Saxon configuration properties
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **moduleURIResolver** (advanced) | To use the custom ModuleURIResolver | | ModuleURIResolver
+| **configuration** (advanced) | To use a custom Saxon configuration | | Configuration
+| **configurationProperties** (advanced) | To set custom Saxon configuration properties | | Map
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -45,79 +41,48 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| resourceUri | | String | *Required* The name of the template to load from classpath or file system
+| Name | Description | Default | Type
+| **resourceUri** | *Required* The name of the template to load from classpath or file system | | String
|=======================================================================
#### Query Parameters (31 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| allowStAX | false | boolean | Whether to allow using StAX mode
-
-| headerName | | String | To use a Camel Message header as the input source instead of Message body.
-
-| namespacePrefixes | | Map | Allows to control which namespace prefixes to use for a set of namespace mappings
-
-| resultsFormat | DOM | ResultFormat | What output result to use
-
-| resultType | | Class<?> | What output result to use defined as a class
-
-| stripsAllWhiteSpace | true | boolean | Whether to strip all whitespaces
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| advanced
-| configuration | | Configuration | To use a custom Saxon configuration
-
-| configurationProperties | | Map | To set custom Saxon configuration properties
-
-| moduleURIResolver | | ModuleURIResolver | To use the custom ModuleURIResolver
-
-| parameters | | Map | Additional parameters
-
-| properties | | Properties | Properties to configure the serialization parameters
-
-| staticQueryContext | | StaticQueryContext | To use a custom Saxon StaticQueryContext
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **allowStAX** (common) | Whether to allow using StAX mode | false | boolean
+| **headerName** (common) | To use a Camel Message header as the input source instead of Message body. | | String
+| **namespacePrefixes** (common) | Allows to control which namespace prefixes to use for a set of namespace mappings | | Map
+| **resultsFormat** (common) | What output result to use | DOM | ResultFormat
+| **resultType** (common) | What output result to use defined as a class | | Class<?>
+| **stripsAllWhiteSpace** (common) | Whether to strip all whitespaces | true | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **configuration** (advanced) | To use a custom Saxon configuration | | Configuration
+| **configurationProperties** (advanced) | To set custom Saxon configuration properties | | Map
+| **moduleURIResolver** (advanced) | To use the custom ModuleURIResolver | | ModuleURIResolver
+| **parameters** (advanced) | Additional parameters | | Map
+| **properties** (advanced) | Properties to configure the serialization parameters | | Properties
+| **staticQueryContext** (advanced) | To use a custom Saxon StaticQueryContext | | StaticQueryContext
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-schematron/src/main/docs/schematron-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-schematron/src/main/docs/schematron-component.adoc b/components/camel-schematron/src/main/docs/schematron-component.adoc
index 8e50982..2c23d9c 100644
--- a/components/camel-schematron/src/main/docs/schematron-component.adoc
+++ b/components/camel-schematron/src/main/docs/schematron-component.adoc
@@ -44,25 +44,21 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| path | | String | *Required* The path to the schematron rules file. Can either be in class path or location in the file system.
+| Name | Description | Default | Type
+| **path** | *Required* The path to the schematron rules file. Can either be in class path or location in the file system. | | String
|=======================================================================
#### Query Parameters (4 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| abort | false | boolean | Flag to abort the route and throw a schematron validation exception.
-
-| rules | | Templates | To use the given schematron rules instead of loading from the path
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| uriResolver | | URIResolver | Set the URIResolver to be used for resolving schematron includes in the rules file.
+| Name | Description | Default | Type
+| **abort** (producer) | Flag to abort the route and throw a schematron validation exception. | false | boolean
+| **rules** (producer) | To use the given schematron rules instead of loading from the path | | Templates
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **uriResolver** (advanced) | Set the URIResolver to be used for resolving schematron includes in the rules file. | | URIResolver
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-servicenow/src/main/docs/servicenow-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-servicenow/src/main/docs/servicenow-component.adoc b/components/camel-servicenow/src/main/docs/servicenow-component.adoc
index 0d1594b..2dc64a0 100644
--- a/components/camel-servicenow/src/main/docs/servicenow-component.adoc
+++ b/components/camel-servicenow/src/main/docs/servicenow-component.adoc
@@ -34,25 +34,17 @@ The ServiceNow component supports 8 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | ServiceNowConfiguration | The ServiceNow default configuration
- 4+^s| producer
-| apiUrl | | String | The ServiceNow REST API url
- 4+^s| security
-| userName | | String | ServiceNow user account name
-
-| password | | String | ServiceNow account password
-
-| oauthClientId | | String | OAuth2 ClientID
-
-| oauthClientSecret | | String | OAuth2 ClientSecret
-
-| oauthTokenUrl | | String | OAuth token Url
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | The ServiceNow default configuration | | ServiceNowConfiguration
+| **apiUrl** (producer) | The ServiceNow REST API url | | String
+| **userName** (security) | ServiceNow user account name | | String
+| **password** (security) | ServiceNow account password | | String
+| **oauthClientId** (security) | OAuth2 ClientID | | String
+| **oauthClientSecret** (security) | OAuth2 ClientSecret | | String
+| **oauthTokenUrl** (security) | OAuth token Url | | String
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -66,97 +58,57 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| instanceName | | String | *Required* The ServiceNow instance name
+| Name | Description | Default | Type
+| **instanceName** | *Required* The ServiceNow instance name | | String
|=======================================================================
#### Query Parameters (40 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| display | true | String | Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value. This parameter is true by default.
-
-| displayValue | false | String | Return the display value (true) actual value (false) or both (all) for reference fields (default: false)
-
-| excludeReferenceLink | | Boolean | True to exclude Table API links for reference fields (default: false)
-
-| favorites | | Boolean | Set this parameter to true to return only scorecards that are favorites of the querying user.
-
-| includeAggregates | | Boolean | Set this parameter to true to always return all available aggregates for an indicator including when an aggregate has already been applied. If a value is not specified this parameter defaults to false and returns no aggregates.
-
-| includeAvailableAggregates | | Boolean | Set this parameter to true to return all available aggregates for an indicator when no aggregate has been applied. If a value is not specified this parameter defaults to false and returns no aggregates.
-
-| includeAvailableBreakdowns | | Boolean | Set this parameter to true to return all available breakdowns for an indicator. If a value is not specified this parameter defaults to false and returns no breakdowns.
-
-| includeScoreNotes | | Boolean | Set this parameter to true to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added.
-
-| includeScores | | Boolean | Set this parameter to true to return all scores for a scorecard. If a value is not specified this parameter defaults to false and returns only the most recent score value.
-
-| inputDisplayValue | | Boolean | True to set raw value of input fields (default: false)
-
-| key | | Boolean | Set this parameter to true to return only scorecards for key indicators.
-
-| models | | String | Defines both request and response models
-
-| perPage | 10 | Integer | Enter the maximum number of scorecards each query can return. By default this value is 10 and the maximum is 100.
-
-| release | HELSINKI | ServiceNowRelease | The ServiceNow release to target default to Helsinki See https://docs.servicenow.com
-
-| requestModels | | String | Defines the request model
-
-| resource | | String | The default resource can be overridden by header CamelServiceNowResource
-
-| responseModels | | String | Defines the response model
-
-| sortBy | | String | Specify the value to use when sorting results. By default queries sort records by value.
-
-| sortDir | | String | Specify the sort direction ascending or descending. By default queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order.
-
-| suppressAutoSysField | | Boolean | True to suppress auto generation of system fields (default: false)
-
-| suppressPaginationHeader | | Boolean | Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit
-
-| table | | String | The default table can be overridden by header CamelServiceNowTable
-
-| target | | Boolean | Set this parameter to true to return only scorecards that have a target.
-
-| topLevelOnly | | Boolean | Gets only those categories whose parent is a catalog.
- 4+^s| advanced
-| apiVersion | | String | The ServiceNow REST API version default latest
-
-| httpClientPolicy | | HTTPClientPolicy | To configure http-client
-
-| mapper | | ObjectMapper | Sets Jackson's ObjectMapper to use for request/reply
-
-| proxyAuthorizationPolicy | | ProxyAuthorizationPolicy | To configure proxy authentication
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| proxy
-| proxyHost | | String | The proxy host name
-
-| proxyPort | | Integer | The proxy port number
- 4+^s| security
-| apiUrl | | String | The ServiceNow REST API url
-
-| oauthClientId | | String | OAuth2 ClientID
-
-| oauthClientSecret | | String | OAuth2 ClientSecret
-
-| oauthTokenUrl | | String | OAuth token Url
-
-| password | | String | *Required* ServiceNow account password MUST be provided
-
-| proxyPassword | | String | Password for proxy authentication
-
-| proxyUserName | | String | Username for proxy authentication
-
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html
-
-| userName | | String | *Required* ServiceNow user account name MUST be provided
+| Name | Description | Default | Type
+| **display** (producer) | Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value. This parameter is true by default. | true | String
+| **displayValue** (producer) | Return the display value (true) actual value (false) or both (all) for reference fields (default: false) | false | String
+| **excludeReferenceLink** (producer) | True to exclude Table API links for reference fields (default: false) | | Boolean
+| **favorites** (producer) | Set this parameter to true to return only scorecards that are favorites of the querying user. | | Boolean
+| **includeAggregates** (producer) | Set this parameter to true to always return all available aggregates for an indicator including when an aggregate has already been applied. If a value is not specified this parameter defaults to false and returns no aggregates. | | Boolean
+| **includeAvailableAggregates** (producer) | Set this parameter to true to return all available aggregates for an indicator when no aggregate has been applied. If a value is not specified this parameter defaults to false and returns no aggregates. | | Boolean
+| **includeAvailableBreakdowns** (producer) | Set this parameter to true to return all available breakdowns for an indicator. If a value is not specified this parameter defaults to false and returns no breakdowns. | | Boolean
+| **includeScoreNotes** (producer) | Set this parameter to true to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added. | | Boolean
+| **includeScores** (producer) | Set this parameter to true to return all scores for a scorecard. If a value is not specified this parameter defaults to false and returns only the most recent score value. | | Boolean
+| **inputDisplayValue** (producer) | True to set raw value of input fields (default: false) | | Boolean
+| **key** (producer) | Set this parameter to true to return only scorecards for key indicators. | | Boolean
+| **models** (producer) | Defines both request and response models | | String
+| **perPage** (producer) | Enter the maximum number of scorecards each query can return. By default this value is 10 and the maximum is 100. | 10 | Integer
+| **release** (producer) | The ServiceNow release to target default to Helsinki See https://docs.servicenow.com | HELSINKI | ServiceNowRelease
+| **requestModels** (producer) | Defines the request model | | String
+| **resource** (producer) | The default resource can be overridden by header CamelServiceNowResource | | String
+| **responseModels** (producer) | Defines the response model | | String
+| **sortBy** (producer) | Specify the value to use when sorting results. By default queries sort records by value. | | String
+| **sortDir** (producer) | Specify the sort direction ascending or descending. By default queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order. | | String
+| **suppressAutoSysField** (producer) | True to suppress auto generation of system fields (default: false) | | Boolean
+| **suppressPaginationHeader** (producer) | Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit | | Boolean
+| **table** (producer) | The default table can be overridden by header CamelServiceNowTable | | String
+| **target** (producer) | Set this parameter to true to return only scorecards that have a target. | | Boolean
+| **topLevelOnly** (producer) | Gets only those categories whose parent is a catalog. | | Boolean
+| **apiVersion** (advanced) | The ServiceNow REST API version default latest | | String
+| **httpClientPolicy** (advanced) | To configure http-client | | HTTPClientPolicy
+| **mapper** (advanced) | Sets Jackson's ObjectMapper to use for request/reply | | ObjectMapper
+| **proxyAuthorizationPolicy** (advanced) | To configure proxy authentication | | ProxyAuthorization Policy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **proxyHost** (proxy) | The proxy host name | | String
+| **proxyPort** (proxy) | The proxy port number | | Integer
+| **apiUrl** (security) | The ServiceNow REST API url | | String
+| **oauthClientId** (security) | OAuth2 ClientID | | String
+| **oauthClientSecret** (security) | OAuth2 ClientSecret | | String
+| **oauthTokenUrl** (security) | OAuth token Url | | String
+| **password** (security) | *Required* ServiceNow account password MUST be provided | | String
+| **proxyPassword** (security) | Password for proxy authentication | | String
+| **proxyUserName** (security) | Username for proxy authentication | | String
+| **sslContextParameters** (security) | To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html | | SSLContextParameters
+| **userName** (security) | *Required* ServiceNow user account name MUST be provided | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-servlet/src/main/docs/servlet-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-servlet/src/main/docs/servlet-component.adoc b/components/camel-servlet/src/main/docs/servlet-component.adoc
index 5cabc39..08e93dc 100644
--- a/components/camel-servlet/src/main/docs/servlet-component.adoc
+++ b/components/camel-servlet/src/main/docs/servlet-component.adoc
@@ -46,25 +46,17 @@ The Servlet component supports 8 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| servletName | | String | Default name of servlet to use. The default name is CamelServlet.
-
-| httpRegistry | | HttpRegistry | To use a custom org.apache.camel.component.servlet.HttpRegistry.
-
-| attachmentMultipartBinding | false | boolean | 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.
- 4+^s| advanced
-| httpBinding | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
-
-| httpConfiguration | | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
-
-| allowJavaSerializedObject | false | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. 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.
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **servletName** (consumer) | Default name of servlet to use. The default name is CamelServlet. | | String
+| **httpRegistry** (consumer) | To use a custom org.apache.camel.component.servlet.HttpRegistry. | | HttpRegistry
+| **attachmentMultipart Binding** (consumer) | 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. | false | boolean
+| **httpBinding** (advanced) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding
+| **httpConfiguration** (advanced) | To use the shared HttpConfiguration as base configuration. | | HttpConfiguration
+| **allowJavaSerialized Object** (advanced) | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. 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. | false | boolean
+| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -77,59 +69,38 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| contextPath | | String | *Required* The context-path to use
+| Name | Description | Default | Type
+| **contextPath** | *Required* The context-path to use | | String
|=======================================================================
#### Query Parameters (21 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| disableStreamCache | false | boolean | 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 r
esponse body stream but use the response stream as-is as the message body.
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| common (advanced)
-| httpBinding | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
- 4+^s| consumer
-| async | false | boolean | Configure the consumer to work in async mode
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| chunked | true | boolean | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response
-
-| httpMethodRestrict | | String | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma.
-
-| matchOnUriPrefix | false | boolean | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.
-
-| responseBufferSize | | Integer | To use a custom buffer size on the javax.servlet.ServletResponse.
-
-| servletName | CamelServlet | String | Name of the servlet to use
-
-| transferException | false | boolean | 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.
- 4+^s| consumer (advanced)
-| attachmentMultipartBinding | false | boolean | 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.
-
-| eagerCheckContentAvailable | false | boolean | 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.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| optionsEnabled | false | boolean | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off.
-
-| traceEnabled | false | boolean | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off.
- 4+^s| advanced
-| mapHttpMessageBody | true | boolean | 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.
-
-| mapHttpMessageFormUrlEncodedBody | true | boolean | 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.
-
-| mapHttpMessageHeaders | true | boolean | 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.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **disableStreamCache** (common) | 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 respon
se body stream but use the response stream as-is as the message body. | false | boolean
+| **headerFilterStrategy** (common) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **httpBinding** (common) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding
+| **async** (consumer) | Configure the consumer to work in async mode | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **chunked** (consumer) | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response | true | boolean
+| **httpMethodRestrict** (consumer) | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. | | String
+| **matchOnUriPrefix** (consumer) | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | false | boolean
+| **responseBufferSize** (consumer) | To use a custom buffer size on the javax.servlet.ServletResponse. | | Integer
+| **servletName** (consumer) | Name of the servlet to use | CamelServlet | String
+| **transferException** (consumer) | 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. | false | boolean
+| **attachmentMultipartBinding** (consumer) | 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. | false | boolean
+| **eagerCheckContentAvailable** (consumer) | 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. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **optionsEnabled** (consumer) | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. | false | boolean
+| **traceEnabled** (consumer) | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. | false | boolean
+| **mapHttpMessageBody** (advanced) | 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. | true | boolean
+| **mapHttpMessageFormUrl EncodedBody** (advanced) | 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. | true | boolean
+| **mapHttpMessageHeaders** (advanced) | 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. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-sip/src/main/docs/sip-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sip/src/main/docs/sip-component.adoc b/components/camel-sip/src/main/docs/sip-component.adoc
index d2e5726..fe8a889 100644
--- a/components/camel-sip/src/main/docs/sip-component.adoc
+++ b/components/camel-sip/src/main/docs/sip-component.adoc
@@ -83,105 +83,61 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| uri | | URI | *Required* URI of the SIP server to connect to (the username and password can be included such as: john:secretmyserver:9999)
+| Name | Description | Default | Type
+| **uri** | *Required* URI of the SIP server to connect to (the username and password can be included such as: john:secretmyserver:9999) | | URI
|=======================================================================
#### Query Parameters (44 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| cacheConnections | false | boolean | Should connections be cached by the SipStack to reduce cost of connection creation. This is useful if the connection is used for long running conversations.
-
-| contentSubType | plain | String | Setting for contentSubType can be set to any valid MimeSubType.
-
-| contentType | text | String | Setting for contentType can be set to any valid MimeType.
-
-| eventHeaderName | | String | Setting for a String based event type.
-
-| eventId | | String | Setting for a String based event Id. Mandatory setting unless a registry based FromHeader is specified
-
-| fromHost | | String | Hostname of the message originator. Mandatory setting unless a registry based FromHeader is specified
-
-| fromPort | | int | Port of the message originator. Mandatory setting unless a registry based FromHeader is specified
-
-| fromUser | | String | Username of the message originator. Mandatory setting unless a registry based custom FromHeader is specified.
-
-| msgExpiration | 3600 | int | The amount of time a message received at an endpoint is considered valid
-
-| receiveTimeoutMillis | 10000 | long | Setting for specifying amount of time to wait for a Response and/or Acknowledgement can be received from another SIP stack
-
-| stackName | NAME_NOT_SET | String | Name of the SIP Stack instance associated with an SIP Endpoint.
-
-| toHost | | String | Hostname of the message receiver. Mandatory setting unless a registry based ToHeader is specified
-
-| toPort | | int | Portname of the message receiver. Mandatory setting unless a registry based ToHeader is specified
-
-| toUser | | String | Username of the message receiver. Mandatory setting unless a registry based custom ToHeader is specified.
-
-| transport | tcp | String | Setting for choice of transport protocol. Valid choices are tcp or udp.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| consumer | false | boolean | This setting is used to determine whether the kind of header (FromHeaderToHeader etc) that needs to be created for this endpoint
-
-| presenceAgent | false | boolean | This setting is used to distinguish between a Presence Agent & a consumer. This is due to the fact that the SIP Camel component ships with a basic Presence Agent (for testing purposes only). Consumers have to set this flag to true.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| addressFactory | | AddressFactory | To use a custom AddressFactory
-
-| callIdHeader | | CallIdHeader | A custom Header object containing call details. Must implement the type javax.sip.header.CallIdHeader
-
-| contactHeader | | ContactHeader | An optional custom Header object containing verbose contact details (email phone number etc). Must implement the type javax.sip.header.ContactHeader
-
-| contentTypeHeader | | ContentTypeHeader | A custom Header object containing message content details. Must implement the type javax.sip.header.ContentTypeHeader
-
-| eventHeader | | EventHeader | A custom Header object containing event details. Must implement the type javax.sip.header.EventHeader
-
-| expiresHeader | | ExpiresHeader | A custom Header object containing message expiration details. Must implement the type javax.sip.header.ExpiresHeader
-
-| extensionHeader | | ExtensionHeader | A custom Header object containing user/application specific details. Must implement the type javax.sip.header.ExtensionHeader
-
-| fromHeader | | FromHeader | A custom Header object containing message originator settings. Must implement the type javax.sip.header.FromHeader
-
-| headerFactory | | HeaderFactory | To use a custom HeaderFactory
-
-| listeningPoint | | ListeningPoint | To use a custom ListeningPoint implementation
-
-| maxForwardsHeader | | MaxForwardsHeader | A custom Header object containing details on maximum proxy forwards. This header places a limit on the viaHeaders possible. Must implement the type javax.sip.header.MaxForwardsHeader
-
-| maxMessageSize | 1048576 | int | Setting for maximum allowed Message size in bytes.
-
-| messageFactory | | MessageFactory | To use a custom MessageFactory
-
-| sipFactory | | SipFactory | To use a custom SipFactory to create the SipStack to be used
-
-| sipStack | | SipStack | To use a custom SipStack
-
-| sipUri | | SipURI | To use a custom SipURI. If none configured then the SipUri fallback to use the options toUser toHost:toPort
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| toHeader | | ToHeader | A custom Header object containing message receiver settings. Must implement the type javax.sip.header.ToHeader
-
-| viaHeaders | | List | List of custom Header objects of the type javax.sip.header.ViaHeader. Each ViaHeader containing a proxy address for request forwarding. (Note this header is automatically updated by each proxy when the request arrives at its listener)
- 4+^s| logging
-| implementationDebugLogFile | | String | Name of client debug log file to use for logging
-
-| implementationServerLogFile | | String | Name of server log file to use for logging
-
-| implementationTraceLevel | 0 | String | Logging level for tracing
- 4+^s| proxy
-| maxForwards | | int | Number of maximum proxy forwards
-
-| useRouterForAllUris | false | boolean | This setting is used when requests are sent to the Presence Agent via a proxy.
+| Name | Description | Default | Type
+| **cacheConnections** (common) | Should connections be cached by the SipStack to reduce cost of connection creation. This is useful if the connection is used for long running conversations. | false | boolean
+| **contentSubType** (common) | Setting for contentSubType can be set to any valid MimeSubType. | plain | String
+| **contentType** (common) | Setting for contentType can be set to any valid MimeType. | text | String
+| **eventHeaderName** (common) | Setting for a String based event type. | | String
+| **eventId** (common) | Setting for a String based event Id. Mandatory setting unless a registry based FromHeader is specified | | String
+| **fromHost** (common) | Hostname of the message originator. Mandatory setting unless a registry based FromHeader is specified | | String
+| **fromPort** (common) | Port of the message originator. Mandatory setting unless a registry based FromHeader is specified | | int
+| **fromUser** (common) | Username of the message originator. Mandatory setting unless a registry based custom FromHeader is specified. | | String
+| **msgExpiration** (common) | The amount of time a message received at an endpoint is considered valid | 3600 | int
+| **receiveTimeoutMillis** (common) | Setting for specifying amount of time to wait for a Response and/or Acknowledgement can be received from another SIP stack | 10000 | long
+| **stackName** (common) | Name of the SIP Stack instance associated with an SIP Endpoint. | NAME_NOT_SET | String
+| **toHost** (common) | Hostname of the message receiver. Mandatory setting unless a registry based ToHeader is specified | | String
+| **toPort** (common) | Portname of the message receiver. Mandatory setting unless a registry based ToHeader is specified | | int
+| **toUser** (common) | Username of the message receiver. Mandatory setting unless a registry based custom ToHeader is specified. | | String
+| **transport** (common) | Setting for choice of transport protocol. Valid choices are tcp or udp. | tcp | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **consumer** (consumer) | This setting is used to determine whether the kind of header (FromHeaderToHeader etc) that needs to be created for this endpoint | false | boolean
+| **presenceAgent** (consumer) | This setting is used to distinguish between a Presence Agent & a consumer. This is due to the fact that the SIP Camel component ships with a basic Presence Agent (for testing purposes only). Consumers have to set this flag to true. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **addressFactory** (advanced) | To use a custom AddressFactory | | AddressFactory
+| **callIdHeader** (advanced) | A custom Header object containing call details. Must implement the type javax.sip.header.CallIdHeader | | CallIdHeader
+| **contactHeader** (advanced) | An optional custom Header object containing verbose contact details (email phone number etc). Must implement the type javax.sip.header.ContactHeader | | ContactHeader
+| **contentTypeHeader** (advanced) | A custom Header object containing message content details. Must implement the type javax.sip.header.ContentTypeHeader | | ContentTypeHeader
+| **eventHeader** (advanced) | A custom Header object containing event details. Must implement the type javax.sip.header.EventHeader | | EventHeader
+| **expiresHeader** (advanced) | A custom Header object containing message expiration details. Must implement the type javax.sip.header.ExpiresHeader | | ExpiresHeader
+| **extensionHeader** (advanced) | A custom Header object containing user/application specific details. Must implement the type javax.sip.header.ExtensionHeader | | ExtensionHeader
+| **fromHeader** (advanced) | A custom Header object containing message originator settings. Must implement the type javax.sip.header.FromHeader | | FromHeader
+| **headerFactory** (advanced) | To use a custom HeaderFactory | | HeaderFactory
+| **listeningPoint** (advanced) | To use a custom ListeningPoint implementation | | ListeningPoint
+| **maxForwardsHeader** (advanced) | A custom Header object containing details on maximum proxy forwards. This header places a limit on the viaHeaders possible. Must implement the type javax.sip.header.MaxForwardsHeader | | MaxForwardsHeader
+| **maxMessageSize** (advanced) | Setting for maximum allowed Message size in bytes. | 1048576 | int
+| **messageFactory** (advanced) | To use a custom MessageFactory | | MessageFactory
+| **sipFactory** (advanced) | To use a custom SipFactory to create the SipStack to be used | | SipFactory
+| **sipStack** (advanced) | To use a custom SipStack | | SipStack
+| **sipUri** (advanced) | To use a custom SipURI. If none configured then the SipUri fallback to use the options toUser toHost:toPort | | SipURI
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **toHeader** (advanced) | A custom Header object containing message receiver settings. Must implement the type javax.sip.header.ToHeader | | ToHeader
+| **viaHeaders** (advanced) | List of custom Header objects of the type javax.sip.header.ViaHeader. Each ViaHeader containing a proxy address for request forwarding. (Note this header is automatically updated by each proxy when the request arrives at its listener) | | List
+| **implementationDebugLogFile** (logging) | Name of client debug log file to use for logging | | String
+| **implementationServerLogFile** (logging) | Name of server log file to use for logging | | String
+| **implementationTraceLevel** (logging) | Logging level for tracing | 0 | String
+| **maxForwards** (proxy) | Number of maximum proxy forwards | | int
+| **useRouterForAllUris** (proxy) | This setting is used when requests are sent to the Presence Agent via a proxy. | false | boolean
|=======================================================================
// endpoint options: END
[20/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-freemarker/src/main/docs/freemarker-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-freemarker/src/main/docs/freemarker-component.adoc b/components/camel-freemarker/src/main/docs/freemarker-component.adoc
index cc69077..dd6025e 100644
--- a/components/camel-freemarker/src/main/docs/freemarker-component.adoc
+++ b/components/camel-freemarker/src/main/docs/freemarker-component.adoc
@@ -43,13 +43,11 @@ The Freemarker component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | Configuration | To use an existing freemarker.template.Configuration instance as the configuration.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use an existing freemarker.template.Configuration instance as the configuration. | | Configuration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -66,27 +64,22 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| resourceUri | | String | *Required* 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.
+| Name | Description | Default | Type
+| **resourceUri** | *Required* 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. | | String
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| configuration | | Configuration | Sets the Freemarker configuration to use
-
-| contentCache | false | boolean | Sets whether to use resource content cache or not
-
-| encoding | | String | Sets the encoding to be used for loading the template file.
-
-| templateUpdateDelay | | int | Number of seconds the loaded template resource will remain in the cache.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **configuration** (producer) | Sets the Freemarker configuration to use | | Configuration
+| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean
+| **encoding** (producer) | Sets the encoding to be used for loading the template file. | | String
+| **templateUpdateDelay** (producer) | Number of seconds the loaded template resource will remain in the cache. | | int
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ftp/src/main/docs/ftp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ftp/src/main/docs/ftp-component.adoc b/components/camel-ftp/src/main/docs/ftp-component.adoc
index 498acfb..23cc21a 100644
--- a/components/camel-ftp/src/main/docs/ftp-component.adoc
+++ b/components/camel-ftp/src/main/docs/ftp-component.adoc
@@ -87,223 +87,121 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* Hostname of the FTP server
-| port | | int | Port of the FTP server
-| directoryName | | String | The starting directory
+| Name | Description | Default | Type
+| **host** | *Required* Hostname of the FTP server | | String
+| **port** | Port of the FTP server | | int
+| **directoryName** | The starting directory | | String
|=======================================================================
#### Query Parameters (102 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| binary | false | boolean | Specifies the file transfer mode BINARY or ASCII. Default is ASCII (false).
-
-| charset | | String | 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.
-
-| disconnect | false | boolean | 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.
-
-| doneFileName | | String | 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.
-
-| fileName | | String | 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 s
tore CamelFileName and have to restore it afterwards.
-
-| passiveMode | false | boolean | Sets passive mode connections. Default is active mode connections.
-
-| separator | UNIX | PathSeparator | 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
- 4+^s| common (advanced)
-| fastExistsCheck | false | boolean | 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.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| delete | false | boolean | If true the file will be deleted after it is processed successfully.
-
-| moveFailed | | String | 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.
-
-| noop | false | boolean | 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.
-
-| preMove | | String | 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.
-
-| recursive | false | boolean | If a directory will look for files in all the sub-directories as well.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| streamDownload | false | boolean | 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.
- 4+^s| consumer (advanced)
-| directoryMustExist | false | boolean | Similar to startingDirectoryMustExist but this applies during polling recursive sub directories.
-
-| download | false | boolean | 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.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| ignoreFileNotFoundOrPermissionError | false | boolean | Whether to ignore when trying to download a file which does not exist or due to permission error. By default when a file does not exists or insufficient permission then an exception is thrown. Setting this option to true allows to ignore that instead.
-
-| inProgressRepository | | String> | 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.
-
-| localWorkDirectory | | String | 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.
-
-| onCompletionExceptionHandler | | ExceptionHandler | 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.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
-
-| processStrategy | | GenericFileProcessStrategy<T> | 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.
-
-| receiveBufferSize | 32768 | int | The receive (download) buffer size Used only by FTPClient
-
-| startingDirectoryMustExist | false | boolean | 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.
-
-| useList | true | boolean | 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.
- 4+^s| producer
-| fileExist | Override | GenericFileExist | 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 Camel 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.
-
-| flatten | false | boolean | 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.
-
-| moveExisting | | String | 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.
-
-| tempFileName | | String | 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.
-
-| tempPrefix | | String | 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.
- 4+^s| producer (advanced)
-| allowNullBody | false | boolean | 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.
-
-| chmod | | String | Allows you to set chmod on the stored file. For example chmod=640.
-
-| disconnectOnBatchComplete | false | boolean | 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.
-
-| eagerDeleteTargetFile | true | boolean | 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.
-
-| keepLastModified | false | boolean | 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.
-
-| sendNoop | true | boolean | 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.
- 4+^s| advanced
-| activePortRange | | String | 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.
-
-| autoCreate | true | boolean | 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.
-
-| bufferSize | 131072 | int | Write buffer sized in bytes.
-
-| connectTimeout | 10000 | int | Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH
-
-| ftpClient | | FTPClient | To use a custom instance of FTPClient
-
-| ftpClientConfig | | FTPClientConfig | To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use.
-
-| ftpClientConfigParameters | | Map | Used by FtpComponent to provide additional parameters for the FTPClientConfig
-
-| ftpClientParameters | | Map | Used by FtpComponent to provide additional parameters for the FTPClient
-
-| maximumReconnectAttempts | | int | Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior.
-
-| reconnectDelay | | long | Delay in millis Camel will wait before performing a reconnect attempt.
-
-| siteCommand | | String | Sets optional site command(s) to be executed after successful login. Multiple site commands can be separated using a new line character (\n).
-
-| soTimeout | 300000 | int | Sets the so timeout Used only by FTPClient
-
-| stepwise | true | boolean | 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.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| throwExceptionOnConnectFailed | false | boolean | 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.
-
-| timeout | 30000 | int | Sets the data timeout for waiting for reply Used only by FTPClient
- 4+^s| filter
-| antExclude | | String | 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.
-
-| antFilterCaseSensitive | true | boolean | Sets case sensitive flag on ant fiter
-
-| antInclude | | String | Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format.
-
-| eagerMaxMessagesPerPoll | true | boolean | 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.
-
-| exclude | | String | 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
-
-| filter | | GenericFileFilter<T> | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method.
-
-| filterDirectory | | String | 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
-
-| filterFile | | String | Filters the file based on Simple language. For example to filter on file size you can use $file:size 5000
-
-| idempotent | false | Boolean | 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.
-
-| idempotentKey | | String | 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
-
-| idempotentRepository | | String> | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true.
-
-| include | | String | 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
-
-| maxDepth | 2147483647 | int | The maximum depth to traverse when recursively processing a directory.
-
-| maxMessagesPerPoll | | int | 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.
-
-| minDepth | | int | 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.
-
-| move | | String | 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.
- 4+^s| lock
-| exclusiveReadLockStrategy | | GenericFileExclusiveReadLockStrategy<T> | Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation.
-
-| readLock | | String | 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 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 wher
e 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.
-
-| readLockCheckInterval | 1000 | long | 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.
-
-| readLockDeleteOrphanLockFiles | true | boolean | 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.
-
-| readLockLoggingLevel | WARN | LoggingLevel | Logging level used when a read lock could not be acquired. By default a WARN 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 rename.
-
-| readLockMarkerFile | true | boolean | 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.
-
-| readLockMinAge | 0 | long | This option applied only for readLock=change. This option 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.
-
-| readLockMinLength | 1 | long | This option applied only for readLock=changed. This option 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.
-
-| readLockRemoveOnCommit | false | boolean | This option applied only for readLock=idempotent. This option 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.
-
-| readLockRemoveOnRollback | true | boolean | This option applied only for readLock=idempotent. This option 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).
-
-| readLockTimeout | 10000 | long | 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.
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| sort
-| shuffle | false | boolean | To shuffle the list of files (sort in random order)
-
-| sortBy | | String | 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.
-
-| sorter | | GenericFile<T>> | Pluggable sorter as a java.util.Comparator class.
- 4+^s| security
-| account | | String | Account to use for login
-
-| password | | String | Password to use for login
-
-| username | | String | Username to use for login
+| Name | Description | Default | Type
+| **binary** (common) | Specifies the file transfer mode BINARY or ASCII. Default is ASCII (false). | false | boolean
+| **charset** (common) | 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. | | String
+| **disconnect** (common) | 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. | false | boolean
+| **doneFileName** (common) | 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. | | String
+| **fileName** (common) | 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. | | String
+| **passiveMode** (common) | Sets passive mode connections. Default is active mode connections. | false | boolean
+| **separator** (common) | 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 | UNIX | PathSeparator
+| **fastExistsCheck** (common) | 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. | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **delete** (consumer) | If true the file will be deleted after it is processed successfully. | false | boolean
+| **moveFailed** (consumer) | 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. | | String
+| **noop** (consumer) | 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. | false | boolean
+| **preMove** (consumer) | 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. | | String
+| **recursive** (consumer) | If a directory will look for files in all the sub-directories as well. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **streamDownload** (consumer) | 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. | false | boolean
+| **directoryMustExist** (consumer) | Similar to startingDirectoryMustExist but this applies during polling recursive sub directories. | false | boolean
+| **download** (consumer) | 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. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **ignoreFileNotFoundOr PermissionError** (consumer) | Whether to ignore when trying to download a file which does not exist or due to permission error. By default when a file does not exists or insufficient permission then an exception is thrown. Setting this option to true allows to ignore that instead. | false | boolean
+| **inProgressRepository** (consumer) | 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. | | String>
+| **localWorkDirectory** (consumer) | 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. | | String
+| **onCompletionException Handler** (consumer) | 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. | | ExceptionHandler
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **processStrategy** (consumer) | 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. | | GenericFileProcess Strategy<T>
+| **receiveBufferSize** (consumer) | The receive (download) buffer size Used only by FTPClient | 32768 | int
+| **startingDirectoryMustExist** (consumer) | 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. | false | boolean
+| **useList** (consumer) | 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. | true | boolean
+| **fileExist** (producer) | 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 Camel 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. | Override | Ge
nericFileExist
+| **flatten** (producer) | 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. | false | boolean
+| **moveExisting** (producer) | 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. | | String
+| **tempFileName** (producer) | 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. | | String
+| **tempPrefix** (producer) | 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. | | String
+| **allowNullBody** (producer) | 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. | false | boolean
+| **chmod** (producer) | Allows you to set chmod on the stored file. For example chmod=640. | | String
+| **disconnectOnBatchComplete** (producer) | 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. | false | boolean
+| **eagerDeleteTargetFile** (producer) | 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. | true | boolean
+| **keepLastModified** (producer) | 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. | false | boolean
+| **sendNoop** (producer) | 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. | true | boolean
+| **activePortRange** (advanced) | 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. | | String
+| **autoCreate** (advanced) | 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. | true | boolean
+| **bufferSize** (advanced) | Write buffer sized in bytes. | 131072 | int
+| **connectTimeout** (advanced) | Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH | 10000 | int
+| **ftpClient** (advanced) | To use a custom instance of FTPClient | | FTPClient
+| **ftpClientConfig** (advanced) | To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use. | | FTPClientConfig
+| **ftpClientConfigParameters** (advanced) | Used by FtpComponent to provide additional parameters for the FTPClientConfig | | Map
+| **ftpClientParameters** (advanced) | Used by FtpComponent to provide additional parameters for the FTPClient | | Map
+| **maximumReconnectAttempts** (advanced) | Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. | | int
+| **reconnectDelay** (advanced) | Delay in millis Camel will wait before performing a reconnect attempt. | | long
+| **siteCommand** (advanced) | Sets optional site command(s) to be executed after successful login. Multiple site commands can be separated using a new line character (\n). | | String
+| **soTimeout** (advanced) | Sets the so timeout Used only by FTPClient | 300000 | int
+| **stepwise** (advanced) | 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. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **throwExceptionOnConnect Failed** (advanced) | 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. | false | boolean
+| **timeout** (advanced) | Sets the data timeout for waiting for reply Used only by FTPClient | 30000 | int
+| **antExclude** (filter) | 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. | | String
+| **antFilterCaseSensitive** (filter) | Sets case sensitive flag on ant fiter | true | boolean
+| **antInclude** (filter) | Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format. | | String
+| **eagerMaxMessagesPerPoll** (filter) | 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. | true | boolean
+| **exclude** (filter) | 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 | | String
+| **filter** (filter) | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. | | GenericFileFilter<T>
+| **filterDirectory** (filter) | 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 | | String
+| **filterFile** (filter) | Filters the file based on Simple language. For example to filter on file size you can use $file:size 5000 | | String
+| **idempotent** (filter) | 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. | false | Boolean
+| **idempotentKey** (filter) | 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 | | String
+| **idempotentRepository** (filter) | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. | | String>
+| **include** (filter) | 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 | | String
+| **maxDepth** (filter) | The maximum depth to traverse when recursively processing a directory. | 2147483647 | int
+| **maxMessagesPerPoll** (filter) | 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. | | int
+| **minDepth** (filter) | 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. | | int
+| **move** (filter) | 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. | | String
+| **exclusiveReadLockStrategy** (lock) | Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation. | | GenericFileExclusive ReadLockStrategy<T>
+| **readLock** (lock) | 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 the FTP component. This approach should be avoided when accessing a r
emote 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. | | String
+| **readLockCheckInterval** (lock) | 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. | 1000 | long
+| **readLockDeleteOrphanLock Files** (lock) | 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. | true | boolean
+| **readLockLoggingLevel** (lock) | Logging level used when a read lock could not be acquired. By default a WARN 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 rename. | WARN | LoggingLevel
+| **readLockMarkerFile** (lock) | 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. | true | boolean
+| **readLockMinAge** (lock) | This option applied only for readLock=change. This option 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. | 0 | long
+| **readLockMinLength** (lock) | This option applied only for readLock=changed. This option 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. | 1 | long
+| **readLockRemoveOnCommit** (lock) | This option applied only for readLock=idempotent. This option 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. | false | boolean
+| **readLockRemoveOnRollback** (lock) | This option applied only for readLock=idempotent. This option 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). | true | boolean
+| **readLockTimeout** (lock) | 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. | 10000 | long
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **shuffle** (sort) | To shuffle the list of files (sort in random order) | false | boolean
+| **sortBy** (sort) | 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. | | String
+| **sorter** (sort) | Pluggable sorter as a java.util.Comparator class. | | GenericFile<T>>
+| **account** (security) | Account to use for login | | String
+| **password** (security) | Password to use for login | | String
+| **username** (security) | Username to use for login | | String
|=======================================================================
// endpoint options: END
[13/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jsch/src/main/docs/scp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jsch/src/main/docs/scp-component.adoc b/components/camel-jsch/src/main/docs/scp-component.adoc
index 24fc3df..44acfe3 100644
--- a/components/camel-jsch/src/main/docs/scp-component.adoc
+++ b/components/camel-jsch/src/main/docs/scp-component.adoc
@@ -45,13 +45,11 @@ The SCP component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| producer
-| verboseLogging | false | boolean | JSCH is verbose logging out of the box. Therefore we turn the logging down to DEBUG logging by default. But setting this option to true turns on the verbose logging again.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **verboseLogging** (producer) | JSCH is verbose logging out of the box. Therefore we turn the logging down to DEBUG logging by default. But setting this option to true turns on the verbose logging again. | false | boolean
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -72,57 +70,38 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* Hostname of the FTP server
-| port | | int | Port of the FTP server
-| directoryName | | String | The starting directory
+| Name | Description | Default | Type
+| **host** | *Required* Hostname of the FTP server | | String
+| **port** | Port of the FTP server | | int
+| **directoryName** | The starting directory | | String
|=======================================================================
#### Query Parameters (19 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| disconnect | false | boolean | 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.
- 4+^s| producer
-| chmod | 664 | String | Allows you to set chmod on the stored file. For example chmod=664.
-
-| fileName | | String | 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 s
tore CamelFileName and have to restore it afterwards.
-
-| flatten | false | boolean | 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.
-
-| strictHostKeyChecking | no | String | Sets whether to use strict host key checking. Possible values are: no yes
- 4+^s| producer (advanced)
-| allowNullBody | false | boolean | 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.
-
-| disconnectOnBatchComplete | false | boolean | 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.
- 4+^s| advanced
-| connectTimeout | 10000 | int | Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH
-
-| soTimeout | 300000 | int | Sets the so timeout Used only by FTPClient
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| timeout | 30000 | int | Sets the data timeout for waiting for reply Used only by FTPClient
- 4+^s| security
-| knownHostsFile | | String | Sets the known_hosts file so that the jsch endpoint can do host key verification.
-
-| password | | String | Password to use for login
-
-| preferredAuthentications | | String | Set a comma separated list of authentications that will be used in order of preference. Possible authentication methods are defined by JCraft JSCH. Some examples include: gssapi-with-micpublickeykeyboard-interactivepassword If not specified the JSCH and/or system defaults will be used.
-
-| privateKeyFile | | String | Set the private key file to that the SFTP endpoint can do private key verification.
-
-| privateKeyFilePassphrase | | String | Set the private key file passphrase to that the SFTP endpoint can do private key verification.
-
-| username | | String | Username to use for login
-
-| useUserKnownHostsFile | true | boolean | If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home) /.ssh/known_hosts
- 4+^s| security (advanced)
-| ciphers | | String | Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: aes128-ctraes128-cbc3des-ctr3des-cbcblowfish-cbcaes192-cbcaes256-cbc. If not specified the default list from JSCH will be used.
+| Name | Description | Default | Type
+| **disconnect** (common) | 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. | false | boolean
+| **chmod** (producer) | Allows you to set chmod on the stored file. For example chmod=664. | 664 | String
+| **fileName** (producer) | 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 temporar
y store CamelFileName and have to restore it afterwards. | | String
+| **flatten** (producer) | 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. | false | boolean
+| **strictHostKeyChecking** (producer) | Sets whether to use strict host key checking. Possible values are: no yes | no | String
+| **allowNullBody** (producer) | 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. | false | boolean
+| **disconnectOnBatchComplete** (producer) | 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. | false | boolean
+| **connectTimeout** (advanced) | Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH | 10000 | int
+| **soTimeout** (advanced) | Sets the so timeout Used only by FTPClient | 300000 | int
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **timeout** (advanced) | Sets the data timeout for waiting for reply Used only by FTPClient | 30000 | int
+| **knownHostsFile** (security) | Sets the known_hosts file so that the jsch endpoint can do host key verification. | | String
+| **password** (security) | Password to use for login | | String
+| **preferredAuthentications** (security) | Set a comma separated list of authentications that will be used in order of preference. Possible authentication methods are defined by JCraft JSCH. Some examples include: gssapi-with-micpublickeykeyboard-interactivepassword If not specified the JSCH and/or system defaults will be used. | | String
+| **privateKeyFile** (security) | Set the private key file to that the SFTP endpoint can do private key verification. | | String
+| **privateKeyFilePassphrase** (security) | Set the private key file passphrase to that the SFTP endpoint can do private key verification. | | String
+| **username** (security) | Username to use for login | | String
+| **useUserKnownHostsFile** (security) | If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home) /.ssh/known_hosts | true | boolean
+| **ciphers** (security) | Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: aes128-ctraes128-cbc3des-ctr3des-cbcblowfish-cbcaes192-cbcaes256-cbc. If not specified the default list from JSCH will be used. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jt400/src/main/docs/jt400-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jt400/src/main/docs/jt400-component.adoc b/components/camel-jt400/src/main/docs/jt400-component.adoc
index 260dd93..dde2f4d 100644
--- a/components/camel-jt400/src/main/docs/jt400-component.adoc
+++ b/components/camel-jt400/src/main/docs/jt400-component.adoc
@@ -42,13 +42,11 @@ The JT400 component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| connectionPool | | AS400ConnectionPool | Returns the default connection pool used by this component.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **connectionPool** (advanced) | Returns the default connection pool used by this component. | | AS400ConnectionPool
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -62,79 +60,50 @@ with the following path and query parameters:
#### Path Parameters (5 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| userID | | String | *Required* Returns the ID of the AS/400 user.
-| password | | String | *Required* Returns the password of the AS/400 user.
-| systemName | | String | *Required* Returns the name of the AS/400 system.
-| objectPath | | String | *Required* Returns the fully qualified integrated file system path name of the target object of this endpoint.
-| type | | Jt400Type | *Required* Whether to work with data queues or remote program call
+| Name | Description | Default | Type
+| **userID** | *Required* Returns the ID of the AS/400 user. | | String
+| **password** | *Required* Returns the password of the AS/400 user. | | String
+| **systemName** | *Required* Returns the name of the AS/400 system. | | String
+| **objectPath** | *Required* Returns the fully qualified integrated file system path name of the target object of this endpoint. | | String
+| **type** | *Required* Whether to work with data queues or remote program call | | Jt400Type
|=======================================================================
#### Query Parameters (29 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| ccsid | | int | Sets the CCSID to use for the connection with the AS/400 system.
-
-| format | text | Format | Sets the data format for sending messages.
-
-| guiAvailable | false | boolean | Sets whether AS/400 prompting is enabled in the environment running Camel.
-
-| keyed | false | boolean | Whether to use keyed or non-keyed data queues.
-
-| outputFieldsIdxArray | | Integer[] | Specifies which fields (program parameters) are output parameters.
-
-| outputFieldsLengthArray | | Integer[] | Specifies the fields (program parameters) length as in the AS/400 program definition.
-
-| searchKey | | String | Search key for keyed data queues.
-
-| searchType | EQ | SearchType | Search type such as EQ for equal etc.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| readTimeout | 30000 | int | Timeout in millis the consumer will wait while trying to read a new message of the data queue.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| security
-| secured | false | boolean | Whether connections to AS/400 are secured with SSL.
+| Name | Description | Default | Type
+| **ccsid** (common) | Sets the CCSID to use for the connection with the AS/400 system. | | int
+| **format** (common) | Sets the data format for sending messages. | text | Format
+| **guiAvailable** (common) | Sets whether AS/400 prompting is enabled in the environment running Camel. | false | boolean
+| **keyed** (common) | Whether to use keyed or non-keyed data queues. | false | boolean
+| **outputFieldsIdxArray** (common) | Specifies which fields (program parameters) are output parameters. | | Integer[]
+| **outputFieldsLengthArray** (common) | Specifies the fields (program parameters) length as in the AS/400 program definition. | | Integer[]
+| **searchKey** (common) | Search key for keyed data queues. | | String
+| **searchType** (common) | Search type such as EQ for equal etc. | EQ | SearchType
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **readTimeout** (consumer) | Timeout in millis the consumer will wait while trying to read a new message of the data queue. | 30000 | int
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **secured** (security) | Whether connections to AS/400 are secured with SSL. | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-kafka/src/main/docs/kafka-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-kafka/src/main/docs/kafka-component.adoc b/components/camel-kafka/src/main/docs/kafka-component.adoc
index 78c9a59..dcfe7c8 100644
--- a/components/camel-kafka/src/main/docs/kafka-component.adoc
+++ b/components/camel-kafka/src/main/docs/kafka-component.adoc
@@ -38,17 +38,13 @@ The Kafka component supports 4 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| configuration | | KafkaConfiguration | Allows to pre-configure the Kafka component with common options that the endpoints will reuse.
-
-| brokers | | String | URL of the Kafka brokers to use. The format is host1:port1host2: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.
- 4+^s| advanced
-| workerPool | | ExecutorService | To use a shared 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. If using this option then you must handle the lifecycle of the thread pool to shut the pool down when no longer needed.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (common) | Allows to pre-configure the Kafka component with common options that the endpoints will reuse. | | KafkaConfiguration
+| **brokers** (common) | URL of the Kafka brokers to use. The format is host1:port1host2: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. | | String
+| **workerPool** (advanced) | To use a shared 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. If using this option then you must handle the lifecycle of the thread pool to shut the pool down when no longer needed. | | ExecutorService
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -63,181 +59,99 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| topic | | String | *Required* 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.
+| Name | Description | Default | Type
+| **topic** | *Required* 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. | | String
|=======================================================================
#### Query Parameters (82 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| brokers | | String | URL of the Kafka brokers to use. The format is host1:port1host2: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.
-
-| clientId | | String | 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.
- 4+^s| consumer
-| autoCommitEnable | true | Boolean | 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.
-
-| autoCommitIntervalMs | 5000 | Integer | The frequency in ms that the consumer offsets are committed to zookeeper.
-
-| autoCommitOnStop | sync | String | 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.
-
-| autoOffsetReset | latest | String | What to do when there is no initial offset in ZooKeeper or if an offset is out of range: smallest : automatically reset the offset to the smallest offset largest : automatically reset the offset to the largest offset fail: throw exception to the consumer
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| checkCrcs | true | Boolean | 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.
-
-| consumerRequestTimeoutMs | 40000 | Integer | 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.
-
-| consumersCount | 1 | int | The number of consumers that connect to kafka server
-
-| consumerStreams | 10 | int | Number of concurrent consumers on the consumer
-
-| fetchMaxBytes | 52428800 | Integer | 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.
-
-| fetchMinBytes | 1 | Integer | 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.
-
-| fetchWaitMaxMs | 500 | Integer | 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
-
-| groupId | | String | 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.
-
-| heartbeatIntervalMs | 3000 | Integer | 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.
-
-| keyDeserializer | org.apache.kafka.common.serialization.StringDeserializer | String | Deserializer class for key that implements the Deserializer interface.
-
-| maxPartitionFetchBytes | 1048576 | Integer | 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.
-
-| maxPollRecords | 500 | Integer | The maximum number of records returned in a single call to poll()
-
-| offsetRepository | | String> | The offset repository to use in order to locally store the offset of each partition of the topic. Defining one will disable the autocommit.
-
-| partitionAssignor | org.apache.kafka.clients.consumer.RangeAssignor | String | 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
-
-| pollTimeoutMs | 5000 | Long | The timeout used when polling the KafkaConsumer.
-
-| seekTo | | String | 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
-
-| sessionTimeoutMs | 10000 | Integer | The timeout used to detect failures when using Kafka's group management facilities.
-
-| valueDeserializer | org.apache.kafka.common.serialization.StringDeserializer | String | Deserializer class for value that implements the Deserializer interface.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| bridgeEndpoint | false | boolean | If the option is true then KafkaProducer will ignore the KafkaConstants.TOPIC header setting of the inbound message.
-
-| bufferMemorySize | 33554432 | Integer | 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.
-
-| compressionCodec | none | String | This parameter allows you to specify the compression codec for all data generated by this producer. Valid values are none gzip and snappy.
-
-| connectionMaxIdleMs | 540000 | Integer | Close idle connections after the number of milliseconds specified by this config.
-
-| key | | String | The record key (or null if no key is specified). If this option has been configured then it take precedence over header link KafkaConstantsKEY
-
-| keySerializerClass | org.apache.kafka.common.serialization.StringSerializer | String | The serializer class for keys (defaults to the same as for messages if nothing is given).
-
-| lingerMs | 0 | Integer | 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 se
tting 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.
-
-| maxBlockMs | 60000 | Integer | 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
-
-| maxInFlightRequest | 5 | Integer | 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).
-
-| maxRequestSize | 1048576 | Integer | 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.
-
-| metadataMaxAgeMs | 300000 | Integer | 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.
-
-| metricReporters | | String | 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.
-
-| metricsSampleWindowMs | 30000 | Integer | The number of samples maintained to compute metrics.
-
-| noOfMetricsSample | 2 | Integer | The number of samples maintained to compute metrics.
-
-| partitioner | org.apache.kafka.clients.producer.internals.DefaultPartitioner | String | The partitioner class for partitioning messages amongst sub-topics. The default partitioner is based on the hash of the key.
-
-| partitionKey | | Integer | 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 link KafkaConstantsPARTITION_KEY
-
-| producerBatchSize | 16384 | Integer | 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.
-
-| queueBufferingMaxMessages | 10000 | Integer | 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.
-
-| receiveBufferBytes | 65536 | Integer | The size of the TCP receive buffer (SO_RCVBUF) to use when reading data.
-
-| reconnectBackoffMs | 50 | Integer | 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.
-
-| recordMetadata | true | boolean | 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 link KafkaConstantsKAFKA_RECORDMETA
-
-| requestRequiredAcks | 1 | String | 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.
-
-| requestTimeoutMs | 305000 | Integer | The amount of time the broker will wait trying to meet the request.required.acks requirement before sending back an error to the client.
-
-| retries | 0 | Integer | 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.
-
-| retryBackoffMs | 100 | Integer | 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.
-
-| sendBufferBytes | 131072 | Integer | Socket write buffer size
-
-| serializerClass | org.apache.kafka.common.serialization.StringSerializer | String | The serializer class for messages.
-
-| workerPool | | ExecutorService | 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.
-
-| workerPoolCoreSize | 10 | Integer | 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.
-
-| workerPoolMaxSize | 20 | Integer | 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.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| monitoring
-| interceptorClasses | | String | 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
- 4+^s| security
-| kerberosBeforeReloginMinTime | 60000 | Integer | Login thread sleep time between refresh attempts.
-
-| kerberosInitCmd | /usr/bin/kinit | String | Kerberos kinit command path. Default is /usr/bin/kinit
-
-| kerberosPrincipalToLocalRules | DEFAULT | String | 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/hostnameREALM are mapped to username. For more details on the format please see security authorization and acls. Multiple values can be separated by comma
-
-| kerberosRenewJitter | 0.05 | Double | Percentage of random jitter added to the renewal time.
-
-| kerberosRenewWindowFactor | 0.8 | Double | 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.
-
-| saslKerberosServiceName | | String | The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config.
-
-| saslMechanism | GSSAPI | String | The Simple Authentication and Security Layer (SASL) Mechanism used. For the valid values see http://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml
-
-| securityProtocol | PLAINTEXT | String | Protocol used to communicate with brokers. Currently only PLAINTEXT and SSL are supported.
-
-| sslCipherSuites | | String | 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.
-
-| sslContextParameters | | SSLContextParameters | SSL configuration using a Camel SSLContextParameters object. If configured it's applied before the other SSL endpoint parameters.
-
-| sslEnabledProtocols | TLSv1.2,TLSv1.1,TLSv1 | String | The list of protocols enabled for SSL connections. TLSv1.2 TLSv1.1 and TLSv1 are enabled by default.
-
-| sslEndpointAlgorithm | | String | The endpoint identification algorithm to validate server hostname using server certificate.
-
-| sslKeymanagerAlgorithm | SunX509 | String | The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine.
-
-| sslKeyPassword | | String | The password of the private key in the key store file. This is optional for client.
-
-| sslKeystoreLocation | | String | The location of the key store file. This is optional for client and can be used for two-way authentication for client.
-
-| sslKeystorePassword | | String | The store password for the key store file.This is optional for client and only needed if ssl.keystore.location is configured.
-
-| sslKeystoreType | JKS | String | The file format of the key store file. This is optional for client. Default value is JKS
-
-| sslProtocol | TLS | String | 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.
-
-| sslProvider | | String | The name of the security provider used for SSL connections. Default value is the default security provider of the JVM.
-
-| sslTrustmanagerAlgorithm | PKIX | String | The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine.
-
-| sslTruststoreLocation | | String | The location of the trust store file.
-
-| sslTruststorePassword | | String | The password for the trust store file.
-
-| sslTruststoreType | JKS | String | The file format of the trust store file. Default value is JKS.
+| Name | Description | Default | Type
+| **brokers** (common) | URL of the Kafka brokers to use. The format is host1:port1host2: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. | | String
+| **clientId** (common) | 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. | | String
+| **autoCommitEnable** (consumer) | 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. | true | Boolean
+| **autoCommitIntervalMs** (consumer) | The frequency in ms that the consumer offsets are committed to zookeeper. | 5000 | Integer
+| **autoCommitOnStop** (consumer) | 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. | sync | String
+| **autoOffsetReset** (consumer) | What to do when there is no initial offset in ZooKeeper or if an offset is out of range: smallest : automatically reset the offset to the smallest offset largest : automatically reset the offset to the largest offset fail: throw exception to the consumer | latest | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **checkCrcs** (consumer) | 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. | true | Boolean
+| **consumerRequestTimeoutMs** (consumer) | 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. | 40000 | Integer
+| **consumersCount** (consumer) | The number of consumers that connect to kafka server | 1 | int
+| **consumerStreams** (consumer) | Number of concurrent consumers on the consumer | 10 | int
+| **fetchMaxBytes** (consumer) | 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. | 52428800 | Integer
+| **fetchMinBytes** (consumer) | 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. | 1 | Integer
+| **fetchWaitMaxMs** (consumer) | 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 | 500 | Integer
+| **groupId** (consumer) | 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. | | String
+| **heartbeatIntervalMs** (consumer) | 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. | 3000 | Integer
+| **keyDeserializer** (consumer) | Deserializer class for key that implements the Deserializer interface. | org.apache.kafka.common.serialization.StringDeserializer | String
+| **maxPartitionFetchBytes** (consumer) | 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. | 1048576 | Integer
+| **maxPollRecords** (consumer) | The maximum number of records returned in a single call to poll() | 500 | Integer
+| **offsetRepository** (consumer) | The offset repository to use in order to locally store the offset of each partition of the topic. Defining one will disable the autocommit. | | String>
+| **partitionAssignor** (consumer) | 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 | org.apache.kafka.clients.consumer.RangeAssignor | String
+| **pollTimeoutMs** (consumer) | The timeout used when polling the KafkaConsumer. | 5000 | Long
+| **seekTo** (consumer) | 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 | | String
+| **sessionTimeoutMs** (consumer) | The timeout used to detect failures when using Kafka's group management facilities. | 10000 | Integer
+| **valueDeserializer** (consumer) | Deserializer class for value that implements the Deserializer interface. | org.apache.kafka.common.serialization.StringDeserializer | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **bridgeEndpoint** (producer) | If the option is true then KafkaProducer will ignore the KafkaConstants.TOPIC header setting of the inbound message. | false | boolean
+| **bufferMemorySize** (producer) | 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. | 33554432 | Integer
+| **compressionCodec** (producer) | This parameter allows you to specify the compression codec for all data generated by this producer. Valid values are none gzip and snappy. | none | String
+| **connectionMaxIdleMs** (producer) | Close idle connections after the number of milliseconds specified by this config. | 540000 | Integer
+| **key** (producer) | The record key (or null if no key is specified). If this option has been configured then it take precedence over header link KafkaConstantsKEY | | String
+| **keySerializerClass** (producer) | The serializer class for keys (defaults to the same as for messages if nothing is given). | org.apache.kafka.common.serialization.StringSerializer | String
+| **lingerMs** (producer) | 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 s
etting 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. | 0 | Integer
+| **maxBlockMs** (producer) | 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 | 60000 | Integer
+| **maxInFlightRequest** (producer) | 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). | 5 | Integer
+| **maxRequestSize** (producer) | 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. | 1048576 | Integer
+| **metadataMaxAgeMs** (producer) | 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. | 300000 | Integer
+| **metricReporters** (producer) | 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. | | String
+| **metricsSampleWindowMs** (producer) | The number of samples maintained to compute metrics. | 30000 | Integer
+| **noOfMetricsSample** (producer) | The number of samples maintained to compute metrics. | 2 | Integer
+| **partitioner** (producer) | The partitioner class for partitioning messages amongst sub-topics. The default partitioner is based on the hash of the key. | org.apache.kafka.clients.producer.internals.DefaultPartitioner | String
+| **partitionKey** (producer) | 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 link KafkaConstantsPARTITION_KEY | | Integer
+| **producerBatchSize** (producer) | 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. | 16384 | Integer
+| **queueBufferingMaxMessages** (producer) | 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. | 10000 | Integer
+| **receiveBufferBytes** (producer) | The size of the TCP receive buffer (SO_RCVBUF) to use when reading data. | 65536 | Integer
+| **reconnectBackoffMs** (producer) | 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. | 50 | Integer
+| **recordMetadata** (producer) | 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 link KafkaConstantsKAFKA_RECORDMETA | true | boolean
+| **requestRequiredAcks** (producer) | 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 th
e 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. | 1 | String
+| **requestTimeoutMs** (producer) | The amount of time the broker will wait trying to meet the request.required.acks requirement before sending back an error to the client. | 305000 | Integer
+| **retries** (producer) | 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. | 0 | Integer
+| **retryBackoffMs** (producer) | 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. | 100 | Integer
+| **sendBufferBytes** (producer) | Socket write buffer size | 131072 | Integer
+| **serializerClass** (producer) | The serializer class for messages. | org.apache.kafka.common.serialization.StringSerializer | String
+| **workerPool** (producer) | 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. | | ExecutorService
+| **workerPoolCoreSize** (producer) | 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. | 10 | Integer
+| **workerPoolMaxSize** (producer) | 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. | 20 | Integer
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **interceptorClasses** (monitoring) | 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 | | String
+| **kerberosBeforeReloginMin Time** (security) | Login thread sleep time between refresh attempts. | 60000 | Integer
+| **kerberosInitCmd** (security) | Kerberos kinit command path. Default is /usr/bin/kinit | /usr/bin/kinit | String
+| **kerberosPrincipalToLocal Rules** (security) | 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/hostnameREALM are mapped to username. For more details on the format please see security authorization and acls. Multiple values can be separated by comma | DEFAULT | String
+| **kerberosRenewJitter** (security) | Percentage of random jitter added to the renewal time. | 0.05 | Double
+| **kerberosRenewWindowFactor** (security) | 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. | 0.8 | Double
+| **saslKerberosServiceName** (security) | The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config. | | String
+| **saslMechanism** (security) | The Simple Authentication and Security Layer (SASL) Mechanism used. For the valid values see http://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml | GSSAPI | String
+| **securityProtocol** (security) | Protocol used to communicate with brokers. Currently only PLAINTEXT and SSL are supported. | PLAINTEXT | String
+| **sslCipherSuites** (security) | 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. | | String
+| **sslContextParameters** (security) | SSL configuration using a Camel SSLContextParameters object. If configured it's applied before the other SSL endpoint parameters. | | SSLContextParameters
+| **sslEnabledProtocols** (security) | The list of protocols enabled for SSL connections. TLSv1.2 TLSv1.1 and TLSv1 are enabled by default. | TLSv1.2,TLSv1.1,TLSv1 | String
+| **sslEndpointAlgorithm** (security) | The endpoint identification algorithm to validate server hostname using server certificate. | | String
+| **sslKeymanagerAlgorithm** (security) | The algorithm used by key manager factory for SSL connections. Default value is the key manager factory algorithm configured for the Java Virtual Machine. | SunX509 | String
+| **sslKeyPassword** (security) | The password of the private key in the key store file. This is optional for client. | | String
+| **sslKeystoreLocation** (security) | The location of the key store file. This is optional for client and can be used for two-way authentication for client. | | String
+| **sslKeystorePassword** (security) | The store password for the key store file.This is optional for client and only needed if ssl.keystore.location is configured. | | String
+| **sslKeystoreType** (security) | The file format of the key store file. This is optional for client. Default value is JKS | JKS | String
+| **sslProtocol** (security) | 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. | TLS | String
+| **sslProvider** (security) | The name of the security provider used for SSL connections. Default value is the default security provider of the JVM. | | String
+| **sslTrustmanagerAlgorithm** (security) | The algorithm used by trust manager factory for SSL connections. Default value is the trust manager factory algorithm configured for the Java Virtual Machine. | PKIX | String
+| **sslTruststoreLocation** (security) | The location of the trust store file. | | String
+| **sslTruststorePassword** (security) | The password for the trust store file. | | String
+| **sslTruststoreType** (security) | The file format of the trust store file. Default value is JKS. | JKS | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-kestrel/src/main/docs/kestrel-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-kestrel/src/main/docs/kestrel-component.adoc b/components/camel-kestrel/src/main/docs/kestrel-component.adoc
index 0c5fa9a..cbcfa7e 100644
--- a/components/camel-kestrel/src/main/docs/kestrel-component.adoc
+++ b/components/camel-kestrel/src/main/docs/kestrel-component.adoc
@@ -70,13 +70,11 @@ The Kestrel component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | KestrelConfiguration | To use a shared configured configuration as base for creating new endpoints.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use a shared configured configuration as base for creating new endpoints. | | KestrelConfiguration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -95,30 +93,24 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| addresses | localhost:22133 | String[] | The address(es) on which kestrel is running
-| queue | | String | *Required* The queue we are polling
+| Name | Description | Default | Type
+| **addresses** | The address(es) on which kestrel is running | localhost:22133 | String[]
+| **queue** | *Required* The queue we are polling | | String
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| concurrentConsumers | 1 | int | How many concurrent listeners to schedule for the thread pool
-
-| waitTimeMs | 100 | int | How long a given wait should block (server side) in milliseconds
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **concurrentConsumers** (common) | How many concurrent listeners to schedule for the thread pool | 1 | int
+| **waitTimeMs** (common) | How long a given wait should block (server side) in milliseconds | 100 | int
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-krati/src/main/docs/krati-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-krati/src/main/docs/krati-component.adoc b/components/camel-krati/src/main/docs/krati-component.adoc
index 3f544f3..f02c210 100644
--- a/components/camel-krati/src/main/docs/krati-component.adoc
+++ b/components/camel-krati/src/main/docs/krati-component.adoc
@@ -59,75 +59,46 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| path | | String | *Required* Path of the datastore is the relative path of the folder that krati will use for its datastore.
+| Name | Description | Default | Type
+| **path** | *Required* Path of the datastore is the relative path of the folder that krati will use for its datastore. | | String
|=======================================================================
#### Query Parameters (29 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| hashFunction | | HashFunction<byte[]> | The hash function to use.
-
-| initialCapacity | 100 | int | The inital capcity of the store.
-
-| keySerializer | | Object> | The serializer that will be used to serialize the key.
-
-| segmentFactory | | SegmentFactory | Sets the segment factory of the target store.
-
-| segmentFileSize | 64 | int | Data store segments size in MB.
-
-| valueSerializer | | Object> | The serializer that will be used to serialize the value.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| maxMessagesPerPoll | | int | The maximum number of messages which can be received in one poll. This can be used to avoid reading in too much data and taking up too much memory.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| producer
-| key | | String | The key.
-
-| operation | | String | Specifies the type of operation that will be performed to the datastore.
-
-| value | | String | The Value.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **hashFunction** (common) | The hash function to use. | | HashFunction<byte[]>
+| **initialCapacity** (common) | The inital capcity of the store. | 100 | int
+| **keySerializer** (common) | The serializer that will be used to serialize the key. | | Object>
+| **segmentFactory** (common) | Sets the segment factory of the target store. | | SegmentFactory
+| **segmentFileSize** (common) | Data store segments size in MB. | 64 | int
+| **valueSerializer** (common) | The serializer that will be used to serialize the value. | | Object>
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **maxMessagesPerPoll** (consumer) | The maximum number of messages which can be received in one poll. This can be used to avoid reading in too much data and taking up too much memory. | | int
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **key** (producer) | The key. | | String
+| **operation** (producer) | Specifies the type of operation that will be performed to the datastore. | | String
+| **value** (producer) | The Value. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
[12/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc
index 000b188..29fe8ae 100644
--- a/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc
+++ b/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc
@@ -51,71 +51,44 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| masterUrl | | String | *Required* Kubernetes Master url
+| Name | Description | Default | Type
+| **masterUrl** | *Required* Kubernetes Master url | | String
|=======================================================================
#### Query Parameters (27 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| apiVersion | | String | The Kubernetes API Version to use
-
-| category | | String | *Required* Kubernetes Producer and Consumer category
-
-| dnsDomain | | String | The dns domain used for ServiceCall EIP
-
-| kubernetesClient | | DefaultKubernetesClient | Default KubernetesClient to use if provided
-
-| portName | | String | The port name used for ServiceCall EIP
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| labelKey | | String | The Consumer Label key when watching at some resources
-
-| labelValue | | String | The Consumer Label value when watching at some resources
-
-| namespace | | String | The namespace
-
-| poolSize | 1 | int | The Consumer pool size
-
-| resourceName | | String | The Consumer Resource Name we would like to watch
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| operation | | String | Producer operation to do on Kubernetes
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| caCertData | | String | The CA Cert Data
-
-| caCertFile | | String | The CA Cert File
-
-| clientCertData | | String | The Client Cert Data
-
-| clientCertFile | | String | The Client Cert File
-
-| clientKeyAlgo | | String | The Key Algorithm used by the client
-
-| clientKeyData | | String | The Client Key data
-
-| clientKeyFile | | String | The Client Key file
-
-| clientKeyPassphrase | | String | The Client Key Passphrase
-
-| oauthToken | | String | The Auth Token
-
-| password | | String | Password to connect to Kubernetes
-
-| trustCerts | | Boolean | Define if the certs we used are trusted anyway or not
-
-| username | | String | Username to connect to Kubernetes
+| Name | Description | Default | Type
+| **apiVersion** (common) | The Kubernetes API Version to use | | String
+| **category** (common) | *Required* Kubernetes Producer and Consumer category | | String
+| **dnsDomain** (common) | The dns domain used for ServiceCall EIP | | String
+| **kubernetesClient** (common) | Default KubernetesClient to use if provided | | DefaultKubernetesClient
+| **portName** (common) | The port name used for ServiceCall EIP | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **labelKey** (consumer) | The Consumer Label key when watching at some resources | | String
+| **labelValue** (consumer) | The Consumer Label value when watching at some resources | | String
+| **namespace** (consumer) | The namespace | | String
+| **poolSize** (consumer) | The Consumer pool size | 1 | int
+| **resourceName** (consumer) | The Consumer Resource Name we would like to watch | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **operation** (producer) | Producer operation to do on Kubernetes | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **caCertData** (security) | The CA Cert Data | | String
+| **caCertFile** (security) | The CA Cert File | | String
+| **clientCertData** (security) | The Client Cert Data | | String
+| **clientCertFile** (security) | The Client Cert File | | String
+| **clientKeyAlgo** (security) | The Key Algorithm used by the client | | String
+| **clientKeyData** (security) | The Client Key data | | String
+| **clientKeyFile** (security) | The Client Key file | | String
+| **clientKeyPassphrase** (security) | The Client Key Passphrase | | String
+| **oauthToken** (security) | The Auth Token | | String
+| **password** (security) | Password to connect to Kubernetes | | String
+| **trustCerts** (security) | Define if the certs we used are trusted anyway or not | | Boolean
+| **username** (security) | Username to connect to Kubernetes | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ldap/src/main/docs/ldap-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ldap/src/main/docs/ldap-component.adoc b/components/camel-ldap/src/main/docs/ldap-component.adoc
index 906922e..ec7f452 100644
--- a/components/camel-ldap/src/main/docs/ldap-component.adoc
+++ b/components/camel-ldap/src/main/docs/ldap-component.adoc
@@ -55,27 +55,22 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| dirContextName | | String | *Required* Name of javax.naming.directory.DirContext bean to lookup in the registry.
+| Name | Description | Default | Type
+| **dirContextName** | *Required* Name of javax.naming.directory.DirContext bean to lookup in the registry. | | String
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| base | ou=system | String | The base DN for searches.
-
-| pageSize | | Integer | 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)
-
-| returnedAttributes | | String | Comma-separated list of attributes that should be set in each entry of the result
-
-| scope | subtree | String | Specifies how deeply to search the tree of entries starting at the base DN.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **base** (producer) | The base DN for searches. | ou=system | String
+| **pageSize** (producer) | 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) | | Integer
+| **returnedAttributes** (producer) | Comma-separated list of attributes that should be set in each entry of the result | | String
+| **scope** (producer) | Specifies how deeply to search the tree of entries starting at the base DN. | subtree | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc
index ff8ac86..0ea6e9b 100644
--- a/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc
+++ b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc
@@ -56,13 +56,11 @@ The Linkedin component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| configuration | | LinkedInConfiguration | To use the shared configuration
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (common) | To use the shared configuration | | LinkedInConfiguration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -79,46 +77,32 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| apiName | | LinkedInApiName | *Required* What kind of operation to perform
-| methodName | | String | *Required* What sub operation to use for the selected operation
+| Name | Description | Default | Type
+| **apiName** | *Required* What kind of operation to perform | | LinkedInApiName
+| **methodName** | *Required* What sub operation to use for the selected operation | | String
|=======================================================================
#### Query Parameters (14 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
-|=======================================================================
-| Name | Default | Java Type | Description
-
-| clientId | | String | LinkedIn application client ID
-
-| clientSecret | | String | LinkedIn application client secret
-
-| httpParams | | Map | Custom HTTP params for example proxy host and port use constants from AllClientPNames
-
-| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body
-
-| lazyAuth | true | boolean | Flag to enable/disable lazy OAuth default is true. when enabled OAuth token retrieval or generation is not done until the first REST call
-
-| redirectUri | | String | Application redirect URI although the component never redirects to this page to avoid having to have a functioning redirect server. So for testing one could use https://localhost
-
-| scopes | | OAuthScope[] | List of LinkedIn scopes as specified at https://developer.linkedin.com/documents/authenticationgranting
-
-| secureStorage | | OAuthSecureStorage | 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
-
-| userName | | String | LinkedIn user account name MUST be provided
-
-| userPassword | | String | LinkedIn account password
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+[width="100%",cols="2,5,^1,2",options="header"]
+|=======================================================================
+| Name | Description | Default | Type
+| **clientId** (common) | LinkedIn application client ID | | String
+| **clientSecret** (common) | LinkedIn application client secret | | String
+| **httpParams** (common) | Custom HTTP params for example proxy host and port use constants from AllClientPNames | | Map
+| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String
+| **lazyAuth** (common) | Flag to enable/disable lazy OAuth default is true. when enabled OAuth token retrieval or generation is not done until the first REST call | true | boolean
+| **redirectUri** (common) | Application redirect URI although the component never redirects to this page to avoid having to have a functioning redirect server. So for testing one could use https://localhost | | String
+| **scopes** (common) | List of LinkedIn scopes as specified at https://developer.linkedin.com/documents/authenticationgranting | | OAuthScope[]
+| **secureStorage** (common) | 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 | | OAuthSecureStorage
+| **userName** (common) | LinkedIn user account name MUST be provided | | String
+| **userPassword** (common) | LinkedIn account password | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-lucene/src/main/docs/lucene-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-lucene/src/main/docs/lucene-component.adoc b/components/camel-lucene/src/main/docs/lucene-component.adoc
index 96b7f67..0314fea 100644
--- a/components/camel-lucene/src/main/docs/lucene-component.adoc
+++ b/components/camel-lucene/src/main/docs/lucene-component.adoc
@@ -55,13 +55,11 @@ The Lucene component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| config | | LuceneConfiguration | To use a shared lucene configuration
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **config** (advanced) | To use a shared lucene configuration | | LuceneConfiguration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -80,28 +78,23 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* The URL to the lucene server
-| operation | | LuceneOperation | *Required* Operation to do such as insert or query.
+| Name | Description | Default | Type
+| **host** | *Required* The URL to the lucene server | | String
+| **operation** | *Required* Operation to do such as insert or query. | | LuceneOperation
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| analyzer | | Analyzer | An Analyzer builds TokenStreams which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box
-
-| indexDir | | File | A file system directory in which index files are created upon analysis of the document by the specified analyzer
-
-| maxHits | | int | An integer value that limits the result set of the search operation
-
-| srcDir | | File | An optional directory containing files to be used to be analyzed and added to the index at producer startup.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **analyzer** (producer) | An Analyzer builds TokenStreams which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box | | Analyzer
+| **indexDir** (producer) | A file system directory in which index files are created upon analysis of the document by the specified analyzer | | File
+| **maxHits** (producer) | An integer value that limits the result set of the search operation | | int
+| **srcDir** (producer) | An optional directory containing files to be used to be analyzed and added to the index at producer startup. | | File
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
index 6892427..4336d86 100644
--- a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
+++ b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
@@ -41,13 +41,11 @@ The Lumberjack component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| security
-| sslContextParameters | | SSLContextParameters | Sets the default SSL configuration to use for all the endpoints. You can also configure it directly at the endpoint level.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **sslContextParameters** (security) | Sets the default SSL configuration to use for all the endpoints. You can also configure it directly at the endpoint level. | | SSLContextParameters
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -66,28 +64,23 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* Network interface on which to listen for Lumberjack
-| port | 5044 | int | Network port on which to listen for Lumberjack
+| Name | Description | Default | Type
+| **host** | *Required* Network interface on which to listen for Lumberjack | | String
+| **port** | Network port on which to listen for Lumberjack | 5044 | int
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| sslContextParameters | | SSLContextParameters | SSL configuration
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **sslContextParameters** (consumer) | SSL configuration | | SSLContextParameters
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-mail/src/main/docs/mail-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mail/src/main/docs/mail-component.adoc b/components/camel-mail/src/main/docs/mail-component.adoc
index a26ef61..5a23607 100644
--- a/components/camel-mail/src/main/docs/mail-component.adoc
+++ b/components/camel-mail/src/main/docs/mail-component.adoc
@@ -81,15 +81,12 @@ The Mail component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | MailConfiguration | Sets the Mail configuration
-
-| contentTypeResolver | | ContentTypeResolver | Resolver to determine Content-Type for file attachments.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | Sets the Mail configuration | | MailConfiguration
+| **contentTypeResolver** (advanced) | Resolver to determine Content-Type for file attachments. | | ContentTypeResolver
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -107,140 +104,79 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* The mail server host name
-| port | | int | The port number of the mail server
+| Name | Description | Default | Type
+| **host** | *Required* The mail server host name | | String
+| **port** | The port number of the mail server | | int
|=======================================================================
#### Query Parameters (61 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| closeFolder | true | boolean | 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.
-
-| copyTo | | String | 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.
-
-| delete | false | boolean | 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.
-
-| disconnect | false | boolean | Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll.
-
-| handleFailedMessage | false | boolean | 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.
-
-| maxMessagesPerPoll | | int | 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.
-
-| peek | true | boolean | 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.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| skipFailedMessage | false | boolean | 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.
-
-| unseen | true | boolean | Whether to limit by unseen mails only.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| fetchSize | -1 | int | 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.
-
-| folderName | INBOX | String | The folder to poll.
-
-| mailUidGenerator | | MailUidGenerator | A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message.
-
-| mapMailMessage | true | boolean | 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).
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
-
-| postProcessAction | | MailBoxPostProcessAction | Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended.
- 4+^s| producer
-| bcc | | String | Sets the BCC email address. Separate multiple email addresses with comma.
-
-| cc | | String | Sets the CC email address. Separate multiple email addresses with comma.
-
-| from | camel@localhost | String | The from email address
-
-| replyTo | | String | The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma.
-
-| subject | | String | The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option.
-
-| to | | String | Sets the To email address. Separate multiple email addresses with comma.
- 4+^s| producer (advanced)
-| javaMailSender | | JavaMailSender | To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails.
- 4+^s| advanced
-| additionalJavaMailProperties | | Properties | 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.
-
-| alternativeBodyHeader | CamelMailAlternativeBody | String | 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.
-
-| attachmentsContentTransferEncodingResolver | | AttachmentsContentTransferEncodingResolver | To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments.
-
-| binding | | MailBinding | Sets the binding used to convert from a Camel message to and from a Mail message
-
-| connectionTimeout | 30000 | int | The connection timeout in milliseconds.
-
-| contentType | text/plain | String | The mail message content type. Use text/html for HTML mails.
-
-| contentTypeResolver | | ContentTypeResolver | Resolver to determine Content-Type for file attachments.
-
-| debugMode | false | boolean | Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default.
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.
-
-| ignoreUnsupportedCharset | false | boolean | 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.
-
-| ignoreUriScheme | false | boolean | 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.
-
-| session | | Session | 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.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| useInlineAttachments | false | boolean | Whether to use disposition inline or attachment.
- 4+^s| filter
-| idempotentRepository | | String> | 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.
-
-| idempotentRepositoryRemoveOnCommit | true | boolean | 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.
-
-| searchTerm | | SearchTerm | 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.
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 60000 | long | Milliseconds before the next poll.
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| sort
-| sortTerm | | String | 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.
- 4+^s| security
-| dummyTrustManager | false | boolean | To use a dummy security setting for trusting all certificates. Should only be used for development mode and not production.
-
-| password | | String | The password for login
-
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters.
-
-| username | | String | The username for login
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **closeFolder** (consumer) | 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. | true | boolean
+| **copyTo** (consumer) | 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. | | String
+| **delete** (consumer) | 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. | false | boolean
+| **disconnect** (consumer) | Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll. | false | boolean
+| **handleFailedMessage** (consumer) | 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. | false | boolean
+| **maxMessagesPerPoll** (consumer) | 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. | | int
+| **peek** (consumer) | 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. | true | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **skipFailedMessage** (consumer) | 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. | false | boolean
+| **unseen** (consumer) | Whether to limit by unseen mails only. | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **fetchSize** (consumer) | 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. | -1 | int
+| **folderName** (consumer) | The folder to poll. | INBOX | String
+| **mailUidGenerator** (consumer) | A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message. | | MailUidGenerator
+| **mapMailMessage** (consumer) | 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). | true | boolean
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **postProcessAction** (consumer) | Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended. | | MailBoxPostProcess Action
+| **bcc** (producer) | Sets the BCC email address. Separate multiple email addresses with comma. | | String
+| **cc** (producer) | Sets the CC email address. Separate multiple email addresses with comma. | | String
+| **from** (producer) | The from email address | camel@localhost | String
+| **replyTo** (producer) | The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma. | | String
+| **subject** (producer) | The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option. | | String
+| **to** (producer) | Sets the To email address. Separate multiple email addresses with comma. | | String
+| **javaMailSender** (producer) | To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails. | | JavaMailSender
+| **additionalJavaMail Properties** (advanced) | 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. | | Properties
+| **alternativeBodyHeader** (advanced) | 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. | CamelMailAlternativeBody | String
+| **attachmentsContentTransfer EncodingResolver** (advanced) | To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments. | | AttachmentsContent TransferEncoding Resolver
+| **binding** (advanced) | Sets the binding used to convert from a Camel message to and from a Mail message | | MailBinding
+| **connectionTimeout** (advanced) | The connection timeout in milliseconds. | 30000 | int
+| **contentType** (advanced) | The mail message content type. Use text/html for HTML mails. | text/plain | String
+| **contentTypeResolver** (advanced) | Resolver to determine Content-Type for file attachments. | | ContentTypeResolver
+| **debugMode** (advanced) | Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default. | false | boolean
+| **headerFilterStrategy** (advanced) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. | | HeaderFilterStrategy
+| **ignoreUnsupportedCharset** (advanced) | 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. | false | boolean
+| **ignoreUriScheme** (advanced) | 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. | false | boolean
+| **session** (advanced) | 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. | | Session
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **useInlineAttachments** (advanced) | Whether to use disposition inline or attachment. | false | boolean
+| **idempotentRepository** (filter) | 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. | | String>
+| **idempotentRepositoryRemove OnCommit** (filter) | 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. | true | boolean
+| **searchTerm** (filter) | 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. | | SearchTerm
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. | 60000 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **sortTerm** (sort) | 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. | | String
+| **dummyTrustManager** (security) | To use a dummy security setting for trusting all certificates. Should only be used for development mode and not production. | false | boolean
+| **password** (security) | The password for login | | String
+| **sslContextParameters** (security) | To configure security using SSLContextParameters. | | SSLContextParameters
+| **username** (security) | The username for login | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-metrics/src/main/docs/metrics-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-metrics/src/main/docs/metrics-component.adoc b/components/camel-metrics/src/main/docs/metrics-component.adoc
index 3b052a5..89a4857 100644
--- a/components/camel-metrics/src/main/docs/metrics-component.adoc
+++ b/components/camel-metrics/src/main/docs/metrics-component.adoc
@@ -48,13 +48,11 @@ The Metrics component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| metricRegistry | | MetricRegistry | To use a custom configured MetricRegistry.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **metricRegistry** (advanced) | To use a custom configured MetricRegistry. | | MetricRegistry
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -68,32 +66,25 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| metricsType | | MetricsType | *Required* Type of metrics
-| metricsName | | String | *Required* Name of metrics
+| Name | Description | Default | Type
+| **metricsType** | *Required* Type of metrics | | MetricsType
+| **metricsName** | *Required* Name of metrics | | String
|=======================================================================
#### Query Parameters (7 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| action | | MetricsTimerAction | Action when using timer type
-
-| decrement | | Long | Decrement value when using counter type
-
-| increment | | Long | Increment value when using counter type
-
-| mark | | Long | Mark when using meter type
-
-| subject | | Object | Subject value when using gauge type
-
-| value | | Long | Value value when using histogram type
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **action** (producer) | Action when using timer type | | MetricsTimerAction
+| **decrement** (producer) | Decrement value when using counter type | | Long
+| **increment** (producer) | Increment value when using counter type | | Long
+| **mark** (producer) | Mark when using meter type | | Long
+| **subject** (producer) | Subject value when using gauge type | | Object
+| **value** (producer) | Value value when using histogram type | | Long
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-mina/src/main/docs/mina-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mina/src/main/docs/mina-component.adoc b/components/camel-mina/src/main/docs/mina-component.adoc
index a239fa0..cfba369 100644
--- a/components/camel-mina/src/main/docs/mina-component.adoc
+++ b/components/camel-mina/src/main/docs/mina-component.adoc
@@ -68,13 +68,11 @@ The Mina component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | MinaConfiguration | To use the shared mina configuration.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use the shared mina configuration. | | MinaConfiguration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -94,61 +92,40 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| protocol | | String | *Required* Protocol to use
-| host | | String | *Required* Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server.
-| port | | int | *Required* Port number
+| Name | Description | Default | Type
+| **protocol** | *Required* Protocol to use | | String
+| **host** | *Required* Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server. | | String
+| **port** | *Required* Port number | | int
|=======================================================================
#### Query Parameters (21 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| disconnect | false | boolean | Whether or not to disconnect(close) from Mina session right after use. Can be used for both consumer and producer.
-
-| minaLogger | false | boolean | You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output.
-
-| sync | true | boolean | Setting to set endpoint as one-way or request-response.
-
-| timeout | 30000 | long | You can configure the timeout that specifies how long to wait for a response from a remote server. The timeout unit is in milliseconds so 60000 is 60 seconds.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| clientMode | false | boolean | If the clientMode is true mina consumer will connect the address as a TCP client.
- 4+^s| consumer (advanced)
-| disconnectOnNoReply | true | boolean | If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| noReplyLogLevel | WARN | LoggingLevel | If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back.
- 4+^s| producer (advanced)
-| lazySessionCreation | true | boolean | Sessions can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| transferExchange | false | boolean | Only used for TCP. You can transfer the exchange over the wire instead of just the body. 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.
- 4+^s| codec
-| allowDefaultCodec | true | boolean | The mina component installs a default codec if both codec is null and textline is false. Setting allowDefaultCodec to false prevents the mina component from installing a default codec as the first element in the filter chain. This is useful in scenarios where another filter must be the first in the filter chain like the SSL filter.
-
-| codec | | ProtocolCodecFactory | To use a custom minda codec implementation.
-
-| decoderMaxLineLength | 1024 | int | To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024.
-
-| encoderMaxLineLength | -1 | int | To set the textline protocol encoder max line length. By default the default value of Mina itself is used which are Integer.MAX_VALUE.
-
-| encoding | | String | You can configure the encoding (a charset name) to use for the TCP textline codec and the UDP protocol. If not provided Camel will use the JVM default Charset
-
-| filters | | List | You can set a list of Mina IoFilters to use.
-
-| textline | false | boolean | Only used for TCP. If no codec is specified you can use this flag to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP.
-
-| textlineDelimiter | | TextLineDelimiter | Only used for TCP and if textline=true. Sets the text line delimiter to use. If none provided Camel will use DEFAULT. This delimiter is used to mark the end of text.
+| Name | Description | Default | Type
+| **disconnect** (common) | Whether or not to disconnect(close) from Mina session right after use. Can be used for both consumer and producer. | false | boolean
+| **minaLogger** (common) | You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output. | false | boolean
+| **sync** (common) | Setting to set endpoint as one-way or request-response. | true | boolean
+| **timeout** (common) | You can configure the timeout that specifies how long to wait for a response from a remote server. The timeout unit is in milliseconds so 60000 is 60 seconds. | 30000 | long
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **clientMode** (consumer) | If the clientMode is true mina consumer will connect the address as a TCP client. | false | boolean
+| **disconnectOnNoReply** (consumer) | If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back. | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **noReplyLogLevel** (consumer) | If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back. | WARN | LoggingLevel
+| **lazySessionCreation** (producer) | Sessions can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **transferExchange** (advanced) | Only used for TCP. You can transfer the exchange over the wire instead of just the body. 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. | false | boolean
+| **allowDefaultCodec** (codec) | The mina component installs a default codec if both codec is null and textline is false. Setting allowDefaultCodec to false prevents the mina component from installing a default codec as the first element in the filter chain. This is useful in scenarios where another filter must be the first in the filter chain like the SSL filter. | true | boolean
+| **codec** (codec) | To use a custom minda codec implementation. | | ProtocolCodecFactory
+| **decoderMaxLineLength** (codec) | To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024. | 1024 | int
+| **encoderMaxLineLength** (codec) | To set the textline protocol encoder max line length. By default the default value of Mina itself is used which are Integer.MAX_VALUE. | -1 | int
+| **encoding** (codec) | You can configure the encoding (a charset name) to use for the TCP textline codec and the UDP protocol. If not provided Camel will use the JVM default Charset | | String
+| **filters** (codec) | You can set a list of Mina IoFilters to use. | | List
+| **textline** (codec) | Only used for TCP. If no codec is specified you can use this flag to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP. | false | boolean
+| **textlineDelimiter** (codec) | Only used for TCP and if textline=true. Sets the text line delimiter to use. If none provided Camel will use DEFAULT. This delimiter is used to mark the end of text. | | TextLineDelimiter
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-mina2/src/main/docs/mina2-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-mina2/src/main/docs/mina2-component.adoc b/components/camel-mina2/src/main/docs/mina2-component.adoc
index d6a0434..f598fe3 100644
--- a/components/camel-mina2/src/main/docs/mina2-component.adoc
+++ b/components/camel-mina2/src/main/docs/mina2-component.adoc
@@ -67,13 +67,11 @@ The Mina2 component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | Mina2Configuration | To use the shared mina configuration.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use the shared mina configuration. | | Mina2Configuration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -93,71 +91,45 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| protocol | | String | *Required* Protocol to use
-| host | | String | *Required* Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server.
-| port | | int | *Required* Port number
+| Name | Description | Default | Type
+| **protocol** | *Required* Protocol to use | | String
+| **host** | *Required* Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server. | | String
+| **port** | *Required* Port number | | int
|=======================================================================
#### Query Parameters (26 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| disconnect | false | boolean | Whether or not to disconnect(close) from Mina session right after use. Can be used for both consumer and producer.
-
-| minaLogger | false | boolean | You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output.
-
-| sync | true | boolean | Setting to set endpoint as one-way or request-response.
-
-| timeout | 30000 | long | You can configure the timeout that specifies how long to wait for a response from a remote server. The timeout unit is in milliseconds so 60000 is 60 seconds.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| clientMode | false | boolean | If the clientMode is true mina consumer will connect the address as a TCP client.
- 4+^s| consumer (advanced)
-| disconnectOnNoReply | true | boolean | If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| noReplyLogLevel | WARN | LoggingLevel | If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back.
- 4+^s| producer (advanced)
-| cachedAddress | true | boolean | Whether to create the InetAddress once and reuse. Setting this to false allows to pickup DNS changes in the network.
-
-| lazySessionCreation | true | boolean | Sessions can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started.
- 4+^s| advanced
-| maximumPoolSize | 16 | int | Number of worker threads in the worker pool for TCP and UDP
-
-| orderedThreadPoolExecutor | true | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| transferExchange | false | boolean | Only used for TCP. You can transfer the exchange over the wire instead of just the body. 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.
- 4+^s| codec
-| allowDefaultCodec | true | boolean | The mina component installs a default codec if both codec is null and textline is false. Setting allowDefaultCodec to false prevents the mina component from installing a default codec as the first element in the filter chain. This is useful in scenarios where another filter must be the first in the filter chain like the SSL filter.
-
-| codec | | ProtocolCodecFactory | To use a custom minda codec implementation.
-
-| decoderMaxLineLength | 1024 | int | To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024.
-
-| encoderMaxLineLength | -1 | int | To set the textline protocol encoder max line length. By default the default value of Mina itself is used which are Integer.MAX_VALUE.
-
-| encoding | | String | You can configure the encoding (a charset name) to use for the TCP textline codec and the UDP protocol. If not provided Camel will use the JVM default Charset
-
-| filters | | List | You can set a list of Mina IoFilters to use.
-
-| textline | false | boolean | Only used for TCP. If no codec is specified you can use this flag to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP.
-
-| textlineDelimiter | | Mina2TextLineDelimiter | Only used for TCP and if textline=true. Sets the text line delimiter to use. If none provided Camel will use DEFAULT. This delimiter is used to mark the end of text.
- 4+^s| security
-| autoStartTls | true | boolean | Whether to auto start SSL handshake.
-
-| sslContextParameters | | SSLContextParameters | To configure SSL security.
+| Name | Description | Default | Type
+| **disconnect** (common) | Whether or not to disconnect(close) from Mina session right after use. Can be used for both consumer and producer. | false | boolean
+| **minaLogger** (common) | You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output. | false | boolean
+| **sync** (common) | Setting to set endpoint as one-way or request-response. | true | boolean
+| **timeout** (common) | You can configure the timeout that specifies how long to wait for a response from a remote server. The timeout unit is in milliseconds so 60000 is 60 seconds. | 30000 | long
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **clientMode** (consumer) | If the clientMode is true mina consumer will connect the address as a TCP client. | false | boolean
+| **disconnectOnNoReply** (consumer) | If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back. | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **noReplyLogLevel** (consumer) | If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back. | WARN | LoggingLevel
+| **cachedAddress** (producer) | Whether to create the InetAddress once and reuse. Setting this to false allows to pickup DNS changes in the network. | true | boolean
+| **lazySessionCreation** (producer) | Sessions can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. | true | boolean
+| **maximumPoolSize** (advanced) | Number of worker threads in the worker pool for TCP and UDP | 16 | int
+| **orderedThreadPoolExecutor** (advanced) | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **transferExchange** (advanced) | Only used for TCP. You can transfer the exchange over the wire instead of just the body. 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. | false | boolean
+| **allowDefaultCodec** (codec) | The mina component installs a default codec if both codec is null and textline is false. Setting allowDefaultCodec to false prevents the mina component from installing a default codec as the first element in the filter chain. This is useful in scenarios where another filter must be the first in the filter chain like the SSL filter. | true | boolean
+| **codec** (codec) | To use a custom minda codec implementation. | | ProtocolCodecFactory
+| **decoderMaxLineLength** (codec) | To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024. | 1024 | int
+| **encoderMaxLineLength** (codec) | To set the textline protocol encoder max line length. By default the default value of Mina itself is used which are Integer.MAX_VALUE. | -1 | int
+| **encoding** (codec) | You can configure the encoding (a charset name) to use for the TCP textline codec and the UDP protocol. If not provided Camel will use the JVM default Charset | | String
+| **filters** (codec) | You can set a list of Mina IoFilters to use. | | List
+| **textline** (codec) | Only used for TCP. If no codec is specified you can use this flag to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP. | false | boolean
+| **textlineDelimiter** (codec) | Only used for TCP and if textline=true. Sets the text line delimiter to use. If none provided Camel will use DEFAULT. This delimiter is used to mark the end of text. | | Mina2TextLineDelimiter
+| **autoStartTls** (security) | Whether to auto start SSL handshake. | true | boolean
+| **sslContextParameters** (security) | To configure SSL security. | | SSLContextParameters
|=======================================================================
// endpoint options: END
[26/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-amqp/src/main/docs/amqp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-amqp/src/main/docs/amqp-component.adoc b/components/camel-amqp/src/main/docs/amqp-component.adoc
index 391de32..44bc8ca 100644
--- a/components/camel-amqp/src/main/docs/amqp-component.adoc
+++ b/components/camel-amqp/src/main/docs/amqp-component.adoc
@@ -38,165 +38,88 @@ link:../../../../camel-jms/src/main/docs/readme.html[JMS] component after the de
// component options: START
-The AMQP component supports 76 options which are listed below.
+The AMQP component supports 75 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | JmsConfiguration | To use a shared JMS configuration
- 4+^s| consumer (advanced)
-| acceptMessagesWhileStopping | false | boolean | 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.
-
-| allowReplyManagerQuickStop | false | boolean | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping 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.
- 4+^s| consumer
-| acknowledgementMode | | int | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode.For the regular modes it is preferable to use the acknowledgementModeName instead.
- 4+^s| consumer (advanced)
-| eagerLoadingOfProperties | false | boolean | Enables eager loading of JMS properties 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
- 4+^s| consumer
-| acknowledgementModeName | AUTO_ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE
-
-| autoStartup | true | boolean | Specifies whether the consumer container should auto-startup.
-
-| cacheLevel | | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.
-
-| cacheLevelName | CACHE_AUTO | String | 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.
- 4+^s| producer (advanced)
-| replyToCacheLevelName | | String | 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.
- 4+^s| common
-| clientId | | String | 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.
- 4+^s| consumer
-| concurrentConsumers | 1 | int | 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.
- 4+^s| producer
-| replyToConcurrentConsumers | 1 | int | 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.
- 4+^s| common
-| connectionFactory | | ConnectionFactory | The connection factory to be use. A connection factory must be configured either on the component or endpoint.
- 4+^s| security
-| username | | String | Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
-
-| password | | String | Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
- 4+^s| producer
-| deliveryPersistent | true | boolean | Specifies whether persistent delivery is used by default.
-
-| deliveryMode | | Integer | Specifies the delivery mode to be used. Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2.
- 4+^s| common
-| durableSubscriptionName | | String | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well.
- 4+^s| advanced
-| exceptionListener | | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
-
-| errorHandler | | ErrorHandler | 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.
- 4+^s| logging
-| errorHandlerLoggingLevel | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
-
-| errorHandlerLogStackTrace | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
- 4+^s| producer
-| explicitQosEnabled | false | boolean | 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.
- 4+^s| consumer (advanced)
-| exposeListenerSession | false | boolean | Specifies whether the listener session should be exposed when consuming messages.
- 4+^s| advanced
-| idleTaskExecutionLimit | 1 | int | 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.
-
-| idleConsumerLimit | 1 | int | Specify the limit for the number of consumers that are allowed to be idle at any given time.
- 4+^s| consumer
-| maxConcurrentConsumers | | int | 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.
- 4+^s| producer
-| replyToMaxConcurrentConsumers | | int | 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.
-
-| replyOnTimeoutToMaxConcurrentConsumers | 1 | int | Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS.
- 4+^s| advanced
-| maxMessagesPerTask | -1 | int | 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.
-
-| messageConverter | | MessageConverter | 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.
-
-| mapJmsMessage | true | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc.
-
-| messageIdEnabled | true | boolean | 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
-
-| messageTimestampEnabled | true | boolean | 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
- 4+^s| producer (advanced)
-| alwaysCopyMessage | false | boolean | 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)
- 4+^s| advanced
-| useMessageIDAsCorrelationID | false | boolean | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
- 4+^s| producer
-| priority | 4 | int | 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.
- 4+^s| advanced
-| pubSubNoLocal | false | boolean | Specifies whether to inhibit the delivery of messages published by its own connection.
-
-| receiveTimeout | 1000 | long | The timeout for receiving messages (in milliseconds).
-
-| recoveryInterval | 5000 | long | 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.
- 4+^s| common
-| subscriptionDurable | false | boolean | Deprecated: Enabled by default if you specify a durableSubscriptionName and a clientId.
- 4+^s| consumer (advanced)
-| taskExecutor | | TaskExecutor | Allows you to specify a custom task executor for consuming messages.
- 4+^s| producer
-| timeToLive | -1 | long | When sending messages specifies the time-to-live of the message (in milliseconds).
- 4+^s| transaction
-| transacted | false | boolean | Specifies whether to use transacted mode
- 4+^s| transaction (advanced)
-| lazyCreateTransactionManager | true | boolean | If true Camel will create a JmsTransactionManager if there is no transactionManager injected when option transacted=true.
-
-| transactionManager | | PlatformTransactionManager | The Spring transaction manager to use.
-
-| transactionName | | String | The name of the transaction to use.
-
-| transactionTimeout | -1 | int | The timeout value of the transaction (in seconds) if using transacted mode.
- 4+^s| common
-| testConnectionOnStartup | false | boolean | 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.
- 4+^s| advanced
-| asyncStartListener | false | boolean | 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.
-
-| asyncStopListener | false | boolean | Whether to stop the JmsConsumer message listener asynchronously when stopping a route.
- 4+^s| producer (advanced)
-| forceSendOriginalMessage | false | boolean | 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.
- 4+^s| producer
-| requestTimeout | 20000 | long | 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.
- 4+^s| advanced
-| requestTimeoutCheckerInterval | 1000 | long | 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.
-
-| transferExchange | false | boolean | 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.
-
-| transferException | false | boolean | 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.
-
-| transferFault | false | boolean | 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 MessageisFault() will be send back in the response as a JMS header with the key org.apache.camel.component.jms.JmsConstantsJMS_TRANSFER_FAULTJMS_TRANSFER_FAULT. If the client is Camel the returned fault flag will be set on the link org.apache.camel.MessagesetFault(boolean). You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws.
-
-| jmsOperations | | JmsOperations | Allows you to use your own implementation of the org.springframework.jms.core.JmsOperations interface. Camel uses JmsTemplate as default. Can be used for testing purpose but not used much as stated in the spring API docs.
-
-| destinationResolver | | DestinationResolver | 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).
- 4+^s| producer
-| replyToType | | ReplyToType | 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.
-
-| preserveMessageQos | false | boolean | 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.
- 4+^s| consumer
-| asyncConsumer | false | boolean | 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).
- 4+^s| producer (advanced)
-| allowNullBody | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown.
-
-| includeSentJMSMessageID | false | boolean | 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.
- 4+^s| advanced
-| includeAllJMSXProperties | false | boolean | 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.
- 4+^s| consumer (advanced)
-| defaultTaskExecutorType | | DefaultTaskExecutorType | 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.
- 4+^s| advanced
-| jmsKeyFormatStrategy | | JmsKeyFormatStrategy | 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.
- 4+^s| common
-| applicationContext | | ApplicationContext | Sets the Spring ApplicationContext to use
- 4+^s| advanced
-| queueBrowseStrategy | | QueueBrowseStrategy | To use a custom QueueBrowseStrategy when browsing queues
-
-| messageCreatedStrategy | | MessageCreatedStrategy | 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.
-
-| waitForProvisionCorrelationToBeUpdatedCounter | 50 | int | 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.
-
-| waitForProvisionCorrelationToBeUpdatedThreadSleepingTime | 100 | long | Interval in millis to sleep each time while waiting for provisional correlation id to be updated.
- 4+^s| producer (advanced)
-| correlationProperty | | String | 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.
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use a shared JMS configuration | | JmsConfiguration
+| **acceptMessagesWhile Stopping** (consumer) | 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. | false | boolean
+| **allowReplyManagerQuick Stop** (consumer) | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping 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. | false | boolean
+| **acknowledgementMode** (consumer) | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode.For the regular modes it is preferable to use the acknowledgementModeName instead. | | int
+| **eagerLoadingOf Properties** (consumer) | Enables eager loading of JMS properties 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 | false | boolean
+| **acknowledgementModeName** (consumer) | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE | AUTO_ ACKNOWLEDGE | String
+| **autoStartup** (consumer) | Specifies whether the consumer container should auto-startup. | true | boolean
+| **cacheLevel** (consumer) | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. | | int
+| **cacheLevelName** (consumer) | 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. | CACHE_AUTO | String
+| **replyToCacheLevelName** (producer) | 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. | | String
+| **clientId** (common) | 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. | | String
+| **concurrentConsumers** (consumer) | 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. | 1 | int
+| **replyToConcurrent Consumers** (producer) | 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. | 1 | int
+| **connectionFactory** (common) | The connection factory to be use. A connection factory must be configured either on the component or endpoint. | | ConnectionFactory
+| **username** (security) | Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory. | | String
+| **password** (security) | Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory. | | String
+| **deliveryPersistent** (producer) | Specifies whether persistent delivery is used by default. | true | boolean
+| **deliveryMode** (producer) | Specifies the delivery mode to be used. Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2. | | Integer
+| **durableSubscriptionName** (common) | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well. | | String
+| **exceptionListener** (advanced) | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. | | ExceptionListener
+| **errorHandler** (advanced) | 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. | | ErrorHandler
+| **errorHandlerLogging Level** (logging) | Allows to configure the default errorHandler logging level for logging uncaught exceptions. | WARN | LoggingLevel
+| **errorHandlerLogStack Trace** (logging) | Allows to control whether stacktraces should be logged or not by the default errorHandler. | true | boolean
+| **explicitQosEnabled** (producer) | 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. | false | boolean
+| **exposeListenerSession** (consumer) | Specifies whether the listener session should be exposed when consuming messages. | false | boolean
+| **idleTaskExecutionLimit** (advanced) | 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. | 1 | int
+| **idleConsumerLimit** (advanced) | Specify the limit for the number of consumers that are allowed to be idle at any given time. | 1 | int
+| **maxConcurrentConsumers** (consumer) | 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. | | int
+| **replyToMaxConcurrent Consumers** (producer) | 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. | | int
+| **replyOnTimeoutToMax ConcurrentConsumers** (producer) | Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS. | 1 | int
+| **maxMessagesPerTask** (advanced) | 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. | -1 | int
+| **messageConverter** (advanced) | 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. | | MessageConverter
+| **mapJmsMessage** (advanced) | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. | true | boolean
+| **messageIdEnabled** (advanced) | 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 | true | boolean
+| **messageTimestampEnabled** (advanced) | 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 | true | boolean
+| **alwaysCopyMessage** (producer) | 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) | false | boolean
+| **useMessageIDAs CorrelationID** (advanced) | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages. | false | boolean
+| **priority** (producer) | 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. | 4 | int
+| **pubSubNoLocal** (advanced) | Specifies whether to inhibit the delivery of messages published by its own connection. | false | boolean
+| **receiveTimeout** (advanced) | The timeout for receiving messages (in milliseconds). | 1000 | long
+| **recoveryInterval** (advanced) | 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. | 5000 | long
+| **subscriptionDurable** (common) | Deprecated: Enabled by default if you specify a durableSubscriptionName and a clientId. | false | boolean
+| **taskExecutor** (consumer) | Allows you to specify a custom task executor for consuming messages. | | TaskExecutor
+| **timeToLive** (producer) | When sending messages specifies the time-to-live of the message (in milliseconds). | -1 | long
+| **transacted** (transaction) | Specifies whether to use transacted mode | false | boolean
+| **lazyCreateTransaction Manager** (transaction) | If true Camel will create a JmsTransactionManager if there is no transactionManager injected when option transacted=true. | true | boolean
+| **transactionManager** (transaction) | The Spring transaction manager to use. | | PlatformTransaction Manager
+| **transactionName** (transaction) | The name of the transaction to use. | | String
+| **transactionTimeout** (transaction) | The timeout value of the transaction (in seconds) if using transacted mode. | -1 | int
+| **testConnectionOn Startup** (common) | 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. | false | boolean
+| **asyncStartListener** (advanced) | 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. | false | boolean
+| **asyncStopListener** (advanced) | Whether to stop the JmsConsumer message listener asynchronously when stopping a route. | false | boolean
+| **forceSendOriginal Message** (producer) | 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. | false | boolean
+| **requestTimeout** (producer) | 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. | 20000 | long
+| **requestTimeoutChecker Interval** (advanced) | 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. | 1000 | long
+| **transferExchange** (advanced) | 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. | false | boolean
+| **transferException** (advanced) | 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. | false | boolean
+| **transferFault** (advanced) | 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 MessageisFault() will be send back in the response as a JMS header with the key org.apache.camel.component.jms.JmsConstantsJMS_TRANSFER_FAULTJMS_TRANSFER_FAULT. If the client is Camel the returned fault flag will be set on the link org.apache.camel.MessagesetFault(boolean). You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws. | false | boolean
+| **jmsOperations** (advanced) | Allows you to use your own implementation of the org.springframework.jms.core.JmsOperations interface. Camel uses JmsTemplate as default. Can be used for testing purpose but not used much as stated in the spring API docs. | | JmsOperations
+| **destinationResolver** (advanced) | 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). | | DestinationResolver
+| **replyToType** (producer) | 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. | | ReplyToType
+| **preserveMessageQos** (producer) | 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. | false | boolean
+| **asyncConsumer** (consumer) | 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). | false | boolean
+| **allowNullBody** (producer) | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. | true | boolean
+| **includeSentJMS MessageID** (producer) | 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. | false | boolean
+| **includeAllJMSX Properties** (advanced) | 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. | false | boolean
+| **defaultTaskExecutor Type** (consumer) | 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. | | DefaultTaskExecutor Type
+| **jmsKeyFormatStrategy** (advanced) | 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. | | JmsKeyFormatStrategy
+| **queueBrowseStrategy** (advanced) | To use a custom QueueBrowseStrategy when browsing queues | | QueueBrowseStrategy
+| **messageCreatedStrategy** (advanced) | 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. | | MessageCreatedStrategy
+| **waitForProvision CorrelationToBeUpdated Counter** (advanced) | 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. | 50 | int
+| **waitForProvision CorrelationToBeUpdated ThreadSleepingTime** (advanced) | Interval in millis to sleep each time while waiting for provisional correlation id to be updated. | 100 | long
+| **correlationProperty** (producer) | 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. | | String
+| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -215,188 +138,103 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| destinationType | queue | String | The kind of destination to use
-| destinationName | | String | *Required* Name of the queue or topic to use as destination
+| Name | Description | Default | Type
+| **destinationType** | The kind of destination to use | queue | String
+| **destinationName** | *Required* Name of the queue or topic to use as destination | | String
|=======================================================================
#### Query Parameters (85 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| clientId | | String | 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.
-
-| connectionFactory | | ConnectionFactory | The connection factory to be use. A connection factory must be configured either on the component or endpoint.
-
-| disableReplyTo | false | boolean | If true a producer will behave like a InOnly exchange with the exception that JMSReplyTo header is sent out and not be suppressed like in the case of InOnly. Like InOnly the producer will not wait for a reply. A consumer with this flag will behave like InOnly. This feature can be used to bridge InOut requests to another queue so that a route on the other queue will send its response directly back to the original JMSReplyTo.
-
-| durableSubscriptionName | | String | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well.
-
-| jmsMessageType | | JmsMessageType | 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.
-
-| testConnectionOnStartup | false | boolean | 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.
- 4+^s| consumer
-| acknowledgementModeName | AUTO_ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE
-
-| asyncConsumer | false | boolean | 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).
-
-| autoStartup | true | boolean | Specifies whether the consumer container should auto-startup.
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| cacheLevel | | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.
-
-| cacheLevelName | CACHE_AUTO | String | 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.
-
-| concurrentConsumers | 1 | int | 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.
-
-| maxConcurrentConsumers | | int | 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.
-
-| replyTo | | String | Provides an explicit ReplyTo destination which overrides any incoming value of Message.getJMSReplyTo().
-
-| replyToDeliveryPersistent | true | boolean | Specifies whether to use persistent delivery by default for replies.
-
-| selector | | String | Sets the JMS selector to use
- 4+^s| consumer (advanced)
-| acceptMessagesWhileStopping | false | boolean | 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.
-
-| allowReplyManagerQuickStop | false | boolean | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping 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.
-
-| consumerType | Default | ConsumerType | 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.
-
-| defaultTaskExecutorType | | DefaultTaskExecutorType | 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.
-
-| eagerLoadingOfProperties | false | boolean | Enables eager loading of JMS properties 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
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| exposeListenerSession | false | boolean | Specifies whether the listener session should be exposed when consuming messages.
-
-| replyToSameDestinationAllowed | false | boolean | 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.
-
-| taskExecutor | | TaskExecutor | Allows you to specify a custom task executor for consuming messages.
- 4+^s| producer
-| deliveryMode | | Integer | Specifies the delivery mode to be used. Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2.
-
-| deliveryPersistent | true | boolean | Specifies whether persistent delivery is used by default.
-
-| explicitQosEnabled | false | Boolean | 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.
-
-| preserveMessageQos | false | boolean | 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.
-
-| priority | 4 | int | 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.
-
-| replyToConcurrentConsumers | 1 | int | 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.
-
-| replyToMaxConcurrentConsumers | | int | 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.
-
-| replyToOnTimeoutMaxConcurrentConsumers | 1 | int | Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS.
-
-| replyToOverride | | String | 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.
-
-| replyToType | | ReplyToType | 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.
-
-| requestTimeout | 20000 | long | 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.
-
-| timeToLive | -1 | long | When sending messages specifies the time-to-live of the message (in milliseconds).
- 4+^s| producer (advanced)
-| allowNullBody | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown.
-
-| alwaysCopyMessage | false | boolean | 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)
-
-| correlationProperty | | String | When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages. If set messages will be correlated solely on the value of this property JMSCorrelationID property will be ignored and not set by Camel.
-
-| disableTimeToLive | false | boolean | 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.
-
-| forceSendOriginalMessage | false | boolean | 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.
-
-| includeSentJMSMessageID | false | boolean | 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.
-
-| replyToCacheLevelName | | String | 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.
-
-| replyToDestinationSelectorName | | String | 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).
- 4+^s| advanced
-| allowSerializedHeaders | false | boolean | Controls whether or not to include serialized headers. Applies only when transferExchange is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level.
-
-| asyncStartListener | false | boolean | 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.
-
-| asyncStopListener | false | boolean | Whether to stop the JmsConsumer message listener asynchronously when stopping a route.
-
-| destinationResolver | | DestinationResolver | 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).
-
-| errorHandler | | ErrorHandler | 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.
-
-| exceptionListener | | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-
-| idleConsumerLimit | 1 | int | Specify the limit for the number of consumers that are allowed to be idle at any given time.
-
-| idleTaskExecutionLimit | 1 | int | 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.
-
-| includeAllJMSXProperties | false | boolean | 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.
-
-| jmsKeyFormatStrategy | | String | 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.
-
-| mapJmsMessage | true | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc.
-
-| maxMessagesPerTask | -1 | int | 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.
-
-| messageConverter | | MessageConverter | 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.
-
-| messageCreatedStrategy | | MessageCreatedStrategy | 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.
-
-| messageIdEnabled | true | boolean | 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
-
-| messageListenerContainerFactory | | MessageListenerContainerFactory | 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.
-
-| messageTimestampEnabled | true | boolean | 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
-
-| pubSubNoLocal | false | boolean | Specifies whether to inhibit the delivery of messages published by its own connection.
-
-| receiveTimeout | 1000 | long | The timeout for receiving messages (in milliseconds).
-
-| recoveryInterval | 5000 | long | 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.
-
-| requestTimeoutCheckerInterval | 1000 | long | 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.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| transferException | false | boolean | 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.
-
-| transferExchange | false | boolean | 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.
-
-| transferFault | false | boolean | 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 MessageisFault() will be send back in the response as a JMS header with the key org.apache.camel.component.jms.JmsConstantsJMS_TRANSFER_FAULTJMS_TRANSFER_FAULT. If the client is Camel the returned fault flag will be set on the link org.apache.camel.MessagesetFault(boolean). You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws.
-
-| useMessageIDAsCorrelationID | false | boolean | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
-
-| waitForProvisionCorrelationToBeUpdatedCounter | 50 | int | 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.
-
-| waitForProvisionCorrelationToBeUpdatedThreadSleepingTime | 100 | long | Interval in millis to sleep each time while waiting for provisional correlation id to be updated.
- 4+^s| logging
-| errorHandlerLoggingLevel | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
-
-| errorHandlerLogStackTrace | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
- 4+^s| security
-| password | | String | Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
-
-| username | | String | Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.
- 4+^s| transaction
-| transacted | false | boolean | Specifies whether to use transacted mode
- 4+^s| transaction (advanced)
-| lazyCreateTransactionManager | true | boolean | If true Camel will create a JmsTransactionManager if there is no transactionManager injected when option transacted=true.
-
-| transactionManager | | PlatformTransactionManager | The Spring transaction manager to use.
-
-| transactionName | | String | The name of the transaction to use.
-
-| transactionTimeout | -1 | int | The timeout value of the transaction (in seconds) if using transacted mode.
+| Name | Description | Default | Type
+| **clientId** (common) | 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. | | String
+| **connectionFactory** (common) | The connection factory to be use. A connection factory must be configured either on the component or endpoint. | | ConnectionFactory
+| **disableReplyTo** (common) | If true a producer will behave like a InOnly exchange with the exception that JMSReplyTo header is sent out and not be suppressed like in the case of InOnly. Like InOnly the producer will not wait for a reply. A consumer with this flag will behave like InOnly. This feature can be used to bridge InOut requests to another queue so that a route on the other queue will send its response directly back to the original JMSReplyTo. | false | boolean
+| **durableSubscriptionName** (common) | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well. | | String
+| **jmsMessageType** (common) | 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. | | JmsMessageType
+| **testConnectionOnStartup** (common) | 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. | false | boolean
+| **acknowledgementModeName** (consumer) | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE | AUTO_ ACKNOWLEDGE | String
+| **asyncConsumer** (consumer) | 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). | false | boolean
+| **autoStartup** (consumer) | Specifies whether the consumer container should auto-startup. | true | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **cacheLevel** (consumer) | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. | | int
+| **cacheLevelName** (consumer) | 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. | CACHE_AUTO | String
+| **concurrentConsumers** (consumer) | 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. | 1 | int
+| **maxConcurrentConsumers** (consumer) | 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. | | int
+| **replyTo** (consumer) | Provides an explicit ReplyTo destination which overrides any incoming value of Message.getJMSReplyTo(). | | String
+| **replyToDeliveryPersistent** (consumer) | Specifies whether to use persistent delivery by default for replies. | true | boolean
+| **selector** (consumer) | Sets the JMS selector to use | | String
+| **acceptMessagesWhileStopping** (consumer) | 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. | false | boolean
+| **allowReplyManagerQuickStop** (consumer) | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping 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. | false | boolean
+| **consumerType** (consumer) | 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. | Default | ConsumerType
+| **defaultTaskExecutorType** (consumer) | 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. | | DefaultTaskExecutor Type
+| **eagerLoadingOfProperties** (consumer) | Enables eager loading of JMS properties 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 | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **exposeListenerSession** (consumer) | Specifies whether the listener session should be exposed when consuming messages. | false | boolean
+| **replyToSameDestination Allowed** (consumer) | 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. | false | boolean
+| **taskExecutor** (consumer) | Allows you to specify a custom task executor for consuming messages. | | TaskExecutor
+| **deliveryMode** (producer) | Specifies the delivery mode to be used. Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2. | | Integer
+| **deliveryPersistent** (producer) | Specifies whether persistent delivery is used by default. | true | boolean
+| **explicitQosEnabled** (producer) | 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. | false | Boolean
+| **preserveMessageQos** (producer) | 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. | false | boolean
+| **priority** (producer) | 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. | 4 | int
+| **replyToConcurrentConsumers** (producer) | 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. | 1 | int
+| **replyToMaxConcurrent Consumers** (producer) | 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. | | int
+| **replyToOnTimeoutMax ConcurrentConsumers** (producer) | Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS. | 1 | int
+| **replyToOverride** (producer) | 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. | | String
+| **replyToType** (producer) | 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. | | ReplyToType
+| **requestTimeout** (producer) | 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. | 20000 | long
+| **timeToLive** (producer) | When sending messages specifies the time-to-live of the message (in milliseconds). | -1 | long
+| **allowNullBody** (producer) | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. | true | boolean
+| **alwaysCopyMessage** (producer) | 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) | false | boolean
+| **correlationProperty** (producer) | When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages. If set messages will be correlated solely on the value of this property JMSCorrelationID property will be ignored and not set by Camel. | | String
+| **disableTimeToLive** (producer) | 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. | false | boolean
+| **forceSendOriginalMessage** (producer) | 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. | false | boolean
+| **includeSentJMSMessageID** (producer) | 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. | false | boolean
+| **replyToCacheLevelName** (producer) | 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. | | String
+| **replyToDestinationSelector Name** (producer) | 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). | | String
+| **allowSerializedHeaders** (advanced) | Controls whether or not to include serialized headers. Applies only when transferExchange is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. | false | boolean
+| **asyncStartListener** (advanced) | 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. | false | boolean
+| **asyncStopListener** (advanced) | Whether to stop the JmsConsumer message listener asynchronously when stopping a route. | false | boolean
+| **destinationResolver** (advanced) | 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). | | DestinationResolver
+| **errorHandler** (advanced) | 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. | | ErrorHandler
+| **exceptionListener** (advanced) | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. | | ExceptionListener
+| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **idleConsumerLimit** (advanced) | Specify the limit for the number of consumers that are allowed to be idle at any given time. | 1 | int
+| **idleTaskExecutionLimit** (advanced) | 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. | 1 | int
+| **includeAllJMSXProperties** (advanced) | 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. | false | boolean
+| **jmsKeyFormatStrategy** (advanced) | 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. | | String
+| **mapJmsMessage** (advanced) | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.T
<TRUNCATED>
[16/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc b/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc
index 86a92a8..6a15115 100644
--- a/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc
+++ b/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc
@@ -57,13 +57,11 @@ The HDFS2 component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| jAASConfiguration | | Configuration | To use the given configuration for security with JAAS.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **jAASConfiguration** (common) | To use the given configuration for security with JAAS. | | Configuration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -81,95 +79,57 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| hostName | | String | *Required* HDFS host to use
-| port | 8020 | int | HDFS port to use
-| path | | String | *Required* The directory path to use
+| Name | Description | Default | Type
+| **hostName** | *Required* HDFS host to use | | String
+| **port** | HDFS port to use | 8020 | int
+| **path** | *Required* The directory path to use | | String
|=======================================================================
#### Query Parameters (38 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| connectOnStartup | true | boolean | 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.
-
-| fileSystemType | HDFS | HdfsFileSystemType | Set to LOCAL to not use HDFS but local java.io.File instead.
-
-| fileType | NORMAL_FILE | HdfsFileType | The file type to use. For more details see Hadoop HDFS documentation about the various files types.
-
-| keyType | NULL | WritableType | The type for the key in case of sequence or map files.
-
-| owner | | String | The file owner must match this owner for the consumer to pickup the file. Otherwise the file is skipped.
-
-| valueType | BYTES | WritableType | The type for the key in case of sequence or map files
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| delay | 1000 | long | The interval (milliseconds) between the directory scans.
-
-| initialDelay | 10000 | long | For the consumer how much to wait (milliseconds) before to start scanning the directory.
-
-| pattern | * | String | The pattern used for scanning the directory
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| producer
-| append | false | boolean | Append to existing file. Notice that not all HDFS file systems support the append option.
-
-| overwrite | true | boolean | Whether to overwrite existing files with the same name
- 4+^s| advanced
-| blockSize | 67108864 | long | The size of the HDFS blocks
-
-| bufferSize | 4096 | int | The buffer size used by HDFS
-
-| checkIdleInterval | 500 | int | 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.
-
-| chunkSize | 4096 | int | When reading a normal file this is split into chunks producing a message per chunk.
-
-| compressionCodec | DEFAULT | HdfsCompressionCodec | The compression codec to use
-
-| compressionType | NONE | CompressionType | The compression type to use (is default not in use)
-
-| openedSuffix | opened | String | When a file is opened for reading/writing the file is renamed with this suffix to avoid to read it during the writing phase.
-
-| readSuffix | read | String | Once the file has been read is renamed with this suffix to avoid to read it again.
-
-| replication | 3 | short | The HDFS replication factor
-
-| splitStrategy | | String | 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:valueST: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
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **connectOnStartup** (common) | 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. | true | boolean
+| **fileSystemType** (common) | Set to LOCAL to not use HDFS but local java.io.File instead. | HDFS | HdfsFileSystemType
+| **fileType** (common) | The file type to use. For more details see Hadoop HDFS documentation about the various files types. | NORMAL_FILE | HdfsFileType
+| **keyType** (common) | The type for the key in case of sequence or map files. | NULL | WritableType
+| **owner** (common) | The file owner must match this owner for the consumer to pickup the file. Otherwise the file is skipped. | | String
+| **valueType** (common) | The type for the key in case of sequence or map files | BYTES | WritableType
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **delay** (consumer) | The interval (milliseconds) between the directory scans. | 1000 | long
+| **initialDelay** (consumer) | For the consumer how much to wait (milliseconds) before to start scanning the directory. | 10000 | long
+| **pattern** (consumer) | The pattern used for scanning the directory | * | String
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **append** (producer) | Append to existing file. Notice that not all HDFS file systems support the append option. | false | boolean
+| **overwrite** (producer) | Whether to overwrite existing files with the same name | true | boolean
+| **blockSize** (advanced) | The size of the HDFS blocks | 67108864 | long
+| **bufferSize** (advanced) | The buffer size used by HDFS | 4096 | int
+| **checkIdleInterval** (advanced) | 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. | 500 | int
+| **chunkSize** (advanced) | When reading a normal file this is split into chunks producing a message per chunk. | 4096 | int
+| **compressionCodec** (advanced) | The compression codec to use | DEFAULT | HdfsCompressionCodec
+| **compressionType** (advanced) | The compression type to use (is default not in use) | NONE | CompressionType
+| **openedSuffix** (advanced) | When a file is opened for reading/writing the file is renamed with this suffix to avoid to read it during the writing phase. | opened | String
+| **readSuffix** (advanced) | Once the file has been read is renamed with this suffix to avoid to read it again. | read | String
+| **replication** (advanced) | The HDFS replication factor | 3 | short
+| **splitStrategy** (advanced) | 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:valueST: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 | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-hipchat/src/main/docs/hipchat-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-hipchat/src/main/docs/hipchat-component.adoc b/components/camel-hipchat/src/main/docs/hipchat-component.adoc
index e2df2f0..e9f49b5 100644
--- a/components/camel-hipchat/src/main/docs/hipchat-component.adoc
+++ b/components/camel-hipchat/src/main/docs/hipchat-component.adoc
@@ -43,61 +43,40 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| protocol | | String | *Required* The protocol for the hipchat server such as http.
-| host | | String | *Required* The host for the hipchat server such as api.hipchat.com
-| port | 80 | Integer | The port for the hipchat server. Is by default 80.
+| Name | Description | Default | Type
+| **protocol** | *Required* The protocol for the hipchat server such as http. | | String
+| **host** | *Required* The host for the hipchat server such as api.hipchat.com | | String
+| **port** | The port for the hipchat server. Is by default 80. | 80 | Integer
|=======================================================================
#### Query Parameters (21 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| authToken | | String | OAuth 2 auth token
-
-| consumeUsers | | String | Username(s) when consuming messages from the hiptchat server. Multiple user names can be separated by comma.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **authToken** (common) | OAuth 2 auth token | | String
+| **consumeUsers** (common) | Username(s) when consuming messages from the hiptchat server. Multiple user names can be separated by comma. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-http/src/main/docs/http-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-http/src/main/docs/http-component.adoc b/components/camel-http/src/main/docs/http-component.adoc
index 8707723..ed0a20a 100644
--- a/components/camel-http/src/main/docs/http-component.adoc
+++ b/components/camel-http/src/main/docs/http-component.adoc
@@ -118,23 +118,16 @@ The HTTP component supports 7 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| httpClientConfigurer | | HttpClientConfigurer | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used.
-
-| httpConnectionManager | | HttpConnectionManager | To use a custom HttpConnectionManager to manage connections
- 4+^s| producer
-| httpBinding | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
-
-| httpConfiguration | | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
-
-| allowJavaSerializedObject | false | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object 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.
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **httpClientConfigurer** (advanced) | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used. | | HttpClientConfigurer
+| **httpConnectionManager** (advanced) | To use a custom HttpConnectionManager to manage connections | | HttpConnectionManager
+| **httpBinding** (producer) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding
+| **httpConfiguration** (producer) | To use the shared HttpConfiguration as base configuration. | | HttpConfiguration
+| **allowJavaSerialized Object** (producer) | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object 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. | false | boolean
+| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -155,93 +148,55 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| httpUri | | URI | *Required* The url of the HTTP endpoint to call.
+| Name | Description | Default | Type
+| **httpUri** | *Required* The url of the HTTP endpoint to call. | | URI
|=======================================================================
#### Query Parameters (38 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| disableStreamCache | false | boolean | 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 r
esponse body stream but use the response stream as-is as the message body.
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| common (advanced)
-| httpBinding | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
- 4+^s| producer
-| bridgeEndpoint | false | boolean | 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.
-
-| chunked | true | boolean | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response
-
-| connectionClose | false | boolean | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false.
-
-| copyHeaders | true | boolean | 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).
-
-| httpMethod | | HttpMethods | Configure the HTTP method to use. The HttpMethod header cannot override this option if set.
-
-| ignoreResponseBody | false | boolean | If this option is true The http producer won't read response body and cache the input stream
-
-| preserveHostHeader | false | boolean | 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
-
-| throwExceptionOnFailure | true | boolean | 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.
-
-| transferException | false | boolean | 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.
- 4+^s| producer (advanced)
-| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session
-
-| okStatusCodeRange | 200-299 | String | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included.
-
-| urlRewrite | | UrlRewrite | 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
- 4+^s| advanced
-| httpClientConfigurer | | HttpClientConfigurer | Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc
-
-| httpClientOptions | | Map | To configure the HttpClient using the key/values from the Map.
-
-| httpConnectionManager | | HttpConnectionManager | To use a custom HttpConnectionManager to manage connections
-
-| httpConnectionManagerOptions | | Map | To configure the HttpConnectionManager using the key/values from the Map.
-
-| mapHttpMessageBody | true | boolean | 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.
-
-| mapHttpMessageFormUrlEncodedBody | true | boolean | 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.
-
-| mapHttpMessageHeaders | true | boolean | 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.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| proxy
-| proxyAuthDomain | | String | Proxy authentication domain to use with NTML
-
-| proxyAuthHost | | String | Proxy authentication host
-
-| proxyAuthMethod | | String | Proxy authentication method to use
-
-| proxyAuthPassword | | String | Proxy authentication password
-
-| proxyAuthPort | | int | Proxy authentication port
-
-| proxyAuthScheme | | String | Proxy authentication scheme to use
-
-| proxyAuthUsername | | String | Proxy authentication username
-
-| proxyHost | | String | Proxy hostname to use
-
-| proxyPort | | int | Proxy port to use
- 4+^s| security
-| authDomain | | String | Authentication domain to use with NTML
-
-| authHost | | String | Authentication host to use with NTML
-
-| authMethod | | String | Authentication methods allowed to use as a comma separated list of values Basic Digest or NTLM.
-
-| authMethodPriority | | String | Which authentication method to prioritize to use either as Basic Digest or NTLM.
-
-| authPassword | | String | Authentication password
-
-| authUsername | | String | Authentication username
+| Name | Description | Default | Type
+| **disableStreamCache** (common) | 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 respon
se body stream but use the response stream as-is as the message body. | false | boolean
+| **headerFilterStrategy** (common) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **httpBinding** (common) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding
+| **bridgeEndpoint** (producer) | 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. | false | boolean
+| **chunked** (producer) | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response | true | boolean
+| **connectionClose** (producer) | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. | false | boolean
+| **copyHeaders** (producer) | 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). | true | boolean
+| **httpMethod** (producer) | Configure the HTTP method to use. The HttpMethod header cannot override this option if set. | | HttpMethods
+| **ignoreResponseBody** (producer) | If this option is true The http producer won't read response body and cache the input stream | false | boolean
+| **preserveHostHeader** (producer) | 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 | false | boolean
+| **throwExceptionOnFailure** (producer) | 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. | true | boolean
+| **transferException** (producer) | 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. | false | boolean
+| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler
+| **okStatusCodeRange** (producer) | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. | 200-299 | String
+| **urlRewrite** (producer) | 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 | | UrlRewrite
+| **httpClientConfigurer** (advanced) | Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc | | HttpClientConfigurer
+| **httpClientOptions** (advanced) | To configure the HttpClient using the key/values from the Map. | | Map
+| **httpConnectionManager** (advanced) | To use a custom HttpConnectionManager to manage connections | | HttpConnectionManager
+| **httpConnectionManager Options** (advanced) | To configure the HttpConnectionManager using the key/values from the Map. | | Map
+| **mapHttpMessageBody** (advanced) | 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. | true | boolean
+| **mapHttpMessageFormUrl EncodedBody** (advanced) | 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. | true | boolean
+| **mapHttpMessageHeaders** (advanced) | 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. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **proxyAuthDomain** (proxy) | Proxy authentication domain to use with NTML | | String
+| **proxyAuthHost** (proxy) | Proxy authentication host | | String
+| **proxyAuthMethod** (proxy) | Proxy authentication method to use | | String
+| **proxyAuthPassword** (proxy) | Proxy authentication password | | String
+| **proxyAuthPort** (proxy) | Proxy authentication port | | int
+| **proxyAuthScheme** (proxy) | Proxy authentication scheme to use | | String
+| **proxyAuthUsername** (proxy) | Proxy authentication username | | String
+| **proxyHost** (proxy) | Proxy hostname to use | | String
+| **proxyPort** (proxy) | Proxy port to use | | int
+| **authDomain** (security) | Authentication domain to use with NTML | | String
+| **authHost** (security) | Authentication host to use with NTML | | String
+| **authMethod** (security) | Authentication methods allowed to use as a comma separated list of values Basic Digest or NTLM. | | String
+| **authMethodPriority** (security) | Which authentication method to prioritize to use either as Basic Digest or NTLM. | | String
+| **authPassword** (security) | Authentication password | | String
+| **authUsername** (security) | Authentication username | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-http4/src/main/docs/http4-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-http4/src/main/docs/http4-component.adoc b/components/camel-http4/src/main/docs/http4-component.adoc
index ca58f49..00e7442 100644
--- a/components/camel-http4/src/main/docs/http4-component.adoc
+++ b/components/camel-http4/src/main/docs/http4-component.adoc
@@ -55,37 +55,23 @@ The HTTP4 component supports 14 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| httpClientConfigurer | | HttpClientConfigurer | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used.
-
-| clientConnectionManager | | HttpClientConnectionManager | To use a custom and shared HttpClientConnectionManager to manage connections. If this has been configured then this is always used for all endpoints created by this component.
-
-| httpContext | | HttpContext | To use a custom org.apache.http.protocol.HttpContext when executing requests.
- 4+^s| security
-| sslContextParameters | | SSLContextParameters | 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.
-
-| x509HostnameVerifier | | HostnameVerifier | To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or org.apache.http.conn.ssl.NoopHostnameVerifier.
- 4+^s| advanced
-| maxTotalConnections | 200 | int | The maximum number of connections.
-
-| connectionsPerRoute | 20 | int | The maximum number of connections per route.
-
-| connectionTimeToLive | | long | The time for connection to live the time unit is millisecond the default value is always keep alive.
- 4+^s| producer
-| cookieStore | | CookieStore | To use a custom org.apache.http.client.CookieStore. By default the org.apache.http.impl.client.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).
- 4+^s| advanced
-| httpBinding | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
-
-| httpConfiguration | | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
-
-| allowJavaSerializedObject | false | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. 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.
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **httpClientConfigurer** (advanced) | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used. | | HttpClientConfigurer
+| **clientConnectionManager** (advanced) | To use a custom and shared HttpClientConnectionManager to manage connections. If this has been configured then this is always used for all endpoints created by this component. | | HttpClientConnection Manager
+| **httpContext** (advanced) | To use a custom org.apache.http.protocol.HttpContext when executing requests. | | HttpContext
+| **sslContextParameters** (security) | 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. | | SSLContextParameters
+| **x509HostnameVerifier** (security) | To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or org.apache.http.conn.ssl.NoopHostnameVerifier. | | HostnameVerifier
+| **maxTotalConnections** (advanced) | The maximum number of connections. | 200 | int
+| **connectionsPerRoute** (advanced) | The maximum number of connections per route. | 20 | int
+| **connectionTimeToLive** (advanced) | The time for connection to live the time unit is millisecond the default value is always keep alive. | | long
+| **cookieStore** (producer) | To use a custom org.apache.http.client.CookieStore. By default the org.apache.http.impl.client.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). | | CookieStore
+| **httpBinding** (advanced) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding
+| **httpConfiguration** (advanced) | To use the shared HttpConfiguration as base configuration. | | HttpConfiguration
+| **allowJavaSerialized Object** (advanced) | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. 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. | false | boolean
+| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -107,113 +93,65 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| httpUri | | URI | *Required* The url of the HTTP endpoint to call.
+| Name | Description | Default | Type
+| **httpUri** | *Required* The url of the HTTP endpoint to call. | | URI
|=======================================================================
#### Query Parameters (48 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| disableStreamCache | false | boolean | 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 r
esponse body stream but use the response stream as-is as the message body.
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| common (advanced)
-| httpBinding | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
- 4+^s| producer
-| authenticationPreemptive | false | boolean | If this option is true camel-http4 sends preemptive basic authentication to the server.
-
-| bridgeEndpoint | false | boolean | 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.
-
-| chunked | true | boolean | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response
-
-| clearExpiredCookies | true | boolean | 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.
-
-| connectionClose | false | boolean | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false.
-
-| cookieStore | | CookieStore | 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.
-
-| copyHeaders | true | boolean | 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).
-
-| deleteWithBody | false | boolean | 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.
-
-| httpMethod | | HttpMethods | Configure the HTTP method to use. The HttpMethod header cannot override this option if set.
-
-| ignoreResponseBody | false | boolean | If this option is true The http producer won't read response body and cache the input stream
-
-| preserveHostHeader | false | boolean | 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
-
-| throwExceptionOnFailure | true | boolean | 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.
-
-| transferException | false | boolean | 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.
- 4+^s| producer (advanced)
-| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session
-
-| okStatusCodeRange | 200-299 | String | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included.
-
-| urlRewrite | | UrlRewrite | 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
- 4+^s| advanced
-| clientBuilder | | HttpClientBuilder | Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint.
-
-| clientConnectionManager | | HttpClientConnectionManager | To use a custom HttpClientConnectionManager to manage connections
-
-| connectionsPerRoute | 20 | int | The maximum number of connections per route.
-
-| httpClient | | HttpClient | Sets a custom HttpClient to be used by the producer
-
-| httpClientConfigurer | | HttpClientConfigurer | Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc
-
-| httpClientOptions | | Map | To configure the HttpClient using the key/values from the Map.
-
-| httpContext | | HttpContext | To use a custom HttpContext instance
-
-| mapHttpMessageBody | true | boolean | 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.
-
-| mapHttpMessageFormUrlEncodedBody | true | boolean | 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.
-
-| mapHttpMessageHeaders | true | boolean | 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.
-
-| maxTotalConnections | 200 | int | The maximum number of connections.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| useSystemProperties | false | boolean | To use System Properties as fallback for configuration
- 4+^s| proxy
-| proxyAuthDomain | | String | Proxy authentication domain to use with NTML
-
-| proxyAuthHost | | String | Proxy authentication host
-
-| proxyAuthMethod | | String | Proxy authentication method to use
-
-| proxyAuthPassword | | String | Proxy authentication password
-
-| proxyAuthPort | | int | Proxy authentication port
-
-| proxyAuthScheme | | String | Proxy authentication scheme to use
-
-| proxyAuthUsername | | String | Proxy authentication username
-
-| proxyHost | | String | Proxy hostname to use
-
-| proxyPort | | int | Proxy port to use
- 4+^s| security
-| authDomain | | String | Authentication domain to use with NTML
-
-| authHost | | String | Authentication host to use with NTML
-
-| authMethod | | String | Authentication methods allowed to use as a comma separated list of values Basic Digest or NTLM.
-
-| authMethodPriority | | String | Which authentication method to prioritize to use either as Basic Digest or NTLM.
-
-| authPassword | | String | Authentication password
-
-| authUsername | | String | Authentication username
-
-| x509HostnameVerifier | | HostnameVerifier | To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or org.apache.http.conn.ssl.NoopHostnameVerifier.
+| Name | Description | Default | Type
+| **disableStreamCache** (common) | 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 respon
se body stream but use the response stream as-is as the message body. | false | boolean
+| **headerFilterStrategy** (common) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **httpBinding** (common) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding
+| **authenticationPreemptive** (producer) | If this option is true camel-http4 sends preemptive basic authentication to the server. | false | boolean
+| **bridgeEndpoint** (producer) | 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. | false | boolean
+| **chunked** (producer) | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response | true | boolean
+| **clearExpiredCookies** (producer) | 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. | true | boolean
+| **connectionClose** (producer) | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. | false | boolean
+| **cookieStore** (producer) | 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. | | CookieStore
+| **copyHeaders** (producer) | 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). | true | boolean
+| **deleteWithBody** (producer) | 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. | false | boolean
+| **httpMethod** (producer) | Configure the HTTP method to use. The HttpMethod header cannot override this option if set. | | HttpMethods
+| **ignoreResponseBody** (producer) | If this option is true The http producer won't read response body and cache the input stream | false | boolean
+| **preserveHostHeader** (producer) | 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 | false | boolean
+| **throwExceptionOnFailure** (producer) | 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. | true | boolean
+| **transferException** (producer) | 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. | false | boolean
+| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler
+| **okStatusCodeRange** (producer) | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. | 200-299 | String
+| **urlRewrite** (producer) | 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 | | UrlRewrite
+| **clientBuilder** (advanced) | Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint. | | HttpClientBuilder
+| **clientConnectionManager** (advanced) | To use a custom HttpClientConnectionManager to manage connections | | HttpClientConnection Manager
+| **connectionsPerRoute** (advanced) | The maximum number of connections per route. | 20 | int
+| **httpClient** (advanced) | Sets a custom HttpClient to be used by the producer | | HttpClient
+| **httpClientConfigurer** (advanced) | Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc | | HttpClientConfigurer
+| **httpClientOptions** (advanced) | To configure the HttpClient using the key/values from the Map. | | Map
+| **httpContext** (advanced) | To use a custom HttpContext instance | | HttpContext
+| **mapHttpMessageBody** (advanced) | 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. | true | boolean
+| **mapHttpMessageFormUrl EncodedBody** (advanced) | 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. | true | boolean
+| **mapHttpMessageHeaders** (advanced) | 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. | true | boolean
+| **maxTotalConnections** (advanced) | The maximum number of connections. | 200 | int
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **useSystemProperties** (advanced) | To use System Properties as fallback for configuration | false | boolean
+| **proxyAuthDomain** (proxy) | Proxy authentication domain to use with NTML | | String
+| **proxyAuthHost** (proxy) | Proxy authentication host | | String
+| **proxyAuthMethod** (proxy) | Proxy authentication method to use | | String
+| **proxyAuthPassword** (proxy) | Proxy authentication password | | String
+| **proxyAuthPort** (proxy) | Proxy authentication port | | int
+| **proxyAuthScheme** (proxy) | Proxy authentication scheme to use | | String
+| **proxyAuthUsername** (proxy) | Proxy authentication username | | String
+| **proxyHost** (proxy) | Proxy hostname to use | | String
+| **proxyPort** (proxy) | Proxy port to use | | int
+| **authDomain** (security) | Authentication domain to use with NTML | | String
+| **authHost** (security) | Authentication host to use with NTML | | String
+| **authMethod** (security) | Authentication methods allowed to use as a comma separated list of values Basic Digest or NTLM. | | String
+| **authMethodPriority** (security) | Which authentication method to prioritize to use either as Basic Digest or NTLM. | | String
+| **authPassword** (security) | Authentication password | | String
+| **authUsername** (security) | Authentication username | | String
+| **x509HostnameVerifier** (security) | To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or org.apache.http.conn.ssl.NoopHostnameVerifier. | | HostnameVerifier
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ibatis/src/main/docs/ibatis-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ibatis/src/main/docs/ibatis-component.adoc b/components/camel-ibatis/src/main/docs/ibatis-component.adoc
index 8c92e15..2eddd0d 100644
--- a/components/camel-ibatis/src/main/docs/ibatis-component.adoc
+++ b/components/camel-ibatis/src/main/docs/ibatis-component.adoc
@@ -60,17 +60,13 @@ The iBatis component supports 4 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| sqlMapClient | | SqlMapClient | To use the given com.ibatis.sqlmap.client.SqlMapClient
- 4+^s| common
-| sqlMapConfig | classpath:SqlMapConfig.xml | String | Location of iBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath
-
-| useTransactions | true | boolean | Whether to use transactions. This option is by default true.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **sqlMapClient** (advanced) | To use the given com.ibatis.sqlmap.client.SqlMapClient | | SqlMapClient
+| **sqlMapConfig** (common) | Location of iBatis xml configuration file. The default value is: SqlMapConfig.xml loaded from the classpath | classpath:SqlMapConfig.xml | String
+| **useTransactions** (common) | Whether to use transactions. This option is by default true. | true | boolean
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -90,71 +86,44 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| statement | | String | *Required* The statement name in the iBatis XML mapping file which maps to the query insert update or delete operation you wish to evaluate.
+| Name | Description | Default | Type
+| **statement** | *Required* The statement name in the iBatis XML mapping file which maps to the query insert update or delete operation you wish to evaluate. | | String
|=======================================================================
#### Query Parameters (27 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| isolation | TRANSACTION_REPEATABLE_READ | String | Transaction isolation level
-
-| useTransactions | true | boolean | Whether to use transactions. This option is by default true.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| maxMessagesPerPoll | 0 | int | This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges. This integer defines the maximum messages to deliver in single exchange. 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 disable it.
-
-| onConsume | | String | Statement to run after data has been processed in the route
-
-| routeEmptyResultSet | false | boolean | Whether allow empty resultset to be routed to the next hop
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| strategy | | IBatisProcessingStrategy | Allows to plugin a custom IBatisProcessingStrategy to use by the consumer.
-
-| useIterator | true | boolean | Process resultset individually or as a list
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| producer
-| statementType | | StatementType | Mandatory to specify for the producer to control which kind of operation to invoke.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **isolation** (common) | Transaction isolation level | TRANSACTION_REPEATABLE_READ | String
+| **useTransactions** (common) | Whether to use transactions. This option is by default true. | true | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **maxMessagesPerPoll** (consumer) | This option is intended to split results returned by the database pool into the batches and deliver them in multiple exchanges. This integer defines the maximum messages to deliver in single exchange. 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 disable it. | 0 | int
+| **onConsume** (consumer) | Statement to run after data has been processed in the route | | String
+| **routeEmptyResultSet** (consumer) | Whether allow empty resultset to be routed to the next hop | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **strategy** (consumer) | Allows to plugin a custom IBatisProcessingStrategy to use by the consumer. | | IBatisProcessing Strategy
+| **useIterator** (consumer) | Process resultset individually or as a list | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **statementType** (producer) | Mandatory to specify for the producer to control which kind of operation to invoke. | | StatementType
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-infinispan/src/main/docs/infinispan-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-infinispan/src/main/docs/infinispan-component.adoc b/components/camel-infinispan/src/main/docs/infinispan-component.adoc
index 446ef8b..9dfa579 100644
--- a/components/camel-infinispan/src/main/docs/infinispan-component.adoc
+++ b/components/camel-infinispan/src/main/docs/infinispan-component.adoc
@@ -53,45 +53,31 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* Specifies the host of the cache on Infinispan instance
+| Name | Description | Default | Type
+| **host** | *Required* Specifies the host of the cache on Infinispan instance | | String
|=======================================================================
#### Query Parameters (14 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| cacheContainer | | BasicCacheContainer | Specifies the cache Container to connect
-
-| cacheName | | String | Specifies the cache name
-
-| queryBuilder | | InfinispanQueryBuilder | Specifies the query builder.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| clusteredListener | false | boolean | If true the listener will be installed for the entire cluster
-
-| customListener | | InfinispanCustomListener | Returns the custom listener in use if provided
-
-| eventTypes | | String | 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
-
-| sync | true | boolean | If true the consumer will receive notifications synchronously
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| command | put | String | The operation to perform.
- 4+^s| advanced
-| configurationUri | | String | An implementation specific URI for the CacheManager
-
-| flags | | String | A comma separated list of Flag to be applied by default on each cache invocation not applicable to remote caches.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **cacheContainer** (common) | Specifies the cache Container to connect | | BasicCacheContainer
+| **cacheName** (common) | Specifies the cache name | | String
+| **queryBuilder** (common) | Specifies the query builder. | | InfinispanQueryBuilder
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **clusteredListener** (consumer) | If true the listener will be installed for the entire cluster | false | boolean
+| **customListener** (consumer) | Returns the custom listener in use if provided | | InfinispanCustom Listener
+| **eventTypes** (consumer) | 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 | | String
+| **sync** (consumer) | If true the consumer will receive notifications synchronously | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **command** (producer) | The operation to perform. | put | String
+| **configurationUri** (advanced) | An implementation specific URI for the CacheManager | | String
+| **flags** (advanced) | A comma separated list of Flag to be applied by default on each cache invocation not applicable to remote caches. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
[28/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/ref-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/ref-component.adoc b/camel-core/src/main/docs/ref-component.adoc
index f7e9318..67767cf 100644
--- a/camel-core/src/main/docs/ref-component.adoc
+++ b/camel-core/src/main/docs/ref-component.adoc
@@ -33,25 +33,21 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* Name of endpoint to lookup in the registry.
+| Name | Description | Default | Type
+| **name** | *Required* Name of endpoint to lookup in the registry. | | String
|=======================================================================
#### Query Parameters (4 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/rest-api-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/rest-api-component.adoc b/camel-core/src/main/docs/rest-api-component.adoc
index 43b19ef..c66121d 100644
--- a/camel-core/src/main/docs/rest-api-component.adoc
+++ b/camel-core/src/main/docs/rest-api-component.adoc
@@ -494,30 +494,24 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| path | | String | *Required* The base path
-| contextIdPattern | | String | Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern.
+| Name | Description | Default | Type
+| **path** | *Required* The base path | | String
+| **contextIdPattern** | Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern. | | String
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| apiComponentName | | String | The Camel Rest API component to use for generating the API of the REST services such as swagger.
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| componentName | | String | The Camel Rest component to use for the REST transport such as restlet spark-rest. If no component has been explicit configured then Camel will lookup if there is a Camel component that integrates with the Rest DSL or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found then that is being used.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **apiComponentName** (consumer) | The Camel Rest API component to use for generating the API of the REST services such as swagger. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **componentName** (consumer) | The Camel Rest component to use for the REST transport such as restlet spark-rest. If no component has been explicit configured then Camel will lookup if there is a Camel component that integrates with the Rest DSL or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found then that is being used. | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/rest-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/rest-component.adoc b/camel-core/src/main/docs/rest-component.adoc
index 0c73b4f..0bbce46 100644
--- a/camel-core/src/main/docs/rest-component.adoc
+++ b/camel-core/src/main/docs/rest-component.adoc
@@ -22,17 +22,13 @@ The REST component supports 4 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| componentName | | String | The Camel Rest component to use for the REST transport such as restlet spark-rest. If no component has been explicit configured then Camel will lookup if there is a Camel component that integrates with the Rest DSL or if a org.apache.camel.spi.RestConsumerFactory (consumer) or org.apache.camel.spi.RestProducerFactory (producer) is registered in the registry. If either one is found then that is being used.
- 4+^s| producer
-| apiDoc | | String | The swagger api doc resource to use. The resource is loaded from classpath by default and must be in JSon format.
-
-| host | | String | Host and port of HTTP service to use (override host in swagger schema)
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **componentName** (common) | The Camel Rest component to use for the REST transport such as restlet spark-rest. If no component has been explicit configured then Camel will lookup if there is a Camel component that integrates with the Rest DSL or if a org.apache.camel.spi.RestConsumerFactory (consumer) or org.apache.camel.spi.RestProducerFactory (producer) is registered in the registry. If either one is found then that is being used. | | String
+| **apiDoc** (producer) | The swagger api doc resource to use. The resource is loaded from classpath by default and must be in JSon format. | | String
+| **host** (producer) | Host and port of HTTP service to use (override host in swagger schema) | | String
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -45,47 +41,33 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| method | | String | *Required* HTTP method to use.
-| path | | String | *Required* The base path
-| uriTemplate | | String | The uri template
+| Name | Description | Default | Type
+| **method** | *Required* HTTP method to use. | | String
+| **path** | *Required* The base path | | String
+| **uriTemplate** | The uri template | | String
|=======================================================================
#### Query Parameters (14 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| componentName | | String | The Camel Rest component to use for the REST transport such as restlet spark-rest. If no component has been explicit configured then Camel will lookup if there is a Camel component that integrates with the Rest DSL or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found then that is being used.
-
-| consumes | | String | Media type such as: 'text/xml' or 'application/json' this REST service accepts. By default we accept all kinds of types.
-
-| inType | | String | To declare the incoming POJO binding type as a FQN class name
-
-| outType | | String | To declare the outgoing POJO binding type as a FQN class name
-
-| produces | | String | Media type such as: 'text/xml' or 'application/json' this REST service returns.
-
-| routeId | | String | Name of the route this REST services creates
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| description | | String | Human description to document this REST service
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
- 4+^s| producer
-| apiDoc | | String | The swagger api doc resource to use. The resource is loaded from classpath by default and must be in JSon format.
-
-| host | | String | Host and port of HTTP service to use (override host in swagger schema)
-
-| queryParameters | | String | Query parameters for the HTTP service to call
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **componentName** (common) | The Camel Rest component to use for the REST transport such as restlet spark-rest. If no component has been explicit configured then Camel will lookup if there is a Camel component that integrates with the Rest DSL or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found then that is being used. | | String
+| **consumes** (common) | Media type such as: 'text/xml' or 'application/json' this REST service accepts. By default we accept all kinds of types. | | String
+| **inType** (common) | To declare the incoming POJO binding type as a FQN class name | | String
+| **outType** (common) | To declare the outgoing POJO binding type as a FQN class name | | String
+| **produces** (common) | Media type such as: 'text/xml' or 'application/json' this REST service returns. | | String
+| **routeId** (common) | Name of the route this REST services creates | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **description** (consumer) | Human description to document this REST service | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **apiDoc** (producer) | The swagger api doc resource to use. The resource is loaded from classpath by default and must be in JSon format. | | String
+| **host** (producer) | Host and port of HTTP service to use (override host in swagger schema) | | String
+| **queryParameters** (producer) | Query parameters for the HTTP service to call | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/scheduler-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/scheduler-component.adoc b/camel-core/src/main/docs/scheduler-component.adoc
index bf3ec14..1bb23cb 100644
--- a/camel-core/src/main/docs/scheduler-component.adoc
+++ b/camel-core/src/main/docs/scheduler-component.adoc
@@ -35,13 +35,11 @@ The Scheduler component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| scheduler
-| concurrentTasks | 1 | int | Number of threads used by the scheduling thread pool. Is by default using a single thread
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **concurrentTasks** (scheduler) | Number of threads used by the scheduling thread pool. Is by default using a single thread | 1 | int
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -55,57 +53,37 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* The name of the scheduler
+| Name | Description | Default | Type
+| **name** | *Required* The name of the scheduler | | String
|=======================================================================
#### Query Parameters (20 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. In other words the error occurred while the polling was gathering information for instance access to a file network failed so Camel cannot access it to scan for files. The default implementation will log the caused exception at WARN level and ignore it.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| concurrentTasks | 1 | int | Number of threads used by the scheduling thread pool. Is by default using a single thread
-
-| delay | 500 | long | Milliseconds before the next poll. The default value is 500. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. The default value is 1000. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. This option allows you to share a thread pool among multiple consumers.
-
-| scheduler | none | ScheduledPollConsumerScheduler | Allow to plugin a custom org.apache.camel.spi.ScheduledPollConsumerScheduler to use as the scheduler for firing when the polling consumer runs. The default implementation uses the ScheduledExecutorService and there is a Quartz2 and Spring based which supports CRON expressions. Notice: If using a custom scheduler then the options for initialDelay useFixedDelay timeUnit and scheduledExecutorService may not be in use. Use the text quartz2 to refer to use the Quartz2 scheduler; and use the text spring to use the Spring based; and use the text myScheduler to refer to a custom scheduler by its id in the Registry. See Quartz2 page for an example.
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. In other words the error occurred while the polling was gathering information for instance access to a file network failed so Camel cannot access it to scan for files. The default implementation will log the caused exception at WARN level and ignore it. | | PollingConsumerPoll Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **concurrentTasks** (scheduler) | Number of threads used by the scheduling thread pool. Is by default using a single thread | 1 | int
+| **delay** (scheduler) | Milliseconds before the next poll. The default value is 500. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. The default value is 1000. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. This option allows you to share a thread pool among multiple consumers. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | Allow to plugin a custom org.apache.camel.spi.ScheduledPollConsumerScheduler to use as the scheduler for firing when the polling consumer runs. The default implementation uses the ScheduledExecutorService and there is a Quartz2 and Spring based which supports CRON expressions. Notice: If using a custom scheduler then the options for initialDelay useFixedDelay timeUnit and scheduledExecutorService may not be in use. Use the text quartz2 to refer to use the Quartz2 scheduler; and use the text spring to use the Spring based; and use the text myScheduler to refer to a custom scheduler by its id in the Registry. See Quartz2 page for an example. | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/seda-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/seda-component.adoc b/camel-core/src/main/docs/seda-component.adoc
index 9fb140e..9a0e6c1 100644
--- a/camel-core/src/main/docs/seda-component.adoc
+++ b/camel-core/src/main/docs/seda-component.adoc
@@ -42,17 +42,13 @@ The SEDA component supports 4 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| queueSize | | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold).
- 4+^s| consumer
-| concurrentConsumers | 1 | int | Sets the default number of concurrent threads processing exchanges.
- 4+^s| advanced
-| defaultQueueFactory | | Exchange> | Sets the default queue factory.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **queueSize** (advanced) | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold). | | int
+| **concurrentConsumers** (consumer) | Sets the default number of concurrent threads processing exchanges. | 1 | int
+| **defaultQueueFactory** (advanced) | Sets the default queue factory. | | Exchange>
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -66,49 +62,33 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* Name of queue
+| Name | Description | Default | Type
+| **name** | *Required* Name of queue | | String
|=======================================================================
#### Query Parameters (16 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| size | 2147483647 | int | The maximum capacity of the SEDA queue (i.e. the number of messages it can hold).
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| concurrentConsumers | 1 | int | Number of concurrent threads processing exchanges.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
-
-| limitConcurrentConsumers | true | boolean | Whether to limit the number of concurrentConsumers to the maximum of 500. By default an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off.
-
-| multipleConsumers | false | boolean | Specifies whether multiple consumers are allowed. If enabled you can use SEDA for Publish-Subscribe messaging. That is you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled this option should be specified on every consumer endpoint.
-
-| pollTimeout | 1000 | int | The timeout used when polling. 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.
-
-| purgeWhenStopping | false | boolean | Whether to purge the task queue when stopping the consumer/route. This allows to stop faster as any pending messages on the queue is discarded.
- 4+^s| producer
-| blockWhenFull | false | boolean | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default an exception will be thrown stating that the queue is full. By enabling this option the calling thread will instead block and wait until the message can be accepted.
-
-| discardIfNoConsumers | false | boolean | Whether the producer should discard the message (do not add the message to the queue) when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time.
-
-| failIfNoConsumers | false | boolean | Whether the producer should fail by throwing an exception when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time.
-
-| timeout | 30000 | long | Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value.
-
-| waitForTaskToComplete | IfReplyExpected | WaitForTaskToComplete | 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. The default option is IfReplyExpected.
- 4+^s| advanced
-| queue | | BlockingQueue | Define the queue instance which will be used by the endpoint. This option is only for rare use-cases where you want to use a custom queue instance.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **size** (common) | The maximum capacity of the SEDA queue (i.e. the number of messages it can hold). | 2147483647 | int
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **concurrentConsumers** (consumer) | Number of concurrent threads processing exchanges. | 1 | int
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **limitConcurrentConsumers** (consumer) | Whether to limit the number of concurrentConsumers to the maximum of 500. By default an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off. | true | boolean
+| **multipleConsumers** (consumer) | Specifies whether multiple consumers are allowed. If enabled you can use SEDA for Publish-Subscribe messaging. That is you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled this option should be specified on every consumer endpoint. | false | boolean
+| **pollTimeout** (consumer) | The timeout used when polling. 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. | 1000 | int
+| **purgeWhenStopping** (consumer) | Whether to purge the task queue when stopping the consumer/route. This allows to stop faster as any pending messages on the queue is discarded. | false | boolean
+| **blockWhenFull** (producer) | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default an exception will be thrown stating that the queue is full. By enabling this option the calling thread will instead block and wait until the message can be accepted. | false | boolean
+| **discardIfNoConsumers** (producer) | Whether the producer should discard the message (do not add the message to the queue) when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time. | false | boolean
+| **failIfNoConsumers** (producer) | Whether the producer should fail by throwing an exception when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time. | false | boolean
+| **timeout** (producer) | Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value. | 30000 | long
+| **waitForTaskToComplete** (producer) | 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. The default option is IfReplyExpected. | IfReplyExpected | WaitForTaskToComplete
+| **queue** (advanced) | Define the queue instance which will be used by the endpoint. This option is only for rare use-cases where you want to use a custom queue instance. | | BlockingQueue
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/stub-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/stub-component.adoc b/camel-core/src/main/docs/stub-component.adoc
index 5ee3597..934f2ee 100644
--- a/camel-core/src/main/docs/stub-component.adoc
+++ b/camel-core/src/main/docs/stub-component.adoc
@@ -32,17 +32,13 @@ The Stub component supports 4 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| queueSize | | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold).
- 4+^s| consumer
-| concurrentConsumers | 1 | int | Sets the default number of concurrent threads processing exchanges.
- 4+^s| advanced
-| defaultQueueFactory | | Exchange> | Sets the default queue factory.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **queueSize** (advanced) | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold). | | int
+| **concurrentConsumers** (consumer) | Sets the default number of concurrent threads processing exchanges. | 1 | int
+| **defaultQueueFactory** (advanced) | Sets the default queue factory. | | Exchange>
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -56,49 +52,33 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* Name of queue
+| Name | Description | Default | Type
+| **name** | *Required* Name of queue | | String
|=======================================================================
#### Query Parameters (16 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| size | 2147483647 | int | The maximum capacity of the SEDA queue (i.e. the number of messages it can hold).
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| concurrentConsumers | 1 | int | Number of concurrent threads processing exchanges.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
-
-| limitConcurrentConsumers | true | boolean | Whether to limit the number of concurrentConsumers to the maximum of 500. By default an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off.
-
-| multipleConsumers | false | boolean | Specifies whether multiple consumers are allowed. If enabled you can use SEDA for Publish-Subscribe messaging. That is you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled this option should be specified on every consumer endpoint.
-
-| pollTimeout | 1000 | int | The timeout used when polling. 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.
-
-| purgeWhenStopping | false | boolean | Whether to purge the task queue when stopping the consumer/route. This allows to stop faster as any pending messages on the queue is discarded.
- 4+^s| producer
-| blockWhenFull | false | boolean | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default an exception will be thrown stating that the queue is full. By enabling this option the calling thread will instead block and wait until the message can be accepted.
-
-| discardIfNoConsumers | false | boolean | Whether the producer should discard the message (do not add the message to the queue) when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time.
-
-| failIfNoConsumers | false | boolean | Whether the producer should fail by throwing an exception when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time.
-
-| timeout | 30000 | long | Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value.
-
-| waitForTaskToComplete | IfReplyExpected | WaitForTaskToComplete | 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. The default option is IfReplyExpected.
- 4+^s| advanced
-| queue | | BlockingQueue | Define the queue instance which will be used by the endpoint. This option is only for rare use-cases where you want to use a custom queue instance.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **size** (common) | The maximum capacity of the SEDA queue (i.e. the number of messages it can hold). | 2147483647 | int
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **concurrentConsumers** (consumer) | Number of concurrent threads processing exchanges. | 1 | int
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **limitConcurrentConsumers** (consumer) | Whether to limit the number of concurrentConsumers to the maximum of 500. By default an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off. | true | boolean
+| **multipleConsumers** (consumer) | Specifies whether multiple consumers are allowed. If enabled you can use SEDA for Publish-Subscribe messaging. That is you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled this option should be specified on every consumer endpoint. | false | boolean
+| **pollTimeout** (consumer) | The timeout used when polling. 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. | 1000 | int
+| **purgeWhenStopping** (consumer) | Whether to purge the task queue when stopping the consumer/route. This allows to stop faster as any pending messages on the queue is discarded. | false | boolean
+| **blockWhenFull** (producer) | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default an exception will be thrown stating that the queue is full. By enabling this option the calling thread will instead block and wait until the message can be accepted. | false | boolean
+| **discardIfNoConsumers** (producer) | Whether the producer should discard the message (do not add the message to the queue) when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time. | false | boolean
+| **failIfNoConsumers** (producer) | Whether the producer should fail by throwing an exception when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time. | false | boolean
+| **timeout** (producer) | Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value. | 30000 | long
+| **waitForTaskToComplete** (producer) | 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. The default option is IfReplyExpected. | IfReplyExpected | WaitForTaskToComplete
+| **queue** (advanced) | Define the queue instance which will be used by the endpoint. This option is only for rare use-cases where you want to use a custom queue instance. | | BlockingQueue
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/test-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/test-component.adoc b/camel-core/src/main/docs/test-component.adoc
index 62c596c..6bcd702 100644
--- a/camel-core/src/main/docs/test-component.adoc
+++ b/camel-core/src/main/docs/test-component.adoc
@@ -66,45 +66,31 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* Name of endpoint to lookup in the registry to use for polling messages used for testing
+| Name | Description | Default | Type
+| **name** | *Required* Name of endpoint to lookup in the registry to use for polling messages used for testing | | String
|=======================================================================
#### Query Parameters (14 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| anyOrder | false | boolean | Whether the expected messages should arrive in the same order or can be in any order.
-
-| assertPeriod | 0 | long | 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 link 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 link setAssertPeriod(long) method for. By default this period is disabled.
-
-| delimiter | | String | The split delimiter to use when split is enabled. By default the delimiter is new line based. The delimiter can be a regular expression.
-
-| expectedCount | -1 | int | 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 link 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 link 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 link setAssertPeriod(long) method for further details.
-
-| reportGroup | | int | A number that is used to turn on throughput logging based on groups of the size.
-
-| resultMinimumWaitTime | 0 | long | Sets the minimum expected amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied
-
-| resultWaitTime | 0 | long | Sets the maximum amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied
-
-| retainFirst | -1 | int | 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 link 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 link getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received.
-
-| retainLast | -1 | int | 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 link 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 link getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received.
-
-| sleepForEmptyTest | 0 | long | Allows a sleep to be specified to wait to check that this endpoint really is empty when link expectedMessageCount(int) is called with zero
-
-| split | false | boolean | If enabled the the messages loaded from the test endpoint will be split using \n\r delimiters (new lines) 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.
-
-| timeout | 2000 | long | The timeout to use when polling for message bodies from the URI
- 4+^s| producer (advanced)
-| copyOnExchange | true | boolean | Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **anyOrder** (producer) | Whether the expected messages should arrive in the same order or can be in any order. | false | boolean
+| **assertPeriod** (producer) | 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 link 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 link setAssertPeriod(long) method for. By default this period is disabled. | 0 | long
+| **delimiter** (producer) | The split delimiter to use when split is enabled. By default the delimiter is new line based. The delimiter can be a regular expression. | | String
+| **expectedCount** (producer) | 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 link 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 link 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 link setAssertPeriod(long) method for further details. | -1 | int
+| **reportGroup** (producer) | A number that is used to turn on throughput logging based on groups of the size. | | int
+| **resultMinimumWaitTime** (producer) | Sets the minimum expected amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied | 0 | long
+| **resultWaitTime** (producer) | Sets the maximum amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied | 0 | long
+| **retainFirst** (producer) | 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 link 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 link getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received. | -1 | int
+| **retainLast** (producer) | 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 link 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 link getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received. | -1 | int
+| **sleepForEmptyTest** (producer) | Allows a sleep to be specified to wait to check that this endpoint really is empty when link expectedMessageCount(int) is called with zero | 0 | long
+| **split** (producer) | If enabled the the messages loaded from the test endpoint will be split using \n\r delimiters (new lines) 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. | false | boolean
+| **timeout** (producer) | The timeout to use when polling for message bodies from the URI | 2000 | long
+| **copyOnExchange** (producer) | Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/timer-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/timer-component.adoc b/camel-core/src/main/docs/timer-component.adoc
index 7da0853..e307872 100644
--- a/camel-core/src/main/docs/timer-component.adoc
+++ b/camel-core/src/main/docs/timer-component.adoc
@@ -48,41 +48,29 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| timerName | | String | *Required* The name of the timer
+| Name | Description | Default | Type
+| **timerName** | *Required* The name of the timer | | String
|=======================================================================
#### Query Parameters (12 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| delay | 1000 | long | The number of milliseconds to wait before the first event is generated. Should not be used in conjunction with the time option. The default value is 1000. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| fixedRate | false | boolean | Events take place at approximately regular intervals separated by the specified period.
-
-| period | 1000 | long | If greater than 0 generate periodic events every period milliseconds. The default value is 1000. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| repeatCount | 0 | long | Specifies a maximum limit of number of fires. So if you set it to 1 the timer will only fire once. If you set it to 5 it will only fire five times. A value of zero or negative means fire forever.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
- 4+^s| advanced
-| daemon | true | boolean | Specifies whether or not the thread associated with the timer endpoint runs as a daemon. The default value is true.
-
-| pattern | | String | Allows you to specify a custom Date pattern to use for setting the time option using URI syntax.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| time | | Date | A java.util.Date the first event should be generated. If using the URI the pattern expected is: yyyy-MM-dd HH:mm:ss or yyyy-MM-dd'T'HH:mm:ss.
-
-| timer | | Timer | To use a custom Timer
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **delay** (consumer) | The number of milliseconds to wait before the first event is generated. Should not be used in conjunction with the time option. The default value is 1000. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **fixedRate** (consumer) | Events take place at approximately regular intervals separated by the specified period. | false | boolean
+| **period** (consumer) | If greater than 0 generate periodic events every period milliseconds. The default value is 1000. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **repeatCount** (consumer) | Specifies a maximum limit of number of fires. So if you set it to 1 the timer will only fire once. If you set it to 5 it will only fire five times. A value of zero or negative means fire forever. | 0 | long
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **daemon** (advanced) | Specifies whether or not the thread associated with the timer endpoint runs as a daemon. The default value is true. | true | boolean
+| **pattern** (advanced) | Allows you to specify a custom Date pattern to use for setting the time option using URI syntax. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **time** (advanced) | A java.util.Date the first event should be generated. If using the URI the pattern expected is: yyyy-MM-dd HH:mm:ss or yyyy-MM-dd'T'HH:mm:ss. | | Date
+| **timer** (advanced) | To use a custom Timer | | Timer
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/validator-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/validator-component.adoc b/camel-core/src/main/docs/validator-component.adoc
index 3911e16..8fba3db 100644
--- a/camel-core/src/main/docs/validator-component.adoc
+++ b/camel-core/src/main/docs/validator-component.adoc
@@ -56,13 +56,11 @@ The Validator component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| resourceResolverFactory | | ValidatorResourceResolverFactory | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **resourceResolverFactory** (advanced) | To use a custom LSResourceResolver which depends on a dynamic endpoint resource URI | | ValidatorResource ResolverFactory
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -76,39 +74,28 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| resourceUri | | String | *Required* URL to a local resource on the classpathor a reference to lookup a bean in the Registry or a full URL to a remote resource or resource on the file system which contains the XSD to validate against.
+| Name | Description | Default | Type
+| **resourceUri** | *Required* URL to a local resource on the classpathor a reference to lookup a bean in the Registry or a full URL to a remote resource or resource on the file system which contains the XSD to validate against. | | String
|=======================================================================
#### Query Parameters (11 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| failOnNullBody | true | boolean | Whether to fail if no body exists.
-
-| failOnNullHeader | true | boolean | Whether to fail if no header exists when validating against a header.
-
-| headerName | | String | To validate against a header instead of the message body.
- 4+^s| advanced
-| errorHandler | | ValidatorErrorHandler | To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler. The default error handler captures the errors and throws an exception.
-
-| resourceResolver | | LSResourceResolver | To use a custom LSResourceResolver. See also link setResourceResolverFactory(ValidatorResourceResolverFactory)
-
-| resourceResolverFactory | | ValidatorResourceResolverFactory | For creating a resource resolver which depends on the endpoint resource URI. Must not be used in combination with method link setResourceResolver(LSResourceResolver). If not set then DefaultValidatorResourceResolverFactory is used
-
-| schemaFactory | | SchemaFactory | To use a custom javax.xml.validation.SchemaFactory
-
-| schemaLanguage | http://www.w3.org/2001/XMLSchema | String | Configures the W3C XML Schema Namespace URI.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| useDom | false | boolean | Whether DOMSource/DOMResult or SaxSource/SaxResult should be used by the validator.
-
-| useSharedSchema | true | boolean | Whether the Schema instance should be shared or not. This option is introduced to work around a JDK 1.6.x bug. Xerces should not have this issue.
+| Name | Description | Default | Type
+| **failOnNullBody** (producer) | Whether to fail if no body exists. | true | boolean
+| **failOnNullHeader** (producer) | Whether to fail if no header exists when validating against a header. | true | boolean
+| **headerName** (producer) | To validate against a header instead of the message body. | | String
+| **errorHandler** (advanced) | To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler. The default error handler captures the errors and throws an exception. | | ValidatorErrorHandler
+| **resourceResolver** (advanced) | To use a custom LSResourceResolver. See also link setResourceResolverFactory(ValidatorResourceResolverFactory) | | LSResourceResolver
+| **resourceResolverFactory** (advanced) | For creating a resource resolver which depends on the endpoint resource URI. Must not be used in combination with method link setResourceResolver(LSResourceResolver). If not set then DefaultValidatorResourceResolverFactory is used | | ValidatorResource ResolverFactory
+| **schemaFactory** (advanced) | To use a custom javax.xml.validation.SchemaFactory | | SchemaFactory
+| **schemaLanguage** (advanced) | Configures the W3C XML Schema Namespace URI. | http://www.w3.org/2001/XMLSchema | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **useDom** (advanced) | Whether DOMSource/DOMResult or SaxSource/SaxResult should be used by the validator. | false | boolean
+| **useSharedSchema** (advanced) | Whether the Schema instance should be shared or not. This option is introduced to work around a JDK 1.6.x bug. Xerces should not have this issue. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/vm-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/vm-component.adoc b/camel-core/src/main/docs/vm-component.adoc
index bc81a7b..b918eb9 100644
--- a/camel-core/src/main/docs/vm-component.adoc
+++ b/camel-core/src/main/docs/vm-component.adoc
@@ -65,17 +65,13 @@ The VM component supports 4 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| queueSize | | int | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold).
- 4+^s| consumer
-| concurrentConsumers | 1 | int | Sets the default number of concurrent threads processing exchanges.
- 4+^s| advanced
-| defaultQueueFactory | | Exchange> | Sets the default queue factory.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **queueSize** (advanced) | Sets the default maximum capacity of the SEDA queue (i.e. the number of messages it can hold). | | int
+| **concurrentConsumers** (consumer) | Sets the default number of concurrent threads processing exchanges. | 1 | int
+| **defaultQueueFactory** (advanced) | Sets the default queue factory. | | Exchange>
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -89,49 +85,33 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* Name of queue
+| Name | Description | Default | Type
+| **name** | *Required* Name of queue | | String
|=======================================================================
#### Query Parameters (16 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| size | 2147483647 | int | The maximum capacity of the SEDA queue (i.e. the number of messages it can hold).
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| concurrentConsumers | 1 | int | Number of concurrent threads processing exchanges.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
-
-| limitConcurrentConsumers | true | boolean | Whether to limit the number of concurrentConsumers to the maximum of 500. By default an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off.
-
-| multipleConsumers | false | boolean | Specifies whether multiple consumers are allowed. If enabled you can use SEDA for Publish-Subscribe messaging. That is you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled this option should be specified on every consumer endpoint.
-
-| pollTimeout | 1000 | int | The timeout used when polling. 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.
-
-| purgeWhenStopping | false | boolean | Whether to purge the task queue when stopping the consumer/route. This allows to stop faster as any pending messages on the queue is discarded.
- 4+^s| producer
-| blockWhenFull | false | boolean | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default an exception will be thrown stating that the queue is full. By enabling this option the calling thread will instead block and wait until the message can be accepted.
-
-| discardIfNoConsumers | false | boolean | Whether the producer should discard the message (do not add the message to the queue) when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time.
-
-| failIfNoConsumers | false | boolean | Whether the producer should fail by throwing an exception when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time.
-
-| timeout | 30000 | long | Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value.
-
-| waitForTaskToComplete | IfReplyExpected | WaitForTaskToComplete | 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. The default option is IfReplyExpected.
- 4+^s| advanced
-| queue | | BlockingQueue | Define the queue instance which will be used by the endpoint. This option is only for rare use-cases where you want to use a custom queue instance.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **size** (common) | The maximum capacity of the SEDA queue (i.e. the number of messages it can hold). | 2147483647 | int
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **concurrentConsumers** (consumer) | Number of concurrent threads processing exchanges. | 1 | int
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **limitConcurrentConsumers** (consumer) | Whether to limit the number of concurrentConsumers to the maximum of 500. By default an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off. | true | boolean
+| **multipleConsumers** (consumer) | Specifies whether multiple consumers are allowed. If enabled you can use SEDA for Publish-Subscribe messaging. That is you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled this option should be specified on every consumer endpoint. | false | boolean
+| **pollTimeout** (consumer) | The timeout used when polling. 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. | 1000 | int
+| **purgeWhenStopping** (consumer) | Whether to purge the task queue when stopping the consumer/route. This allows to stop faster as any pending messages on the queue is discarded. | false | boolean
+| **blockWhenFull** (producer) | Whether a thread that sends messages to a full SEDA queue will block until the queue's capacity is no longer exhausted. By default an exception will be thrown stating that the queue is full. By enabling this option the calling thread will instead block and wait until the message can be accepted. | false | boolean
+| **discardIfNoConsumers** (producer) | Whether the producer should discard the message (do not add the message to the queue) when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time. | false | boolean
+| **failIfNoConsumers** (producer) | Whether the producer should fail by throwing an exception when sending to a queue with no active consumers. Only one of the options discardIfNoConsumers and failIfNoConsumers can be enabled at the same time. | false | boolean
+| **timeout** (producer) | Timeout (in milliseconds) before a SEDA producer will stop waiting for an asynchronous task to complete. You can disable timeout by using 0 or a negative value. | 30000 | long
+| **waitForTaskToComplete** (producer) | 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. The default option is IfReplyExpected. | IfReplyExpected | WaitForTaskToComplete
+| **queue** (advanced) | Define the queue instance which will be used by the endpoint. This option is only for rare use-cases where you want to use a custom queue instance. | | BlockingQueue
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
[07/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc
index 623e40a..cbd0e2b 100644
--- a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc
+++ b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc
@@ -53,133 +53,76 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| hostname | | String | *Required* The hostname of the running rabbitmq instance or cluster.
-| portNumber | 5672 | int | *Required* Port number for the host with the running rabbitmq instance or cluster. Default value is 5672.
-| exchangeName | | String | *Required* The exchange name determines which exchange produced messages will sent to. In the case of consumers the exchange name determines which exchange the queue will bind to.
+| Name | Description | Default | Type
+| **hostname** | *Required* The hostname of the running rabbitmq instance or cluster. | | String
+| **portNumber** | *Required* Port number for the host with the running rabbitmq instance or cluster. Default value is 5672. | 5672 | int
+| **exchangeName** | *Required* The exchange name determines which exchange produced messages will sent to. In the case of consumers the exchange name determines which exchange the queue will bind to. | | String
|=======================================================================
#### Query Parameters (57 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| autoDelete | true | boolean | If it is true the exchange will be deleted when it is no longer in use
-
-| connectionTimeout | 60000 | int | Connection timeout
-
-| deadLetterExchange | | String | The name of the dead letter exchange
-
-| deadLetterExchangeType | direct | String | The type of the dead letter exchange
-
-| deadLetterQueue | | String | The name of the dead letter queue
-
-| deadLetterRoutingKey | | String | The routing key for the dead letter exchange
-
-| declare | true | boolean | If the option is true camel declare the exchange and queue name and bind them together. If the option is false camel won't declare the exchange and queue name on the server.
-
-| durable | true | boolean | If we are declaring a durable exchange (the exchange will survive a server restart)
-
-| exchangeType | direct | String | The exchange type such as direct or topic.
-
-| exclusive | false | boolean | Exclusive queues may only be accessed by the current connection and are deleted when that connection closes.
-
-| queue | | String | The queue to receive messages from
-
-| routingKey | | String | The routing key to use when binding a consumer queue to the exchange. For producer routing keys you set the header rabbitmq.ROUTING_KEY.
-
-| skipExchangeDeclare | false | boolean | This can be used if we need to declare the queue but not the exchange
-
-| skipQueueBind | false | boolean | If true the queue will not be bound to the exchange after declaring it
-
-| skipQueueDeclare | false | boolean | If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key.
-
-| vhost | / | String | The vhost for the channel
- 4+^s| consumer
-| autoAck | true | boolean | If messages should be auto acknowledged
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| concurrentConsumers | 1 | int | Number of concurrent consumers when consuming from broker. (eg similar as to the same option for the JMS component).
-
-| prefetchCount | | int | The maximum number of messages that the server will deliver 0 if unlimited. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time
-
-| prefetchEnabled | false | boolean | Enables the quality of service on the RabbitMQConsumer side. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time
-
-| prefetchGlobal | false | boolean | If the settings should be applied to the entire channel rather than each consumer You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time
-
-| prefetchSize | | int | The maximum amount of content (measured in octets) that the server will deliver 0 if unlimited. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| threadPoolSize | 10 | int | The consumer uses a Thread Pool Executor with a fixed number of threads. This setting allows you to set that number of threads.
- 4+^s| producer
-| bridgeEndpoint | false | boolean | If the bridgeEndpoint is true the producer will ignore the message header of rabbitmq.EXCHANGE_NAME and rabbitmq.ROUTING_KEY
-
-| channelPoolMaxSize | 10 | int | Get maximum number of opened channel in pool
-
-| channelPoolMaxWait | 1000 | long | Set the maximum number of milliseconds to wait for a channel from the pool
-
-| guaranteedDeliveries | false | boolean | When true an exception will be thrown when the message cannot be delivered (basic.return) and the message is marked as mandatory. PublisherAcknowledgement will also be activated in this case See also publisher acknowledgements - When will messages be confirmed
-
-| immediate | false | boolean | This flag tells the server how to react if the message cannot be routed to a queue consumer immediately. If this flag is set the server will return an undeliverable message with a Return method. If this flag is zero the server will queue the message but with no guarantee that it will ever be consumed. If the header is present rabbitmq.IMMEDIATE it will override this option.
-
-| mandatory | false | boolean | This flag tells the server how to react if the message cannot be routed to a queue. If this flag is set the server will return an unroutable message with a Return method. If this flag is zero the server silently drops the message. If the header is present rabbitmq.MANDATORY it will override this option.
-
-| publisherAcknowledgements | false | boolean | When true the message will be published with publisher acknowledgements turned on
-
-| publisherAcknowledgementsTimeout | | long | The amount of time in milliseconds to wait for a basic.ack response from RabbitMQ server
- 4+^s| advanced
-| addresses | | Address[] | If this option is set camel-rabbitmq will try to create connection based on the setting of option addresses. The addresses value is a string which looks like server1:12345 server2:12345
-
-| args | | Map | Specify arguments for configuring the different RabbitMQ concepts a different prefix is required for each: Exchange: arg.exchange. Queue: arg.queue. Binding: arg.binding. For example to declare a queue with message ttl argument: http://localhost:5672/exchange/queueargs=arg.queue.x-message-ttl=60000
-
-| automaticRecoveryEnabled | | Boolean | Enables connection automatic recovery (uses connection implementation that performs automatic recovery when connection shutdown is not initiated by the application)
-
-| bindingArgs | | Map | Key/value args for configuring the queue binding parameters when declare=true
-
-| clientProperties | | Map | Connection client properties (client info used in negotiating with the server)
-
-| connectionFactory | | ConnectionFactory | To use a custom RabbitMQ connection factory. When this option is set all connection options (connectionTimeout requestedChannelMax...) set on URI are not used
-
-| exchangeArgs | | Map | Key/value args for configuring the exchange parameters when declare=true
-
-| exchangeArgsConfigurer | | ArgsConfigurer | Set the configurer for setting the exchange args in Channel.exchangeDeclare
-
-| networkRecoveryInterval | | Integer | Network recovery interval in milliseconds (interval used when recovering from network failure)
-
-| queueArgs | | Map | Key/value args for configuring the queue parameters when declare=true
-
-| queueArgsConfigurer | | ArgsConfigurer | Set the configurer for setting the queue args in Channel.queueDeclare
-
-| requestedChannelMax | 0 | int | Connection requested channel max (max number of channels offered)
-
-| requestedFrameMax | 0 | int | Connection requested frame max (max size of frame offered)
-
-| requestedHeartbeat | 60 | int | Connection requested heartbeat (heart-beat in seconds offered)
-
-| requestTimeout | | long | Set timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds)
-
-| requestTimeoutCheckerInterval | | long | Set requestTimeoutCheckerInterval for inOut exchange
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| topologyRecoveryEnabled | | Boolean | Enables connection topology recovery (should topology recovery be performed)
-
-| transferException | false | boolean | When true and an inOut Exchange failed on the consumer side send the caused Exception back in the response
- 4+^s| security
-| password | guest | String | Password for authenticated access
-
-| sslProtocol | | String | Enables SSL on connection accepted value are true TLS and 'SSLv3
-
-| trustManager | | TrustManager | Configure SSL trust manager SSL should be enabled for this option to be effective
-
-| username | guest | String | Username in case of authenticated access
+| Name | Description | Default | Type
+| **autoDelete** (common) | If it is true the exchange will be deleted when it is no longer in use | true | boolean
+| **connectionTimeout** (common) | Connection timeout | 60000 | int
+| **deadLetterExchange** (common) | The name of the dead letter exchange | | String
+| **deadLetterExchangeType** (common) | The type of the dead letter exchange | direct | String
+| **deadLetterQueue** (common) | The name of the dead letter queue | | String
+| **deadLetterRoutingKey** (common) | The routing key for the dead letter exchange | | String
+| **declare** (common) | If the option is true camel declare the exchange and queue name and bind them together. If the option is false camel won't declare the exchange and queue name on the server. | true | boolean
+| **durable** (common) | If we are declaring a durable exchange (the exchange will survive a server restart) | true | boolean
+| **exchangeType** (common) | The exchange type such as direct or topic. | direct | String
+| **exclusive** (common) | Exclusive queues may only be accessed by the current connection and are deleted when that connection closes. | false | boolean
+| **queue** (common) | The queue to receive messages from | | String
+| **routingKey** (common) | The routing key to use when binding a consumer queue to the exchange. For producer routing keys you set the header rabbitmq.ROUTING_KEY. | | String
+| **skipExchangeDeclare** (common) | This can be used if we need to declare the queue but not the exchange | false | boolean
+| **skipQueueBind** (common) | If true the queue will not be bound to the exchange after declaring it | false | boolean
+| **skipQueueDeclare** (common) | If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key. | false | boolean
+| **vhost** (common) | The vhost for the channel | / | String
+| **autoAck** (consumer) | If messages should be auto acknowledged | true | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **concurrentConsumers** (consumer) | Number of concurrent consumers when consuming from broker. (eg similar as to the same option for the JMS component). | 1 | int
+| **prefetchCount** (consumer) | The maximum number of messages that the server will deliver 0 if unlimited. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | | int
+| **prefetchEnabled** (consumer) | Enables the quality of service on the RabbitMQConsumer side. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | false | boolean
+| **prefetchGlobal** (consumer) | If the settings should be applied to the entire channel rather than each consumer You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | false | boolean
+| **prefetchSize** (consumer) | The maximum amount of content (measured in octets) that the server will deliver 0 if unlimited. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time | | int
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **threadPoolSize** (consumer) | The consumer uses a Thread Pool Executor with a fixed number of threads. This setting allows you to set that number of threads. | 10 | int
+| **bridgeEndpoint** (producer) | If the bridgeEndpoint is true the producer will ignore the message header of rabbitmq.EXCHANGE_NAME and rabbitmq.ROUTING_KEY | false | boolean
+| **channelPoolMaxSize** (producer) | Get maximum number of opened channel in pool | 10 | int
+| **channelPoolMaxWait** (producer) | Set the maximum number of milliseconds to wait for a channel from the pool | 1000 | long
+| **guaranteedDeliveries** (producer) | When true an exception will be thrown when the message cannot be delivered (basic.return) and the message is marked as mandatory. PublisherAcknowledgement will also be activated in this case See also publisher acknowledgements - When will messages be confirmed | false | boolean
+| **immediate** (producer) | This flag tells the server how to react if the message cannot be routed to a queue consumer immediately. If this flag is set the server will return an undeliverable message with a Return method. If this flag is zero the server will queue the message but with no guarantee that it will ever be consumed. If the header is present rabbitmq.IMMEDIATE it will override this option. | false | boolean
+| **mandatory** (producer) | This flag tells the server how to react if the message cannot be routed to a queue. If this flag is set the server will return an unroutable message with a Return method. If this flag is zero the server silently drops the message. If the header is present rabbitmq.MANDATORY it will override this option. | false | boolean
+| **publisherAcknowledgements** (producer) | When true the message will be published with publisher acknowledgements turned on | false | boolean
+| **publisherAcknowledgements Timeout** (producer) | The amount of time in milliseconds to wait for a basic.ack response from RabbitMQ server | | long
+| **addresses** (advanced) | If this option is set camel-rabbitmq will try to create connection based on the setting of option addresses. The addresses value is a string which looks like server1:12345 server2:12345 | | Address[]
+| **args** (advanced) | Specify arguments for configuring the different RabbitMQ concepts a different prefix is required for each: Exchange: arg.exchange. Queue: arg.queue. Binding: arg.binding. For example to declare a queue with message ttl argument: http://localhost:5672/exchange/queueargs=arg.queue.x-message-ttl=60000 | | Map
+| **automaticRecoveryEnabled** (advanced) | Enables connection automatic recovery (uses connection implementation that performs automatic recovery when connection shutdown is not initiated by the application) | | Boolean
+| **bindingArgs** (advanced) | Key/value args for configuring the queue binding parameters when declare=true | | Map
+| **clientProperties** (advanced) | Connection client properties (client info used in negotiating with the server) | | Map
+| **connectionFactory** (advanced) | To use a custom RabbitMQ connection factory. When this option is set all connection options (connectionTimeout requestedChannelMax...) set on URI are not used | | ConnectionFactory
+| **exchangeArgs** (advanced) | Key/value args for configuring the exchange parameters when declare=true | | Map
+| **exchangeArgsConfigurer** (advanced) | Set the configurer for setting the exchange args in Channel.exchangeDeclare | | ArgsConfigurer
+| **networkRecoveryInterval** (advanced) | Network recovery interval in milliseconds (interval used when recovering from network failure) | | Integer
+| **queueArgs** (advanced) | Key/value args for configuring the queue parameters when declare=true | | Map
+| **queueArgsConfigurer** (advanced) | Set the configurer for setting the queue args in Channel.queueDeclare | | ArgsConfigurer
+| **requestedChannelMax** (advanced) | Connection requested channel max (max number of channels offered) | 0 | int
+| **requestedFrameMax** (advanced) | Connection requested frame max (max size of frame offered) | 0 | int
+| **requestedHeartbeat** (advanced) | Connection requested heartbeat (heart-beat in seconds offered) | 60 | int
+| **requestTimeout** (advanced) | Set timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds) | | long
+| **requestTimeoutChecker Interval** (advanced) | Set requestTimeoutCheckerInterval for inOut exchange | | long
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **topologyRecoveryEnabled** (advanced) | Enables connection topology recovery (should topology recovery be performed) | | Boolean
+| **transferException** (advanced) | When true and an inOut Exchange failed on the consumer side send the caused Exception back in the response | false | boolean
+| **password** (security) | Password for authenticated access | guest | String
+| **sslProtocol** (security) | Enables SSL on connection accepted value are true TLS and 'SSLv3 | | String
+| **trustManager** (security) | Configure SSL trust manager SSL should be enabled for this option to be effective | | TrustManager
+| **username** (security) | Username in case of authenticated access | guest | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc b/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc
index 62fd3fe..0c6fc8a 100644
--- a/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc
+++ b/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc
@@ -48,15 +48,12 @@ The Reactive Streams component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| internalEngineConfiguration | | ReactiveStreamsEngineConfiguration | Configures the internal engine for Reactive Streams.
-
-| backpressureStrategy | | ReactiveStreamsBackpressureStrategy | The backpressure strategy to use when pushing events to a slow subscriber.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **internalEngine Configuration** (common) | Configures the internal engine for Reactive Streams. | | ReactiveStreamsEngine Configuration
+| **backpressureStrategy** (common) | The backpressure strategy to use when pushing events to a slow subscriber. | | ReactiveStreams BackpressureStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -73,37 +70,27 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| stream | | String | Name of the stream channel used by the endpoint to exchange messages.
+| Name | Description | Default | Type
+| **stream** | Name of the stream channel used by the endpoint to exchange messages. | | String
|=======================================================================
#### Query Parameters (10 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| serviceName | | String | Allows using an alternative CamelReactiveStreamService implementation. The implementation is looked up from the registry.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| concurrentConsumers | 1 | int | Number of threads used to process exchanges in the Camel route.
-
-| forwardOnComplete | false | boolean | Determines if onComplete events should be pushed to the Camel route.
-
-| forwardOnError | false | boolean | Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body.
-
-| maxInflightExchanges | 128 | Integer | Maximum number of exchanges concurrently being processed by Camel. This parameter controls backpressure on the stream. Setting a non-positive value will disable backpressure.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| backpressureStrategy | | ReactiveStreamsBackpressureStrategy | The backpressure strategy to use when pushing events to a slow subscriber.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **serviceName** (common) | Allows using an alternative CamelReactiveStreamService implementation. The implementation is looked up from the registry. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **concurrentConsumers** (consumer) | Number of threads used to process exchanges in the Camel route. | 1 | int
+| **forwardOnComplete** (consumer) | Determines if onComplete events should be pushed to the Camel route. | false | boolean
+| **forwardOnError** (consumer) | Determines if onError events should be pushed to the Camel route. Exceptions will be set as message body. | false | boolean
+| **maxInflightExchanges** (consumer) | Maximum number of exchanges concurrently being processed by Camel. This parameter controls backpressure on the stream. Setting a non-positive value will disable backpressure. | 128 | Integer
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **backpressureStrategy** (producer) | The backpressure strategy to use when pushing events to a slow subscriber. | | ReactiveStreams BackpressureStrategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc b/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc
index 9be24f4..0d07e2c 100644
--- a/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc
+++ b/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc
@@ -80,23 +80,16 @@ The REST Swagger component supports 7 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| producer
-| basePath | | String | API basePath for example /v2. Default is unset if set overrides the value present in Swagger specification.
-
-| componentName | | String | Name of the Camel component that will perform the requests. The compnent must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Can be overriden in endpoint configuration.
-
-| consumes | | String | What payload type this component capable of consuming. Could be one type like application/json or multiple types as application/json application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the Swagger specification. Can be overriden in endpoint configuration
-
-| host | | String | Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint component or in the correspoding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first rest-swagger next and global configuration last. If set overrides any value found in the Swagger specification RestConfiguration. Can be overriden in endpoint configuration.
-
-| produces | | String | What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the Swagger specification. Can be overriden in endpoint configuration.
-
-| specificationUri | swagger.json | URI | Path to the Swagger specification file. The scheme host base path are taken from this specification but these can be overriden with properties on the component or endpoint level. If not given the component tries to load swagger.json resource. Note that the host defined on the component and endpoint of this Component should contain the scheme hostname and optionally the port in the URI syntax (i.e. https://api.example.com:8080). Can be overriden in endpoint configuration.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **basePath** (producer) | API basePath for example /v2. Default is unset if set overrides the value present in Swagger specification. | | String
+| **componentName** (producer) | Name of the Camel component that will perform the requests. The compnent must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Can be overriden in endpoint configuration. | | String
+| **consumes** (producer) | What payload type this component capable of consuming. Could be one type like application/json or multiple types as application/json application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the Swagger specification. Can be overriden in endpoint configuration | | String
+| **host** (producer) | Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint component or in the correspoding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first rest-swagger next and global configuration last. If set overrides any value found in the Swagger specification RestConfiguration. Can be overriden in endpoint configuration. | | String
+| **produces** (producer) | What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the Swagger specification. Can be overriden in endpoint configuration. | | String
+| **specificationUri** (producer) | Path to the Swagger specification file. The scheme host base path are taken from this specification but these can be overriden with properties on the component or endpoint level. If not given the component tries to load swagger.json resource. Note that the host defined on the component and endpoint of this Component should contain the scheme hostname and optionally the port in the URI syntax (i.e. https://api.example.com:8080). Can be overriden in endpoint configuration. | swagger.json | URI
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -109,30 +102,24 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| specificationUri | swagger.json | URI | Path to the Swagger specification file. The scheme host base path are taken from this specification but these can be overriden with properties on the component or endpoint level. If not given the component tries to load swagger.json resource. Note that the host defined on the component and endpoint of this Component should contain the scheme hostname and optionally the port in the URI syntax (i.e. https://api.example.com:8080). Overrides component configuration.
-| operationId | | String | *Required* ID of the operation from the Swagger specification.
+| Name | Description | Default | Type
+| **specificationUri** | Path to the Swagger specification file. The scheme host base path are taken from this specification but these can be overriden with properties on the component or endpoint level. If not given the component tries to load swagger.json resource. Note that the host defined on the component and endpoint of this Component should contain the scheme hostname and optionally the port in the URI syntax (i.e. https://api.example.com:8080). Overrides component configuration. | swagger.json | URI
+| **operationId** | *Required* ID of the operation from the Swagger specification. | | String
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| basePath | | String | API basePath for example /v2. Default is unset if set overrides the value present in Swagger specification and in the component configuration.
-
-| componentName | | String | Name of the Camel component that will perform the requests. The compnent must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Overrides component configuration.
-
-| consumes | | String | What payload type this component capable of consuming. Could be one type like application/json or multiple types as application/json application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the Swagger specification and. in the component configuration
-
-| host | | String | Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint component or in the correspoding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first rest-swagger next and global configuration last. If set overrides any value found in the Swagger specification RestConfiguration. Overrides all other configuration.
-
-| produces | | String | What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the Swagger specification. Overrides all other configuration.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **basePath** (producer) | API basePath for example /v2. Default is unset if set overrides the value present in Swagger specification and in the component configuration. | | String
+| **componentName** (producer) | Name of the Camel component that will perform the requests. The compnent must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Overrides component configuration. | | String
+| **consumes** (producer) | What payload type this component capable of consuming. Could be one type like application/json or multiple types as application/json application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the Swagger specification and. in the component configuration | | String
+| **host** (producer) | Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint component or in the correspoding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first rest-swagger next and global configuration last. If set overrides any value found in the Swagger specification RestConfiguration. Overrides all other configuration. | | String
+| **produces** (producer) | What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the Swagger specification. Overrides all other configuration. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-restlet/src/main/docs/restlet-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-restlet/src/main/docs/restlet-component.adoc b/components/camel-restlet/src/main/docs/restlet-component.adoc
index 7668370..6730bbe 100644
--- a/components/camel-restlet/src/main/docs/restlet-component.adoc
+++ b/components/camel-restlet/src/main/docs/restlet-component.adoc
@@ -66,51 +66,30 @@ The Restlet component supports 21 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer (advanced)
-| controllerDaemon | | Boolean | Indicates if the controller thread should be a daemon (not blocking JVM exit).
-
-| controllerSleepTimeMs | | Integer | Time for the controller thread to sleep between each control.
- 4+^s| consumer
-| inboundBufferSize | | Integer | The size of the buffer when reading messages.
- 4+^s| common
-| maxConnectionsPerHost | | Integer | Maximum number of concurrent connections per host (IP address).
- 4+^s| consumer (advanced)
-| maxThreads | | Integer | Maximum threads that will service requests.
-
-| lowThreads | | Integer | Number of worker threads determining when the connector is considered overloaded.
- 4+^s| common
-| maxTotalConnections | | Integer | Maximum number of concurrent connections in total.
- 4+^s| consumer (advanced)
-| minThreads | | Integer | Minimum threads waiting to service requests.
- 4+^s| consumer
-| outboundBufferSize | | Integer | The size of the buffer when writing messages.
- 4+^s| consumer (advanced)
-| persistingConnections | | Boolean | Indicates if connections should be kept alive after a call.
-
-| pipeliningConnections | | Boolean | Indicates if pipelining connections are supported.
-
-| threadMaxIdleTimeMs | | Integer | Time for an idle thread to wait for an operation before being collected.
- 4+^s| consumer
-| useForwardedForHeader | | Boolean | Lookup the X-Forwarded-For header supported by popular proxies and caches and uses it to populate the Request.getClientAddresses() method result. This information is only safe for intermediary components within your local network. Other addresses could easily be changed by setting a fake header and should not be trusted for serious security checks.
-
-| reuseAddress | | Boolean | Enable/disable the SO_REUSEADDR socket option. See java.io.ServerSocketreuseAddress property for additional details.
- 4+^s| consumer (advanced)
-| maxQueued | | Integer | Maximum number of calls that can be queued if there aren't any worker thread available to service them. If the value is '0' then no queue is used and calls are rejected if no worker thread is immediately available. If the value is '-1' then an unbounded queue is used and calls are never rejected.
-
-| disableStreamCache | false | boolean | Determines whether or not the raw input stream from Restlet 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 Restlet input stream to support reading it multiple times to ensure 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. DefaultRestletBinding 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.
- 4+^s| consumer
-| port | | int | To configure the port number for the restlet consumer routes. This allows to configure this once to reuse the same port for these consumers.
- 4+^s| producer
-| synchronous | | Boolean | Whether to use synchronous Restlet Client for the producer. Setting this option to true can yield faster performance as it seems the Restlet synchronous Client works better.
- 4+^s| advanced
-| enabledConverters | | List | A list of converters to enable as full class name or simple class name. All the converters automatically registered are enabled if empty or null
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **controllerDaemon** (consumer) | Indicates if the controller thread should be a daemon (not blocking JVM exit). | | Boolean
+| **controllerSleepTimeMs** (consumer) | Time for the controller thread to sleep between each control. | | Integer
+| **inboundBufferSize** (consumer) | The size of the buffer when reading messages. | | Integer
+| **maxConnectionsPerHost** (common) | Maximum number of concurrent connections per host (IP address). | | Integer
+| **maxThreads** (consumer) | Maximum threads that will service requests. | | Integer
+| **lowThreads** (consumer) | Number of worker threads determining when the connector is considered overloaded. | | Integer
+| **maxTotalConnections** (common) | Maximum number of concurrent connections in total. | | Integer
+| **minThreads** (consumer) | Minimum threads waiting to service requests. | | Integer
+| **outboundBufferSize** (consumer) | The size of the buffer when writing messages. | | Integer
+| **persistingConnections** (consumer) | Indicates if connections should be kept alive after a call. | | Boolean
+| **pipeliningConnections** (consumer) | Indicates if pipelining connections are supported. | | Boolean
+| **threadMaxIdleTimeMs** (consumer) | Time for an idle thread to wait for an operation before being collected. | | Integer
+| **useForwardedForHeader** (consumer) | Lookup the X-Forwarded-For header supported by popular proxies and caches and uses it to populate the Request.getClientAddresses() method result. This information is only safe for intermediary components within your local network. Other addresses could easily be changed by setting a fake header and should not be trusted for serious security checks. | | Boolean
+| **reuseAddress** (consumer) | Enable/disable the SO_REUSEADDR socket option. See java.io.ServerSocketreuseAddress property for additional details. | | Boolean
+| **maxQueued** (consumer) | Maximum number of calls that can be queued if there aren't any worker thread available to service them. If the value is '0' then no queue is used and calls are rejected if no worker thread is immediately available. If the value is '-1' then an unbounded queue is used and calls are never rejected. | | Integer
+| **disableStreamCache** (consumer) | Determines whether or not the raw input stream from Restlet 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 Restlet input stream to support reading it multiple times to ensure 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. DefaultRestletBinding 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. | false | boolean
+| **port** (consumer) | To configure the port number for the restlet consumer routes. This allows to configure this once to reuse the same port for these consumers. | | int
+| **synchronous** (producer) | Whether to use synchronous Restlet Client for the producer. Setting this option to true can yield faster performance as it seems the Restlet synchronous Client works better. | | Boolean
+| **enabledConverters** (advanced) | A list of converters to enable as full class name or simple class name. All the converters automatically registered are enabled if empty or null | | List
+| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -126,56 +105,38 @@ with the following path and query parameters:
#### Path Parameters (4 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| protocol | | String | *Required* The protocol to use which is http or https
-| host | | String | *Required* The hostname of the restlet service
-| port | 80 | int | *Required* The port number of the restlet service
-| uriPattern | | String | The resource pattern such as /customer/id
+| Name | Description | Default | Type
+| **protocol** | *Required* The protocol to use which is http or https | | String
+| **host** | *Required* The hostname of the restlet service | | String
+| **port** | *Required* The port number of the restlet service | 80 | int
+| **uriPattern** | The resource pattern such as /customer/id | | String
|=======================================================================
#### Query Parameters (18 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| restletMethod | GET | Method | On a producer endpoint specifies the request method to use. On a consumer endpoint specifies that the endpoint consumes only restletMethod requests.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| restletMethods | | String | Specify one or more methods separated by commas (e.g. restletMethods=postput) to be serviced by a restlet consumer endpoint. If both restletMethod and restletMethods options are specified the restletMethod setting is ignored. The possible methods are: ALLCONNECTDELETEGETHEADOPTIONSPATCHPOSTPUTTRACE
-
-| restletUriPatterns | | List | Specify one ore more URI templates to be serviced by a restlet consumer endpoint using the notation to reference a List in the Camel Registry. If a URI pattern has been defined in the endpoint URI both the URI pattern defined in the endpoint and the restletUriPatterns option will be honored.
- 4+^s| consumer (advanced)
-| disableStreamCache | false | boolean | Determines whether or not the raw input stream from Restlet 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 Restlet input stream to support reading it multiple times to ensure 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. DefaultRestletBinding 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.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| connectTimeout | 30000 | int | The Client will give up connection if the connection is timeout 0 for unlimited wait.
-
-| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session
-
-| socketTimeout | 30000 | int | The Client socket receive timeout 0 for unlimited wait.
-
-| throwExceptionOnFailure | true | boolean | Whether to throw exception on a producer failure. If this option is false then the http status code is set as a message header which can be checked if it has an error value.
- 4+^s| producer (advanced)
-| autoCloseStream | false | boolean | Whether to auto close the stream representation as response from calling a REST service using the restlet producer. If the response is streaming and the option streamRepresentation is enabled then you may want to auto close the InputStream from the streaming response to ensure the input stream is closed when the Camel Exchange is done being routed. However if you need to read the stream outside a Camel route you may need to not auto close the stream.
-
-| streamRepresentation | false | boolean | Whether to support stream representation as response from calling a REST service using the restlet producer. If the response is streaming then this option can be enabled to use an java.io.InputStream as the message body on the Camel Message body. If using this option you may want to enable the autoCloseStream option as well to ensure the input stream is closed when the Camel Exchange is done being routed. However if you need to read the stream outside a Camel route you may need to not auto close the stream.
- 4+^s| advanced
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-
-| restletBinding | | RestletBinding | To use a custom RestletBinding to bind between Restlet and Camel message.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| restletRealm | | Map | To configure the security realms of restlet as a map.
-
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters.
+| Name | Description | Default | Type
+| **restletMethod** (common) | On a producer endpoint specifies the request method to use. On a consumer endpoint specifies that the endpoint consumes only restletMethod requests. | GET | Method
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **restletMethods** (consumer) | Specify one or more methods separated by commas (e.g. restletMethods=postput) to be serviced by a restlet consumer endpoint. If both restletMethod and restletMethods options are specified the restletMethod setting is ignored. The possible methods are: ALLCONNECTDELETEGETHEADOPTIONSPATCHPOSTPUTTRACE | | String
+| **restletUriPatterns** (consumer) | Specify one ore more URI templates to be serviced by a restlet consumer endpoint using the notation to reference a List in the Camel Registry. If a URI pattern has been defined in the endpoint URI both the URI pattern defined in the endpoint and the restletUriPatterns option will be honored. | | List
+| **disableStreamCache** (consumer) | Determines whether or not the raw input stream from Restlet 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 Restlet input stream to support reading it multiple times to ensure 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. DefaultRestletBinding 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. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **connectTimeout** (producer) | The Client will give up connection if the connection is timeout 0 for unlimited wait. | 30000 | int
+| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler
+| **socketTimeout** (producer) | The Client socket receive timeout 0 for unlimited wait. | 30000 | int
+| **throwExceptionOnFailure** (producer) | Whether to throw exception on a producer failure. If this option is false then the http status code is set as a message header which can be checked if it has an error value. | true | boolean
+| **autoCloseStream** (producer) | Whether to auto close the stream representation as response from calling a REST service using the restlet producer. If the response is streaming and the option streamRepresentation is enabled then you may want to auto close the InputStream from the streaming response to ensure the input stream is closed when the Camel Exchange is done being routed. However if you need to read the stream outside a Camel route you may need to not auto close the stream. | false | boolean
+| **streamRepresentation** (producer) | Whether to support stream representation as response from calling a REST service using the restlet producer. If the response is streaming then this option can be enabled to use an java.io.InputStream as the message body on the Camel Message body. If using this option you may want to enable the autoCloseStream option as well to ensure the input stream is closed when the Camel Exchange is done being routed. However if you need to read the stream outside a Camel route you may need to not auto close the stream. | false | boolean
+| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **restletBinding** (advanced) | To use a custom RestletBinding to bind between Restlet and Camel message. | | RestletBinding
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **restletRealm** (security) | To configure the security realms of restlet as a map. | | Map
+| **sslContextParameters** (security) | To configure security using SSLContextParameters. | | SSLContextParameters
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-rmi/src/main/docs/rmi-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-rmi/src/main/docs/rmi-component.adoc b/components/camel-rmi/src/main/docs/rmi-component.adoc
index 15a4f52..a7f89d6 100644
--- a/components/camel-rmi/src/main/docs/rmi-component.adoc
+++ b/components/camel-rmi/src/main/docs/rmi-component.adoc
@@ -61,31 +61,25 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| hostname | localhost | String | Hostname of RMI server
-| name | | String | *Required* Name to use when binding to RMI server
-| port | 1099 | int | Port number of RMI server
+| Name | Description | Default | Type
+| **hostname** | Hostname of RMI server | localhost | String
+| **name** | *Required* Name to use when binding to RMI server | | String
+| **port** | Port number of RMI server | 1099 | int
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| method | | String | You can set the name of the method to invoke.
-
-| remoteInterfaces | | List | To specific the remote interfaces.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **method** (common) | You can set the name of the method to invoke. | | String
+| **remoteInterfaces** (common) | To specific the remote interfaces. | | List
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-routebox/src/main/docs/routebox-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-routebox/src/main/docs/routebox-component.adoc b/components/camel-routebox/src/main/docs/routebox-component.adoc
index 4919683..16bcaa5 100644
--- a/components/camel-routebox/src/main/docs/routebox-component.adoc
+++ b/components/camel-routebox/src/main/docs/routebox-component.adoc
@@ -113,51 +113,34 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| routeboxName | | String | *Required* Logical name for the routebox (eg like a queue name)
+| Name | Description | Default | Type
+| **routeboxName** | *Required* Logical name for the routebox (eg like a queue name) | | String
|=======================================================================
#### Query Parameters (17 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| dispatchMap | | Map | A string representing a key in the Camel Registry matching an object value of the type HashMap. The HashMap key should contain strings that can be matched against the value set for the exchange header ROUTE_DISPATCH_KEY. The HashMap value should contain inner route consumer URI's to which requests should be directed.
-
-| dispatchStrategy | | RouteboxDispatchStrategy | To use a custom RouteboxDispatchStrategy which allows to use custom dispatching instead of the default.
-
-| forkContext | true | boolean | Whether to fork and create a new inner CamelContext instead of reusing the same CamelContext.
-
-| innerProtocol | direct | String | The Protocol used internally by the Routebox component. Can be Direct or SEDA. The Routebox component currently offers protocols that are JVM bound.
-
-| queueSize | | int | Create a fixed size queue to receive requests.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| pollInterval | 1000 | long | The timeout used when polling from seda. 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.
-
-| threads | 20 | int | Number of threads to be used by the routebox to receive requests.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| connectionTimeout | 20000 | long | Timeout in millis used by the producer when sending a message.
-
-| sendToConsumer | true | boolean | Dictates whether a Producer endpoint sends a request to an external routebox consumer. If the setting is false the Producer creates an embedded inner context and processes requests internally.
- 4+^s| advanced
-| innerContext | | CamelContext | A string representing a key in the Camel Registry matching an object value of the type org.apache.camel.CamelContext. If a CamelContext is not provided by the user a CamelContext is automatically created for deployment of inner routes.
-
-| innerProducerTemplate | | ProducerTemplate | The ProducerTemplate to use by the internal embeded CamelContext
-
-| innerRegistry | | Registry | To use a custom registry for the internal embedded CamelContext.
-
-| routeBuilders | | String | A string representing a key in the Camel Registry matching an object value of the type List. If the user does not supply an innerContext pre-primed with inner routes the routeBuilders option must be provided as a non-empty list of RouteBuilders containing inner routes
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **dispatchMap** (common) | A string representing a key in the Camel Registry matching an object value of the type HashMap. The HashMap key should contain strings that can be matched against the value set for the exchange header ROUTE_DISPATCH_KEY. The HashMap value should contain inner route consumer URI's to which requests should be directed. | | Map
+| **dispatchStrategy** (common) | To use a custom RouteboxDispatchStrategy which allows to use custom dispatching instead of the default. | | RouteboxDispatch Strategy
+| **forkContext** (common) | Whether to fork and create a new inner CamelContext instead of reusing the same CamelContext. | true | boolean
+| **innerProtocol** (common) | The Protocol used internally by the Routebox component. Can be Direct or SEDA. The Routebox component currently offers protocols that are JVM bound. | direct | String
+| **queueSize** (common) | Create a fixed size queue to receive requests. | | int
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **pollInterval** (consumer) | The timeout used when polling from seda. 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. | 1000 | long
+| **threads** (consumer) | Number of threads to be used by the routebox to receive requests. | 20 | int
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **connectionTimeout** (producer) | Timeout in millis used by the producer when sending a message. | 20000 | long
+| **sendToConsumer** (producer) | Dictates whether a Producer endpoint sends a request to an external routebox consumer. If the setting is false the Producer creates an embedded inner context and processes requests internally. | true | boolean
+| **innerContext** (advanced) | A string representing a key in the Camel Registry matching an object value of the type org.apache.camel.CamelContext. If a CamelContext is not provided by the user a CamelContext is automatically created for deployment of inner routes. | | CamelContext
+| **innerProducerTemplate** (advanced) | The ProducerTemplate to use by the internal embeded CamelContext | | ProducerTemplate
+| **innerRegistry** (advanced) | To use a custom registry for the internal embedded CamelContext. | | Registry
+| **routeBuilders** (advanced) | A string representing a key in the Camel Registry matching an object value of the type List. If the user does not supply an innerContext pre-primed with inner routes the routeBuilders option must be provided as a non-empty list of RouteBuilders containing inner routes | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-rss/src/main/docs/rss-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-rss/src/main/docs/rss-component.adoc b/components/camel-rss/src/main/docs/rss-component.adoc
index 3c4b7ef..02b3387 100644
--- a/components/camel-rss/src/main/docs/rss-component.adoc
+++ b/components/camel-rss/src/main/docs/rss-component.adoc
@@ -56,71 +56,44 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| feedUri | | String | *Required* The URI to the feed to poll.
+| Name | Description | Default | Type
+| **feedUri** | *Required* The URI to the feed to poll. | | String
|=======================================================================
#### Query Parameters (27 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| feedHeader | true | boolean | Sets whether to add the feed object as a header
-
-| filter | true | boolean | Sets whether to use filtering or not of the entries.
-
-| lastUpdate | | Date | Sets the timestamp to be used for filtering entries from the atom feeds. This options is only in conjunction with the splitEntries.
-
-| password | | String | Sets the password to be used for basic authentication when polling from a HTTP feed
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| sortEntries | false | boolean | Sets whether to sort entries by published date. Only works when splitEntries = true.
-
-| splitEntries | true | boolean | Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message
-
-| throttleEntries | true | boolean | 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.
-
-| username | | String | Sets the username to be used for basic authentication when polling from a HTTP feed
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **feedHeader** (consumer) | Sets whether to add the feed object as a header | true | boolean
+| **filter** (consumer) | Sets whether to use filtering or not of the entries. | true | boolean
+| **lastUpdate** (consumer) | Sets the timestamp to be used for filtering entries from the atom feeds. This options is only in conjunction with the splitEntries. | | Date
+| **password** (consumer) | Sets the password to be used for basic authentication when polling from a HTTP feed | | String
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **sortEntries** (consumer) | Sets whether to sort entries by published date. Only works when splitEntries = true. | false | boolean
+| **splitEntries** (consumer) | Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message | true | boolean
+| **throttleEntries** (consumer) | 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. | true | boolean
+| **username** (consumer) | Sets the username to be used for basic authentication when polling from a HTTP feed | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
[25/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-apns/src/main/docs/apns-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-apns/src/main/docs/apns-component.adoc b/components/camel-apns/src/main/docs/apns-component.adoc
index 2b2fada..e2e08a8 100644
--- a/components/camel-apns/src/main/docs/apns-component.adoc
+++ b/components/camel-apns/src/main/docs/apns-component.adoc
@@ -55,13 +55,11 @@ The APNS component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| apnsService | | ApnsService | *Required* The ApnsService to use. The org.apache.camel.component.apns.factory.ApnsServiceFactory can be used to build a ApnsService
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **apnsService** (common) | *Required* The ApnsService to use. The org.apache.camel.component.apns.factory.ApnsServiceFactory can be used to build a ApnsService | | ApnsService
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -77,57 +75,37 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | Name of the endpoint
+| Name | Description | Default | Type
+| **name** | Name of the endpoint | | String
|=======================================================================
#### Query Parameters (20 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| tokens | | String | Configure this property in case you want to statically declare tokens related to devices you want to notify. Tokens are separated by comma.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **tokens** (common) | Configure this property in case you want to statically declare tokens related to devices you want to notify. Tokens are separated by comma. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-asterisk/src/main/docs/asterisk-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-asterisk/src/main/docs/asterisk-component.adoc b/components/camel-asterisk/src/main/docs/asterisk-component.adoc
index 696cc7b..91fe7cd 100644
--- a/components/camel-asterisk/src/main/docs/asterisk-component.adoc
+++ b/components/camel-asterisk/src/main/docs/asterisk-component.adoc
@@ -41,33 +41,25 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* Logical name
+| Name | Description | Default | Type
+| **name** | *Required* Logical name | | String
|=======================================================================
#### Query Parameters (8 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| hostname | | String | The hostname of the asterix server
-
-| password | | String | Login password
-
-| username | | String | Login username
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| action | | AsteriskActionEnum | What action to perform such as getting queue status sip peers or extension state.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **hostname** (common) | The hostname of the asterix server | | String
+| **password** (common) | Login password | | String
+| **username** (common) | Login username | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **action** (producer) | What action to perform such as getting queue status sip peers or extension state. | | AsteriskActionEnum
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-atmos/src/main/docs/atmos-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-atmos/src/main/docs/atmos-component.adoc b/components/camel-atmos/src/main/docs/atmos-component.adoc
index 676d669..3f8a2ee 100644
--- a/components/camel-atmos/src/main/docs/atmos-component.adoc
+++ b/components/camel-atmos/src/main/docs/atmos-component.adoc
@@ -29,42 +29,30 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | Atmos name
-| operation | | AtmosOperation | *Required* Operation to perform
+| Name | Description | Default | Type
+| **name** | Atmos name | | String
+| **operation** | *Required* Operation to perform | | AtmosOperation
|=======================================================================
#### Query Parameters (12 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| enableSslValidation | false | boolean | Atmos SSL validation
-
-| fullTokenId | | String | Atmos client fullTokenId
-
-| localPath | | String | Local path to put files
-
-| newRemotePath | | String | New path on Atmos when moving files
-
-| query | | String | Search query on Atmos
-
-| remotePath | | String | Where to put files on Atmos
-
-| secretKey | | String | Atmos shared secret
-
-| uri | | String | Atomos server uri
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **enableSslValidation** (common) | Atmos SSL validation | false | boolean
+| **fullTokenId** (common) | Atmos client fullTokenId | | String
+| **localPath** (common) | Local path to put files | | String
+| **newRemotePath** (common) | New path on Atmos when moving files | | String
+| **query** (common) | Search query on Atmos | | String
+| **remotePath** (common) | Where to put files on Atmos | | String
+| **secretKey** (common) | Atmos shared secret | | String
+| **uri** (common) | Atomos server uri | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
index a1a3492..69a9711 100644
--- a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
+++ b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
@@ -38,25 +38,17 @@ The Atmosphere Websocket component supports 8 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| servletName | | String | Default name of servlet to use. The default name is CamelServlet.
-
-| httpRegistry | | HttpRegistry | To use a custom org.apache.camel.component.servlet.HttpRegistry.
-
-| attachmentMultipartBinding | false | boolean | 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.
- 4+^s| advanced
-| httpBinding | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
-
-| httpConfiguration | | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
-
-| allowJavaSerializedObject | false | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. 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.
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **servletName** (common) | Default name of servlet to use. The default name is CamelServlet. | | String
+| **httpRegistry** (common) | To use a custom org.apache.camel.component.servlet.HttpRegistry. | | HttpRegistry
+| **attachmentMultipart Binding** (common) | 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. | false | boolean
+| **httpBinding** (advanced) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding
+| **httpConfiguration** (advanced) | To use the shared HttpConfiguration as base configuration. | | HttpConfiguration
+| **allowJavaSerialized Object** (advanced) | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. 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. | false | boolean
+| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -72,91 +64,54 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| servicePath | | String | *Required* Name of websocket endpoint
+| Name | Description | Default | Type
+| **servicePath** | *Required* Name of websocket endpoint | | String
|=======================================================================
#### Query Parameters (37 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| chunked | true | boolean | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response
-
-| disableStreamCache | false | boolean | 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 r
esponse body stream but use the response stream as-is as the message body.
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-
-| sendToAll | false | boolean | Whether to send to all (broadcast) or send to a single receiver.
-
-| transferException | false | boolean | 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.
-
-| useStreaming | false | boolean | To enable streaming to send data as multiple text fragments.
- 4+^s| common (advanced)
-| httpBinding | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
- 4+^s| consumer
-| async | false | boolean | Configure the consumer to work in async mode
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| httpMethodRestrict | | String | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma.
-
-| matchOnUriPrefix | false | boolean | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.
-
-| responseBufferSize | | Integer | To use a custom buffer size on the javax.servlet.ServletResponse.
-
-| servletName | CamelServlet | String | Name of the servlet to use
- 4+^s| consumer (advanced)
-| attachmentMultipartBinding | false | boolean | 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.
-
-| eagerCheckContentAvailable | false | boolean | 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.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| optionsEnabled | false | boolean | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off.
-
-| traceEnabled | false | boolean | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off.
- 4+^s| producer
-| bridgeEndpoint | false | boolean | 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.
-
-| connectionClose | false | boolean | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false.
-
-| copyHeaders | true | boolean | 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).
-
-| httpMethod | | HttpMethods | Configure the HTTP method to use. The HttpMethod header cannot override this option if set.
-
-| ignoreResponseBody | false | boolean | If this option is true The http producer won't read response body and cache the input stream
-
-| preserveHostHeader | false | boolean | 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
-
-| throwExceptionOnFailure | true | boolean | 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.
- 4+^s| producer (advanced)
-| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session
-
-| okStatusCodeRange | 200-299 | String | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included.
-
-| urlRewrite | | UrlRewrite | 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
- 4+^s| advanced
-| mapHttpMessageBody | true | boolean | 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.
-
-| mapHttpMessageFormUrlEncodedBody | true | boolean | 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.
-
-| mapHttpMessageHeaders | true | boolean | 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.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| proxy
-| proxyAuthScheme | | String | Proxy authentication scheme to use
-
-| proxyHost | | String | Proxy hostname to use
-
-| proxyPort | | int | Proxy port to use
- 4+^s| security
-| authHost | | String | Authentication host to use with NTML
+| Name | Description | Default | Type
+| **chunked** (common) | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response | true | boolean
+| **disableStreamCache** (common) | 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 respon
se body stream but use the response stream as-is as the message body. | false | boolean
+| **headerFilterStrategy** (common) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **sendToAll** (common) | Whether to send to all (broadcast) or send to a single receiver. | false | boolean
+| **transferException** (common) | 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. | false | boolean
+| **useStreaming** (common) | To enable streaming to send data as multiple text fragments. | false | boolean
+| **httpBinding** (common) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding
+| **async** (consumer) | Configure the consumer to work in async mode | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **httpMethodRestrict** (consumer) | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. | | String
+| **matchOnUriPrefix** (consumer) | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | false | boolean
+| **responseBufferSize** (consumer) | To use a custom buffer size on the javax.servlet.ServletResponse. | | Integer
+| **servletName** (consumer) | Name of the servlet to use | CamelServlet | String
+| **attachmentMultipartBinding** (consumer) | 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. | false | boolean
+| **eagerCheckContentAvailable** (consumer) | 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. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **optionsEnabled** (consumer) | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. | false | boolean
+| **traceEnabled** (consumer) | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. | false | boolean
+| **bridgeEndpoint** (producer) | 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. | false | boolean
+| **connectionClose** (producer) | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. | false | boolean
+| **copyHeaders** (producer) | 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). | true | boolean
+| **httpMethod** (producer) | Configure the HTTP method to use. The HttpMethod header cannot override this option if set. | | HttpMethods
+| **ignoreResponseBody** (producer) | If this option is true The http producer won't read response body and cache the input stream | false | boolean
+| **preserveHostHeader** (producer) | 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 | false | boolean
+| **throwExceptionOnFailure** (producer) | 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. | true | boolean
+| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler
+| **okStatusCodeRange** (producer) | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. | 200-299 | String
+| **urlRewrite** (producer) | 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 | | UrlRewrite
+| **mapHttpMessageBody** (advanced) | 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. | true | boolean
+| **mapHttpMessageFormUrl EncodedBody** (advanced) | 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. | true | boolean
+| **mapHttpMessageHeaders** (advanced) | 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. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **proxyAuthScheme** (proxy) | Proxy authentication scheme to use | | String
+| **proxyHost** (proxy) | Proxy hostname to use | | String
+| **proxyPort** (proxy) | Proxy port to use | | int
+| **authHost** (security) | Authentication host to use with NTML | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-atom/src/main/docs/atom-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-atom/src/main/docs/atom-component.adoc b/components/camel-atom/src/main/docs/atom-component.adoc
index f3fbd2a..33a8a57 100644
--- a/components/camel-atom/src/main/docs/atom-component.adoc
+++ b/components/camel-atom/src/main/docs/atom-component.adoc
@@ -48,71 +48,44 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| feedUri | | String | *Required* The URI to the feed to poll.
+| Name | Description | Default | Type
+| **feedUri** | *Required* The URI to the feed to poll. | | String
|=======================================================================
#### Query Parameters (27 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| feedHeader | true | boolean | Sets whether to add the feed object as a header
-
-| filter | true | boolean | Sets whether to use filtering or not of the entries.
-
-| lastUpdate | | Date | Sets the timestamp to be used for filtering entries from the atom feeds. This options is only in conjunction with the splitEntries.
-
-| password | | String | Sets the password to be used for basic authentication when polling from a HTTP feed
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| sortEntries | false | boolean | Sets whether to sort entries by published date. Only works when splitEntries = true.
-
-| splitEntries | true | boolean | Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message
-
-| throttleEntries | true | boolean | 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.
-
-| username | | String | Sets the username to be used for basic authentication when polling from a HTTP feed
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **feedHeader** (consumer) | Sets whether to add the feed object as a header | true | boolean
+| **filter** (consumer) | Sets whether to use filtering or not of the entries. | true | boolean
+| **lastUpdate** (consumer) | Sets the timestamp to be used for filtering entries from the atom feeds. This options is only in conjunction with the splitEntries. | | Date
+| **password** (consumer) | Sets the password to be used for basic authentication when polling from a HTTP feed | | String
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **sortEntries** (consumer) | Sets whether to sort entries by published date. Only works when splitEntries = true. | false | boolean
+| **splitEntries** (consumer) | Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message | true | boolean
+| **throttleEntries** (consumer) | 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. | true | boolean
+| **username** (consumer) | Sets the username to be used for basic authentication when polling from a HTTP feed | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-avro/src/main/docs/avro-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-avro/src/main/docs/avro-component.adoc b/components/camel-avro/src/main/docs/avro-component.adoc
index ad9d242..9edb78d 100644
--- a/components/camel-avro/src/main/docs/avro-component.adoc
+++ b/components/camel-avro/src/main/docs/avro-component.adoc
@@ -175,13 +175,11 @@ The Avro component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | AvroConfiguration | To use a shared AvroConfiguration to configure options once
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use a shared AvroConfiguration to configure options once | | AvroConfiguration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -199,40 +197,30 @@ with the following path and query parameters:
#### Path Parameters (4 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| transport | | AvroTransport | *Required* Transport to use
-| port | | int | *Required* Port number to use
-| host | | String | *Required* Hostname to use
-| messageName | | String | The name of the message to send.
+| Name | Description | Default | Type
+| **transport** | *Required* Transport to use | | AvroTransport
+| **port** | *Required* Port number to use | | int
+| **host** | *Required* Hostname to use | | String
+| **messageName** | The name of the message to send. | | String
|=======================================================================
#### Query Parameters (10 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| protocol | | Protocol | Avro protocol to use
-
-| protocolClassName | | String | Avro protocol to use defined by the FQN class name
-
-| protocolLocation | | String | Avro protocol location
-
-| reflectionProtocol | false | boolean | If protocol object provided is reflection protocol. Should be used only with protocol parameter because for protocolClassName protocol type will be auto detected
-
-| singleParameter | false | boolean | If true consumer parameter won't be wrapped into array. Will fail if protocol specifies more then 1 parameter for the message
-
-| uriAuthority | | String | Authority to use (username and password)
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **protocol** (common) | Avro protocol to use | | Protocol
+| **protocolClassName** (common) | Avro protocol to use defined by the FQN class name | | String
+| **protocolLocation** (common) | Avro protocol location | | String
+| **reflectionProtocol** (common) | If protocol object provided is reflection protocol. Should be used only with protocol parameter because for protocolClassName protocol type will be auto detected | false | boolean
+| **singleParameter** (common) | If true consumer parameter won't be wrapped into array. Will fail if protocol specifies more then 1 parameter for the message | false | boolean
+| **uriAuthority** (common) | Authority to use (username and password) | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-aws/src/main/docs/aws-cw-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-cw-component.adoc b/components/camel-aws/src/main/docs/aws-cw-component.adoc
index dffd474..6dc8157 100644
--- a/components/camel-aws/src/main/docs/aws-cw-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-cw-component.adoc
@@ -43,39 +43,28 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| namespace | | String | *Required* The metric namespace
+| Name | Description | Default | Type
+| **namespace** | *Required* The metric namespace | | String
|=======================================================================
#### Query Parameters (11 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| accessKey | | String | Amazon AWS Access Key
-
-| amazonCwClient | | AmazonCloudWatch | To use the AmazonCloudWatch as the client
-
-| amazonCwEndpoint | | String | The region with which the AWS-CW client wants to work with.
-
-| name | | String | The metric name
-
-| proxyHost | | String | To define a proxy host when instantiating the SQS client
-
-| proxyPort | | Integer | To define a proxy port when instantiating the SQS client
-
-| secretKey | | String | Amazon AWS Secret Key
-
-| timestamp | | Date | The metric timestamp
-
-| unit | | String | The metric unit
-
-| value | | Double | The metric value
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **accessKey** (producer) | Amazon AWS Access Key | | String
+| **amazonCwClient** (producer) | To use the AmazonCloudWatch as the client | | AmazonCloudWatch
+| **amazonCwEndpoint** (producer) | The region with which the AWS-CW client wants to work with. | | String
+| **name** (producer) | The metric name | | String
+| **proxyHost** (producer) | To define a proxy host when instantiating the SQS client | | String
+| **proxyPort** (producer) | To define a proxy port when instantiating the SQS client | | Integer
+| **secretKey** (producer) | Amazon AWS Secret Key | | String
+| **timestamp** (producer) | The metric timestamp | | Date
+| **unit** (producer) | The metric unit | | String
+| **value** (producer) | The metric value | | Double
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-aws/src/main/docs/aws-ddb-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-ddb-component.adoc b/components/camel-aws/src/main/docs/aws-ddb-component.adoc
index e278160..a8a6b8b 100644
--- a/components/camel-aws/src/main/docs/aws-ddb-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-ddb-component.adoc
@@ -40,43 +40,30 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| tableName | | String | *Required* The name of the table currently worked with.
+| Name | Description | Default | Type
+| **tableName** | *Required* The name of the table currently worked with. | | String
|=======================================================================
#### Query Parameters (13 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| accessKey | | String | Amazon AWS Access Key
-
-| amazonDDBClient | | AmazonDynamoDB | To use the AmazonDynamoDB as the client
-
-| amazonDdbEndpoint | | String | The region with which the AWS-DDB client wants to work with.
-
-| consistentRead | false | boolean | Determines whether or not strong consistency should be enforced when data is read.
-
-| keyAttributeName | | String | Attribute name when creating table
-
-| keyAttributeType | | String | Attribute type when creating table
-
-| operation | PutItem | DdbOperations | What operation to perform
-
-| proxyHost | | String | To define a proxy host when instantiating the SQS client
-
-| proxyPort | | Integer | To define a proxy port when instantiating the SQS client
-
-| readCapacity | | Long | The provisioned throughput to reserve for reading resources from your table
-
-| secretKey | | String | Amazon AWS Secret Key
-
-| writeCapacity | | Long | The provisioned throughput to reserved for writing resources to your table
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **accessKey** (producer) | Amazon AWS Access Key | | String
+| **amazonDDBClient** (producer) | To use the AmazonDynamoDB as the client | | AmazonDynamoDB
+| **amazonDdbEndpoint** (producer) | The region with which the AWS-DDB client wants to work with. | | String
+| **consistentRead** (producer) | Determines whether or not strong consistency should be enforced when data is read. | false | boolean
+| **keyAttributeName** (producer) | Attribute name when creating table | | String
+| **keyAttributeType** (producer) | Attribute type when creating table | | String
+| **operation** (producer) | What operation to perform | PutItem | DdbOperations
+| **proxyHost** (producer) | To define a proxy host when instantiating the SQS client | | String
+| **proxyPort** (producer) | To define a proxy port when instantiating the SQS client | | Integer
+| **readCapacity** (producer) | The provisioned throughput to reserve for reading resources from your table | | Long
+| **secretKey** (producer) | Amazon AWS Secret Key | | String
+| **writeCapacity** (producer) | The provisioned throughput to reserved for writing resources to your table | | Long
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc b/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc
index a394cdb..86a3af5 100644
--- a/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-ddbstream-component.adoc
@@ -43,63 +43,40 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| tableName | | String | *Required* Name of the dynamodb table
+| Name | Description | Default | Type
+| **tableName** | *Required* Name of the dynamodb table | | String
|=======================================================================
#### Query Parameters (23 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| amazonDynamoDbStreamsClient | | AmazonDynamoDBStreams | *Required* Amazon DynamoDB client to use for all requests for this endpoint
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| iteratorType | LATEST | ShardIteratorType | 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 ATAFTER_SEQUENCE_NUMBER are used then a sequenceNumberProvider MUST be supplied.
-
-| maxResultsPerRequest | | int | Maximum number of records that will be fetched in each poll
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| sequenceNumberProvider | | SequenceNumberProvider | Provider for the sequence number when using one of the two ShardIteratorType.ATAFTER_SEQUENCE_NUMBER iterator types. Can be a registry reference or a literal sequence number.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **amazonDynamoDbStreams Client** (consumer) | *Required* Amazon DynamoDB client to use for all requests for this endpoint | | AmazonDynamoDBStreams
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **iteratorType** (consumer) | 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 ATAFTER_SEQUENCE_NUMBER are used then a sequenceNumberProvider MUST be supplied. | LATEST | ShardIteratorType
+| **maxResultsPerRequest** (consumer) | Maximum number of records that will be fetched in each poll | | int
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **sequenceNumberProvider** (consumer) | Provider for the sequence number when using one of the two ShardIteratorType.ATAFTER_SEQUENCE_NUMBER iterator types. Can be a registry reference or a literal sequence number. | | SequenceNumberProvider
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-aws/src/main/docs/aws-ec2-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-ec2-component.adoc b/components/camel-aws/src/main/docs/aws-ec2-component.adoc
index 0530c2a..74aeeac 100644
--- a/components/camel-aws/src/main/docs/aws-ec2-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-ec2-component.adoc
@@ -40,33 +40,25 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| label | | String | *Required* Logical name
+| Name | Description | Default | Type
+| **label** | *Required* Logical name | | String
|=======================================================================
#### Query Parameters (8 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| accessKey | | String | Amazon AWS Access Key
-
-| amazonEc2Client | | AmazonEC2Client | To use a existing configured AmazonEC2Client as client
-
-| amazonEc2Endpoint | | String | The region with which the AWS-EC2 client wants to work with.
-
-| operation | | EC2Operations | *Required* The operation to perform. It can be createAndRunInstances startInstances stopInstances terminateInstances describeInstances describeInstancesStatus rebootInstances monitorInstances unmonitorInstances createTags or deleteTags
-
-| proxyHost | | String | To define a proxy host when instantiating the SQS client
-
-| proxyPort | | Integer | To define a proxy port when instantiating the SQS client
-
-| secretKey | | String | Amazon AWS Secret Key
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **accessKey** (producer) | Amazon AWS Access Key | | String
+| **amazonEc2Client** (producer) | To use a existing configured AmazonEC2Client as client | | AmazonEC2Client
+| **amazonEc2Endpoint** (producer) | The region with which the AWS-EC2 client wants to work with. | | String
+| **operation** (producer) | *Required* The operation to perform. It can be createAndRunInstances startInstances stopInstances terminateInstances describeInstances describeInstancesStatus rebootInstances monitorInstances unmonitorInstances createTags or deleteTags | | EC2Operations
+| **proxyHost** (producer) | To define a proxy host when instantiating the SQS client | | String
+| **proxyPort** (producer) | To define a proxy port when instantiating the SQS client | | Integer
+| **secretKey** (producer) | Amazon AWS Secret Key | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-aws/src/main/docs/aws-kinesis-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-kinesis-component.adoc b/components/camel-aws/src/main/docs/aws-kinesis-component.adoc
index 3f6ad07..b449fdc 100644
--- a/components/camel-aws/src/main/docs/aws-kinesis-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-kinesis-component.adoc
@@ -44,65 +44,41 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| streamName | | String | *Required* Name of the stream
+| Name | Description | Default | Type
+| **streamName** | *Required* Name of the stream | | String
|=======================================================================
#### Query Parameters (24 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| amazonKinesisClient | | AmazonKinesis | *Required* Amazon Kinesis client to use for all requests for this endpoint
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| iteratorType | TRIM_HORIZON | ShardIteratorType | Defines where in the Kinesis stream to start getting records
-
-| maxResultsPerRequest | 1 | int | Maximum number of records that will be fetched in each poll
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| sequenceNumber | | String | The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER
-
-| shardId | | String | Defines which shardId in the Kinesis stream to get records from
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **amazonKinesisClient** (common) | *Required* Amazon Kinesis client to use for all requests for this endpoint | | AmazonKinesis
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **iteratorType** (consumer) | Defines where in the Kinesis stream to start getting records | TRIM_HORIZON | ShardIteratorType
+| **maxResultsPerRequest** (consumer) | Maximum number of records that will be fetched in each poll | 1 | int
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **sequenceNumber** (consumer) | The sequence number to start polling from. Required if iteratorType is set to AFTER_SEQUENCE_NUMBER or AT_SEQUENCE_NUMBER | | String
+| **shardId** (consumer) | Defines which shardId in the Kinesis stream to get records from | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
[14/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jetty9/src/main/docs/jetty-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jetty9/src/main/docs/jetty-component.adoc b/components/camel-jetty9/src/main/docs/jetty-component.adoc
index b31d915..222ecf4 100644
--- a/components/camel-jetty9/src/main/docs/jetty-component.adoc
+++ b/components/camel-jetty9/src/main/docs/jetty-component.adoc
@@ -56,73 +56,41 @@ The Jetty 9 component supports 32 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| security
-| sslKeyPassword | | String | The key password which is used to access the certificate's key entry in the keystore (this is the same password that is supplied to the keystore command's -keypass option).
-
-| sslPassword | | String | The ssl password which is required to access the keystore file (this is the same password that is supplied to the keystore command's -storepass option).
-
-| keystore | | String | Specifies the location of the Java keystore file which contains the Jetty server's own X.509 certificate in a key entry.
- 4+^s| advanced
-| errorHandler | | ErrorHandler | This option is used to set the ErrorHandler that Jetty server uses.
- 4+^s| security
-| sslSocketConnectors | | Map | A map which contains per port number specific SSL connectors.
-
-| socketConnectors | | Map | A map which contains per port number specific HTTP connectors. Uses the same principle as sslSocketConnectors.
- 4+^s| producer
-| httpClientMinThreads | | Integer | To set a value for minimum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured.
-
-| httpClientMaxThreads | | Integer | To set a value for maximum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured.
- 4+^s| consumer
-| minThreads | | Integer | To set a value for minimum number of threads in server thread pool. Notice that both a min and max size must be configured.
-
-| maxThreads | | Integer | To set a value for maximum number of threads in server thread pool. Notice that both a min and max size must be configured.
- 4+^s| consumer (advanced)
-| threadPool | | ThreadPool | To use a custom thread pool for the server. This option should only be used in special circumstances.
- 4+^s| common
-| enableJmx | false | boolean | If this option is true Jetty JMX support will be enabled for this endpoint.
- 4+^s| advanced
-| jettyHttpBinding | | JettyHttpBinding | To use a custom org.apache.camel.component.jetty.JettyHttpBinding which are used to customize how a response should be written for the producer.
-
-| httpBinding | | HttpBinding | Not to be used - use JettyHttpBinding instead.
-
-| httpConfiguration | | HttpConfiguration | Jetty component does not use HttpConfiguration.
-
-| mbContainer | | MBeanContainer | To use a existing configured org.eclipse.jetty.jmx.MBeanContainer if JMX is enabled that Jetty uses for registering mbeans.
- 4+^s| security
-| sslSocketConnectorProperties | | Map | A map which contains general SSL connector properties.
-
-| socketConnectorProperties | | Map | A map which contains general HTTP connector properties. Uses the same principle as sslSocketConnectorProperties.
- 4+^s| consumer
-| continuationTimeout | 30000 | Long | 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.
-
-| useContinuation | true | boolean | Whether or not to use Jetty continuations for the Jetty Server.
- 4+^s| security
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
- 4+^s| common
-| responseBufferSize | | Integer | Allows to configure a custom value of the response buffer size on the Jetty connectors.
-
-| requestBufferSize | | Integer | Allows to configure a custom value of the request buffer size on the Jetty connectors.
-
-| requestHeaderSize | | Integer | Allows to configure a custom value of the request header size on the Jetty connectors.
-
-| responseHeaderSize | | Integer | Allows to configure a custom value of the response header size on the Jetty connectors.
- 4+^s| proxy
-| proxyHost | | String | To use a http proxy to configure the hostname.
-
-| proxyPort | | Integer | To use a http proxy to configure the port number.
- 4+^s| common
-| useXForwardedForHeader | false | boolean | To use the X-Forwarded-For header in HttpServletRequest.getRemoteAddr.
- 4+^s| consumer
-| sendServerVersion | true | boolean | 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.
- 4+^s| advanced
-| allowJavaSerializedObject | false | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. 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.
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **sslKeyPassword** (security) | The key password which is used to access the certificate's key entry in the keystore (this is the same password that is supplied to the keystore command's -keypass option). | | String
+| **sslPassword** (security) | The ssl password which is required to access the keystore file (this is the same password that is supplied to the keystore command's -storepass option). | | String
+| **keystore** (security) | Specifies the location of the Java keystore file which contains the Jetty server's own X.509 certificate in a key entry. | | String
+| **errorHandler** (advanced) | This option is used to set the ErrorHandler that Jetty server uses. | | ErrorHandler
+| **sslSocketConnectors** (security) | A map which contains per port number specific SSL connectors. | | Map
+| **socketConnectors** (security) | A map which contains per port number specific HTTP connectors. Uses the same principle as sslSocketConnectors. | | Map
+| **httpClientMinThreads** (producer) | To set a value for minimum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured. | | Integer
+| **httpClientMaxThreads** (producer) | To set a value for maximum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured. | | Integer
+| **minThreads** (consumer) | To set a value for minimum number of threads in server thread pool. Notice that both a min and max size must be configured. | | Integer
+| **maxThreads** (consumer) | To set a value for maximum number of threads in server thread pool. Notice that both a min and max size must be configured. | | Integer
+| **threadPool** (consumer) | To use a custom thread pool for the server. This option should only be used in special circumstances. | | ThreadPool
+| **enableJmx** (common) | If this option is true Jetty JMX support will be enabled for this endpoint. | false | boolean
+| **jettyHttpBinding** (advanced) | To use a custom org.apache.camel.component.jetty.JettyHttpBinding which are used to customize how a response should be written for the producer. | | JettyHttpBinding
+| **httpBinding** (advanced) | Not to be used - use JettyHttpBinding instead. | | HttpBinding
+| **httpConfiguration** (advanced) | Jetty component does not use HttpConfiguration. | | HttpConfiguration
+| **mbContainer** (advanced) | To use a existing configured org.eclipse.jetty.jmx.MBeanContainer if JMX is enabled that Jetty uses for registering mbeans. | | MBeanContainer
+| **sslSocketConnector Properties** (security) | A map which contains general SSL connector properties. | | Map
+| **socketConnector Properties** (security) | A map which contains general HTTP connector properties. Uses the same principle as sslSocketConnectorProperties. | | Map
+| **continuationTimeout** (consumer) | 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. | 30000 | Long
+| **useContinuation** (consumer) | Whether or not to use Jetty continuations for the Jetty Server. | true | boolean
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
+| **responseBufferSize** (common) | Allows to configure a custom value of the response buffer size on the Jetty connectors. | | Integer
+| **requestBufferSize** (common) | Allows to configure a custom value of the request buffer size on the Jetty connectors. | | Integer
+| **requestHeaderSize** (common) | Allows to configure a custom value of the request header size on the Jetty connectors. | | Integer
+| **responseHeaderSize** (common) | Allows to configure a custom value of the response header size on the Jetty connectors. | | Integer
+| **proxyHost** (proxy) | To use a http proxy to configure the hostname. | | String
+| **proxyPort** (proxy) | To use a http proxy to configure the port number. | | Integer
+| **useXForwardedFor Header** (common) | To use the X-Forwarded-For header in HttpServletRequest.getRemoteAddr. | false | boolean
+| **sendServerVersion** (consumer) | 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. | true | boolean
+| **allowJavaSerialized Object** (advanced) | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. 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. | false | boolean
+| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -143,127 +111,72 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| httpUri | | URI | *Required* The url of the HTTP endpoint to call.
+| Name | Description | Default | Type
+| **httpUri** | *Required* The url of the HTTP endpoint to call. | | URI
|=======================================================================
#### Query Parameters (55 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| chunked | true | boolean | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response
-
-| disableStreamCache | false | boolean | 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 r
esponse body stream but use the response stream as-is as the message body.
-
-| enableMultipartFilter | false | boolean | 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.
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-
-| transferException | false | boolean | 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.
- 4+^s| common (advanced)
-| httpBinding | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
- 4+^s| consumer
-| async | false | boolean | Configure the consumer to work in async mode
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| continuationTimeout | 30000 | Long | 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.
-
-| enableCORS | false | boolean | If the option is true Jetty server will setup the CrossOriginFilter which supports the CORS out of box.
-
-| enableJmx | false | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details.
-
-| httpMethodRestrict | | String | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma.
-
-| matchOnUriPrefix | false | boolean | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.
-
-| responseBufferSize | | Integer | To use a custom buffer size on the javax.servlet.ServletResponse.
-
-| sendDateHeader | false | boolean | 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.
-
-| sendServerVersion | true | boolean | 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.
-
-| sessionSupport | false | boolean | Specifies whether to enable the session manager on the server side of Jetty.
-
-| useContinuation | | Boolean | Whether or not to use Jetty continuations for the Jetty Server.
- 4+^s| consumer (advanced)
-| eagerCheckContentAvailable | false | boolean | 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.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| filterInitParameters | | Map | Configuration of the filter init parameters. These parameters will be applied to the filter list before starting the jetty server.
-
-| filtersRef | | String | 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.
-
-| handlers | | String | 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.
-
-| httpBindingRef | | String | 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.
-
-| multipartFilter | | Filter | Allows using a custom multipart filter. Note: setting multipartFilterRef forces the value of enableMultipartFilter to true.
-
-| multipartFilterRef | | String | Allows using a custom multipart filter. Note: setting multipartFilterRef forces the value of enableMultipartFilter to true.
-
-| optionsEnabled | false | boolean | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off.
-
-| traceEnabled | false | boolean | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off.
- 4+^s| producer
-| bridgeEndpoint | false | boolean | 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.
-
-| connectionClose | false | boolean | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false.
-
-| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session
-
-| copyHeaders | true | boolean | 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).
-
-| httpClientMaxThreads | 254 | Integer | To set a value for maximum number of threads in HttpClient thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to max 254 threads used in Jettys thread pool.
-
-| httpClientMinThreads | 8 | Integer | To set a value for minimum number of threads in HttpClient thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to min 8 threads used in Jettys thread pool.
-
-| httpMethod | | HttpMethods | Configure the HTTP method to use. The HttpMethod header cannot override this option if set.
-
-| ignoreResponseBody | false | boolean | If this option is true The http producer won't read response body and cache the input stream
-
-| preserveHostHeader | false | boolean | 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
-
-| throwExceptionOnFailure | true | boolean | 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.
- 4+^s| producer (advanced)
-| httpClient | | HttpClient | Sets a shared HttpClient to use for all producers created by this endpoint. By default each producer will use a new http client and not share. Important: Make sure to handle the lifecycle of the shared client such as stopping the client when it is no longer in use. Camel will call the start method on the client to ensure its started when this endpoint creates a producer. This options should only be used in special circumstances.
-
-| httpClientParameters | | Map | Configuration of Jetty's HttpClient. For example setting httpClient.idleTimeout=30000 sets the idle timeout to 30 seconds. And httpClient.timeout=30000 sets the request timeout to 30 seconds in case you want to timeout sooner if you have long running request/response calls.
-
-| jettyBinding | | JettyHttpBinding | To use a custom JettyHttpBinding which be used to customize how a response should be written for the producer.
-
-| jettyBindingRef | | String | To use a custom JettyHttpBinding which be used to customize how a response should be written for the producer.
-
-| okStatusCodeRange | 200-299 | String | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included.
-
-| urlRewrite | | UrlRewrite | 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
- 4+^s| advanced
-| mapHttpMessageBody | true | boolean | 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.
-
-| mapHttpMessageFormUrlEncodedBody | true | boolean | 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.
-
-| mapHttpMessageHeaders | true | boolean | 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.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| proxy
-| proxyAuthScheme | | String | Proxy authentication scheme to use
-
-| proxyHost | | String | Proxy hostname to use
-
-| proxyPort | | int | Proxy port to use
- 4+^s| security
-| authHost | | String | Authentication host to use with NTML
-
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
-
-| sslContextParametersRef | | String | To configure security using SSLContextParameters
+| Name | Description | Default | Type
+| **chunked** (common) | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response | true | boolean
+| **disableStreamCache** (common) | 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 respon
se body stream but use the response stream as-is as the message body. | false | boolean
+| **enableMultipartFilter** (common) | 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. | false | boolean
+| **headerFilterStrategy** (common) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **transferException** (common) | 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. | false | boolean
+| **httpBinding** (common) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | HttpBinding
+| **async** (consumer) | Configure the consumer to work in async mode | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **continuationTimeout** (consumer) | 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. | 30000 | Long
+| **enableCORS** (consumer) | If the option is true Jetty server will setup the CrossOriginFilter which supports the CORS out of box. | false | boolean
+| **enableJmx** (consumer) | If this option is true Jetty JMX support will be enabled for this endpoint. See Jetty JMX support for more details. | false | boolean
+| **httpMethodRestrict** (consumer) | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. | | String
+| **matchOnUriPrefix** (consumer) | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | false | boolean
+| **responseBufferSize** (consumer) | To use a custom buffer size on the javax.servlet.ServletResponse. | | Integer
+| **sendDateHeader** (consumer) | 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. | false | boolean
+| **sendServerVersion** (consumer) | 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. | true | boolean
+| **sessionSupport** (consumer) | Specifies whether to enable the session manager on the server side of Jetty. | false | boolean
+| **useContinuation** (consumer) | Whether or not to use Jetty continuations for the Jetty Server. | | Boolean
+| **eagerCheckContentAvailable** (consumer) | 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. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **filterInitParameters** (consumer) | Configuration of the filter init parameters. These parameters will be applied to the filter list before starting the jetty server. | | Map
+| **filtersRef** (consumer) | 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. | | String
+| **handlers** (consumer) | 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. | | String
+| **httpBindingRef** (consumer) | 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. | | String
+| **multipartFilter** (consumer) | Allows using a custom multipart filter. Note: setting multipartFilterRef forces the value of enableMultipartFilter to true. | | Filter
+| **multipartFilterRef** (consumer) | Allows using a custom multipart filter. Note: setting multipartFilterRef forces the value of enableMultipartFilter to true. | | String
+| **optionsEnabled** (consumer) | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. | false | boolean
+| **traceEnabled** (consumer) | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off. | false | boolean
+| **bridgeEndpoint** (producer) | 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. | false | boolean
+| **connectionClose** (producer) | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. | false | boolean
+| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler
+| **copyHeaders** (producer) | 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). | true | boolean
+| **httpClientMaxThreads** (producer) | To set a value for maximum number of threads in HttpClient thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to max 254 threads used in Jettys thread pool. | 254 | Integer
+| **httpClientMinThreads** (producer) | To set a value for minimum number of threads in HttpClient thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to min 8 threads used in Jettys thread pool. | 8 | Integer
+| **httpMethod** (producer) | Configure the HTTP method to use. The HttpMethod header cannot override this option if set. | | HttpMethods
+| **ignoreResponseBody** (producer) | If this option is true The http producer won't read response body and cache the input stream | false | boolean
+| **preserveHostHeader** (producer) | 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 | false | boolean
+| **throwExceptionOnFailure** (producer) | 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. | true | boolean
+| **httpClient** (producer) | Sets a shared HttpClient to use for all producers created by this endpoint. By default each producer will use a new http client and not share. Important: Make sure to handle the lifecycle of the shared client such as stopping the client when it is no longer in use. Camel will call the start method on the client to ensure its started when this endpoint creates a producer. This options should only be used in special circumstances. | | HttpClient
+| **httpClientParameters** (producer) | Configuration of Jetty's HttpClient. For example setting httpClient.idleTimeout=30000 sets the idle timeout to 30 seconds. And httpClient.timeout=30000 sets the request timeout to 30 seconds in case you want to timeout sooner if you have long running request/response calls. | | Map
+| **jettyBinding** (producer) | To use a custom JettyHttpBinding which be used to customize how a response should be written for the producer. | | JettyHttpBinding
+| **jettyBindingRef** (producer) | To use a custom JettyHttpBinding which be used to customize how a response should be written for the producer. | | String
+| **okStatusCodeRange** (producer) | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. | 200-299 | String
+| **urlRewrite** (producer) | 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 | | UrlRewrite
+| **mapHttpMessageBody** (advanced) | 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. | true | boolean
+| **mapHttpMessageFormUrl EncodedBody** (advanced) | 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. | true | boolean
+| **mapHttpMessageHeaders** (advanced) | 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. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **proxyAuthScheme** (proxy) | Proxy authentication scheme to use | | String
+| **proxyHost** (proxy) | Proxy hostname to use | | String
+| **proxyPort** (proxy) | Proxy port to use | | int
+| **authHost** (security) | Authentication host to use with NTML | | String
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
+| **sslContextParametersRef** (security) | To configure security using SSLContextParameters | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jgroups/src/main/docs/jgroups-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jgroups/src/main/docs/jgroups-component.adoc b/components/camel-jgroups/src/main/docs/jgroups-component.adoc
index 40ec9a9..6799449 100644
--- a/components/camel-jgroups/src/main/docs/jgroups-component.adoc
+++ b/components/camel-jgroups/src/main/docs/jgroups-component.adoc
@@ -53,17 +53,13 @@ The JGroups component supports 4 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| channel | | JChannel | Channel to use
-
-| channelProperties | | String | Specifies configuration properties of the JChannel used by the endpoint.
- 4+^s| consumer
-| enableViewMessages | false | boolean | 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.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **channel** (common) | Channel to use | | JChannel
+| **channelProperties** (common) | Specifies configuration properties of the JChannel used by the endpoint. | | String
+| **enableViewMessages** (consumer) | 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. | false | boolean
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -81,29 +77,23 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| clusterName | | String | *Required* The name of the JGroups cluster the component should connect to.
+| Name | Description | Default | Type
+| **clusterName** | *Required* The name of the JGroups cluster the component should connect to. | | String
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| channelProperties | | String | Specifies configuration properties of the JChannel used by the endpoint.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| enableViewMessages | false | boolean | 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.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **channelProperties** (common) | Specifies configuration properties of the JChannel used by the endpoint. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **enableViewMessages** (consumer) | 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. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jing/src/main/docs/jing-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jing/src/main/docs/jing-component.adoc b/components/camel-jing/src/main/docs/jing-component.adoc
index 4a49314..111690a 100644
--- a/components/camel-jing/src/main/docs/jing-component.adoc
+++ b/components/camel-jing/src/main/docs/jing-component.adoc
@@ -55,21 +55,19 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| resourceUri | | String | *Required* 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.
+| Name | Description | Default | Type
+| **resourceUri** | *Required* 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. | | String
|=======================================================================
#### Query Parameters (2 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| compactSyntax | false | boolean | 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)
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **compactSyntax** (producer) | 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) | false | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jira/src/main/docs/jira-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jira/src/main/docs/jira-component.adoc b/components/camel-jira/src/main/docs/jira-component.adoc
index f448508..ea9339f 100644
--- a/components/camel-jira/src/main/docs/jira-component.adoc
+++ b/components/camel-jira/src/main/docs/jira-component.adoc
@@ -57,35 +57,26 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| type | | JIRAType | *Required* Operation to perform such as create a new issue or a new comment
+| Name | Description | Default | Type
+| **type** | *Required* Operation to perform such as create a new issue or a new comment | | JIRAType
|=======================================================================
#### Query Parameters (9 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| password | | String | Password for login
-
-| serverUrl | | String | *Required* URL to the JIRA server
-
-| username | | String | Username for login
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| delay | 6000 | int | Delay in seconds when querying JIRA using the consumer.
-
-| jql | | String | 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.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **password** (common) | Password for login | | String
+| **serverUrl** (common) | *Required* URL to the JIRA server | | String
+| **username** (common) | Username for login | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **delay** (consumer) | Delay in seconds when querying JIRA using the consumer. | 6000 | int
+| **jql** (consumer) | 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. | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jmx/src/main/docs/jmx-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jmx/src/main/docs/jmx-component.adoc b/components/camel-jmx/src/main/docs/jmx-component.adoc
index b5ddef8..32e5e9a 100644
--- a/components/camel-jmx/src/main/docs/jmx-component.adoc
+++ b/components/camel-jmx/src/main/docs/jmx-component.adoc
@@ -34,75 +34,46 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| serverURL | | String | server url comes from the remaining endpoint
+| Name | Description | Default | Type
+| **serverURL** | server url comes from the remaining endpoint | | String
|=======================================================================
#### Query Parameters (29 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| format | xml | String | URI Property: 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.
-
-| granularityPeriod | 10000 | long | URI Property: monitor types only The frequency to poll the bean to check the monitor.
-
-| monitorType | | String | URI Property: monitor types only The type of monitor to create. One of string gauge counter.
-
-| objectDomain | | String | *Required* URI Property: The domain for the mbean you're connecting to
-
-| objectName | | String | URI Property: The name key for the mbean you're connecting to. This value is mutually exclusive with the object properties that get passed.
-
-| observedAttribute | | String | URI Property: monitor types only The attribute to observe for the monitor bean.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| handback | | Object | URI Property: 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
-
-| notificationFilter | | NotificationFilter | URI Property: Reference to a bean that implements the NotificationFilter.
-
-| objectProperties | | Map | URI Property: properties for the object name. These values will be used if the objectName param is not set
-
-| reconnectDelay | 10 | int | URI Property: The number of seconds to wait before attempting to retry establishment of the initial connection or attempt to reconnect a lost connection
-
-| reconnectOnConnectionFailure | false | boolean | URI Property: 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
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| testConnectionOnStartup | true | boolean | URI Property: 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
- 4+^s| counter
-| initThreshold | | int | URI Property: counter monitor only Initial threshold for the monitor. The value must exceed this before notifications are fired.
-
-| modulus | | int | URI Property: counter monitor only The value at which the counter is reset to zero
-
-| offset | | int | URI Property: counter monitor only The amount to increment the threshold after it's been exceeded.
- 4+^s| gauge
-| differenceMode | false | boolean | URI Property: counter gauge monitor only If true then the value reported in the notification is the difference from the threshold as opposed to the value itself.
-
-| notifyHigh | false | boolean | URI Property: gauge monitor only If true the gauge will fire a notification when the high threshold is exceeded
-
-| notifyLow | false | boolean | URI Property: gauge monitor only If true the gauge will fire a notification when the low threshold is exceeded
-
-| thresholdHigh | | Double | URI Property: gauge monitor only Value for the gauge's high threshold
-
-| thresholdLow | | Double | URI Property: gauge monitor only Value for the gauge's low threshold
- 4+^s| security
-| password | | String | URI Property: credentials for making a remote connection
-
-| user | | String | URI Property: credentials for making a remote connection
- 4+^s| string
-| notifyDiffer | false | boolean | URI Property: string monitor only If true the string monitor will fire a notification when the string attribute differs from the string to compare.
-
-| notifyMatch | false | boolean | URI Property: string monitor only If true the string monitor will fire a notification when the string attribute matches the string to compare.
-
-| stringToCompare | | String | URI Property: string monitor only Value for the string monitor's string to compare.
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **format** (consumer) | URI Property: 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. | xml | String
+| **granularityPeriod** (consumer) | URI Property: monitor types only The frequency to poll the bean to check the monitor. | 10000 | long
+| **monitorType** (consumer) | URI Property: monitor types only The type of monitor to create. One of string gauge counter. | | String
+| **objectDomain** (consumer) | *Required* URI Property: The domain for the mbean you're connecting to | | String
+| **objectName** (consumer) | URI Property: The name key for the mbean you're connecting to. This value is mutually exclusive with the object properties that get passed. | | String
+| **observedAttribute** (consumer) | URI Property: monitor types only The attribute to observe for the monitor bean. | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **handback** (advanced) | URI Property: 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 | | Object
+| **notificationFilter** (advanced) | URI Property: Reference to a bean that implements the NotificationFilter. | | NotificationFilter
+| **objectProperties** (advanced) | URI Property: properties for the object name. These values will be used if the objectName param is not set | | Map
+| **reconnectDelay** (advanced) | URI Property: The number of seconds to wait before attempting to retry establishment of the initial connection or attempt to reconnect a lost connection | 10 | int
+| **reconnectOnConnection Failure** (advanced) | URI Property: 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 | false | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **testConnectionOnStartup** (advanced) | URI Property: 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 | true | boolean
+| **initThreshold** (counter) | URI Property: counter monitor only Initial threshold for the monitor. The value must exceed this before notifications are fired. | | int
+| **modulus** (counter) | URI Property: counter monitor only The value at which the counter is reset to zero | | int
+| **offset** (counter) | URI Property: counter monitor only The amount to increment the threshold after it's been exceeded. | | int
+| **differenceMode** (gauge) | URI Property: counter gauge monitor only If true then the value reported in the notification is the difference from the threshold as opposed to the value itself. | false | boolean
+| **notifyHigh** (gauge) | URI Property: gauge monitor only If true the gauge will fire a notification when the high threshold is exceeded | false | boolean
+| **notifyLow** (gauge) | URI Property: gauge monitor only If true the gauge will fire a notification when the low threshold is exceeded | false | boolean
+| **thresholdHigh** (gauge) | URI Property: gauge monitor only Value for the gauge's high threshold | | Double
+| **thresholdLow** (gauge) | URI Property: gauge monitor only Value for the gauge's low threshold | | Double
+| **password** (security) | URI Property: credentials for making a remote connection | | String
+| **user** (security) | URI Property: credentials for making a remote connection | | String
+| **notifyDiffer** (string) | URI Property: string monitor only If true the string monitor will fire a notification when the string attribute differs from the string to compare. | false | boolean
+| **notifyMatch** (string) | URI Property: string monitor only If true the string monitor will fire a notification when the string attribute matches the string to compare. | false | boolean
+| **stringToCompare** (string) | URI Property: string monitor only Value for the string monitor's string to compare. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jolt/src/main/docs/jolt-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jolt/src/main/docs/jolt-component.adoc b/components/camel-jolt/src/main/docs/jolt-component.adoc
index 931df53..2eeb0e1 100644
--- a/components/camel-jolt/src/main/docs/jolt-component.adoc
+++ b/components/camel-jolt/src/main/docs/jolt-component.adoc
@@ -45,13 +45,11 @@ The JOLT component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| transform | | Transform | Explicitly sets the Transform to use. If not set a Transform specified by the transformDsl will be created
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **transform** (advanced) | Explicitly sets the Transform to use. If not set a Transform specified by the transformDsl will be created | | Transform
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -69,27 +67,22 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| resourceUri | | String | *Required* 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.
+| Name | Description | Default | Type
+| **resourceUri** | *Required* 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. | | String
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| contentCache | false | boolean | Sets whether to use resource content cache or not
-
-| inputType | Hydrated | JoltInputOutputType | Specifies if the input is hydrated JSON or a JSON String.
-
-| outputType | Hydrated | JoltInputOutputType | Specifies if the output should be hydrated JSON or a JSON String.
-
-| transformDsl | Chainr | JoltTransformType | Specifies the Transform DSL of the endpoint resource. If none is specified Chainr will be used.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean
+| **inputType** (producer) | Specifies if the input is hydrated JSON or a JSON String. | Hydrated | JoltInputOutputType
+| **outputType** (producer) | Specifies if the output should be hydrated JSON or a JSON String. | Hydrated | JoltInputOutputType
+| **transformDsl** (producer) | Specifies the Transform DSL of the endpoint resource. If none is specified Chainr will be used. | Chainr | JoltTransformType
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jpa/src/main/docs/jpa-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jpa/src/main/docs/jpa-component.adoc b/components/camel-jpa/src/main/docs/jpa-component.adoc
index 3769f7f..8f168d5 100644
--- a/components/camel-jpa/src/main/docs/jpa-component.adoc
+++ b/components/camel-jpa/src/main/docs/jpa-component.adoc
@@ -98,19 +98,14 @@ The JPA component supports 5 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| entityManagerFactory | | EntityManagerFactory | To use the EntityManagerFactory. This is strongly recommended to configure.
-
-| transactionManager | | PlatformTransactionManager | To use the PlatformTransactionManager for managing transactions.
-
-| joinTransaction | true | boolean | 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.
-
-| sharedEntityManager | false | boolean | 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.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **entityManagerFactory** (common) | To use the EntityManagerFactory. This is strongly recommended to configure. | | EntityManagerFactory
+| **transactionManager** (common) | To use the PlatformTransactionManager for managing transactions. | | PlatformTransaction Manager
+| **joinTransaction** (common) | 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. | true | boolean
+| **sharedEntityManager** (common) | 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. | false | boolean
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -130,101 +125,59 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| entityType | | Class<?> | *Required* The JPA annotated class to use as entity.
+| Name | Description | Default | Type
+| **entityType** | *Required* The JPA annotated class to use as entity. | | Class<?>
|=======================================================================
#### Query Parameters (42 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| joinTransaction | true | boolean | 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.
-
-| maximumResults | -1 | int | Set the maximum number of results to retrieve on the Query.
-
-| namedQuery | | String | To use a named query.
-
-| nativeQuery | | String | To use a custom native query. You may want to use the option resultClass also when using native queries.
-
-| parameters | | Map | 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.
-
-| persistenceUnit | camel | String | *Required* The JPA persistence unit used by default.
-
-| query | | String | To use a custom query.
-
-| resultClass | | Class<?> | 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.
-
-| sharedEntityManager | false | boolean | 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.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| consumeDelete | true | boolean | If true the entity is deleted after it is consumed; if false the entity is not deleted.
-
-| consumeLockEntity | true | boolean | Specifies whether or not to set an exclusive lock on each entity bean while processing the results from polling.
-
-| deleteHandler | | Object> | To use a custom DeleteHandler to delete the row after the consumer is done processing the exchange
-
-| lockModeType | PESSIMISTIC_WRITE | LockModeType | To configure the lock mode on the consumer.
-
-| maxMessagesPerPoll | | int | 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.
-
-| preDeleteHandler | | Object> | To use a custom Pre-DeleteHandler to delete the row after the consumer has read the entity.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| skipLockedEntity | false | boolean | To configure whether to use NOWAIT on lock and silently skip the entity.
-
-| transacted | false | boolean | 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.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| producer
-| flushOnSend | true | boolean | Flushes the EntityManager after the entity bean has been persisted.
-
-| remove | false | boolean | Indicates to use entityManager.remove(entity).
-
-| useExecuteUpdate | | Boolean | 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'.
-
-| usePassedInEntityManager | false | boolean | If set to true then Camel will use the EntityManager from the header JpaConstants.ENTITYMANAGER instead of the configured entity manager on the component/endpoint. This allows end users to control which entity manager will be in use.
-
-| usePersist | false | boolean | 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)!
- 4+^s| advanced
-| entityManagerProperties | | Map | Additional properties for the entity manager to use.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **joinTransaction** (common) | 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. | true | boolean
+| **maximumResults** (common) | Set the maximum number of results to retrieve on the Query. | -1 | int
+| **namedQuery** (common) | To use a named query. | | String
+| **nativeQuery** (common) | To use a custom native query. You may want to use the option resultClass also when using native queries. | | String
+| **parameters** (common) | 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. | | Map
+| **persistenceUnit** (common) | *Required* The JPA persistence unit used by default. | camel | String
+| **query** (common) | To use a custom query. | | String
+| **resultClass** (common) | 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. | | Class<?>
+| **sharedEntityManager** (common) | 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. | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **consumeDelete** (consumer) | If true the entity is deleted after it is consumed; if false the entity is not deleted. | true | boolean
+| **consumeLockEntity** (consumer) | Specifies whether or not to set an exclusive lock on each entity bean while processing the results from polling. | true | boolean
+| **deleteHandler** (consumer) | To use a custom DeleteHandler to delete the row after the consumer is done processing the exchange | | Object>
+| **lockModeType** (consumer) | To configure the lock mode on the consumer. | PESSIMISTIC_WRITE | LockModeType
+| **maxMessagesPerPoll** (consumer) | 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. | | int
+| **preDeleteHandler** (consumer) | To use a custom Pre-DeleteHandler to delete the row after the consumer has read the entity. | | Object>
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **skipLockedEntity** (consumer) | To configure whether to use NOWAIT on lock and silently skip the entity. | false | boolean
+| **transacted** (consumer) | 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. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **flushOnSend** (producer) | Flushes the EntityManager after the entity bean has been persisted. | true | boolean
+| **remove** (producer) | Indicates to use entityManager.remove(entity). | false | boolean
+| **useExecuteUpdate** (producer) | 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'. | | Boolean
+| **usePassedInEntityManager** (producer) | If set to true then Camel will use the EntityManager from the header JpaConstants.ENTITYMANAGER instead of the configured entity manager on the component/endpoint. This allows end users to control which entity manager will be in use. | false | boolean
+| **usePersist** (producer) | 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)! | false | boolean
+| **entityManagerProperties** (advanced) | Additional properties for the entity manager to use. | | Map
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
[17/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc
index 085ff27..c6616b8 100644
--- a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc
+++ b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc
@@ -41,15 +41,12 @@ The Google Calendar component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| configuration | | GoogleCalendarConfiguration | To use the shared configuration
- 4+^s| advanced
-| clientFactory | | GoogleCalendarClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (common) | To use the shared configuration | | GoogleCalendar Configuration
+| **clientFactory** (advanced) | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory | | GoogleCalendarClient Factory
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -69,46 +66,32 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| apiName | | GoogleCalendarApiName | *Required* What kind of operation to perform
-| methodName | | String | *Required* What sub operation to use for the selected operation
+| Name | Description | Default | Type
+| **apiName** | *Required* What kind of operation to perform | | GoogleCalendarApiName
+| **methodName** | *Required* What sub operation to use for the selected operation | | String
|=======================================================================
#### Query Parameters (14 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| accessToken | | String | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.
-
-| applicationName | | String | Google calendar application name. Example would be camel-google-calendar/1.0
-
-| clientId | | String | Client ID of the calendar application
-
-| clientSecret | | String | Client secret of the calendar application
-
-| emailAddress | | String | The emailAddress of the Google Service Account.
-
-| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body
-
-| p12FileName | | String | The name of the p12 file which has the private key to use with the Google Service Account.
-
-| refreshToken | | String | 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.
-
-| scopes | https://www.googleapis.com/auth/calendar | String | 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.
-
-| user | | String | The email address of the user the application is trying to impersonate in the service account flow
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **accessToken** (common) | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. | | String
+| **applicationName** (common) | Google calendar application name. Example would be camel-google-calendar/1.0 | | String
+| **clientId** (common) | Client ID of the calendar application | | String
+| **clientSecret** (common) | Client secret of the calendar application | | String
+| **emailAddress** (common) | The emailAddress of the Google Service Account. | | String
+| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String
+| **p12FileName** (common) | The name of the p12 file which has the private key to use with the Google Service Account. | | String
+| **refreshToken** (common) | 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. | | String
+| **scopes** (common) | 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. | https://www.googleapis.com/auth/calendar | String
+| **user** (common) | The email address of the user the application is trying to impersonate in the service account flow | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-google-drive/src/main/docs/google-drive-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-google-drive/src/main/docs/google-drive-component.adoc b/components/camel-google-drive/src/main/docs/google-drive-component.adoc
index 4469677..26f5339 100644
--- a/components/camel-google-drive/src/main/docs/google-drive-component.adoc
+++ b/components/camel-google-drive/src/main/docs/google-drive-component.adoc
@@ -66,15 +66,12 @@ The Google Drive component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| configuration | | GoogleDriveConfiguration | To use the shared configuration
- 4+^s| advanced
-| clientFactory | | GoogleDriveClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (common) | To use the shared configuration | | GoogleDrive Configuration
+| **clientFactory** (advanced) | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory | | GoogleDriveClient Factory
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -94,42 +91,30 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| apiName | | GoogleDriveApiName | *Required* What kind of operation to perform
-| methodName | | String | *Required* What sub operation to use for the selected operation
+| Name | Description | Default | Type
+| **apiName** | *Required* What kind of operation to perform | | GoogleDriveApiName
+| **methodName** | *Required* What sub operation to use for the selected operation | | String
|=======================================================================
#### Query Parameters (12 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| accessToken | | String | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.
-
-| applicationName | | String | Google drive application name. Example would be camel-google-drive/1.0
-
-| clientFactory | | GoogleDriveClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory
-
-| clientId | | String | Client ID of the drive application
-
-| clientSecret | | String | Client secret of the drive application
-
-| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body
-
-| refreshToken | | String | 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.
-
-| scopes | | List | 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.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **accessToken** (common) | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. | | String
+| **applicationName** (common) | Google drive application name. Example would be camel-google-drive/1.0 | | String
+| **clientFactory** (common) | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory | | GoogleDriveClient Factory
+| **clientId** (common) | Client ID of the drive application | | String
+| **clientSecret** (common) | Client secret of the drive application | | String
+| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String
+| **refreshToken** (common) | 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. | | String
+| **scopes** (common) | 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. | | List
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-google-mail/src/main/docs/google-mail-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-google-mail/src/main/docs/google-mail-component.adoc b/components/camel-google-mail/src/main/docs/google-mail-component.adoc
index d7ac3e0..95100c5 100644
--- a/components/camel-google-mail/src/main/docs/google-mail-component.adoc
+++ b/components/camel-google-mail/src/main/docs/google-mail-component.adoc
@@ -61,15 +61,12 @@ The Google Mail component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| configuration | | GoogleMailConfiguration | To use the shared configuration
- 4+^s| advanced
-| clientFactory | | GoogleMailClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleMailClientFactory
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (common) | To use the shared configuration | | GoogleMailConfiguration
+| **clientFactory** (advanced) | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleMailClientFactory | | GoogleMailClient Factory
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -88,40 +85,29 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| apiName | | GoogleMailApiName | *Required* What kind of operation to perform
-| methodName | | String | *Required* What sub operation to use for the selected operation
+| Name | Description | Default | Type
+| **apiName** | *Required* What kind of operation to perform | | GoogleMailApiName
+| **methodName** | *Required* What sub operation to use for the selected operation | | String
|=======================================================================
#### Query Parameters (11 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| accessToken | | String | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.
-
-| applicationName | | String | Google mail application name. Example would be camel-google-mail/1.0
-
-| clientId | | String | Client ID of the mail application
-
-| clientSecret | | String | Client secret of the mail application
-
-| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body
-
-| refreshToken | | String | 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.
-
-| scopes | | List | Specifies the level of permissions you want a mail application to have to a user account. See https://developers.google.com/gmail/api/auth/scopes for more info.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **accessToken** (common) | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. | | String
+| **applicationName** (common) | Google mail application name. Example would be camel-google-mail/1.0 | | String
+| **clientId** (common) | Client ID of the mail application | | String
+| **clientSecret** (common) | Client secret of the mail application | | String
+| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String
+| **refreshToken** (common) | 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. | | String
+| **scopes** (common) | Specifies the level of permissions you want a mail application to have to a user account. See https://developers.google.com/gmail/api/auth/scopes for more info. | | List
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc b/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
index e7935ae..28787b6 100644
--- a/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
+++ b/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc
@@ -59,13 +59,11 @@ The Google Pubsub component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| connectionFactory | | GooglePubsubConnectionFactory | Sets the connection factory to use: provides the ability to explicitly manage connection credentials: - the path to the key file - the Service Account Key / Email pair
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **connectionFactory** (common) | Sets the connection factory to use: provides the ability to explicitly manage connection credentials: - the path to the key file - the Service Account Key / Email pair | | GooglePubsubConnection Factory
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -78,36 +76,27 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| projectId | | String | *Required* Project Id
-| destinationName | | String | *Required* Destination Name
+| Name | Description | Default | Type
+| **projectId** | *Required* Project Id | | String
+| **destinationName** | *Required* Destination Name | | String
|=======================================================================
#### Query Parameters (9 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| ackMode | AUTO | AckMode | AUTO = exchange gets ack'ed/nack'ed on completion. NONE = downstream process has to ack/nack explicitly
-
-| concurrentConsumers | 1 | Integer | The number of parallel streams consuming from the subscription
-
-| connectionFactory | | GooglePubsubConnectionFactory | ConnectionFactory to obtain connection to PubSub Service. If non provided the default will be used.
-
-| loggerId | | String | Logger ID to use when a match to the parent route required
-
-| maxMessagesPerPoll | 1 | Integer | The max number of messages to receive from the server in a single API call
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **ackMode** (common) | AUTO = exchange gets ack'ed/nack'ed on completion. NONE = downstream process has to ack/nack explicitly | AUTO | AckMode
+| **concurrentConsumers** (common) | The number of parallel streams consuming from the subscription | 1 | Integer
+| **connectionFactory** (common) | ConnectionFactory to obtain connection to PubSub Service. If non provided the default will be used. | | GooglePubsubConnection Factory
+| **loggerId** (common) | Logger ID to use when a match to the parent route required | | String
+| **maxMessagesPerPoll** (common) | The max number of messages to receive from the server in a single API call | 1 | Integer
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-gora/src/main/docs/gora-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-gora/src/main/docs/gora-component.adoc b/components/camel-gora/src/main/docs/gora-component.adoc
index cbd7398..9e3916a 100644
--- a/components/camel-gora/src/main/docs/gora-component.adoc
+++ b/components/camel-gora/src/main/docs/gora-component.adoc
@@ -91,59 +91,38 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* Instance name
+| Name | Description | Default | Type
+| **name** | *Required* Instance name | | String
|=======================================================================
#### Query Parameters (21 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| dataStoreClass | | String | The type of the dataStore
-
-| keyClass | | String | The type class of the key
-
-| valueClass | | String | The type of the value
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| concurrentConsumers | 1 | int | Number of concurrent consumers
-
-| endKey | | Object | The End Key
-
-| endTime | | long | The End Time
-
-| fields | | Strings | The Fields
-
-| keyRangeFrom | | Object | The Key Range From
-
-| keyRangeTo | | Object | The Key Range To
-
-| limit | | long | The Limit
-
-| startKey | | Object | The Start Key
-
-| startTime | | long | The Start Time
-
-| timeRangeFrom | | long | The Time Range From
-
-| timeRangeTo | | long | The Time Range To
-
-| timestamp | | long | The Timestamp
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| flushOnEveryOperation | true | boolean | Flush on every operation
- 4+^s| advanced
-| hadoopConfiguration | | Configuration | Hadoop Configuration
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **dataStoreClass** (common) | The type of the dataStore | | String
+| **keyClass** (common) | The type class of the key | | String
+| **valueClass** (common) | The type of the value | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **concurrentConsumers** (consumer) | Number of concurrent consumers | 1 | int
+| **endKey** (consumer) | The End Key | | Object
+| **endTime** (consumer) | The End Time | | long
+| **fields** (consumer) | The Fields | | Strings
+| **keyRangeFrom** (consumer) | The Key Range From | | Object
+| **keyRangeTo** (consumer) | The Key Range To | | Object
+| **limit** (consumer) | The Limit | | long
+| **startKey** (consumer) | The Start Key | | Object
+| **startTime** (consumer) | The Start Time | | long
+| **timeRangeFrom** (consumer) | The Time Range From | | long
+| **timeRangeTo** (consumer) | The Time Range To | | long
+| **timestamp** (consumer) | The Timestamp | | long
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **flushOnEveryOperation** (producer) | Flush on every operation | true | boolean
+| **hadoopConfiguration** (advanced) | Hadoop Configuration | | Configuration
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-grape/src/main/docs/grape-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-grape/src/main/docs/grape-component.adoc b/components/camel-grape/src/main/docs/grape-component.adoc
index ebc1ba1..2119770 100644
--- a/components/camel-grape/src/main/docs/grape-component.adoc
+++ b/components/camel-grape/src/main/docs/grape-component.adoc
@@ -25,21 +25,19 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| defaultCoordinates | | String | *Required* Maven coordinates to use as default to grab if the message body is empty.
+| Name | Description | Default | Type
+| **defaultCoordinates** | *Required* Maven coordinates to use as default to grab if the message body is empty. | | String
|=======================================================================
#### Query Parameters (2 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| exchangePattern | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **exchangePattern** () | Sets the default exchange pattern when creating an exchange. | InOnly | ExchangePattern
+| **synchronous** () | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc b/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
index 0dde801..0926d61 100644
--- a/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
+++ b/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc
@@ -51,15 +51,12 @@ The Guava EventBus component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| eventBus | | EventBus | To use the given Guava EventBus instance
-
-| listenerInterface | | Class<?> | 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.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **eventBus** (common) | To use the given Guava EventBus instance | | EventBus
+| **listenerInterface** (common) | 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. | | Class<?>
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -76,29 +73,23 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| eventBusRef | | String | To lookup the Guava EventBus from the registry with the given name
+| Name | Description | Default | Type
+| **eventBusRef** | To lookup the Guava EventBus from the registry with the given name | | String
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| eventClass | | Class<?> | 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.
-
-| listenerInterface | | Class<?> | 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.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **eventClass** (common) | 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. | | Class<?>
+| **listenerInterface** (common) | 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. | | Class<?>
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-hazelcast/src/main/docs/hazelcast-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-component.adoc
index 277d2e8..184f039 100644
--- a/components/camel-hazelcast/src/main/docs/hazelcast-component.adoc
+++ b/components/camel-hazelcast/src/main/docs/hazelcast-component.adoc
@@ -50,15 +50,12 @@ The Hazelcast component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| hazelcastInstance | | HazelcastInstance | The hazelcast instance reference 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.
-
-| hazelcastMode | node | String | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **hazelcastInstance** (advanced) | The hazelcast instance reference 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. | | HazelcastInstance
+| **hazelcastMode** (advanced) | The hazelcast mode reference which kind of instance should be used. If you don't specify the mode then the node mode will be the default. | node | String
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -76,42 +73,30 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| command | | HazelcastCommand | *Required* What operation to perform.
-| cacheName | | String | *Required* The name of the cache
+| Name | Description | Default | Type
+| **command** | *Required* What operation to perform. | | HazelcastCommand
+| **cacheName** | *Required* The name of the cache | | String
|=======================================================================
#### Query Parameters (12 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| defaultOperation | | String | To specify a default operation to use if no operation header has been provided.
-
-| hazelcastInstance | | HazelcastInstance | The hazelcast instance reference which can be used for hazelcast endpoint.
-
-| hazelcastInstanceName | | String | 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.
-
-| reliable | false | boolean | Define if the endpoint will use a reliable Topic struct or not.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| seda
-| concurrentConsumers | 1 | int | To use concurrent consumers polling from the SEDA queue.
-
-| pollTimeout | 1000 | int | 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.
-
-| transacted | false | boolean | 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.
-
-| transferExchange | false | boolean | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped.
+| Name | Description | Default | Type
+| **defaultOperation** (common) | To specify a default operation to use if no operation header has been provided. | | String
+| **hazelcastInstance** (common) | The hazelcast instance reference which can be used for hazelcast endpoint. | | HazelcastInstance
+| **hazelcastInstanceName** (common) | 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. | | String
+| **reliable** (common) | Define if the endpoint will use a reliable Topic struct or not. | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **concurrentConsumers** (seda) | To use concurrent consumers polling from the SEDA queue. | 1 | int
+| **pollTimeout** (seda) | 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. | 1000 | int
+| **transacted** (seda) | 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. | false | boolean
+| **transferExchange** (seda) | If set to true the whole Exchange will be transfered. If header or body contains not serializable objects they will be skipped. | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-hbase/src/main/docs/hbase-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-hbase/src/main/docs/hbase-component.adoc b/components/camel-hbase/src/main/docs/hbase-component.adoc
index 597afe8..032c6f7 100644
--- a/components/camel-hbase/src/main/docs/hbase-component.adoc
+++ b/components/camel-hbase/src/main/docs/hbase-component.adoc
@@ -105,15 +105,12 @@ The HBase component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | Configuration | To use the shared configuration
- 4+^s| common
-| poolMaxSize | 10 | int | Maximum number of references to keep for each table in the HTable pool. The default value is 10.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use the shared configuration | | Configuration
+| **poolMaxSize** (common) | Maximum number of references to keep for each table in the HTable pool. The default value is 10. | 10 | int
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -131,49 +128,33 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| tableName | | String | *Required* The name of the table
+| Name | Description | Default | Type
+| **tableName** | *Required* The name of the table | | String
|=======================================================================
#### Query Parameters (16 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| cellMappingStrategyFactory | | CellMappingStrategyFactory | To use a custom CellMappingStrategyFactory that is responsible for mapping cells.
-
-| filters | | List | A list of filters to use.
-
-| mappingStrategyClassName | | String | The class name of a custom mapping strategy implementation.
-
-| mappingStrategyName | | String | The strategy to use for mapping Camel messages to HBase columns. Supported values: header or body.
-
-| rowMapping | | Map | 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.
-
-| rowModel | | HBaseRow | An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled
-
-| userGroupInformation | | UserGroupInformation | Defines privileges to communicate with HBase such as using kerberos.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| maxMessagesPerPoll | | int | 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.
-
-| operation | | String | The HBase operation to perform
-
-| remove | true | boolean | If the option is true Camel HBase Consumer will remove the rows which it processes.
-
-| removeHandler | | HBaseRemoveHandler | To use a custom HBaseRemoveHandler that is executed when a row is to be removed.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| maxResults | 100 | int | The maximum number of rows to scan.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **cellMappingStrategyFactory** (common) | To use a custom CellMappingStrategyFactory that is responsible for mapping cells. | | CellMappingStrategy Factory
+| **filters** (common) | A list of filters to use. | | List
+| **mappingStrategyClassName** (common) | The class name of a custom mapping strategy implementation. | | String
+| **mappingStrategyName** (common) | The strategy to use for mapping Camel messages to HBase columns. Supported values: header or body. | | String
+| **rowMapping** (common) | 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. | | Map
+| **rowModel** (common) | An instance of org.apache.camel.component.hbase.model.HBaseRow which describes how each row should be modeled | | HBaseRow
+| **userGroupInformation** (common) | Defines privileges to communicate with HBase such as using kerberos. | | UserGroupInformation
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **maxMessagesPerPoll** (consumer) | 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. | | int
+| **operation** (consumer) | The HBase operation to perform | | String
+| **remove** (consumer) | If the option is true Camel HBase Consumer will remove the rows which it processes. | true | boolean
+| **removeHandler** (consumer) | To use a custom HBaseRemoveHandler that is executed when a row is to be removed. | | HBaseRemoveHandler
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **maxResults** (producer) | The maximum number of rows to scan. | 100 | int
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-hdfs/src/main/docs/hdfs-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-hdfs/src/main/docs/hdfs-component.adoc b/components/camel-hdfs/src/main/docs/hdfs-component.adoc
index 47ef064..5d192e9 100644
--- a/components/camel-hdfs/src/main/docs/hdfs-component.adoc
+++ b/components/camel-hdfs/src/main/docs/hdfs-component.adoc
@@ -59,13 +59,11 @@ The HDFS component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| jAASConfiguration | | Configuration | To use the given configuration for security with JAAS.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **jAASConfiguration** (common) | To use the given configuration for security with JAAS. | | Configuration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -84,95 +82,57 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| hostName | | String | *Required* HDFS host to use
-| port | 8020 | int | HDFS port to use
-| path | | String | *Required* The directory path to use
+| Name | Description | Default | Type
+| **hostName** | *Required* HDFS host to use | | String
+| **port** | HDFS port to use | 8020 | int
+| **path** | *Required* The directory path to use | | String
|=======================================================================
#### Query Parameters (38 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| connectOnStartup | true | boolean | 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.
-
-| fileSystemType | HDFS | HdfsFileSystemType | Set to LOCAL to not use HDFS but local java.io.File instead.
-
-| fileType | NORMAL_FILE | HdfsFileType | The file type to use. For more details see Hadoop HDFS documentation about the various files types.
-
-| keyType | NULL | WritableType | The type for the key in case of sequence or map files.
-
-| owner | | String | The file owner must match this owner for the consumer to pickup the file. Otherwise the file is skipped.
-
-| valueType | BYTES | WritableType | The type for the key in case of sequence or map files
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| delay | 1000 | long | The interval (milliseconds) between the directory scans.
-
-| initialDelay | | long | For the consumer how much to wait (milliseconds) before to start scanning the directory.
-
-| pattern | * | String | The pattern used for scanning the directory
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| producer
-| append | false | boolean | Append to existing file. Notice that not all HDFS file systems support the append option.
-
-| overwrite | true | boolean | Whether to overwrite existing files with the same name
- 4+^s| advanced
-| blockSize | 67108864 | long | The size of the HDFS blocks
-
-| bufferSize | 4096 | int | The buffer size used by HDFS
-
-| checkIdleInterval | 500 | int | 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.
-
-| chunkSize | 4096 | int | When reading a normal file this is split into chunks producing a message per chunk.
-
-| compressionCodec | DEFAULT | HdfsCompressionCodec | The compression codec to use
-
-| compressionType | NONE | CompressionType | The compression type to use (is default not in use)
-
-| openedSuffix | opened | String | When a file is opened for reading/writing the file is renamed with this suffix to avoid to read it during the writing phase.
-
-| readSuffix | read | String | Once the file has been read is renamed with this suffix to avoid to read it again.
-
-| replication | 3 | short | The HDFS replication factor
-
-| splitStrategy | | String | 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:valueST: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
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **connectOnStartup** (common) | 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. | true | boolean
+| **fileSystemType** (common) | Set to LOCAL to not use HDFS but local java.io.File instead. | HDFS | HdfsFileSystemType
+| **fileType** (common) | The file type to use. For more details see Hadoop HDFS documentation about the various files types. | NORMAL_FILE | HdfsFileType
+| **keyType** (common) | The type for the key in case of sequence or map files. | NULL | WritableType
+| **owner** (common) | The file owner must match this owner for the consumer to pickup the file. Otherwise the file is skipped. | | String
+| **valueType** (common) | The type for the key in case of sequence or map files | BYTES | WritableType
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **delay** (consumer) | The interval (milliseconds) between the directory scans. | 1000 | long
+| **initialDelay** (consumer) | For the consumer how much to wait (milliseconds) before to start scanning the directory. | | long
+| **pattern** (consumer) | The pattern used for scanning the directory | * | String
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **append** (producer) | Append to existing file. Notice that not all HDFS file systems support the append option. | false | boolean
+| **overwrite** (producer) | Whether to overwrite existing files with the same name | true | boolean
+| **blockSize** (advanced) | The size of the HDFS blocks | 67108864 | long
+| **bufferSize** (advanced) | The buffer size used by HDFS | 4096 | int
+| **checkIdleInterval** (advanced) | 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. | 500 | int
+| **chunkSize** (advanced) | When reading a normal file this is split into chunks producing a message per chunk. | 4096 | int
+| **compressionCodec** (advanced) | The compression codec to use | DEFAULT | HdfsCompressionCodec
+| **compressionType** (advanced) | The compression type to use (is default not in use) | NONE | CompressionType
+| **openedSuffix** (advanced) | When a file is opened for reading/writing the file is renamed with this suffix to avoid to read it during the writing phase. | opened | String
+| **readSuffix** (advanced) | Once the file has been read is renamed with this suffix to avoid to read it again. | read | String
+| **replication** (advanced) | The HDFS replication factor | 3 | short
+| **splitStrategy** (advanced) | 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:valueST: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 | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
[03/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-sql/src/main/docs/sql-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sql/src/main/docs/sql-component.adoc b/components/camel-sql/src/main/docs/sql-component.adoc
index 92dee04..e9baa47 100644
--- a/components/camel-sql/src/main/docs/sql-component.adoc
+++ b/components/camel-sql/src/main/docs/sql-component.adoc
@@ -111,15 +111,12 @@ The SQL component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| dataSource | | DataSource | Sets the DataSource to use to communicate with the database.
- 4+^s| advanced
-| usePlaceholder | true | boolean | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **dataSource** (common) | Sets the DataSource to use to communicate with the database. | | DataSource
+| **usePlaceholder** (advanced) | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true | true | boolean
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -135,107 +132,62 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| query | | String | *Required* Sets the SQL query to perform. You can externalize the query by using file: or classpath: as prefix and specify the location of the file.
+| Name | Description | Default | Type
+| **query** | *Required* Sets the SQL query to perform. You can externalize the query by using file: or classpath: as prefix and specify the location of the file. | | String
|=======================================================================
#### Query Parameters (45 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| allowNamedParameters | true | boolean | Whether to allow using named parameters in the queries.
-
-| dataSource | | DataSource | Sets the DataSource to use to communicate with the database.
-
-| dataSourceRef | | String | Sets the reference to a DataSource to lookup from the registry to use for communicating with the database.
-
-| outputClass | | String | Specify the full package and class name to use as conversion when outputType=SelectOne.
-
-| outputHeader | | String | 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.
-
-| outputType | SelectList | SqlOutputType | 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.
-
-| separator | , | char | 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.
- 4+^s| consumer
-| breakBatchOnConsumeFail | false | boolean | Sets whether to break batch if onConsume failed.
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| expectedUpdateCount | -1 | int | Sets an expected update count to validate when using onConsume.
-
-| maxMessagesPerPoll | | int | Sets the maximum number of messages to poll
-
-| onConsume | | String | 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.
-
-| onConsumeBatchComplete | | String | After processing the entire batch this query can be executed to bulk update rows etc. The query cannot have parameters.
-
-| onConsumeFailed | | String | 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.
-
-| routeEmptyResultSet | false | boolean | 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.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| transacted | false | boolean | Enables or disables transaction. If enabled then if processing an exchange failed then the consumer break out processing any further exchanges to cause a rollback eager
-
-| useIterator | true | boolean | Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
-
-| processingStrategy | | SqlProcessingStrategy | Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch.
- 4+^s| producer
-| batch | false | boolean | Enables or disables batch mode
-
-| noop | false | boolean | 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
-
-| useMessageBodyForSql | false | boolean | 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.
- 4+^s| producer (advanced)
-| alwaysPopulateStatement | false | boolean | 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.
-
-| parametersCount | | int | 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.
- 4+^s| advanced
-| placeholder | # | String | 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).
-
-| prepareStatementStrategy | | SqlPrepareStatementStrategy | Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| templateOptions | | Map | Configures the Spring JdbcTemplate with the key/values from the Map
-
-| usePlaceholder | true | boolean | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **allowNamedParameters** (common) | Whether to allow using named parameters in the queries. | true | boolean
+| **dataSource** (common) | Sets the DataSource to use to communicate with the database. | | DataSource
+| **dataSourceRef** (common) | Sets the reference to a DataSource to lookup from the registry to use for communicating with the database. | | String
+| **outputClass** (common) | Specify the full package and class name to use as conversion when outputType=SelectOne. | | String
+| **outputHeader** (common) | 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. | | String
+| **outputType** (common) | 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. | SelectList | SqlOutputType
+| **separator** (common) | 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. | , | char
+| **breakBatchOnConsumeFail** (consumer) | Sets whether to break batch if onConsume failed. | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **expectedUpdateCount** (consumer) | Sets an expected update count to validate when using onConsume. | -1 | int
+| **maxMessagesPerPoll** (consumer) | Sets the maximum number of messages to poll | | int
+| **onConsume** (consumer) | 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. | | String
+| **onConsumeBatchComplete** (consumer) | After processing the entire batch this query can be executed to bulk update rows etc. The query cannot have parameters. | | String
+| **onConsumeFailed** (consumer) | 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. | | String
+| **routeEmptyResultSet** (consumer) | 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. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **transacted** (consumer) | Enables or disables transaction. If enabled then if processing an exchange failed then the consumer break out processing any further exchanges to cause a rollback eager | false | boolean
+| **useIterator** (consumer) | Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true. | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **processingStrategy** (consumer) | Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch. | | SqlProcessingStrategy
+| **batch** (producer) | Enables or disables batch mode | false | boolean
+| **noop** (producer) | 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 | false | boolean
+| **useMessageBodyForSql** (producer) | 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. | false | boolean
+| **alwaysPopulateStatement** (producer) | 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. | false | boolean
+| **parametersCount** (producer) | 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. | | int
+| **placeholder** (advanced) | 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). | # | String
+| **prepareStatementStrategy** (advanced) | Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement. | | SqlPrepareStatement Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **templateOptions** (advanced) | Configures the Spring JdbcTemplate with the key/values from the Map | | Map
+| **usePlaceholder** (advanced) | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true | true | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-sql/src/main/docs/sql-stored-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-sql/src/main/docs/sql-stored-component.adoc b/components/camel-sql/src/main/docs/sql-stored-component.adoc
index a02d139..e1b55de 100644
--- a/components/camel-sql/src/main/docs/sql-stored-component.adoc
+++ b/components/camel-sql/src/main/docs/sql-stored-component.adoc
@@ -67,13 +67,11 @@ The SQL StoredProcedure component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| producer
-| dataSource | | DataSource | Sets the DataSource to use to communicate with the database.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **dataSource** (producer) | Sets the DataSource to use to communicate with the database. | | DataSource
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -89,29 +87,23 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| template | | String | *Required* Sets the StoredProcedure template to perform
+| Name | Description | Default | Type
+| **template** | *Required* Sets the StoredProcedure template to perform | | String
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| batch | false | boolean | Enables or disables batch mode
-
-| dataSource | | DataSource | Sets the DataSource to use to communicate with the database.
-
-| noop | false | boolean | If set will ignore the results of the template and use the existing IN message as the OUT message for the continuation of processing
-
-| outputHeader | | String | Store the template result in a header instead of the message body. By default outputHeader == null and the template 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 template result and the original message body is preserved.
-
-| useMessageBodyForTemplate | false | boolean | Whether to use the message body as the template and then headers for parameters. If this option is enabled then the template in the uri is not used.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **batch** (producer) | Enables or disables batch mode | false | boolean
+| **dataSource** (producer) | Sets the DataSource to use to communicate with the database. | | DataSource
+| **noop** (producer) | If set will ignore the results of the template and use the existing IN message as the OUT message for the continuation of processing | false | boolean
+| **outputHeader** (producer) | Store the template result in a header instead of the message body. By default outputHeader == null and the template 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 template result and the original message body is preserved. | | String
+| **useMessageBodyForTemplate** (producer) | Whether to use the message body as the template and then headers for parameters. If this option is enabled then the template in the uri is not used. | false | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ssh/src/main/docs/ssh-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ssh/src/main/docs/ssh-component.adoc b/components/camel-ssh/src/main/docs/ssh-component.adoc
index 69403e8..3db3d0e 100644
--- a/components/camel-ssh/src/main/docs/ssh-component.adoc
+++ b/components/camel-ssh/src/main/docs/ssh-component.adoc
@@ -34,33 +34,21 @@ The SSH component supports 12 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | SshConfiguration | To use the shared SSH configuration
- 4+^s| common
-| host | | String | Sets the hostname of the remote SSH server.
-
-| port | | int | Sets the port number for the remote SSH server.
- 4+^s| security
-| username | | String | Sets the username to use in logging into the remote SSH server.
-
-| password | | String | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null.
- 4+^s| common
-| pollCommand | | String | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...). You may need to end your command with a newline and that must be URL encoded 0A
- 4+^s| security
-| keyPairProvider | | KeyPairProvider | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server.
-
-| keyType | | String | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa.
- 4+^s| common
-| timeout | | long | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds.
- 4+^s| security
-| certFilename | | String | Sets the resource path of the certificate to use for Authentication.
-
-| certResource | | String | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use the shared SSH configuration | | SshConfiguration
+| **host** (common) | Sets the hostname of the remote SSH server. | | String
+| **port** (common) | Sets the port number for the remote SSH server. | | int
+| **username** (security) | Sets the username to use in logging into the remote SSH server. | | String
+| **password** (security) | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. | | String
+| **pollCommand** (common) | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...). You may need to end your command with a newline and that must be URL encoded 0A | | String
+| **keyPairProvider** (security) | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. | | KeyPairProvider
+| **keyType** (security) | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa. | | String
+| **timeout** (common) | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. | | long
+| **certFilename** (security) | Sets the resource path of the certificate to use for Authentication. | | String
+| **certResource** (security) | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting. | | String
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -76,70 +64,44 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* Sets the hostname of the remote SSH server.
-| port | 22 | int | Sets the port number for the remote SSH server.
+| Name | Description | Default | Type
+| **host** | *Required* Sets the hostname of the remote SSH server. | | String
+| **port** | Sets the port number for the remote SSH server. | 22 | int
|=======================================================================
#### Query Parameters (26 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| timeout | 30000 | long | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| pollCommand | | String | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...) You may need to end your command with a newline and that must be URL encoded 0A
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| security
-| certResource | | String | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting.
-
-| keyPairProvider | | KeyPairProvider | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server.
-
-| keyType | ssh-rsa | String | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa.
-
-| password | | String | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null.
-
-| username | | String | Sets the username to use in logging into the remote SSH server.
+| Name | Description | Default | Type
+| **timeout** (common) | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. | 30000 | long
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **pollCommand** (consumer) | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...) You may need to end your command with a newline and that must be URL encoded 0A | | String
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **certResource** (security) | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting. | | String
+| **keyPairProvider** (security) | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. | | KeyPairProvider
+| **keyType** (security) | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa. | ssh-rsa | String
+| **password** (security) | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. | | String
+| **username** (security) | Sets the username to use in logging into the remote SSH server. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-stax/src/main/docs/stax-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-stax/src/main/docs/stax-component.adoc b/components/camel-stax/src/main/docs/stax-component.adoc
index c2befeb..e8ad441 100644
--- a/components/camel-stax/src/main/docs/stax-component.adoc
+++ b/components/camel-stax/src/main/docs/stax-component.adoc
@@ -62,19 +62,18 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| contentHandlerClass | | String | *Required* The FQN class name for the ContentHandler implementation to use.
+| Name | Description | Default | Type
+| **contentHandlerClass** | *Required* The FQN class name for the ContentHandler implementation to use. | | String
|=======================================================================
#### Query Parameters (1 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-stomp/src/main/docs/stomp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-stomp/src/main/docs/stomp-component.adoc b/components/camel-stomp/src/main/docs/stomp-component.adoc
index 0296941..6ad7c7a 100644
--- a/components/camel-stomp/src/main/docs/stomp-component.adoc
+++ b/components/camel-stomp/src/main/docs/stomp-component.adoc
@@ -38,21 +38,15 @@ The Stomp component supports 6 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | StompConfiguration | To use the shared stomp configuration
- 4+^s| common
-| brokerURL | | String | The URI of the Stomp broker to connect to
- 4+^s| security
-| login | | String | The username
-
-| passcode | | String | The password
- 4+^s| common
-| host | | String | The virtual host
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use the shared stomp configuration | | StompConfiguration
+| **brokerURL** (common) | The URI of the Stomp broker to connect to | | String
+| **login** (security) | The username | | String
+| **passcode** (security) | The password | | String
+| **host** (common) | The virtual host | | String
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -69,35 +63,26 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| destination | | String | *Required* Name of the queue
+| Name | Description | Default | Type
+| **destination** | *Required* Name of the queue | | String
|=======================================================================
#### Query Parameters (9 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| brokerURL | tcp://localhost:61613 | String | *Required* The URI of the Stomp broker to connect to
-
-| host | | String | The virtual host name
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| login | | String | The username
-
-| passcode | | String | The password
-
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
+| Name | Description | Default | Type
+| **brokerURL** (common) | *Required* The URI of the Stomp broker to connect to | tcp://localhost:61613 | String
+| **host** (common) | The virtual host name | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **login** (security) | The username | | String
+| **passcode** (security) | The password | | String
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-stream/src/main/docs/stream-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-stream/src/main/docs/stream-component.adoc b/components/camel-stream/src/main/docs/stream-component.adoc
index 492a1f4..97df8c8 100644
--- a/components/camel-stream/src/main/docs/stream-component.adoc
+++ b/components/camel-stream/src/main/docs/stream-component.adoc
@@ -61,53 +61,35 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| kind | | String | *Required* Kind of stream to use such as System.in or System.out.
+| Name | Description | Default | Type
+| **kind** | *Required* Kind of stream to use such as System.in or System.out. | | String
|=======================================================================
#### Query Parameters (18 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| encoding | | String | You can configure the encoding (is a charset name) to use text-based streams (for example message body is a String object). If not provided Camel uses the JVM default Charset.
-
-| fileName | | String | When using the stream:file URI format this option specifies the filename to stream to/from.
-
-| url | | String | When using the stream:url URI format this option specifies the URL to stream to/from. The input/output stream will be opened using the JDK URLConnection facility.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| groupLines | | int | To group X number of lines in the consumer. For example to group 10 lines and therefore only spit out an Exchange with 10 lines instead of 1 Exchange per line.
-
-| groupStrategy | | GroupStrategy | Allows to use a custom GroupStrategy to control how to group lines.
-
-| initialPromptDelay | 2000 | long | Initial delay in milliseconds before showing the message prompt. This delay occurs only once. Can be used during system startup to avoid message prompts being written while other logging is done to the system out.
-
-| promptDelay | | long | Optional delay in milliseconds before showing the message prompt.
-
-| promptMessage | | String | Message prompt to use when reading from stream:in; for example you could set this to Enter a command:
-
-| retry | false | boolean | Will retry opening the file if it's overwritten somewhat like tail --retry
-
-| scanStream | false | boolean | To be used for continuously reading a stream such as the unix tail command.
-
-| scanStreamDelay | | long | Delay in milliseconds between read attempts when using scanStream.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| autoCloseCount | | int | Number of messages to process before closing stream on Producer side. Never close stream by default (only when Producer is stopped). If more messages are sent the stream is reopened for another autoCloseCount batch.
-
-| closeOnDone | false | boolean | This option is used in combination with Splitter and streaming to the same file. The idea is to keep the stream open and only close when the Splitter is done to improve performance. Mind this requires that you only stream to the same file and not 2 or more files.
-
-| delay | | long | Initial delay in milliseconds before producing the stream.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **encoding** (common) | You can configure the encoding (is a charset name) to use text-based streams (for example message body is a String object). If not provided Camel uses the JVM default Charset. | | String
+| **fileName** (common) | When using the stream:file URI format this option specifies the filename to stream to/from. | | String
+| **url** (common) | When using the stream:url URI format this option specifies the URL to stream to/from. The input/output stream will be opened using the JDK URLConnection facility. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **groupLines** (consumer) | To group X number of lines in the consumer. For example to group 10 lines and therefore only spit out an Exchange with 10 lines instead of 1 Exchange per line. | | int
+| **groupStrategy** (consumer) | Allows to use a custom GroupStrategy to control how to group lines. | | GroupStrategy
+| **initialPromptDelay** (consumer) | Initial delay in milliseconds before showing the message prompt. This delay occurs only once. Can be used during system startup to avoid message prompts being written while other logging is done to the system out. | 2000 | long
+| **promptDelay** (consumer) | Optional delay in milliseconds before showing the message prompt. | | long
+| **promptMessage** (consumer) | Message prompt to use when reading from stream:in; for example you could set this to Enter a command: | | String
+| **retry** (consumer) | Will retry opening the file if it's overwritten somewhat like tail --retry | false | boolean
+| **scanStream** (consumer) | To be used for continuously reading a stream such as the unix tail command. | false | boolean
+| **scanStreamDelay** (consumer) | Delay in milliseconds between read attempts when using scanStream. | | long
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **autoCloseCount** (producer) | Number of messages to process before closing stream on Producer side. Never close stream by default (only when Producer is stopped). If more messages are sent the stream is reopened for another autoCloseCount batch. | | int
+| **closeOnDone** (producer) | This option is used in combination with Splitter and streaming to the same file. The idea is to keep the stream open and only close when the Splitter is done to improve performance. Mind this requires that you only stream to the same file and not 2 or more files. | false | boolean
+| **delay** (producer) | Initial delay in milliseconds before producing the stream. | | long
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-stringtemplate/src/main/docs/string-template-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc
index f60fc57..3c24125 100644
--- a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc
+++ b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc
@@ -51,25 +51,21 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| resourceUri | | String | *Required* 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.
+| Name | Description | Default | Type
+| **resourceUri** | *Required* 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. | | String
|=======================================================================
#### Query Parameters (4 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| contentCache | false | boolean | Sets whether to use resource content cache or not
-
-| delimiterStart | < | char | The variable start delimiter
-
-| delimiterStop | > | char | The variable end delimiter
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean
+| **delimiterStart** (producer) | The variable start delimiter | < | char
+| **delimiterStop** (producer) | The variable end delimiter | > | char
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-telegram/src/main/docs/telegram-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-telegram/src/main/docs/telegram-component.adoc b/components/camel-telegram/src/main/docs/telegram-component.adoc
index 0e3ee61..9b1dd53 100644
--- a/components/camel-telegram/src/main/docs/telegram-component.adoc
+++ b/components/camel-telegram/src/main/docs/telegram-component.adoc
@@ -47,13 +47,11 @@ The Telegram component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| security
-| authorizationToken | | String | The default Telegram authorization token to be used when the information is not provided in the endpoints.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **authorizationToken** (security) | The default Telegram authorization token to be used when the information is not provided in the endpoints. | | String
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -68,62 +66,40 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| type | | String | *Required* The endpoint type. Currently only the 'bots' type is supported.
-| authorizationToken | | String | *Required* The authorization token for using the bot (ask the BotFather) eg. 654321531:HGF_dTra456323dHuOedsE343211fqr3t-H.
+| Name | Description | Default | Type
+| **type** | *Required* The endpoint type. Currently only the 'bots' type is supported. | | String
+| **authorizationToken** | *Required* The authorization token for using the bot (ask the BotFather) eg. 654321531:HGF_dTra456323dHuOedsE343211fqr3t-H. | | String
|=======================================================================
#### Query Parameters (22 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| limit | 100 | Integer | Limit on the number of updates that can be received in a single polling request.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| timeout | 30 | Integer | Timeout in seconds for long polling. Put 0 for short polling or a bigger number for long polling. Long polling produces shorter response time.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| producer
-| chatId | | String | The identifier of the chat that will receive the produced messages. Chat ids can be first obtained from incoming messages (eg. when a telegram user starts a conversation with a bot its client sends automatically a '/start' message containing the chat id). It is an optional parameter as the chat id can be set dynamically for each outgoing message (using body or headers).
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **limit** (consumer) | Limit on the number of updates that can be received in a single polling request. | 100 | Integer
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **timeout** (consumer) | Timeout in seconds for long polling. Put 0 for short polling or a bigger number for long polling. Long polling produces shorter response time. | 30 | Integer
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **chatId** (producer) | The identifier of the chat that will receive the produced messages. Chat ids can be first obtained from incoming messages (eg. when a telegram user starts a conversation with a bot its client sends automatically a '/start' message containing the chat id). It is an optional parameter as the chat id can be set dynamically for each outgoing message (using body or headers). | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-tika/src/main/docs/tika-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-tika/src/main/docs/tika-component.adoc b/components/camel-tika/src/main/docs/tika-component.adoc
index 4d14c5a..1639336 100644
--- a/components/camel-tika/src/main/docs/tika-component.adoc
+++ b/components/camel-tika/src/main/docs/tika-component.adoc
@@ -48,27 +48,22 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| operation | | TikaOperation | *Required* Tika Operation. parse or detect
+| Name | Description | Default | Type
+| **operation** | *Required* Tika Operation. parse or detect | | TikaOperation
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| tikaConfig | | TikaConfig | Tika Config
-
-| tikaConfigUri | | String | Tika Config Uri: The URI of tika-config.xml
-
-| tikaParseOutputEncoding | | String | Tika Parse Output Encoding - Used to specify the character encoding of the parsed output. Defaults to Charset.defaultCharset() .
-
-| tikaParseOutputFormat | xml | TikaParseOutputFormat | Tika Output Format. Supported output formats. xml: Returns Parsed Content as XML. html: Returns Parsed Content as HTML. text: Returns Parsed Content as Text. textMain: Uses the boilerpipe library to automatically extract the main content from a web page.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **tikaConfig** (producer) | Tika Config | | TikaConfig
+| **tikaConfigUri** (producer) | Tika Config Uri: The URI of tika-config.xml | | String
+| **tikaParseOutputEncoding** (producer) | Tika Parse Output Encoding - Used to specify the character encoding of the parsed output. Defaults to Charset.defaultCharset() . | | String
+| **tikaParseOutputFormat** (producer) | Tika Output Format. Supported output formats. xml: Returns Parsed Content as XML. html: Returns Parsed Content as HTML. text: Returns Parsed Content as Text. textMain: Uses the boilerpipe library to automatically extract the main content from a web page. | xml | TikaParseOutputFormat
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
[27/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/xslt-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/xslt-component.adoc b/camel-core/src/main/docs/xslt-component.adoc
index 4deb512..67ab2ff 100644
--- a/camel-core/src/main/docs/xslt-component.adoc
+++ b/camel-core/src/main/docs/xslt-component.adoc
@@ -71,27 +71,18 @@ The XSLT component supports 9 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| xmlConverter | | XmlConverter | To use a custom implementation of org.apache.camel.converter.jaxp.XmlConverter
-
-| uriResolverFactory | | XsltUriResolverFactory | To use a custom javax.xml.transform.URIResolver which depends on a dynamic endpoint resource URI or which is a subclass of XsltUriResolver. Do not use in combination with uriResolver. See also link setUriResolver(URIResolver).
-
-| uriResolver | | URIResolver | To use a custom javax.xml.transform.URIResolver. Do not use in combination with uriResolverFactory. See also link setUriResolverFactory(XsltUriResolverFactory).
- 4+^s| producer
-| contentCache | false | boolean | Cache for the resource content (the stylesheet file) when it is loaded. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation.
-
-| saxon | false | boolean | Whether to use Saxon as the transformerFactoryClass. If enabled then the class net.sf.saxon.TransformerFactoryImpl. You would need to add Saxon to the classpath.
-
-| saxonExtensionFunctions | | List | Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry where you can comma to separate multiple values to lookup.
-
-| saxonConfiguration | true | Object | To use a custom Saxon configuration
- 4+^s| advanced
-| saxonConfigurationProperties | | Map | To set custom Saxon configuration properties
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **xmlConverter** (advanced) | To use a custom implementation of org.apache.camel.converter.jaxp.XmlConverter | | XmlConverter
+| **uriResolverFactory** (advanced) | To use a custom javax.xml.transform.URIResolver which depends on a dynamic endpoint resource URI or which is a subclass of XsltUriResolver. Do not use in combination with uriResolver. See also link setUriResolver(URIResolver). | | XsltUriResolverFactory
+| **uriResolver** (advanced) | To use a custom javax.xml.transform.URIResolver. Do not use in combination with uriResolverFactory. See also link setUriResolverFactory(XsltUriResolverFactory). | | URIResolver
+| **contentCache** (producer) | Cache for the resource content (the stylesheet file) when it is loaded. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation. | false | boolean
+| **saxon** (producer) | Whether to use Saxon as the transformerFactoryClass. If enabled then the class net.sf.saxon.TransformerFactoryImpl. You would need to add Saxon to the classpath. | false | boolean
+| **saxonExtensionFunctions** (producer) | Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry where you can comma to separate multiple values to lookup. | | List
+| **saxonConfiguration** (producer) | To use a custom Saxon configuration | true | Object
+| **saxonConfiguration Properties** (advanced) | To set custom Saxon configuration properties | | Map
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -105,51 +96,34 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| resourceUri | | String | *Required* The name of the template to load from classpath or file system
+| Name | Description | Default | Type
+| **resourceUri** | *Required* The name of the template to load from classpath or file system | | String
|=======================================================================
#### Query Parameters (17 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| allowStAX | true | boolean | Whether to allow using StAX as the javax.xml.transform.Source.
-
-| contentCache | true | boolean | Cache for the resource content (the stylesheet file) when it is loaded. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation.
-
-| deleteOutputFile | false | boolean | If you have output=file then this option dictates whether or not the output file should be deleted when the Exchange is done processing. For example suppose the output file is a temporary file then it can be a good idea to delete it after use.
-
-| failOnNullBody | true | boolean | Whether or not to throw an exception if the input body is null.
-
-| output | string | XsltOutput | Option to specify which output type to use. Possible values are: string bytes DOM file. The first three options are all in memory based where as file is streamed directly to a java.io.File. For file you must specify the filename in the IN header with the key Exchange.XSLT_FILE_NAME which is also CamelXsltFileName. Also any paths leading to the filename must be created beforehand otherwise an exception is thrown at runtime.
-
-| saxon | false | boolean | Whether to use Saxon as the transformerFactoryClass. If enabled then the class net.sf.saxon.TransformerFactoryImpl. You would need to add Saxon to the classpath.
-
-| transformerCacheSize | 0 | int | The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer().
- 4+^s| advanced
-| converter | | XmlConverter | To use a custom implementation of org.apache.camel.converter.jaxp.XmlConverter
-
-| entityResolver | | EntityResolver | To use a custom org.xml.sax.EntityResolver with javax.xml.transform.sax.SAXSource.
-
-| errorListener | | ErrorListener | Allows to configure to use a custom javax.xml.transform.ErrorListener. Beware when doing this then the default error listener which captures any errors or fatal errors and store information on the Exchange as properties is not in use. So only use this option for special use-cases.
-
-| resultHandlerFactory | | ResultHandlerFactory | Allows you to use a custom org.apache.camel.builder.xml.ResultHandlerFactory which is capable of using custom org.apache.camel.builder.xml.ResultHandler types.
-
-| saxonConfiguration | | Object | To use a custom Saxon configuration
-
-| saxonExtensionFunctions | | String | Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry where you can comma to separate multiple values to lookup.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| transformerFactory | | TransformerFactory | To use a custom XSLT transformer factory
-
-| transformerFactoryClass | | String | To use a custom XSLT transformer factory specified as a FQN class name
-
-| uriResolver | | URIResolver | To use a custom javax.xml.transform.URIResolver
+| Name | Description | Default | Type
+| **allowStAX** (producer) | Whether to allow using StAX as the javax.xml.transform.Source. | true | boolean
+| **contentCache** (producer) | Cache for the resource content (the stylesheet file) when it is loaded. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation. | true | boolean
+| **deleteOutputFile** (producer) | If you have output=file then this option dictates whether or not the output file should be deleted when the Exchange is done processing. For example suppose the output file is a temporary file then it can be a good idea to delete it after use. | false | boolean
+| **failOnNullBody** (producer) | Whether or not to throw an exception if the input body is null. | true | boolean
+| **output** (producer) | Option to specify which output type to use. Possible values are: string bytes DOM file. The first three options are all in memory based where as file is streamed directly to a java.io.File. For file you must specify the filename in the IN header with the key Exchange.XSLT_FILE_NAME which is also CamelXsltFileName. Also any paths leading to the filename must be created beforehand otherwise an exception is thrown at runtime. | string | XsltOutput
+| **saxon** (producer) | Whether to use Saxon as the transformerFactoryClass. If enabled then the class net.sf.saxon.TransformerFactoryImpl. You would need to add Saxon to the classpath. | false | boolean
+| **transformerCacheSize** (producer) | The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer(). | 0 | int
+| **converter** (advanced) | To use a custom implementation of org.apache.camel.converter.jaxp.XmlConverter | | XmlConverter
+| **entityResolver** (advanced) | To use a custom org.xml.sax.EntityResolver with javax.xml.transform.sax.SAXSource. | | EntityResolver
+| **errorListener** (advanced) | Allows to configure to use a custom javax.xml.transform.ErrorListener. Beware when doing this then the default error listener which captures any errors or fatal errors and store information on the Exchange as properties is not in use. So only use this option for special use-cases. | | ErrorListener
+| **resultHandlerFactory** (advanced) | Allows you to use a custom org.apache.camel.builder.xml.ResultHandlerFactory which is capable of using custom org.apache.camel.builder.xml.ResultHandler types. | | ResultHandlerFactory
+| **saxonConfiguration** (advanced) | To use a custom Saxon configuration | | Object
+| **saxonExtensionFunctions** (advanced) | Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry where you can comma to separate multiple values to lookup. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **transformerFactory** (advanced) | To use a custom XSLT transformer factory | | TransformerFactory
+| **transformerFactoryClass** (advanced) | To use a custom XSLT transformer factory specified as a FQN class name | | String
+| **uriResolver** (advanced) | To use a custom javax.xml.transform.URIResolver | | URIResolver
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc b/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc
index 627c379..a8f0370 100644
--- a/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc
+++ b/components/camel-ahc-ws/src/main/docs/ahc-ws-component.adoc
@@ -45,23 +45,16 @@ The AHC Websocket component supports 7 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| client | | AsyncHttpClient | To use a custom AsyncHttpClient
-
-| binding | | AhcBinding | To use a custom AhcBinding which allows to control how to bind between AHC and Camel.
-
-| clientConfig | | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance.
- 4+^s| security
-| sslContextParameters | | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level.
- 4+^s| advanced
-| allowJavaSerializedObject | false | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object 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.
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **client** (advanced) | To use a custom AsyncHttpClient | | AsyncHttpClient
+| **binding** (advanced) | To use a custom AhcBinding which allows to control how to bind between AHC and Camel. | | AhcBinding
+| **clientConfig** (advanced) | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance. | | AsyncHttpClientConfig
+| **sslContextParameters** (security) | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level. | | SSLContextParameters
+| **allowJavaSerialized Object** (advanced) | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object 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. | false | boolean
+| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -77,53 +70,35 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| httpUri | | URI | *Required* The URI to use such as http://hostname:port/path
+| Name | Description | Default | Type
+| **httpUri** | *Required* The URI to use such as http://hostname:port/path | | URI
|=======================================================================
#### Query Parameters (18 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeEndpoint | false | boolean | 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.
-
-| bufferSize | 4096 | int | The initial in-memory buffer size used when transferring data between Camel and AHC Client.
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-
-| throwExceptionOnFailure | true | boolean | 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.
-
-| transferException | false | boolean | 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.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| sendMessageOnError | false | boolean | Whether to send an message if the web-socket listener received an error.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| connectionClose | false | boolean | Define if the Connection Close header has to be added to HTTP Request. This parameter is false by default
-
-| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session
-
-| useStreaming | false | boolean | To enable streaming to send data as multiple text fragments.
- 4+^s| advanced
-| binding | | AhcBinding | To use a custom AhcBinding which allows to control how to bind between AHC and Camel.
-
-| clientConfig | | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance.
-
-| clientConfigOptions | | Map | To configure the AsyncHttpClientConfig using the key/values from the Map.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| clientConfigRealmOptions | | Map | To configure the AsyncHttpClientConfig Realm using the key/values from the Map.
-
-| sslContextParameters | | SSLContextParameters | Reference to a org.apache.camel.util.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.
+| Name | Description | Default | Type
+| **bridgeEndpoint** (common) | 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. | false | boolean
+| **bufferSize** (common) | The initial in-memory buffer size used when transferring data between Camel and AHC Client. | 4096 | int
+| **headerFilterStrategy** (common) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **throwExceptionOnFailure** (common) | 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. | true | boolean
+| **transferException** (common) | 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. | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **sendMessageOnError** (consumer) | Whether to send an message if the web-socket listener received an error. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **connectionClose** (producer) | Define if the Connection Close header has to be added to HTTP Request. This parameter is false by default | false | boolean
+| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler
+| **useStreaming** (producer) | To enable streaming to send data as multiple text fragments. | false | boolean
+| **binding** (advanced) | To use a custom AhcBinding which allows to control how to bind between AHC and Camel. | | AhcBinding
+| **clientConfig** (advanced) | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance. | | AsyncHttpClientConfig
+| **clientConfigOptions** (advanced) | To configure the AsyncHttpClientConfig using the key/values from the Map. | | Map
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **clientConfigRealmOptions** (security) | To configure the AsyncHttpClientConfig Realm using the key/values from the Map. | | Map
+| **sslContextParameters** (security) | Reference to a org.apache.camel.util.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. | | SSLContextParameters
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ahc/src/main/docs/ahc-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ahc/src/main/docs/ahc-component.adoc b/components/camel-ahc/src/main/docs/ahc-component.adoc
index 9b06f24..48a5c63 100644
--- a/components/camel-ahc/src/main/docs/ahc-component.adoc
+++ b/components/camel-ahc/src/main/docs/ahc-component.adoc
@@ -52,43 +52,30 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| httpUri | | URI | *Required* The URI to use such as http://hostname:port/path
+| Name | Description | Default | Type
+| **httpUri** | *Required* The URI to use such as http://hostname:port/path | | URI
|=======================================================================
#### Query Parameters (13 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeEndpoint | false | boolean | 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.
-
-| bufferSize | 4096 | int | The initial in-memory buffer size used when transferring data between Camel and AHC Client.
-
-| connectionClose | false | boolean | Define if the Connection Close header has to be added to HTTP Request. This parameter is false by default
-
-| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-
-| throwExceptionOnFailure | true | boolean | 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.
-
-| transferException | false | boolean | 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.
- 4+^s| advanced
-| binding | | AhcBinding | To use a custom AhcBinding which allows to control how to bind between AHC and Camel.
-
-| clientConfig | | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance.
-
-| clientConfigOptions | | Map | To configure the AsyncHttpClientConfig using the key/values from the Map.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| clientConfigRealmOptions | | Map | To configure the AsyncHttpClientConfig Realm using the key/values from the Map.
-
-| sslContextParameters | | SSLContextParameters | Reference to a org.apache.camel.util.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.
+| Name | Description | Default | Type
+| **bridgeEndpoint** (producer) | 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. | false | boolean
+| **bufferSize** (producer) | The initial in-memory buffer size used when transferring data between Camel and AHC Client. | 4096 | int
+| **connectionClose** (producer) | Define if the Connection Close header has to be added to HTTP Request. This parameter is false by default | false | boolean
+| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler
+| **headerFilterStrategy** (producer) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **throwExceptionOnFailure** (producer) | 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. | true | boolean
+| **transferException** (producer) | 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. | false | boolean
+| **binding** (advanced) | To use a custom AhcBinding which allows to control how to bind between AHC and Camel. | | AhcBinding
+| **clientConfig** (advanced) | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance. | | AsyncHttpClientConfig
+| **clientConfigOptions** (advanced) | To configure the AsyncHttpClientConfig using the key/values from the Map. | | Map
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **clientConfigRealmOptions** (security) | To configure the AsyncHttpClientConfig Realm using the key/values from the Map. | | Map
+| **sslContextParameters** (security) | Reference to a org.apache.camel.util.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. | | SSLContextParameters
|=======================================================================
// endpoint options: END
@@ -114,23 +101,16 @@ The AHC component supports 7 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| client | | AsyncHttpClient | To use a custom AsyncHttpClient
-
-| binding | | AhcBinding | To use a custom AhcBinding which allows to control how to bind between AHC and Camel.
-
-| clientConfig | | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance.
- 4+^s| security
-| sslContextParameters | | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level.
- 4+^s| advanced
-| allowJavaSerializedObject | false | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object 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.
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **client** (advanced) | To use a custom AsyncHttpClient | | AsyncHttpClient
+| **binding** (advanced) | To use a custom AhcBinding which allows to control how to bind between AHC and Camel. | | AhcBinding
+| **clientConfig** (advanced) | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance. | | AsyncHttpClientConfig
+| **sslContextParameters** (security) | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level. | | SSLContextParameters
+| **allowJavaSerialized Object** (advanced) | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object 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. | false | boolean
+| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
[18/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ftp/src/main/docs/sftp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ftp/src/main/docs/sftp-component.adoc b/components/camel-ftp/src/main/docs/sftp-component.adoc
index aa3eb1f..733caf9 100644
--- a/components/camel-ftp/src/main/docs/sftp-component.adoc
+++ b/components/camel-ftp/src/main/docs/sftp-component.adoc
@@ -38,236 +38,127 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* Hostname of the FTP server
-| port | | int | Port of the FTP server
-| directoryName | | String | The starting directory
+| Name | Description | Default | Type
+| **host** | *Required* Hostname of the FTP server | | String
+| **port** | Port of the FTP server | | int
+| **directoryName** | The starting directory | | String
|=======================================================================
#### Query Parameters (109 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| charset | | String | 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.
-
-| disconnect | false | boolean | 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.
-
-| doneFileName | | String | 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.
-
-| fileName | | String | 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 s
tore CamelFileName and have to restore it afterwards.
-
-| jschLoggingLevel | WARN | LoggingLevel | The logging level to use for JSCH activity logging. As JSCH is verbose at by default at INFO level the threshold is WARN by default.
-
-| separator | UNIX | PathSeparator | 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
- 4+^s| common (advanced)
-| fastExistsCheck | false | boolean | 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.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| delete | false | boolean | If true the file will be deleted after it is processed successfully.
-
-| moveFailed | | String | 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.
-
-| noop | false | boolean | 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.
-
-| preMove | | String | 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.
-
-| recursive | false | boolean | If a directory will look for files in all the sub-directories as well.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| streamDownload | false | boolean | 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.
- 4+^s| consumer (advanced)
-| directoryMustExist | false | boolean | Similar to startingDirectoryMustExist but this applies during polling recursive sub directories.
-
-| download | false | boolean | 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.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| ignoreFileNotFoundOrPermissionError | false | boolean | Whether to ignore when trying to download a file which does not exist or due to permission error. By default when a file does not exists or insufficient permission then an exception is thrown. Setting this option to true allows to ignore that instead.
-
-| inProgressRepository | | String> | 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.
-
-| localWorkDirectory | | String | 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.
-
-| onCompletionExceptionHandler | | ExceptionHandler | 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.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
-
-| processStrategy | | GenericFileProcessStrategy<T> | 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.
-
-| startingDirectoryMustExist | false | boolean | 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.
- 4+^s| producer
-| fileExist | Override | GenericFileExist | 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 Camel 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.
-
-| flatten | false | boolean | 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.
-
-| moveExisting | | String | 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.
-
-| tempFileName | | String | 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.
-
-| tempPrefix | | String | 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.
- 4+^s| producer (advanced)
-| allowNullBody | false | boolean | 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.
-
-| chmod | | String | Allows you to set chmod on the stored file. For example chmod=640.
-
-| disconnectOnBatchComplete | false | boolean | 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.
-
-| eagerDeleteTargetFile | true | boolean | 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.
-
-| keepLastModified | false | boolean | 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.
-
-| sendNoop | true | boolean | 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.
- 4+^s| advanced
-| autoCreate | true | boolean | 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.
-
-| bufferSize | 131072 | int | Write buffer sized in bytes.
-
-| bulkRequests | | Integer | Specifies how many requests may be outstanding at any one time. Increasing this value may slightly improve file transfer speed but will increase memory usage.
-
-| compression | | int | To use compression. Specify a level from 1 to 10. Important: You must manually add the needed JSCH zlib JAR to the classpath for compression support.
-
-| connectTimeout | 10000 | int | Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH
-
-| maximumReconnectAttempts | | int | Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior.
-
-| proxy | | Proxy | To use a custom configured com.jcraft.jsch.Proxy. This proxy is used to consume/send messages from the target SFTP host.
-
-| reconnectDelay | | long | Delay in millis Camel will wait before performing a reconnect attempt.
-
-| serverAliveCountMax | 1 | int | Allows you to set the serverAliveCountMax of the sftp session
-
-| serverAliveInterval | | int | Allows you to set the serverAliveInterval of the sftp session
-
-| soTimeout | 300000 | int | Sets the so timeout Used only by FTPClient
-
-| stepwise | true | boolean | 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.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| throwExceptionOnConnectFailed | false | boolean | 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.
-
-| timeout | 30000 | int | Sets the data timeout for waiting for reply Used only by FTPClient
- 4+^s| filter
-| antExclude | | String | 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.
-
-| antFilterCaseSensitive | true | boolean | Sets case sensitive flag on ant fiter
-
-| antInclude | | String | Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format.
-
-| eagerMaxMessagesPerPoll | true | boolean | 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.
-
-| exclude | | String | 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
-
-| filter | | GenericFileFilter<T> | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method.
-
-| filterDirectory | | String | 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
-
-| filterFile | | String | Filters the file based on Simple language. For example to filter on file size you can use $file:size 5000
-
-| idempotent | false | Boolean | 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.
-
-| idempotentKey | | String | 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
-
-| idempotentRepository | | String> | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true.
-
-| include | | String | 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
-
-| maxDepth | 2147483647 | int | The maximum depth to traverse when recursively processing a directory.
-
-| maxMessagesPerPoll | | int | 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.
-
-| minDepth | | int | 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.
-
-| move | | String | 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.
- 4+^s| lock
-| exclusiveReadLockStrategy | | GenericFileExclusiveReadLockStrategy<T> | Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation.
-
-| readLock | | String | 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 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 wher
e 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.
-
-| readLockCheckInterval | 1000 | long | 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.
-
-| readLockDeleteOrphanLockFiles | true | boolean | 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.
-
-| readLockLoggingLevel | WARN | LoggingLevel | Logging level used when a read lock could not be acquired. By default a WARN 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 rename.
-
-| readLockMarkerFile | true | boolean | 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.
-
-| readLockMinAge | 0 | long | This option applied only for readLock=change. This option 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.
-
-| readLockMinLength | 1 | long | This option applied only for readLock=changed. This option 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.
-
-| readLockRemoveOnCommit | false | boolean | This option applied only for readLock=idempotent. This option 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.
-
-| readLockRemoveOnRollback | true | boolean | This option applied only for readLock=idempotent. This option 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).
-
-| readLockTimeout | 10000 | long | 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.
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| sort
-| shuffle | false | boolean | To shuffle the list of files (sort in random order)
-
-| sortBy | | String | 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.
-
-| sorter | | GenericFile<T>> | Pluggable sorter as a java.util.Comparator class.
- 4+^s| security
-| ciphers | | String | Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: aes128-ctraes128-cbc3des-ctr3des-cbcblowfish-cbcaes192-cbcaes256-cbc. If not specified the default list from JSCH will be used.
-
-| keyPair | | KeyPair | Sets a key pair of the public and private key so to that the SFTP endpoint can do public/private key verification.
-
-| knownHosts | | byte[] | Sets the known_hosts from the byte array so that the SFTP endpoint can do host key verification.
-
-| knownHostsFile | | String | Sets the known_hosts file so that the SFTP endpoint can do host key verification.
-
-| knownHostsUri | | String | Sets the known_hosts file (loaded from classpath by default) so that the SFTP endpoint can do host key verification.
-
-| password | | String | Password to use for login
-
-| preferredAuthentications | | String | Set the preferred authentications which SFTP endpoint will used. Some example include:passwordpublickey. If not specified the default list from JSCH will be used.
-
-| privateKey | | byte[] | Set the private key as byte so that the SFTP endpoint can do private key verification.
-
-| privateKeyFile | | String | Set the private key file so that the SFTP endpoint can do private key verification.
-
-| privateKeyPassphrase | | String | Set the private key file passphrase so that the SFTP endpoint can do private key verification.
-
-| privateKeyUri | | String | Set the private key file (loaded from classpath by default) so that the SFTP endpoint can do private key verification.
-
-| strictHostKeyChecking | no | String | Sets whether to use strict host key checking.
-
-| username | | String | Username to use for login
-
-| useUserKnownHostsFile | true | boolean | If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts
+| Name | Description | Default | Type
+| **charset** (common) | 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. | | String
+| **disconnect** (common) | 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. | false | boolean
+| **doneFileName** (common) | 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. | | String
+| **fileName** (common) | 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. | | String
+| **jschLoggingLevel** (common) | The logging level to use for JSCH activity logging. As JSCH is verbose at by default at INFO level the threshold is WARN by default. | WARN | LoggingLevel
+| **separator** (common) | 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 | UNIX | PathSeparator
+| **fastExistsCheck** (common) | 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. | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **delete** (consumer) | If true the file will be deleted after it is processed successfully. | false | boolean
+| **moveFailed** (consumer) | 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. | | String
+| **noop** (consumer) | 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. | false | boolean
+| **preMove** (consumer) | 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. | | String
+| **recursive** (consumer) | If a directory will look for files in all the sub-directories as well. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **streamDownload** (consumer) | 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. | false | boolean
+| **directoryMustExist** (consumer) | Similar to startingDirectoryMustExist but this applies during polling recursive sub directories. | false | boolean
+| **download** (consumer) | 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. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **ignoreFileNotFoundOr PermissionError** (consumer) | Whether to ignore when trying to download a file which does not exist or due to permission error. By default when a file does not exists or insufficient permission then an exception is thrown. Setting this option to true allows to ignore that instead. | false | boolean
+| **inProgressRepository** (consumer) | 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. | | String>
+| **localWorkDirectory** (consumer) | 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. | | String
+| **onCompletionException Handler** (consumer) | 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. | | ExceptionHandler
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **processStrategy** (consumer) | 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. | | GenericFileProcess Strategy<T>
+| **startingDirectoryMustExist** (consumer) | 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. | false | boolean
+| **fileExist** (producer) | 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 Camel 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. | Override | Ge
nericFileExist
+| **flatten** (producer) | 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. | false | boolean
+| **moveExisting** (producer) | 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. | | String
+| **tempFileName** (producer) | 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. | | String
+| **tempPrefix** (producer) | 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. | | String
+| **allowNullBody** (producer) | 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. | false | boolean
+| **chmod** (producer) | Allows you to set chmod on the stored file. For example chmod=640. | | String
+| **disconnectOnBatchComplete** (producer) | 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. | false | boolean
+| **eagerDeleteTargetFile** (producer) | 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. | true | boolean
+| **keepLastModified** (producer) | 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. | false | boolean
+| **sendNoop** (producer) | 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. | true | boolean
+| **autoCreate** (advanced) | 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. | true | boolean
+| **bufferSize** (advanced) | Write buffer sized in bytes. | 131072 | int
+| **bulkRequests** (advanced) | Specifies how many requests may be outstanding at any one time. Increasing this value may slightly improve file transfer speed but will increase memory usage. | | Integer
+| **compression** (advanced) | To use compression. Specify a level from 1 to 10. Important: You must manually add the needed JSCH zlib JAR to the classpath for compression support. | | int
+| **connectTimeout** (advanced) | Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH | 10000 | int
+| **maximumReconnectAttempts** (advanced) | Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. | | int
+| **proxy** (advanced) | To use a custom configured com.jcraft.jsch.Proxy. This proxy is used to consume/send messages from the target SFTP host. | | Proxy
+| **reconnectDelay** (advanced) | Delay in millis Camel will wait before performing a reconnect attempt. | | long
+| **serverAliveCountMax** (advanced) | Allows you to set the serverAliveCountMax of the sftp session | 1 | int
+| **serverAliveInterval** (advanced) | Allows you to set the serverAliveInterval of the sftp session | | int
+| **soTimeout** (advanced) | Sets the so timeout Used only by FTPClient | 300000 | int
+| **stepwise** (advanced) | 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. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **throwExceptionOnConnect Failed** (advanced) | 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. | false | boolean
+| **timeout** (advanced) | Sets the data timeout for waiting for reply Used only by FTPClient | 30000 | int
+| **antExclude** (filter) | 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. | | String
+| **antFilterCaseSensitive** (filter) | Sets case sensitive flag on ant fiter | true | boolean
+| **antInclude** (filter) | Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format. | | String
+| **eagerMaxMessagesPerPoll** (filter) | 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. | true | boolean
+| **exclude** (filter) | 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 | | String
+| **filter** (filter) | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. | | GenericFileFilter<T>
+| **filterDirectory** (filter) | 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 | | String
+| **filterFile** (filter) | Filters the file based on Simple language. For example to filter on file size you can use $file:size 5000 | | String
+| **idempotent** (filter) | 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. | false | Boolean
+| **idempotentKey** (filter) | 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 | | String
+| **idempotentRepository** (filter) | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. | | String>
+| **include** (filter) | 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 | | String
+| **maxDepth** (filter) | The maximum depth to traverse when recursively processing a directory. | 2147483647 | int
+| **maxMessagesPerPoll** (filter) | 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. | | int
+| **minDepth** (filter) | 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. | | int
+| **move** (filter) | 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. | | String
+| **exclusiveReadLockStrategy** (lock) | Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation. | | GenericFileExclusive ReadLockStrategy<T>
+| **readLock** (lock) | 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 the FTP component. This approach should be avoided when accessing a r
emote 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. | | String
+| **readLockCheckInterval** (lock) | 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. | 1000 | long
+| **readLockDeleteOrphanLock Files** (lock) | 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. | true | boolean
+| **readLockLoggingLevel** (lock) | Logging level used when a read lock could not be acquired. By default a WARN 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 rename. | WARN | LoggingLevel
+| **readLockMarkerFile** (lock) | 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. | true | boolean
+| **readLockMinAge** (lock) | This option applied only for readLock=change. This option 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. | 0 | long
+| **readLockMinLength** (lock) | This option applied only for readLock=changed. This option 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. | 1 | long
+| **readLockRemoveOnCommit** (lock) | This option applied only for readLock=idempotent. This option 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. | false | boolean
+| **readLockRemoveOnRollback** (lock) | This option applied only for readLock=idempotent. This option 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). | true | boolean
+| **readLockTimeout** (lock) | 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. | 10000 | long
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **shuffle** (sort) | To shuffle the list of files (sort in random order) | false | boolean
+| **sortBy** (sort) | 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. | | String
+| **sorter** (sort) | Pluggable sorter as a java.util.Comparator class. | | GenericFile<T>>
+| **ciphers** (security) | Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: aes128-ctraes128-cbc3des-ctr3des-cbcblowfish-cbcaes192-cbcaes256-cbc. If not specified the default list from JSCH will be used. | | String
+| **keyPair** (security) | Sets a key pair of the public and private key so to that the SFTP endpoint can do public/private key verification. | | KeyPair
+| **knownHosts** (security) | Sets the known_hosts from the byte array so that the SFTP endpoint can do host key verification. | | byte[]
+| **knownHostsFile** (security) | Sets the known_hosts file so that the SFTP endpoint can do host key verification. | | String
+| **knownHostsUri** (security) | Sets the known_hosts file (loaded from classpath by default) so that the SFTP endpoint can do host key verification. | | String
+| **password** (security) | Password to use for login | | String
+| **preferredAuthentications** (security) | Set the preferred authentications which SFTP endpoint will used. Some example include:passwordpublickey. If not specified the default list from JSCH will be used. | | String
+| **privateKey** (security) | Set the private key as byte so that the SFTP endpoint can do private key verification. | | byte[]
+| **privateKeyFile** (security) | Set the private key file so that the SFTP endpoint can do private key verification. | | String
+| **privateKeyPassphrase** (security) | Set the private key file passphrase so that the SFTP endpoint can do private key verification. | | String
+| **privateKeyUri** (security) | Set the private key file (loaded from classpath by default) so that the SFTP endpoint can do private key verification. | | String
+| **strictHostKeyChecking** (security) | Sets whether to use strict host key checking. | no | String
+| **username** (security) | Username to use for login | | String
+| **useUserKnownHostsFile** (security) | If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ganglia/src/main/docs/ganglia-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ganglia/src/main/docs/ganglia-component.adoc b/components/camel-ganglia/src/main/docs/ganglia-component.adoc
index afc44f0..2bf3955 100644
--- a/components/camel-ganglia/src/main/docs/ganglia-component.adoc
+++ b/components/camel-ganglia/src/main/docs/ganglia-component.adoc
@@ -54,13 +54,11 @@ The Ganglia component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | GangliaConfiguration | To use the shared configuration
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use the shared configuration | | GangliaConfiguration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -78,44 +76,31 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | 239.2.11.71 | String | Host name for Ganglia server
-| port | 8649 | int | Port for Ganglia server
+| Name | Description | Default | Type
+| **host** | Host name for Ganglia server | 239.2.11.71 | String
+| **port** | Port for Ganglia server | 8649 | int
|=======================================================================
#### Query Parameters (13 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| dmax | 0 | int | 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.
-
-| groupName | java | String | The group that the metric belongs to.
-
-| metricName | metric | String | The name to use for the metric.
-
-| mode | MULTICAST | UDPAddressingMode | Send the UDP metric packets using MULTICAST or UNICAST
-
-| prefix | | String | Prefix the metric name with this string and an underscore.
-
-| slope | BOTH | GMetricSlope | The slope
-
-| spoofHostname | | String | Spoofing information IP:hostname
-
-| tmax | 60 | int | Maximum time in seconds that the value can be considered current. After this Ganglia considers the value to have expired.
-
-| ttl | 5 | int | If using multicast set the TTL of the packets
-
-| type | STRING | GMetricType | The type of value
-
-| units | | String | 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.
-
-| wireFormat31x | true | boolean | Use the wire format of Ganglia 3.1.0 and later versions. Set this to false to use Ganglia 3.0.x or earlier.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **dmax** (producer) | 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. | 0 | int
+| **groupName** (producer) | The group that the metric belongs to. | java | String
+| **metricName** (producer) | The name to use for the metric. | metric | String
+| **mode** (producer) | Send the UDP metric packets using MULTICAST or UNICAST | MULTICAST | UDPAddressingMode
+| **prefix** (producer) | Prefix the metric name with this string and an underscore. | | String
+| **slope** (producer) | The slope | BOTH | GMetricSlope
+| **spoofHostname** (producer) | Spoofing information IP:hostname | | String
+| **tmax** (producer) | Maximum time in seconds that the value can be considered current. After this Ganglia considers the value to have expired. | 60 | int
+| **ttl** (producer) | If using multicast set the TTL of the packets | 5 | int
+| **type** (producer) | The type of value | STRING | GMetricType
+| **units** (producer) | 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. | | String
+| **wireFormat31x** (producer) | Use the wire format of Ganglia 3.1.0 and later versions. Set this to false to use Ganglia 3.0.x or earlier. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-geocoder/src/main/docs/geocoder-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-geocoder/src/main/docs/geocoder-component.adoc b/components/camel-geocoder/src/main/docs/geocoder-component.adoc
index 39fb566..a0442da 100644
--- a/components/camel-geocoder/src/main/docs/geocoder-component.adoc
+++ b/components/camel-geocoder/src/main/docs/geocoder-component.adoc
@@ -47,46 +47,32 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| address | | String | The geo address which should be prefixed with address:
-| latlng | | String | The geo latitude and longitude which should be prefixed with latlng:
+| Name | Description | Default | Type
+| **address** | The geo address which should be prefixed with address: | | String
+| **latlng** | The geo latitude and longitude which should be prefixed with latlng: | | String
|=======================================================================
#### Query Parameters (14 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| clientId | | String | To use google premium with this client id
-
-| clientKey | | String | To use google premium with this client key
-
-| headersOnly | false | boolean | Whether to only enrich the Exchange with headers and leave the body as-is.
-
-| language | en | String | The language to use.
- 4+^s| advanced
-| httpClientConfigurer | | HttpClientConfigurer | Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc
-
-| httpConnectionManager | | HttpConnectionManager | To use a custom HttpConnectionManager to manage connections
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| proxy
-| proxyAuthDomain | | String | Domain for proxy NTML authentication
-
-| proxyAuthHost | | String | Optional host for proxy NTML authentication
-
-| proxyAuthMethod | | String | Authentication method for proxy either as Basic Digest or NTLM.
-
-| proxyAuthPassword | | String | Password for proxy authentication
-
-| proxyAuthUsername | | String | Username for proxy authentication
-
-| proxyHost | | String | The proxy host name
-
-| proxyPort | | Integer | The proxy port number
+| Name | Description | Default | Type
+| **clientId** (producer) | To use google premium with this client id | | String
+| **clientKey** (producer) | To use google premium with this client key | | String
+| **headersOnly** (producer) | Whether to only enrich the Exchange with headers and leave the body as-is. | false | boolean
+| **language** (producer) | The language to use. | en | String
+| **httpClientConfigurer** (advanced) | Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc | | HttpClientConfigurer
+| **httpConnectionManager** (advanced) | To use a custom HttpConnectionManager to manage connections | | HttpConnectionManager
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **proxyAuthDomain** (proxy) | Domain for proxy NTML authentication | | String
+| **proxyAuthHost** (proxy) | Optional host for proxy NTML authentication | | String
+| **proxyAuthMethod** (proxy) | Authentication method for proxy either as Basic Digest or NTLM. | | String
+| **proxyAuthPassword** (proxy) | Password for proxy authentication | | String
+| **proxyAuthUsername** (proxy) | Username for proxy authentication | | String
+| **proxyHost** (proxy) | The proxy host name | | String
+| **proxyPort** (proxy) | The proxy port number | | Integer
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-git/src/main/docs/git-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-git/src/main/docs/git-component.adoc b/components/camel-git/src/main/docs/git-component.adoc
index 71522ea..fe66e00 100644
--- a/components/camel-git/src/main/docs/git-component.adoc
+++ b/components/camel-git/src/main/docs/git-component.adoc
@@ -44,43 +44,30 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| localPath | | String | *Required* Local repository path
+| Name | Description | Default | Type
+| **localPath** | *Required* Local repository path | | String
|=======================================================================
#### Query Parameters (13 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| branchName | | String | The branch name to work on
-
-| password | | String | Remote repository password
-
-| remoteName | | String | The remote repository name to use in particular operation like pull
-
-| remotePath | | String | The remote repository path
-
-| tagName | | String | The tag name to work on
-
-| username | | String | Remote repository username
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| type | | GitType | The consumer type
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| allowEmpty | true | boolean | The flag to manage empty git commits
-
-| operation | | String | The operation to do on the repository
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **branchName** (common) | The branch name to work on | | String
+| **password** (common) | Remote repository password | | String
+| **remoteName** (common) | The remote repository name to use in particular operation like pull | | String
+| **remotePath** (common) | The remote repository path | | String
+| **tagName** (common) | The tag name to work on | | String
+| **username** (common) | Remote repository username | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **type** (consumer) | The consumer type | | GitType
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **allowEmpty** (producer) | The flag to manage empty git commits | true | boolean
+| **operation** (producer) | The operation to do on the repository | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-github/src/main/docs/github-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-github/src/main/docs/github-component.adoc b/components/camel-github/src/main/docs/github-component.adoc
index 3231b77..b9679d8 100644
--- a/components/camel-github/src/main/docs/github-component.adoc
+++ b/components/camel-github/src/main/docs/github-component.adoc
@@ -59,42 +59,30 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| type | | GitHubType | *Required* What git operation to execute
-| branchName | | String | Name of branch
+| Name | Description | Default | Type
+| **type** | *Required* What git operation to execute | | GitHubType
+| **branchName** | Name of branch | | String
|=======================================================================
#### Query Parameters (12 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| oauthToken | | String | GitHub OAuth token required unless username & password are provided
-
-| password | | String | GitHub password required unless oauthToken is provided
-
-| repoName | | String | *Required* GitHub repository name
-
-| repoOwner | | String | *Required* GitHub repository owner (organization)
-
-| username | | String | GitHub username required unless oauthToken is provided
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| encoding | | String | To use the given encoding when getting a git commit file
-
-| state | | String | To set git commit status state
-
-| targetUrl | | String | To set git commit status target url
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **oauthToken** (common) | GitHub OAuth token required unless username & password are provided | | String
+| **password** (common) | GitHub password required unless oauthToken is provided | | String
+| **repoName** (common) | *Required* GitHub repository name | | String
+| **repoOwner** (common) | *Required* GitHub repository owner (organization) | | String
+| **username** (common) | GitHub username required unless oauthToken is provided | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **encoding** (producer) | To use the given encoding when getting a git commit file | | String
+| **state** (producer) | To set git commit status state | | String
+| **targetUrl** (producer) | To set git commit status target url | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
[04/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-snmp/src/main/docs/snmp-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-snmp/src/main/docs/snmp-component.adoc b/components/camel-snmp/src/main/docs/snmp-component.adoc
index e37146d..100b522 100644
--- a/components/camel-snmp/src/main/docs/snmp-component.adoc
+++ b/components/camel-snmp/src/main/docs/snmp-component.adoc
@@ -57,86 +57,52 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* Hostname of the SNMP enabled device
-| port | | Integer | *Required* Port number of the SNMP enabled device
+| Name | Description | Default | Type
+| **host** | *Required* Hostname of the SNMP enabled device | | String
+| **port** | *Required* Port number of the SNMP enabled device | | Integer
|=======================================================================
#### Query Parameters (34 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| delay | 60000 | long | Sets update rate in seconds
-
-| oids | | String | Defines which values you are interested in. Please have a look at the Wikipedia to get a better understanding. You may provide a single OID or a coma separated list of OIDs. Example: oids=1.3.6.1.2.1.1.3.01.3.6.1.2.1.25.3.2.1.5.11.3.6.1.2.1.25.3.5.1.1.11.3.6.1.2.1.43.5.1.1.11.1
-
-| protocol | udp | String | Here you can select which protocol to use. You can use either udp or tcp.
-
-| retries | 2 | int | Defines how often a retry is made before canceling the request.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| snmpCommunity | public | String | Sets the community octet string for the snmp request.
-
-| snmpContextEngineId | | String | Sets the context engine ID field of the scoped PDU.
-
-| snmpContextName | | String | Sets the context name field of this scoped PDU.
-
-| snmpVersion | 0 | int | Sets the snmp version for the request. The value 0 means SNMPv1 1 means SNMPv2c and the value 3 means SNMPv3
-
-| timeout | 1500 | int | Sets the timeout value for the request in millis.
-
-| type | | SnmpActionType | Which operation to perform such as poll trap etc.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| security
-| authenticationPassphrase | | String | The authentication passphrase. If not null authenticationProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown.
-
-| authenticationProtocol | | String | Authentication protocol to use if security level is set to enable authentication The possible values are: MD5 SHA1
-
-| privacyPassphrase | | String | The privacy passphrase. If not null privacyProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown.
-
-| privacyProtocol | | String | The privacy protocol ID to be associated with this user. If set to null this user only supports unencrypted messages.
-
-| securityLevel | 3 | int | Sets the security level for this target. The supplied security level must be supported by the security model dependent information associated with the security name set for this target. The value 1 means: No authentication and no encryption. Anyone can create and read messages with this security level The value 2 means: Authentication and no encryption. Only the one with the right authentication key can create messages with this security level but anyone can read the contents of the message. The value 3 means: Authentication and encryption. Only the one with the right authentication key can create messages with this security level and only the one with the right encryption/decryption key can read the contents of the message.
-
-| securityName | | String | Sets the security name to be used with this target.
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **delay** (consumer) | Sets update rate in seconds | 60000 | long
+| **oids** (consumer) | Defines which values you are interested in. Please have a look at the Wikipedia to get a better understanding. You may provide a single OID or a coma separated list of OIDs. Example: oids=1.3.6.1.2.1.1.3.01.3.6.1.2.1.25.3.2.1.5.11.3.6.1.2.1.25.3.5.1.1.11.3.6.1.2.1.43.5.1.1.11.1 | | String
+| **protocol** (consumer) | Here you can select which protocol to use. You can use either udp or tcp. | udp | String
+| **retries** (consumer) | Defines how often a retry is made before canceling the request. | 2 | int
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **snmpCommunity** (consumer) | Sets the community octet string for the snmp request. | public | String
+| **snmpContextEngineId** (consumer) | Sets the context engine ID field of the scoped PDU. | | String
+| **snmpContextName** (consumer) | Sets the context name field of this scoped PDU. | | String
+| **snmpVersion** (consumer) | Sets the snmp version for the request. The value 0 means SNMPv1 1 means SNMPv2c and the value 3 means SNMPv3 | 0 | int
+| **timeout** (consumer) | Sets the timeout value for the request in millis. | 1500 | int
+| **type** (consumer) | Which operation to perform such as poll trap etc. | | SnmpActionType
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **authenticationPassphrase** (security) | The authentication passphrase. If not null authenticationProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown. | | String
+| **authenticationProtocol** (security) | Authentication protocol to use if security level is set to enable authentication The possible values are: MD5 SHA1 | | String
+| **privacyPassphrase** (security) | The privacy passphrase. If not null privacyProtocol must also be not null. RFC3414 11.2 requires passphrases to have a minimum length of 8 bytes. If the length of authenticationPassphrase is less than 8 bytes an IllegalArgumentException is thrown. | | String
+| **privacyProtocol** (security) | The privacy protocol ID to be associated with this user. If set to null this user only supports unencrypted messages. | | String
+| **securityLevel** (security) | Sets the security level for this target. The supplied security level must be supported by the security model dependent information associated with the security name set for this target. The value 1 means: No authentication and no encryption. Anyone can create and read messages with this security level The value 2 means: Authentication and no encryption. Only the one with the right authentication key can create messages with this security level but anyone can read the contents of the message. The value 3 means: Authentication and encryption. Only the one with the right authentication key can create messages with this security level and only the one with the right encryption/decryption key can read the contents of the message. | 3 | int
+| **securityName** (security) | Sets the security name to be used with this target. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-solr/src/main/docs/solr-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-solr/src/main/docs/solr-component.adoc b/components/camel-solr/src/main/docs/solr-component.adoc
index 3d240bb..63da91e 100644
--- a/components/camel-solr/src/main/docs/solr-component.adoc
+++ b/components/camel-solr/src/main/docs/solr-component.adoc
@@ -48,43 +48,30 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| url | | String | *Required* Hostname and port for the solr server
+| Name | Description | Default | Type
+| **url** | *Required* Hostname and port for the solr server | | String
|=======================================================================
#### Query Parameters (13 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| allowCompression | | Boolean | Server side must support gzip or deflate for this to have any effect
-
-| connectionTimeout | | Integer | connectionTimeout on the underlying HttpConnectionManager
-
-| defaultMaxConnectionsPerHost | | Integer | maxConnectionsPerHost on the underlying HttpConnectionManager
-
-| followRedirects | | Boolean | indicates whether redirects are used to get to the Solr server
-
-| maxRetries | | Integer | Maximum number of retries to attempt in the event of transient errors
-
-| maxTotalConnections | | Integer | maxTotalConnection on the underlying HttpConnectionManager
-
-| requestHandler | | String | Set the request handler to be used
-
-| soTimeout | | Integer | Read timeout on the underlying HttpConnectionManager. This is desirable for queries but probably not for indexing
-
-| streamingQueueSize | 10 | int | Set the queue size for the StreamingUpdateSolrServer
-
-| streamingThreadCount | 2 | int | Set the number of threads for the StreamingUpdateSolrServer
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| solrCloud
-| collection | | String | Set the collection name which the solrCloud server could use
-
-| zkHost | | String | Set the ZooKeeper host information which the solrCloud could use such as zkhost=localhost:8123.
+| Name | Description | Default | Type
+| **allowCompression** (producer) | Server side must support gzip or deflate for this to have any effect | | Boolean
+| **connectionTimeout** (producer) | connectionTimeout on the underlying HttpConnectionManager | | Integer
+| **defaultMaxConnectionsPer Host** (producer) | maxConnectionsPerHost on the underlying HttpConnectionManager | | Integer
+| **followRedirects** (producer) | indicates whether redirects are used to get to the Solr server | | Boolean
+| **maxRetries** (producer) | Maximum number of retries to attempt in the event of transient errors | | Integer
+| **maxTotalConnections** (producer) | maxTotalConnection on the underlying HttpConnectionManager | | Integer
+| **requestHandler** (producer) | Set the request handler to be used | | String
+| **soTimeout** (producer) | Read timeout on the underlying HttpConnectionManager. This is desirable for queries but probably not for indexing | | Integer
+| **streamingQueueSize** (producer) | Set the queue size for the StreamingUpdateSolrServer | 10 | int
+| **streamingThreadCount** (producer) | Set the number of threads for the StreamingUpdateSolrServer | 2 | int
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **collection** (solrCloud) | Set the collection name which the solrCloud server could use | | String
+| **zkHost** (solrCloud) | Set the ZooKeeper host information which the solrCloud could use such as zkhost=localhost:8123. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc b/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc
index ae92e17..c3f04d8 100644
--- a/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc
+++ b/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc
@@ -36,33 +36,21 @@ The Spark Rest component supports 12 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| port | 4567 | int | Port number. Will by default use 4567
-
-| ipAddress | 0.0.0.0 | String | Set the IP address that Spark should listen on. If not called the default address is '0.0.0.0'.
- 4+^s| advanced
-| minThreads | | int | Minimum number of threads in Spark thread-pool (shared globally)
-
-| maxThreads | | int | Maximum number of threads in Spark thread-pool (shared globally)
-
-| timeOutMillis | | int | Thread idle timeout in millis where threads that has been idle for a longer period will be terminated from the thread pool
- 4+^s| security
-| keystoreFile | | String | Configures connection to be secure to use the keystore file
-
-| keystorePassword | | String | Configures connection to be secure to use the keystore password
-
-| truststoreFile | | String | Configures connection to be secure to use the truststore file
-
-| truststorePassword | | String | Configures connection to be secure to use the truststore password
- 4+^s| advanced
-| sparkConfiguration | | SparkConfiguration | To use the shared SparkConfiguration
-
-| sparkBinding | | SparkBinding | To use a custom SparkBinding to map to/from Camel message.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **port** (consumer) | Port number. Will by default use 4567 | 4567 | int
+| **ipAddress** (consumer) | Set the IP address that Spark should listen on. If not called the default address is '0.0.0.0'. | 0.0.0.0 | String
+| **minThreads** (advanced) | Minimum number of threads in Spark thread-pool (shared globally) | | int
+| **maxThreads** (advanced) | Maximum number of threads in Spark thread-pool (shared globally) | | int
+| **timeOutMillis** (advanced) | Thread idle timeout in millis where threads that has been idle for a longer period will be terminated from the thread pool | | int
+| **keystoreFile** (security) | Configures connection to be secure to use the keystore file | | String
+| **keystorePassword** (security) | Configures connection to be secure to use the keystore password | | String
+| **truststoreFile** (security) | Configures connection to be secure to use the truststore file | | String
+| **truststorePassword** (security) | Configures connection to be secure to use the truststore password | | String
+| **sparkConfiguration** (advanced) | To use the shared SparkConfiguration | | SparkConfiguration
+| **sparkBinding** (advanced) | To use a custom SparkBinding to map to/from Camel message. | | SparkBinding
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -78,40 +66,29 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| verb | | String | *Required* get post put patch delete head trace connect or options.
-| path | | String | *Required* The content path which support Spark syntax.
+| Name | Description | Default | Type
+| **verb** | *Required* get post put patch delete head trace connect or options. | | String
+| **path** | *Required* The content path which support Spark syntax. | | String
|=======================================================================
#### Query Parameters (11 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| accept | | String | Accept type such as: 'text/xml' or 'application/json'. By default we accept all kinds of types.
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| disableStreamCache | false | boolean | Determines whether or not the raw input stream from Spark HttpRequestgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure 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. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Spark raw stream.
-
-| mapHeaders | true | boolean | If this option is enabled then during binding from Spark to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.sparkrest.SparkMessage message with the method getRequest() that returns the Spark HTTP request instance.
-
-| transferException | false | boolean | 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. 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.
-
-| urlDecodeHeaders | false | boolean | If this option is enabled then during binding from Spark to Camel Message then the header values will be URL decoded (eg 20 will be a space character.)
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| matchOnUriPrefix | false | boolean | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.
-
-| sparkBinding | | SparkBinding | To use a custom SparkBinding to map to/from Camel message.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **accept** (consumer) | Accept type such as: 'text/xml' or 'application/json'. By default we accept all kinds of types. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **disableStreamCache** (consumer) | Determines whether or not the raw input stream from Spark HttpRequestgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure 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. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Spark raw stream. | false | boolean
+| **mapHeaders** (consumer) | If this option is enabled then during binding from Spark to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.sparkrest.SparkMessage message with the method getRequest() that returns the Spark HTTP request instance. | true | boolean
+| **transferException** (consumer) | 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. 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. | false | boolean
+| **urlDecodeHeaders** (consumer) | If this option is enabled then during binding from Spark to Camel Message then the header values will be URL decoded (eg 20 will be a space character.) | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **matchOnUriPrefix** (advanced) | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | false | boolean
+| **sparkBinding** (advanced) | To use a custom SparkBinding to map to/from Camel message. | | SparkBinding
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spark/src/main/docs/spark-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spark/src/main/docs/spark-component.adoc b/components/camel-spark/src/main/docs/spark-component.adoc
index a967a1a..1213150 100644
--- a/components/camel-spark/src/main/docs/spark-component.adoc
+++ b/components/camel-spark/src/main/docs/spark-component.adoc
@@ -55,15 +55,12 @@ The Apache Spark component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| producer
-| rdd | | JavaRDDLike | RDD to compute against.
-
-| rddCallback | | RddCallback | Function performing action against an RDD.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **rdd** (producer) | RDD to compute against. | | JavaRDDLike
+| **rddCallback** (producer) | Function performing action against an RDD. | | RddCallback
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -79,29 +76,23 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| endpointType | | EndpointType | *Required* Type of the endpoint (rdd dataframe hive).
+| Name | Description | Default | Type
+| **endpointType** | *Required* Type of the endpoint (rdd dataframe hive). | | EndpointType
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| collect | true | boolean | Indicates if results should be collected or counted.
-
-| dataFrame | | DataFrame | DataFrame to compute against.
-
-| dataFrameCallback | | DataFrameCallback | Function performing action against an DataFrame.
-
-| rdd | | JavaRDDLike | RDD to compute against.
-
-| rddCallback | | RddCallback | Function performing action against an RDD.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **collect** (producer) | Indicates if results should be collected or counted. | true | boolean
+| **dataFrame** (producer) | DataFrame to compute against. | | DataFrame
+| **dataFrameCallback** (producer) | Function performing action against an DataFrame. | | DataFrameCallback
+| **rdd** (producer) | RDD to compute against. | | JavaRDDLike
+| **rddCallback** (producer) | Function performing action against an RDD. | | RddCallback
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-splunk/src/main/docs/splunk-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-splunk/src/main/docs/splunk-component.adoc b/components/camel-splunk/src/main/docs/splunk-component.adoc
index 948ef38..7eac5bd 100644
--- a/components/camel-splunk/src/main/docs/splunk-component.adoc
+++ b/components/camel-splunk/src/main/docs/splunk-component.adoc
@@ -90,13 +90,11 @@ The Splunk component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| splunkConfigurationFactory | | SplunkConfigurationFactory | To use the SplunkConfigurationFactory
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **splunkConfiguration Factory** (advanced) | To use the SplunkConfigurationFactory | | SplunkConfiguration Factory
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -112,101 +110,59 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* Name has no purpose
+| Name | Description | Default | Type
+| **name** | *Required* Name has no purpose | | String
|=======================================================================
#### Query Parameters (42 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| app | | String | Splunk app
-
-| connectionTimeout | 5000 | int | Timeout in MS when connecting to Splunk server
-
-| host | localhost | String | Splunk host.
-
-| owner | | String | Splunk owner
-
-| port | 8089 | int | Splunk port
-
-| scheme | https | String | Splunk scheme
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| count | | int | A number that indicates the maximum number of entities to return.
-
-| earliestTime | | String | Earliest time of the search time window.
-
-| initEarliestTime | | String | Initial start offset of the first search
-
-| latestTime | | String | Latest time of the search time window.
-
-| savedSearch | | String | The name of the query saved in Splunk to run
-
-| search | | String | The Splunk query to run
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| streaming | | Boolean | Sets streaming mode. Streaming mode sends exchanges as they are received rather than in a batch.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| producer
-| eventHost | | String | Override the default Splunk event host field
-
-| index | | String | Splunk index to write to
-
-| raw | false | boolean | Should the payload be inserted raw
-
-| source | | String | Splunk source argument
-
-| sourceType | | String | Splunk sourcetype argument
-
-| tcpReceiverPort | | int | Splunk tcp receiver port
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| security
-| password | | String | Password for Splunk
-
-| sslProtocol | TLSv1.2 | SSLSecurityProtocol | Set the ssl protocol to use
-
-| username | | String | Username for Splunk
-
-| useSunHttpsHandler | false | boolean | Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. Can be useful when running in application servers to avoid app. server https handling.
+| Name | Description | Default | Type
+| **app** (common) | Splunk app | | String
+| **connectionTimeout** (common) | Timeout in MS when connecting to Splunk server | 5000 | int
+| **host** (common) | Splunk host. | localhost | String
+| **owner** (common) | Splunk owner | | String
+| **port** (common) | Splunk port | 8089 | int
+| **scheme** (common) | Splunk scheme | https | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **count** (consumer) | A number that indicates the maximum number of entities to return. | | int
+| **earliestTime** (consumer) | Earliest time of the search time window. | | String
+| **initEarliestTime** (consumer) | Initial start offset of the first search | | String
+| **latestTime** (consumer) | Latest time of the search time window. | | String
+| **savedSearch** (consumer) | The name of the query saved in Splunk to run | | String
+| **search** (consumer) | The Splunk query to run | | String
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **streaming** (consumer) | Sets streaming mode. Streaming mode sends exchanges as they are received rather than in a batch. | | Boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **eventHost** (producer) | Override the default Splunk event host field | | String
+| **index** (producer) | Splunk index to write to | | String
+| **raw** (producer) | Should the payload be inserted raw | false | boolean
+| **source** (producer) | Splunk source argument | | String
+| **sourceType** (producer) | Splunk sourcetype argument | | String
+| **tcpReceiverPort** (producer) | Splunk tcp receiver port | | int
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **password** (security) | Password for Splunk | | String
+| **sslProtocol** (security) | Set the ssl protocol to use | TLSv1.2 | SSLSecurityProtocol
+| **username** (security) | Username for Splunk | | String
+| **useSunHttpsHandler** (security) | Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. Can be useful when running in application servers to avoid app. server https handling. | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc
index 36c1e89..e996f8c 100644
--- a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc
+++ b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc
@@ -44,15 +44,12 @@ The Spring Batch component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| producer
-| jobLauncher | | JobLauncher | Explicitly specifies a JobLauncher to be used.
-
-| jobRegistry | | JobRegistry | Explicitly specifies a JobRegistry to be used.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **jobLauncher** (producer) | Explicitly specifies a JobLauncher to be used. | | JobLauncher
+| **jobRegistry** (producer) | Explicitly specifies a JobRegistry to be used. | | JobRegistry
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -72,25 +69,21 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| jobName | | String | *Required* The name of the Spring Batch job located in the registry.
+| Name | Description | Default | Type
+| **jobName** | *Required* The name of the Spring Batch job located in the registry. | | String
|=======================================================================
#### Query Parameters (4 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| jobFromHeader | false | boolean | Explicitly defines if the jobName should be taken from the headers instead of the URI.
-
-| jobLauncher | | JobLauncher | Explicitly specifies a JobLauncher to be used.
-
-| jobRegistry | | JobRegistry | Explicitly specifies a JobRegistry to be used.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **jobFromHeader** (producer) | Explicitly defines if the jobName should be taken from the headers instead of the URI. | false | boolean
+| **jobLauncher** (producer) | Explicitly specifies a JobLauncher to be used. | | JobLauncher
+| **jobRegistry** (producer) | Explicitly specifies a JobRegistry to be used. | | JobRegistry
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc b/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc
index ce01cdc..ab76f1c 100644
--- a/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc
+++ b/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc
@@ -53,31 +53,24 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| defaultChannel | | String | *Required* The default channel name which is used by the Spring Integration Spring context. It will equal to the inputChannel name for the Spring Integration consumer and the outputChannel name for the Spring Integration provider.
+| Name | Description | Default | Type
+| **defaultChannel** | *Required* The default channel name which is used by the Spring Integration Spring context. It will equal to the inputChannel name for the Spring Integration consumer and the outputChannel name for the Spring Integration provider. | | String
|=======================================================================
#### Query Parameters (7 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| inOut | false | boolean | The exchange pattern that the Spring integration endpoint should use. If inOut=true then a reply channel is expected either from the Spring Integration Message header or configured on the endpoint.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| inputChannel | | String | The Spring integration input channel name that this endpoint wants to consume from Spring integration.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| outputChannel | | String | The Spring integration output channel name that is used to send messages to Spring integration.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **inOut** (common) | The exchange pattern that the Spring integration endpoint should use. If inOut=true then a reply channel is expected either from the Spring Integration Message header or configured on the endpoint. | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **inputChannel** (consumer) | The Spring integration input channel name that this endpoint wants to consume from Spring integration. | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **outputChannel** (producer) | The Spring integration output channel name that is used to send messages to Spring integration. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
index 1f1e91b..07886ba 100644
--- a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
+++ b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
@@ -48,23 +48,20 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| templateName | | String | *Required* Name of the Spring LDAP Template bean
+| Name | Description | Default | Type
+| **templateName** | *Required* Name of the Spring LDAP Template bean | | String
|=======================================================================
#### Query Parameters (3 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| operation | | LdapOperation | *Required* The LDAP operation to be performed.
-
-| scope | subtree | String | The scope of the search operation.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **operation** (producer) | *Required* The LDAP operation to be performed. | | LdapOperation
+| **scope** (producer) | The scope of the search operation. | subtree | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc b/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc
index 364180c..be9057a 100644
--- a/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc
+++ b/components/camel-spring-redis/src/main/docs/spring-redis-component.adoc
@@ -43,38 +43,28 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* The host where Redis server is running.
-| port | | Integer | *Required* Redis server port number
+| Name | Description | Default | Type
+| **host** | *Required* The host where Redis server is running. | | String
+| **port** | *Required* Redis server port number | | Integer
|=======================================================================
#### Query Parameters (10 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| channels | | String | List of topic names or name patterns to subscribe to. Multiple names can be separated by comma.
-
-| command | SET | Command | Default command which can be overridden by message header. Notice the consumer only supports the following commands: PSUBSCRIBE and SUBSCRIBE
-
-| connectionFactory | | RedisConnectionFactory | Reference to a pre-configured RedisConnectionFactory instance to use.
-
-| redisTemplate | | RedisTemplate | Reference to a pre-configured RedisTemplate instance to use.
-
-| serializer | | RedisSerializer | Reference to a pre-configured RedisSerializer instance to use.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| listenerContainer | | RedisMessageListenerContainer | Reference to a pre-configured RedisMessageListenerContainer instance to use.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **channels** (common) | List of topic names or name patterns to subscribe to. Multiple names can be separated by comma. | | String
+| **command** (common) | Default command which can be overridden by message header. Notice the consumer only supports the following commands: PSUBSCRIBE and SUBSCRIBE | SET | Command
+| **connectionFactory** (common) | Reference to a pre-configured RedisConnectionFactory instance to use. | | RedisConnectionFactory
+| **redisTemplate** (common) | Reference to a pre-configured RedisTemplate instance to use. | | RedisTemplate
+| **serializer** (common) | Reference to a pre-configured RedisSerializer instance to use. | | RedisSerializer
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **listenerContainer** (consumer) | Reference to a pre-configured RedisMessageListenerContainer instance to use. | | RedisMessageListener Container
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc b/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc
index af7fc53..2a671a6 100644
--- a/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc
+++ b/components/camel-spring-ws/src/main/docs/spring-ws-component.adoc
@@ -95,63 +95,41 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| type | | EndpointMappingType | Endpoint mapping type if endpoint mapping is used. rootqname - Offers the option to map web service requests based on the qualified name of the root element contained in the message. soapaction - Used to map web service requests based on the SOAP action specified in the header of the message. uri - In order to map web service requests that target a specific URI. xpathresult - Used to map web service requests based on the evaluation of an XPath expression against the incoming message. The result of the evaluation should match the XPath result specified in the endpoint URI. beanname - Allows you to reference an org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher object in order to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping SoapActionEndpointMapping etc
-| lookupKey | | String | Endpoint mapping key if endpoint mapping is used
-| webServiceEndpointUri | | String | The default Web Service endpoint uri to use for the producer.
+| Name | Description | Default | Type
+| **type** | Endpoint mapping type if endpoint mapping is used. rootqname - Offers the option to map web service requests based on the qualified name of the root element contained in the message. soapaction - Used to map web service requests based on the SOAP action specified in the header of the message. uri - In order to map web service requests that target a specific URI. xpathresult - Used to map web service requests based on the evaluation of an XPath expression against the incoming message. The result of the evaluation should match the XPath result specified in the endpoint URI. beanname - Allows you to reference an org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher object in order to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping SoapActionEndpointMapping etc | | EndpointMappingType
+| **lookupKey** | Endpoint mapping key if endpoint mapping is used | | String
+| **webServiceEndpointUri** | The default Web Service endpoint uri to use for the producer. | | String
|=======================================================================
#### Query Parameters (22 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| messageFilter | | MessageFilter | Option to provide a custom MessageFilter. For example when you want to process your headers or attachments by your own.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| endpointDispatcher | | CamelEndpointDispatcher | Spring org.springframework.ws.server.endpoint.MessageEndpoint for dispatching messages received by Spring-WS to a Camel endpoint to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping SoapActionEndpointMapping etc.
-
-| endpointMapping | | CamelSpringWSEndpointMapping | Reference to an instance of org.apache.camel.component.spring.ws.bean.CamelEndpointMapping in the Registry/ApplicationContext. Only one bean is required in the registry to serve all Camel/Spring-WS endpoints. This bean is auto-discovered by the MessageDispatcher and used to map requests to Camel endpoints based on characteristics specified on the endpoint (like root QName SOAP action etc)
-
-| expression | | String | The XPath expression to use when option type=xpathresult. Then this option is required to be configured.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| allowResponseAttachmentOverride | false | boolean | Option to override soap response attachments in in/out exchange with attachments from the actual service layer. If the invoked service appends or rewrites the soap attachments this option when set to true allows the modified soap attachments to be overwritten in in/out message attachments
-
-| allowResponseHeaderOverride | false | boolean | Option to override soap response header in in/out exchange with header info from the actual service layer. If the invoked service appends or rewrites the soap header this option when set to true allows the modified soap header to be overwritten in in/out message headers
-
-| faultAction | | URI | Signifies the value for the faultAction response WS-Addressing Fault Action header that is provided by the method.
-
-| faultTo | | URI | Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method.
-
-| messageFactory | | WebServiceMessageFactory | Option to provide a custom WebServiceMessageFactory. For example when you want Apache Axiom to handle web service messages instead of SAAJ.
-
-| messageIdStrategy | | MessageIdStrategy | Option to provide a custom MessageIdStrategy to control generation of unique message ids.
-
-| messageSender | | WebServiceMessageSender | Option to provide a custom WebServiceMessageSender. For example to perform authentication or use alternative transports
-
-| outputAction | | URI | Signifies the value for the response WS-Addressing Action header that is provided by the method.
-
-| replyTo | | URI | Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method.
-
-| soapAction | | String | SOAP action to include inside a SOAP request when accessing remote web services
-
-| timeout | | int | Sets the socket read timeout (in milliseconds) while invoking a webservice using the producer see URLConnection.setReadTimeout() and CommonsHttpMessageSender.setReadTimeout(). This option works when using the built-in message sender implementations: CommonsHttpMessageSender and HttpUrlConnectionMessageSender. One of these implementations will be used by default for HTTP based services unless you customize the Spring WS configuration options supplied to the component. If you are using a non-standard sender it is assumed that you will handle your own timeout configuration. The built-in message sender HttpComponentsMessageSender is considered instead of CommonsHttpMessageSender which has been deprecated see HttpComponentsMessageSender.setReadTimeout().
-
-| webServiceTemplate | | WebServiceTemplate | Option to provide a custom WebServiceTemplate. This allows for full control over client-side web services handling; like adding a custom interceptor or specifying a fault resolver message sender or message factory.
-
-| wsAddressingAction | | URI | WS-Addressing 1.0 action header to include when accessing web services. The To header is set to the address of the web service as specified in the endpoint URI (default Spring-WS behavior).
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
+| Name | Description | Default | Type
+| **messageFilter** (common) | Option to provide a custom MessageFilter. For example when you want to process your headers or attachments by your own. | | MessageFilter
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **endpointDispatcher** (consumer) | Spring org.springframework.ws.server.endpoint.MessageEndpoint for dispatching messages received by Spring-WS to a Camel endpoint to integrate with existing (legacy) endpoint mappings like PayloadRootQNameEndpointMapping SoapActionEndpointMapping etc. | | CamelEndpointDispatcher
+| **endpointMapping** (consumer) | Reference to an instance of org.apache.camel.component.spring.ws.bean.CamelEndpointMapping in the Registry/ApplicationContext. Only one bean is required in the registry to serve all Camel/Spring-WS endpoints. This bean is auto-discovered by the MessageDispatcher and used to map requests to Camel endpoints based on characteristics specified on the endpoint (like root QName SOAP action etc) | | CamelSpringWSEndpoint Mapping
+| **expression** (consumer) | The XPath expression to use when option type=xpathresult. Then this option is required to be configured. | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **allowResponseAttachment Override** (producer) | Option to override soap response attachments in in/out exchange with attachments from the actual service layer. If the invoked service appends or rewrites the soap attachments this option when set to true allows the modified soap attachments to be overwritten in in/out message attachments | false | boolean
+| **allowResponseHeaderOverride** (producer) | Option to override soap response header in in/out exchange with header info from the actual service layer. If the invoked service appends or rewrites the soap header this option when set to true allows the modified soap header to be overwritten in in/out message headers | false | boolean
+| **faultAction** (producer) | Signifies the value for the faultAction response WS-Addressing Fault Action header that is provided by the method. | | URI
+| **faultTo** (producer) | Signifies the value for the faultAction response WS-Addressing FaultTo header that is provided by the method. | | URI
+| **messageFactory** (producer) | Option to provide a custom WebServiceMessageFactory. For example when you want Apache Axiom to handle web service messages instead of SAAJ. | | WebServiceMessage Factory
+| **messageIdStrategy** (producer) | Option to provide a custom MessageIdStrategy to control generation of unique message ids. | | MessageIdStrategy
+| **messageSender** (producer) | Option to provide a custom WebServiceMessageSender. For example to perform authentication or use alternative transports | | WebServiceMessage Sender
+| **outputAction** (producer) | Signifies the value for the response WS-Addressing Action header that is provided by the method. | | URI
+| **replyTo** (producer) | Signifies the value for the replyTo response WS-Addressing ReplyTo header that is provided by the method. | | URI
+| **soapAction** (producer) | SOAP action to include inside a SOAP request when accessing remote web services | | String
+| **timeout** (producer) | Sets the socket read timeout (in milliseconds) while invoking a webservice using the producer see URLConnection.setReadTimeout() and CommonsHttpMessageSender.setReadTimeout(). This option works when using the built-in message sender implementations: CommonsHttpMessageSender and HttpUrlConnectionMessageSender. One of these implementations will be used by default for HTTP based services unless you customize the Spring WS configuration options supplied to the component. If you are using a non-standard sender it is assumed that you will handle your own timeout configuration. The built-in message sender HttpComponentsMessageSender is considered instead of CommonsHttpMessageSender which has been deprecated see HttpComponentsMessageSender.setReadTimeout(). | | int
+| **webServiceTemplate** (producer) | Option to provide a custom WebServiceTemplate. This allows for full control over client-side web services handling; like adding a custom interceptor or specifying a fault resolver message sender or message factory. | | WebServiceTemplate
+| **wsAddressingAction** (producer) | WS-Addressing 1.0 action header to include when accessing web services. The To header is set to the address of the web service as specified in the endpoint URI (default Spring-WS behavior). | | URI
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-spring/src/main/docs/spring-event-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring/src/main/docs/spring-event-component.adoc b/components/camel-spring/src/main/docs/spring-event-component.adoc
index 8d2c475..2ce103b 100644
--- a/components/camel-spring/src/main/docs/spring-event-component.adoc
+++ b/components/camel-spring/src/main/docs/spring-event-component.adoc
@@ -25,18 +25,7 @@ easily change in future releases, so please check back.
// component options: START
-The Spring Event component supports 2 options which are listed below.
-
-
-
-[width="100%",cols="2,1m,1m,6",options="header"]
-|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| applicationContext | | ApplicationContext | The Spring ApplicationContext
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
-|=======================================================================
+The Spring Event component has no options.
// component options: END
@@ -51,25 +40,21 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | Name of endpoint
+| Name | Description | Default | Type
+| **name** | Name of endpoint | | String
|=======================================================================
#### Query Parameters (4 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
[23/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-box/camel-box-component/src/main/docs/box-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc
index 0cfa410..2f2aff4 100644
--- a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc
+++ b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc
@@ -51,13 +51,11 @@ The Box component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| configuration | | BoxConfiguration | To use the shared configuration
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (common) | To use the shared configuration | | BoxConfiguration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -70,58 +68,38 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| apiName | | BoxApiName | *Required* What kind of operation to perform
-| methodName | | String | *Required* What sub operation to use for the selected operation
+| Name | Description | Default | Type
+| **apiName** | *Required* What kind of operation to perform | | BoxApiName
+| **methodName** | *Required* What sub operation to use for the selected operation | | String
|=======================================================================
#### Query Parameters (20 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
-|=======================================================================
-| Name | Default | Java Type | Description
-
-| clientId | | String | Box application client ID
-
-| enterpriseId | | String | The enterprise ID to use for an App Enterprise.
-
-| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body
-
-| userId | | String | The user ID to use for an App User.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| httpParams | | Map | Custom HTTP params for settings like proxy host
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| accessTokenCache | | IAccessTokenCache | Custom Access Token Cache for storing and retrieving access tokens.
-
-| clientSecret | | String | Box application client secret
-
-| encryptionAlgorithm | RSA_SHA_256 | EncryptionAlgorithm | The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512
-
-| maxCacheEntries | 100 | int | The maximum number of access tokens in cache.
- 4+^s| authentication
-| authenticationType | APP_USER_AUTHENTICATION | String | 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
- 4+^s| security
-| privateKeyFile | | String | The private key for generating the JWT signature.
-
-| privateKeyPassword | | String | The password for the private key.
-
-| publicKeyId | | String | The ID for public key for validating the JWT signature.
-
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters.
-
-| userName | | String | Box user name MUST be provided
-
-| userPassword | | String | Box user password MUST be provided if authSecureStorage is not set or returns null on first call
+[width="100%",cols="2,5,^1,2",options="header"]
+|=======================================================================
+| Name | Description | Default | Type
+| **clientId** (common) | Box application client ID | | String
+| **enterpriseId** (common) | The enterprise ID to use for an App Enterprise. | | String
+| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String
+| **userId** (common) | The user ID to use for an App User. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **httpParams** (advanced) | Custom HTTP params for settings like proxy host | | Map
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **accessTokenCache** (security) | Custom Access Token Cache for storing and retrieving access tokens. | | IAccessTokenCache
+| **clientSecret** (security) | Box application client secret | | String
+| **encryptionAlgorithm** (security) | The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512 | RSA_SHA_256 | EncryptionAlgorithm
+| **maxCacheEntries** (security) | The maximum number of access tokens in cache. | 100 | int
+| **authenticationType** (authentication) | 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 | APP_USER_AUTHENTICATION | String
+| **privateKeyFile** (security) | The private key for generating the JWT signature. | | String
+| **privateKeyPassword** (security) | The password for the private key. | | String
+| **publicKeyId** (security) | The ID for public key for validating the JWT signature. | | String
+| **sslContextParameters** (security) | To configure security using SSLContextParameters. | | SSLContextParameters
+| **userName** (security) | Box user name MUST be provided | | String
+| **userPassword** (security) | Box user password MUST be provided if authSecureStorage is not set or returns null on first call | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-braintree/src/main/docs/braintree-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-braintree/src/main/docs/braintree-component.adoc b/components/camel-braintree/src/main/docs/braintree-component.adoc
index dfbf10e..223c9a2 100644
--- a/components/camel-braintree/src/main/docs/braintree-component.adoc
+++ b/components/camel-braintree/src/main/docs/braintree-component.adoc
@@ -39,13 +39,11 @@ The Braintree component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| configuration | | BraintreeConfiguration | To use the shared configuration
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (common) | To use the shared configuration | | BraintreeConfiguration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -62,44 +60,31 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| apiName | | BraintreeApiName | *Required* What kind of operation to perform
-| methodName | | String | What sub operation to use for the selected operation
+| Name | Description | Default | Type
+| **apiName** | *Required* What kind of operation to perform | | BraintreeApiName
+| **methodName** | What sub operation to use for the selected operation | | String
|=======================================================================
#### Query Parameters (13 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| environment | | String | *Required* The environment Either SANDBOX or PRODUCTION
-
-| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body
-
-| merchantId | | String | *Required* The merchant id provided by Braintree.
-
-| privateKey | | String | *Required* The private key provided by Braintree.
-
-| publicKey | | String | *Required* The public key provided by Braintree.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| httpReadTimeout | | Integer | Set read timeout for http calls.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| logging
-| httpLogLevel | | String | Set logging level for http calls see java.util.logging.Level
- 4+^s| proxy
-| proxyHost | | String | The proxy host
-
-| proxyPort | | Integer | The proxy port
+| Name | Description | Default | Type
+| **environment** (common) | *Required* The environment Either SANDBOX or PRODUCTION | | String
+| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String
+| **merchantId** (common) | *Required* The merchant id provided by Braintree. | | String
+| **privateKey** (common) | *Required* The private key provided by Braintree. | | String
+| **publicKey** (common) | *Required* The public key provided by Braintree. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **httpReadTimeout** (advanced) | Set read timeout for http calls. | | Integer
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **httpLogLevel** (logging) | Set logging level for http calls see java.util.logging.Level | | String
+| **proxyHost** (proxy) | The proxy host | | String
+| **proxyPort** (proxy) | The proxy port | | Integer
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-cache/src/main/docs/cache-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cache/src/main/docs/cache-component.adoc b/components/camel-cache/src/main/docs/cache-component.adoc
index 0bec379..52f3c87 100644
--- a/components/camel-cache/src/main/docs/cache-component.adoc
+++ b/components/camel-cache/src/main/docs/cache-component.adoc
@@ -48,17 +48,13 @@ The EHCache component supports 4 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| cacheManagerFactory | | CacheManagerFactory | To use the given CacheManagerFactory for creating the CacheManager. By default the DefaultCacheManagerFactory is used.
- 4+^s| common
-| configuration | | CacheConfiguration | Sets the Cache configuration
-
-| configurationFile | classpath:ehcache.xml | String | Sets the location of the ehcache.xml file to load from classpath or file system. By default the file is loaded from classpath:ehcache.xml
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **cacheManagerFactory** (advanced) | To use the given CacheManagerFactory for creating the CacheManager. By default the DefaultCacheManagerFactory is used. | | CacheManagerFactory
+| **configuration** (common) | Sets the Cache configuration | | CacheConfiguration
+| **configurationFile** (common) | Sets the location of the ehcache.xml file to load from classpath or file system. By default the file is loaded from classpath:ehcache.xml | classpath:ehcache.xml | String
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -76,55 +72,36 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| cacheName | | String | *Required* Name of the cache
+| Name | Description | Default | Type
+| **cacheName** | *Required* Name of the cache | | String
|=======================================================================
#### Query Parameters (19 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| diskExpiryThreadIntervalSeconds | | long | The number of seconds between runs of the disk expiry thread.
-
-| diskPersistent | false | boolean | Whether the disk store persists between restarts of the application.
-
-| diskStorePath | | String | This parameter is ignored. CacheManager sets it using setter injection.
-
-| eternal | false | boolean | Sets whether elements are eternal. If eternal timeouts are ignored and the element never expires.
-
-| key | | String | The default key to use. If a key is provided in the message header then the key from the header takes precedence.
-
-| maxElementsInMemory | 1000 | int | The number of elements that may be stored in the defined cache in memory.
-
-| memoryStoreEvictionPolicy | LFU | MemoryStoreEvictionPolicy | Which eviction strategy to use when maximum number of elements in memory is reached. The strategy defines which elements to be removed. LRU - Lest Recently Used LFU - Lest Frequently Used FIFO - First In First Out
-
-| objectCache | false | boolean | Whether to turn on allowing to store non serializable objects in the cache. If this option is enabled then overflow to disk cannot be enabled as well.
-
-| operation | | String | The default cache operation to use. If an operation in the message header then the operation from the header takes precedence.
-
-| overflowToDisk | true | boolean | Specifies whether cache may overflow to disk
-
-| timeToIdleSeconds | 300 | long | The maximum amount of time between accesses before an element expires
-
-| timeToLiveSeconds | 300 | long | The maximum time between creation time and when an element expires. Is used only if the element is not eternal
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| cacheLoaderRegistry | | CacheLoaderRegistry | To configure cache loader using the CacheLoaderRegistry
-
-| cacheManagerFactory | | CacheManagerFactory | To use a custom CacheManagerFactory for creating the CacheManager to be used by this endpoint. By default the CacheManagerFactory configured on the component is used.
-
-| eventListenerRegistry | | CacheEventListenerRegistry | To configure event listeners using the CacheEventListenerRegistry
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **diskExpiryThreadInterval Seconds** (common) | The number of seconds between runs of the disk expiry thread. | | long
+| **diskPersistent** (common) | Whether the disk store persists between restarts of the application. | false | boolean
+| **diskStorePath** (common) | This parameter is ignored. CacheManager sets it using setter injection. | | String
+| **eternal** (common) | Sets whether elements are eternal. If eternal timeouts are ignored and the element never expires. | false | boolean
+| **key** (common) | The default key to use. If a key is provided in the message header then the key from the header takes precedence. | | String
+| **maxElementsInMemory** (common) | The number of elements that may be stored in the defined cache in memory. | 1000 | int
+| **memoryStoreEvictionPolicy** (common) | Which eviction strategy to use when maximum number of elements in memory is reached. The strategy defines which elements to be removed. LRU - Lest Recently Used LFU - Lest Frequently Used FIFO - First In First Out | LFU | MemoryStoreEviction Policy
+| **objectCache** (common) | Whether to turn on allowing to store non serializable objects in the cache. If this option is enabled then overflow to disk cannot be enabled as well. | false | boolean
+| **operation** (common) | The default cache operation to use. If an operation in the message header then the operation from the header takes precedence. | | String
+| **overflowToDisk** (common) | Specifies whether cache may overflow to disk | true | boolean
+| **timeToIdleSeconds** (common) | The maximum amount of time between accesses before an element expires | 300 | long
+| **timeToLiveSeconds** (common) | The maximum time between creation time and when an element expires. Is used only if the element is not eternal | 300 | long
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **cacheLoaderRegistry** (advanced) | To configure cache loader using the CacheLoaderRegistry | | CacheLoaderRegistry
+| **cacheManagerFactory** (advanced) | To use a custom CacheManagerFactory for creating the CacheManager to be used by this endpoint. By default the CacheManagerFactory configured on the component is used. | | CacheManagerFactory
+| **eventListenerRegistry** (advanced) | To configure event listeners using the CacheEventListenerRegistry | | CacheEventListener Registry
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-cassandraql/src/main/docs/cql-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cassandraql/src/main/docs/cql-component.adoc b/components/camel-cassandraql/src/main/docs/cql-component.adoc
index 77065e0..18ab579 100644
--- a/components/camel-cassandraql/src/main/docs/cql-component.adoc
+++ b/components/camel-cassandraql/src/main/docs/cql-component.adoc
@@ -68,48 +68,34 @@ with the following path and query parameters:
#### Path Parameters (4 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| beanRef | | String | beanRef is defined using bean:id
-| hosts | | String | Hostname(s) cassansdra server(s). Multiple hosts can be separated by comma.
-| port | | Integer | Port number of cassansdra server(s)
-| keyspace | | String | Keyspace to use
+| Name | Description | Default | Type
+| **beanRef** | beanRef is defined using bean:id | | String
+| **hosts** | Hostname(s) cassansdra server(s). Multiple hosts can be separated by comma. | | String
+| **port** | Port number of cassansdra server(s) | | Integer
+| **keyspace** | Keyspace to use | | String
|=======================================================================
#### Query Parameters (14 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| cluster | | Cluster | To use the Cluster instance (you would normally not use this option)
-
-| clusterName | | String | Cluster name
-
-| consistencyLevel | | ConsistencyLevel | Consistency level to use
-
-| cql | | String | CQL query to perform. Can be overridden with the message header with key CamelCqlQuery.
-
-| loadBalancingPolicy | | String | To use a specific LoadBalancingPolicy
-
-| password | | String | Password for session authentication
-
-| prepareStatements | true | boolean | Whether to use PreparedStatements or regular Statements
-
-| resultSetConversionStrategy | | String | To use a custom class that implements logic for converting ResultSet into message body ALL ONE LIMIT_10 LIMIT_100...
-
-| session | | Session | To use the Session instance (you would normally not use this option)
-
-| username | | String | Username for session authentication
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **cluster** (common) | To use the Cluster instance (you would normally not use this option) | | Cluster
+| **clusterName** (common) | Cluster name | | String
+| **consistencyLevel** (common) | Consistency level to use | | ConsistencyLevel
+| **cql** (common) | CQL query to perform. Can be overridden with the message header with key CamelCqlQuery. | | String
+| **loadBalancingPolicy** (common) | To use a specific LoadBalancingPolicy | | String
+| **password** (common) | Password for session authentication | | String
+| **prepareStatements** (common) | Whether to use PreparedStatements or regular Statements | true | boolean
+| **resultSetConversionStrategy** (common) | To use a custom class that implements logic for converting ResultSet into message body ALL ONE LIMIT_10 LIMIT_100... | | String
+| **session** (common) | To use the Session instance (you would normally not use this option) | | Session
+| **username** (common) | Username for session authentication | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc b/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc
index 770002b..dc212d2 100644
--- a/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc
+++ b/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc
@@ -30,41 +30,29 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| addresses | | String | *Required* Engine addresses. Multiple addresses can be separated by comma.
-| path | | String | *Required* Engine path
+| Name | Description | Default | Type
+| **addresses** | *Required* Engine addresses. Multiple addresses can be separated by comma. | | String
+| **path** | *Required* Engine path | | String
|=======================================================================
#### Query Parameters (12 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| action | | String | The default action to perform valid values are: - PUBLISH - PPUBLISH_AND_INDEX - PPUT - PGET_AND_PUT - PPUT_ALL - PPUT_IF_ABSENT - PGET - PGET_AND_REMOVE - PREMOVE - PIS_EMPTY - PSIZE
-
-| clusterName | | String | Cluster name for queue
-
-| filteredMapEvents | | String | A comma separated list of Map event type to filer valid values are: INSERT UPDATE REMOVE.
-
-| persistent | true | boolean | Enable/disable data persistence
-
-| subscribeMapEvents | true | boolean | Set if consumer should subscribe to Map events default true.
-
-| subscribeTopicEvents | false | boolean | Set if consumer should subscribe to TopicEventsd efault false.
-
-| subscribeTopologicalEvents | false | boolean | Set if consumer should subscribe to TopologicalEventsd efault false.
-
-| wireType | BINARY | String | The Wire type to use default to binary wire.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **action** (common) | The default action to perform valid values are: - PUBLISH - PPUBLISH_AND_INDEX - PPUT - PGET_AND_PUT - PPUT_ALL - PPUT_IF_ABSENT - PGET - PGET_AND_REMOVE - PREMOVE - PIS_EMPTY - PSIZE | | String
+| **clusterName** (common) | Cluster name for queue | | String
+| **filteredMapEvents** (common) | A comma separated list of Map event type to filer valid values are: INSERT UPDATE REMOVE. | | String
+| **persistent** (common) | Enable/disable data persistence | true | boolean
+| **subscribeMapEvents** (common) | Set if consumer should subscribe to Map events default true. | true | boolean
+| **subscribeTopicEvents** (common) | Set if consumer should subscribe to TopicEventsd efault false. | false | boolean
+| **subscribeTopologicalEvents** (common) | Set if consumer should subscribe to TopologicalEventsd efault false. | false | boolean
+| **wireType** (common) | The Wire type to use default to binary wire. | BINARY | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-chunk/src/main/docs/chunk-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-chunk/src/main/docs/chunk-component.adoc b/components/camel-chunk/src/main/docs/chunk-component.adoc
index 05e58d1..887f70b 100644
--- a/components/camel-chunk/src/main/docs/chunk-component.adoc
+++ b/components/camel-chunk/src/main/docs/chunk-component.adoc
@@ -50,31 +50,24 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| resourceUri | | String | *Required* 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.
+| Name | Description | Default | Type
+| **resourceUri** | *Required* 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. | | String
|=======================================================================
#### Query Parameters (7 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| contentCache | false | boolean | Sets whether to use resource content cache or not
-
-| encoding | | String | Define the encoding of the body
-
-| extension | | String | Define the file extension of the template
-
-| themeFolder | | String | Define the themes folder to scan
-
-| themeLayer | | String | Define the theme layer to elaborate
-
-| themeSubfolder | | String | Define the themes subfolder to scan
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean
+| **encoding** (producer) | Define the encoding of the body | | String
+| **extension** (producer) | Define the file extension of the template | | String
+| **themeFolder** (producer) | Define the themes folder to scan | | String
+| **themeLayer** (producer) | Define the theme layer to elaborate | | String
+| **themeSubfolder** (producer) | Define the themes subfolder to scan | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc b/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc
index 77a262b..592c731 100644
--- a/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc
+++ b/components/camel-cm-sms/src/main/docs/cm-sms-component.adoc
@@ -45,27 +45,22 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* SMS Provider HOST with scheme
+| Name | Description | Default | Type
+| **host** | *Required* SMS Provider HOST with scheme | | String
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| defaultFrom | | String | This is the sender name. The maximum length is 11 characters.
-
-| defaultMaxNumberOfParts | 8 | int | 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.
-
-| productToken | | String | *Required* The unique token to use
-
-| testConnectionOnStartup | false | boolean | Whether to test the connection to the SMS Gateway on startup
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **defaultFrom** (producer) | This is the sender name. The maximum length is 11 characters. | | String
+| **defaultMaxNumberOfParts** (producer) | 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. | 8 | int
+| **productToken** (producer) | *Required* The unique token to use | | String
+| **testConnectionOnStartup** (producer) | Whether to test the connection to the SMS Gateway on startup | false | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-cmis/src/main/docs/cmis-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cmis/src/main/docs/cmis-component.adoc b/components/camel-cmis/src/main/docs/cmis-component.adoc
index 677242c..8687c8d 100644
--- a/components/camel-cmis/src/main/docs/cmis-component.adoc
+++ b/components/camel-cmis/src/main/docs/cmis-component.adoc
@@ -25,13 +25,11 @@ The CMIS component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| sessionFacadeFactory | | CMISSessionFacadeFactory | To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **sessionFacadeFactory** (common) | To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances | | CMISSessionFacade Factory
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -46,43 +44,30 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| cmsUrl | | String | *Required* URL to the cmis repository
+| Name | Description | Default | Type
+| **cmsUrl** | *Required* URL to the cmis repository | | String
|=======================================================================
#### Query Parameters (13 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| pageSize | 100 | int | Number of nodes to retrieve per page
-
-| readContent | false | boolean | If set to true the content of document node will be retrieved in addition to the properties
-
-| readCount | | int | Max number of nodes to read
-
-| repositoryId | | String | The Id of the repository to use. If not specified the first available repository is used
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| query | | String | 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
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| queryMode | false | boolean | If true will execute the cmis query from the message body and return result otherwise will create a node in the cmis repository
- 4+^s| advanced
-| sessionFacadeFactory | | CMISSessionFacadeFactory | To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| password | | String | Password for the cmis repository
-
-| username | | String | Username for the cmis repository
+| Name | Description | Default | Type
+| **pageSize** (common) | Number of nodes to retrieve per page | 100 | int
+| **readContent** (common) | If set to true the content of document node will be retrieved in addition to the properties | false | boolean
+| **readCount** (common) | Max number of nodes to read | | int
+| **repositoryId** (common) | The Id of the repository to use. If not specified the first available repository is used | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **query** (consumer) | 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 | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **queryMode** (producer) | If true will execute the cmis query from the message body and return result otherwise will create a node in the cmis repository | false | boolean
+| **sessionFacadeFactory** (advanced) | To use a custom CMISSessionFacadeFactory to create the CMISSessionFacade instances | | CMISSessionFacade Factory
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **password** (security) | Password for the cmis repository | | String
+| **username** (security) | Username for the cmis repository | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-coap/src/main/docs/coap-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-coap/src/main/docs/coap-component.adoc b/components/camel-coap/src/main/docs/coap-component.adoc
index 451c18d..e367018 100644
--- a/components/camel-coap/src/main/docs/coap-component.adoc
+++ b/components/camel-coap/src/main/docs/coap-component.adoc
@@ -39,26 +39,21 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| uri | | URI | The URI for the CoAP endpoint
+| Name | Description | Default | Type
+| **uri** | The URI for the CoAP endpoint | | URI
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| coapMethod | * | String | The CoAP method this endpoint binds to. Default is to bind to all () but can be restricted to GET POST PUT DELETE PING
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **coapMethod** (common) | The CoAP method this endpoint binds to. Default is to bind to all () but can be restricted to GET POST PUT DELETE PING | * | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-cometd/src/main/docs/cometd-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cometd/src/main/docs/cometd-component.adoc b/components/camel-cometd/src/main/docs/cometd-component.adoc
index cb275fa..1b2d637 100644
--- a/components/camel-cometd/src/main/docs/cometd-component.adoc
+++ b/components/camel-cometd/src/main/docs/cometd-component.adoc
@@ -52,23 +52,16 @@ The CometD component supports 7 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| security
-| sslKeyPassword | | String | The password for the keystore when using SSL.
-
-| sslPassword | | String | The password when using SSL.
-
-| sslKeystore | | String | The path to the keystore.
-
-| securityPolicy | | SecurityPolicy | To use a custom configured SecurityPolicy to control authorization
- 4+^s| common
-| extensions | | List | To use a list of custom BayeuxServer.Extension that allows modifying incoming and outgoing requests.
- 4+^s| security
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **sslKeyPassword** (security) | The password for the keystore when using SSL. | | String
+| **sslPassword** (security) | The password when using SSL. | | String
+| **sslKeystore** (security) | The path to the keystore. | | String
+| **securityPolicy** (security) | To use a custom configured SecurityPolicy to control authorization | | SecurityPolicy
+| **extensions** (common) | To use a list of custom BayeuxServer.Extension that allows modifying incoming and outgoing requests. | | List
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -86,51 +79,35 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* Hostname
-| port | | int | *Required* Host port number
-| channelName | | String | *Required* The channelName represents a topic that can be subscribed to by the Camel endpoints.
+| Name | Description | Default | Type
+| **host** | *Required* Hostname | | String
+| **port** | *Required* Host port number | | int
+| **channelName** | *Required* The channelName represents a topic that can be subscribed to by the Camel endpoints. | | String
|=======================================================================
#### Query Parameters (16 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| allowedOrigins | * | String | The origins domain that support to cross if the crosssOriginFilterOn is true
-
-| baseResource | | String | 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
-
-| crossOriginFilterOn | false | boolean | If true the server will support for cross-domain filtering
-
-| filterPath | | String | The filterPath will be used by the CrossOriginFilter if the crosssOriginFilterOn is true
-
-| interval | | int | The client side poll timeout in milliseconds. How long a client will wait between reconnects
-
-| jsonCommented | true | boolean | 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.
-
-| logLevel | 1 | int | Logging level. 0=none 1=info 2=debug.
-
-| maxInterval | 30000 | int | The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time.
-
-| multiFrameInterval | 1500 | int | The client side poll timeout if multiple connections are detected from the same browser.
-
-| timeout | 240000 | int | The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| sessionHeadersEnabled | false | boolean | Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| disconnectLocalSession | false | boolean | 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.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **allowedOrigins** (common) | The origins domain that support to cross if the crosssOriginFilterOn is true | * | String
+| **baseResource** (common) | 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 | | String
+| **crossOriginFilterOn** (common) | If true the server will support for cross-domain filtering | false | boolean
+| **filterPath** (common) | The filterPath will be used by the CrossOriginFilter if the crosssOriginFilterOn is true | | String
+| **interval** (common) | The client side poll timeout in milliseconds. How long a client will wait between reconnects | | int
+| **jsonCommented** (common) | 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. | true | boolean
+| **logLevel** (common) | Logging level. 0=none 1=info 2=debug. | 1 | int
+| **maxInterval** (common) | The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time. | 30000 | int
+| **multiFrameInterval** (common) | The client side poll timeout if multiple connections are detected from the same browser. | 1500 | int
+| **timeout** (common) | The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding. | 240000 | int
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **sessionHeadersEnabled** (consumer) | Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **disconnectLocalSession** (producer) | 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. | false | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-consul/src/main/docs/consul-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-consul/src/main/docs/consul-component.adoc b/components/camel-consul/src/main/docs/consul-component.adoc
index 85996d0..8c8823f 100644
--- a/components/camel-consul/src/main/docs/consul-component.adoc
+++ b/components/camel-consul/src/main/docs/consul-component.adoc
@@ -52,59 +52,38 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| apiEndpoint | | String | *Required* The API endpoint
+| Name | Description | Default | Type
+| **apiEndpoint** | *Required* The API endpoint | | String
|=======================================================================
#### Query Parameters (21 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| connectTimeoutMillis | | Long | Connect timeout for OkHttpClient
-
-| dc | | String | The data center
-
-| key | | String | The default key. Can be overridden by CamelConsulKey
-
-| pingInstance | true | boolean | Configure if the AgentClient should attempt a ping before returning the Consul instance
-
-| readTimeoutMillis | | Long | Read timeout for OkHttpClient
-
-| tags | | String | Set tags. You can separate multiple tags by comma.
-
-| url | | String | The Consul agent URL
-
-| writeTimeoutMillis | | Long | Write timeout for OkHttpClient
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| action | | String | The default action. Can be overridden by CamelConsulAction
-
-| valueAsString | false | boolean | Default to transform values retrieved from Consul i.e. on KV endpoint to string.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| watch
-| blockSeconds | 10 | Integer | The second to wait for a watch event default 10 seconds
-
-| firstIndex | 0 | long | The first index for watch for default 0
-
-| recursive | false | boolean | Recursively watch default false
- 4+^s| security
-| aclToken | | String | Sets the ACL token to be used with Consul
-
-| password | | String | Sets the password to be used for basic authentication
-
-| sslContextParameters | | SSLContextParameters | SSL configuration using an org.apache.camel.util.jsse.SSLContextParameters instance.
-
-| userName | | String | Sets the username to be used for basic authentication
+| Name | Description | Default | Type
+| **connectTimeoutMillis** (common) | Connect timeout for OkHttpClient | | Long
+| **dc** (common) | The data center | | String
+| **key** (common) | The default key. Can be overridden by CamelConsulKey | | String
+| **pingInstance** (common) | Configure if the AgentClient should attempt a ping before returning the Consul instance | true | boolean
+| **readTimeoutMillis** (common) | Read timeout for OkHttpClient | | Long
+| **tags** (common) | Set tags. You can separate multiple tags by comma. | | String
+| **url** (common) | The Consul agent URL | | String
+| **writeTimeoutMillis** (common) | Write timeout for OkHttpClient | | Long
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **action** (producer) | The default action. Can be overridden by CamelConsulAction | | String
+| **valueAsString** (producer) | Default to transform values retrieved from Consul i.e. on KV endpoint to string. | false | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **blockSeconds** (watch) | The second to wait for a watch event default 10 seconds | 10 | Integer
+| **firstIndex** (watch) | The first index for watch for default 0 | 0 | long
+| **recursive** (watch) | Recursively watch default false | false | boolean
+| **aclToken** (security) | Sets the ACL token to be used with Consul | | String
+| **password** (security) | Sets the password to be used for basic authentication | | String
+| **sslContextParameters** (security) | SSL configuration using an org.apache.camel.util.jsse.SSLContextParameters instance. | | SSLContextParameters
+| **userName** (security) | Sets the username to be used for basic authentication | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-context/src/main/docs/context-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-context/src/main/docs/context-component.adoc b/components/camel-context/src/main/docs/context-component.adoc
index 0db41fa..3e5c9a7 100644
--- a/components/camel-context/src/main/docs/context-component.adoc
+++ b/components/camel-context/src/main/docs/context-component.adoc
@@ -56,26 +56,22 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| contextId | | String | *Required* Is the ID you used to register the CamelContext into the Registry.
-| localEndpointUrl | | String | *Required* Can be a valid Camel URI evaluated within the black box CamelContext. Or it can be a logical name which is mapped to any local endpoints. For example if you locally have endpoints like direct:invoices and seda:purchaseOrders inside a CamelContext of id supplyChain then you can just use the URIs supplyChain:invoices or supplyChain:purchaseOrders to omit the physical endpoint kind and use pure logical URIs.
+| Name | Description | Default | Type
+| **contextId** | *Required* Is the ID you used to register the CamelContext into the Registry. | | String
+| **localEndpointUrl** | *Required* Can be a valid Camel URI evaluated within the black box CamelContext. Or it can be a logical name which is mapped to any local endpoints. For example if you locally have endpoints like direct:invoices and seda:purchaseOrders inside a CamelContext of id supplyChain then you can just use the URIs supplyChain:invoices or supplyChain:purchaseOrders to omit the physical endpoint kind and use pure logical URIs. | | String
|=======================================================================
#### Query Parameters (4 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-couchbase/src/main/docs/couchbase-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-couchbase/src/main/docs/couchbase-component.adoc b/components/camel-couchbase/src/main/docs/couchbase-component.adoc
index f6b2696..01d9825 100644
--- a/components/camel-couchbase/src/main/docs/couchbase-component.adoc
+++ b/components/camel-couchbase/src/main/docs/couchbase-component.adoc
@@ -41,113 +41,65 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| protocol | | String | *Required* The protocol to use
-| hostname | | String | *Required* The hostname to use
+| Name | Description | Default | Type
+| **protocol** | *Required* The protocol to use | | String
+| **hostname** | *Required* The hostname to use | | String
|=======================================================================
#### Query Parameters (48 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bucket | | String | The bucket to use
-
-| key | | String | The key to use
-
-| port | 8091 | int | The port number to use
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| consumerProcessedStrategy | none | String | Define the consumer Processed strategy to use
-
-| descending | false | boolean | Define if this operation is descending or not
-
-| designDocumentName | beer | String | The design document name to use
-
-| limit | -1 | int | The output limit to use
-
-| rangeEndKey | | String | Define a range for the end key
-
-| rangeStartKey | | String | Define a range for the start key
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| skip | -1 | int | Define the skip to use
-
-| viewName | brewery_beers | String | The view name to use
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| producer
-| autoStartIdForInserts | false | boolean | Define if we want an autostart Id when we are doing an insert operation
-
-| operation | CCB_PUT | String | The operation to do
-
-| persistTo | 0 | int | Where to persist the data
-
-| producerRetryAttempts | 2 | int | Define the number of retry attempts
-
-| producerRetryPause | 5000 | int | Define the retry pause between different attempts
-
-| replicateTo | 0 | int | Where to replicate the data
-
-| startingIdForInsertsFrom | | long | Define the starting Id where we are doing an insert operation
- 4+^s| advanced
-| additionalHosts | | String | The additional hosts
-
-| maxReconnectDelay | 30000 | long | Define the max delay during a reconnection
-
-| obsPollInterval | 400 | long | Define the observation polling interval
-
-| obsTimeout | -1 | long | Define the observation timeout
-
-| opQueueMaxBlockTime | 10000 | long | Define the max time an operation can be in queue blocked
-
-| opTimeOut | 2500 | long | Define the operation timeout
-
-| readBufferSize | 16384 | int | Define the buffer size
-
-| shouldOptimize | false | boolean | Define if we want to use optimization or not where possible
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| timeoutExceptionThreshold | 998 | int | Define the threshold for throwing a timeout Exception
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| security
-| password | | String | The password to use
-
-| username | | String | The username to use
+| Name | Description | Default | Type
+| **bucket** (common) | The bucket to use | | String
+| **key** (common) | The key to use | | String
+| **port** (common) | The port number to use | 8091 | int
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **consumerProcessedStrategy** (consumer) | Define the consumer Processed strategy to use | none | String
+| **descending** (consumer) | Define if this operation is descending or not | false | boolean
+| **designDocumentName** (consumer) | The design document name to use | beer | String
+| **limit** (consumer) | The output limit to use | -1 | int
+| **rangeEndKey** (consumer) | Define a range for the end key | | String
+| **rangeStartKey** (consumer) | Define a range for the start key | | String
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **skip** (consumer) | Define the skip to use | -1 | int
+| **viewName** (consumer) | The view name to use | brewery_beers | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **autoStartIdForInserts** (producer) | Define if we want an autostart Id when we are doing an insert operation | false | boolean
+| **operation** (producer) | The operation to do | CCB_PUT | String
+| **persistTo** (producer) | Where to persist the data | 0 | int
+| **producerRetryAttempts** (producer) | Define the number of retry attempts | 2 | int
+| **producerRetryPause** (producer) | Define the retry pause between different attempts | 5000 | int
+| **replicateTo** (producer) | Where to replicate the data | 0 | int
+| **startingIdForInsertsFrom** (producer) | Define the starting Id where we are doing an insert operation | | long
+| **additionalHosts** (advanced) | The additional hosts | | String
+| **maxReconnectDelay** (advanced) | Define the max delay during a reconnection | 30000 | long
+| **obsPollInterval** (advanced) | Define the observation polling interval | 400 | long
+| **obsTimeout** (advanced) | Define the observation timeout | -1 | long
+| **opQueueMaxBlockTime** (advanced) | Define the max time an operation can be in queue blocked | 10000 | long
+| **opTimeOut** (advanced) | Define the operation timeout | 2500 | long
+| **readBufferSize** (advanced) | Define the buffer size | 16384 | int
+| **shouldOptimize** (advanced) | Define if we want to use optimization or not where possible | false | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **timeoutExceptionThreshold** (advanced) | Define the threshold for throwing a timeout Exception | 998 | int
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **password** (security) | The password to use | | String
+| **username** (security) | The username to use | | String
|=======================================================================
// endpoint options: END
[22/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-couchdb/src/main/docs/couchdb-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-couchdb/src/main/docs/couchdb-component.adoc b/components/camel-couchdb/src/main/docs/couchdb-component.adoc
index 143184f..c118b76 100644
--- a/components/camel-couchdb/src/main/docs/couchdb-component.adoc
+++ b/components/camel-couchdb/src/main/docs/couchdb-component.adoc
@@ -56,44 +56,32 @@ with the following path and query parameters:
#### Path Parameters (4 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| protocol | | String | *Required* The protocol to use for communicating with the database.
-| hostname | | String | *Required* Hostname of the running couchdb instance
-| port | 5984 | int | Port number for the running couchdb instance
-| database | | String | *Required* Name of the database to use
+| Name | Description | Default | Type
+| **protocol** | *Required* The protocol to use for communicating with the database. | | String
+| **hostname** | *Required* Hostname of the running couchdb instance | | String
+| **port** | Port number for the running couchdb instance | 5984 | int
+| **database** | *Required* Name of the database to use | | String
|=======================================================================
#### Query Parameters (12 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| createDatabase | false | boolean | Creates the database if it does not already exist
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| deletes | true | boolean | Document deletes are published as events
-
-| heartbeat | 30000 | long | How often to send an empty message to keep socket alive in millis
-
-| since | | String | Start tracking changes immediately after the given update sequence. The default null will start monitoring from the latest sequence.
-
-| style | main_only | String | 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.)
-
-| updates | true | boolean | Document inserts/updates are published as events
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| password | | String | Password for authenticated databases
-
-| username | | String | Username in case of authenticated databases
+| Name | Description | Default | Type
+| **createDatabase** (common) | Creates the database if it does not already exist | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **deletes** (consumer) | Document deletes are published as events | true | boolean
+| **heartbeat** (consumer) | How often to send an empty message to keep socket alive in millis | 30000 | long
+| **since** (consumer) | Start tracking changes immediately after the given update sequence. The default null will start monitoring from the latest sequence. | | String
+| **style** (consumer) | 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.) | main_only | String
+| **updates** (consumer) | Document inserts/updates are published as events | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **password** (security) | Password for authenticated databases | | String
+| **username** (security) | Username in case of authenticated databases | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-crypto/src/main/docs/crypto-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-crypto/src/main/docs/crypto-component.adoc b/components/camel-crypto/src/main/docs/crypto-component.adoc
index 0123592..140b685 100644
--- a/components/camel-crypto/src/main/docs/crypto-component.adoc
+++ b/components/camel-crypto/src/main/docs/crypto-component.adoc
@@ -84,13 +84,11 @@ The Crypto (JCE) component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | DigitalSignatureConfiguration | To use the shared DigitalSignatureConfiguration as configuration
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use the shared DigitalSignatureConfiguration as configuration | | DigitalSignature Configuration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -103,56 +101,37 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| cryptoOperation | | CryptoOperation | *Required* Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto:sign sets sign as the operation.
-| name | | String | *Required* The logical name of this operation.
+| Name | Description | Default | Type
+| **cryptoOperation** | *Required* Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto:sign sets sign as the operation. | | CryptoOperation
+| **name** | *Required* The logical name of this operation. | | String
|=======================================================================
#### Query Parameters (19 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| algorithm | SHA1WithDSA | String | Sets the JCE name of the Algorithm that should be used for the signer.
-
-| alias | | String | 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 link org.apache.camel.component.crypto.DigitalSignatureConstantsKEYSTORE_ALIAS
-
-| certificateName | | String | Sets the reference name for a PrivateKey that can be fond in the registry.
-
-| keystore | | KeyStore | 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.
-
-| keystoreName | | String | Sets the reference name for a Keystore that can be fond in the registry.
-
-| privateKey | | PrivateKey | Set the PrivateKey that should be used to sign the exchange
-
-| privateKeyName | | String | Sets the reference name for a PrivateKey that can be fond in the registry.
-
-| provider | | String | Set the id of the security provider that provides the configured Signature algorithm.
-
-| publicKeyName | | String | references that should be resolved when the context changes
-
-| secureRandomName | | String | Sets the reference name for a SecureRandom that can be fond in the registry.
-
-| signatureHeaderName | | String | Set the name of the message header that should be used to store the base64 encoded signature. This defaults to 'CamelDigitalSignature'
- 4+^s| advanced
-| bufferSize | 2048 | Integer | Set the size of the buffer used to read in the Exchange payload data.
-
-| certificate | | Certificate | Set the Certificate that should be used to verify the signature in the exchange based on its payload.
-
-| clearHeaders | true | boolean | 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.
-
-| keyStoreParameters | | KeyStoreParameters | 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.
-
-| publicKey | | PublicKey | Set the PublicKey that should be used to verify the signature in the exchange.
-
-| secureRandom | | SecureRandom | Set the SecureRandom used to initialize the Signature service
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| password | | String | Sets the password used to access an aliased PrivateKey in the KeyStore.
+| Name | Description | Default | Type
+| **algorithm** (producer) | Sets the JCE name of the Algorithm that should be used for the signer. | SHA1WithDSA | String
+| **alias** (producer) | 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 link org.apache.camel.component.crypto.DigitalSignatureConstantsKEYSTORE_ALIAS | | String
+| **certificateName** (producer) | Sets the reference name for a PrivateKey that can be fond in the registry. | | String
+| **keystore** (producer) | 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. | | KeyStore
+| **keystoreName** (producer) | Sets the reference name for a Keystore that can be fond in the registry. | | String
+| **privateKey** (producer) | Set the PrivateKey that should be used to sign the exchange | | PrivateKey
+| **privateKeyName** (producer) | Sets the reference name for a PrivateKey that can be fond in the registry. | | String
+| **provider** (producer) | Set the id of the security provider that provides the configured Signature algorithm. | | String
+| **publicKeyName** (producer) | references that should be resolved when the context changes | | String
+| **secureRandomName** (producer) | Sets the reference name for a SecureRandom that can be fond in the registry. | | String
+| **signatureHeaderName** (producer) | Set the name of the message header that should be used to store the base64 encoded signature. This defaults to 'CamelDigitalSignature' | | String
+| **bufferSize** (advanced) | Set the size of the buffer used to read in the Exchange payload data. | 2048 | Integer
+| **certificate** (advanced) | Set the Certificate that should be used to verify the signature in the exchange based on its payload. | | Certificate
+| **clearHeaders** (advanced) | 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. | true | boolean
+| **keyStoreParameters** (advanced) | 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. | | KeyStoreParameters
+| **publicKey** (advanced) | Set the PublicKey that should be used to verify the signature in the exchange. | | PublicKey
+| **secureRandom** (advanced) | Set the SecureRandom used to initialize the Signature service | | SecureRandom
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **password** (security) | Sets the password used to access an aliased PrivateKey in the KeyStore. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-cxf/src/main/docs/cxf-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cxf/src/main/docs/cxf-component.adoc b/components/camel-cxf/src/main/docs/cxf-component.adoc
index 95fbc89..2479464 100644
--- a/components/camel-cxf/src/main/docs/cxf-component.adoc
+++ b/components/camel-cxf/src/main/docs/cxf-component.adoc
@@ -116,15 +116,12 @@ The CXF component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| allowStreaming | | Boolean | 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.
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **allowStreaming** (advanced) | 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. | | Boolean
+| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -141,86 +138,52 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| beanId | | String | To lookup an existing configured CxfEndpoint. Must used bean: as prefix.
-| address | | String | The service publish address.
+| Name | Description | Default | Type
+| **beanId** | To lookup an existing configured CxfEndpoint. Must used bean: as prefix. | | String
+| **address** | The service publish address. | | String
|=======================================================================
#### Query Parameters (34 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| dataFormat | POJO | DataFormat | The data type messages supported by the CXF endpoint.
-
-| wrappedStyle | | Boolean | 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
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session
-
-| defaultOperationName | | String | This option will set the default operationName that will be used by the CxfProducer which invokes the remote service.
-
-| defaultOperationNamespace | | String | This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service.
-
-| hostnameVerifier | | HostnameVerifier | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry.
-
-| sslContextParameters | | SSLContextParameters | The Camel SSL setting reference. Use the notation to reference the SSL Context.
-
-| wrapped | false | boolean | Which kind of operation that CXF endpoint producer will invoke
- 4+^s| advanced
-| allowStreaming | | Boolean | 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.
-
-| bus | | Bus | To use a custom configured CXF Bus.
-
-| continuationTimeout | 30000 | long | 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.
-
-| cxfBinding | | CxfBinding | To use a custom CxfBinding to control the binding between Camel Message and CXF Message.
-
-| cxfEndpointConfigurer | | CxfEndpointConfigurer | 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 configureServerClient method of CxfEndpointConfigurer.
-
-| defaultBus | false | boolean | Will set the default bus when CXF endpoint create a bus by itself
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-
-| mergeProtocolHeaders | false | boolean | 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.
-
-| mtomEnabled | false | boolean | To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode.
-
-| properties | | Map | 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
-
-| skipPayloadMessagePartCheck | false | boolean | Sets whether SOAP message validation should be disabled.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| logging
-| loggingFeatureEnabled | false | boolean | This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log.
-
-| loggingSizeLimit | 49152 | int | To limit the total size of number of bytes the logger will output when logging feature has been enabled and -1 for no limit.
-
-| skipFaultLogging | false | boolean | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches.
- 4+^s| security
-| password | | String | This option is used to set the basic authentication information of password for the CXF client.
-
-| username | | String | This option is used to set the basic authentication information of username for the CXF client.
- 4+^s| service
-| bindingId | | String | The bindingId for the service model to use.
-
-| portName | | String | 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.
-
-| publishedEndpointUrl | | String | This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus wsd
-
-| serviceClass | | Class<?> | The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not.
-
-| serviceName | | String | The service name this service is implementing it maps to the wsdl:servicename.
-
-| wsdlURL | | String | The location of the WSDL. Can be on the classpath file system or be hosted remotely.
+| Name | Description | Default | Type
+| **dataFormat** (common) | The data type messages supported by the CXF endpoint. | POJO | DataFormat
+| **wrappedStyle** (common) | 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 | | Boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler
+| **defaultOperationName** (producer) | This option will set the default operationName that will be used by the CxfProducer which invokes the remote service. | | String
+| **defaultOperationNamespace** (producer) | This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service. | | String
+| **hostnameVerifier** (producer) | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry. | | HostnameVerifier
+| **sslContextParameters** (producer) | The Camel SSL setting reference. Use the notation to reference the SSL Context. | | SSLContextParameters
+| **wrapped** (producer) | Which kind of operation that CXF endpoint producer will invoke | false | boolean
+| **allowStreaming** (advanced) | 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. | | Boolean
+| **bus** (advanced) | To use a custom configured CXF Bus. | | Bus
+| **continuationTimeout** (advanced) | 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. | 30000 | long
+| **cxfBinding** (advanced) | To use a custom CxfBinding to control the binding between Camel Message and CXF Message. | | CxfBinding
+| **cxfEndpointConfigurer** (advanced) | 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 configureServerClient method of CxfEndpointConfigurer. | | CxfEndpointConfigurer
+| **defaultBus** (advanced) | Will set the default bus when CXF endpoint create a bus by itself | false | boolean
+| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **mergeProtocolHeaders** (advanced) | 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. | false | boolean
+| **mtomEnabled** (advanced) | To enable MTOM (attachments). This requires to use POJO or PAYLOAD data format mode. | false | boolean
+| **properties** (advanced) | 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 | | Map
+| **skipPayloadMessagePart Check** (advanced) | Sets whether SOAP message validation should be disabled. | false | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **loggingFeatureEnabled** (logging) | This option enables CXF Logging Feature which writes inbound and outbound SOAP messages to log. | false | boolean
+| **loggingSizeLimit** (logging) | To limit the total size of number of bytes the logger will output when logging feature has been enabled and -1 for no limit. | 49152 | int
+| **skipFaultLogging** (logging) | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. | false | boolean
+| **password** (security) | This option is used to set the basic authentication information of password for the CXF client. | | String
+| **username** (security) | This option is used to set the basic authentication information of username for the CXF client. | | String
+| **bindingId** (service) | The bindingId for the service model to use. | | String
+| **portName** (service) | 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. | | String
+| **publishedEndpointUrl** (service) | This option can override the endpointUrl that published from the WSDL which can be accessed with service address url plus wsd | | String
+| **serviceClass** (service) | The class name of the SEI (Service Endpoint Interface) class which could have JSR181 annotation or not. | | Class<?>
+| **serviceName** (service) | The service name this service is implementing it maps to the wsdl:servicename. | | String
+| **wsdlURL** (service) | The location of the WSDL. Can be on the classpath file system or be hosted remotely. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-cxf/src/main/docs/cxfrs-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cxf/src/main/docs/cxfrs-component.adoc b/components/camel-cxf/src/main/docs/cxfrs-component.adoc
index f69f77d..2cd74dd 100644
--- a/components/camel-cxf/src/main/docs/cxfrs-component.adoc
+++ b/components/camel-cxf/src/main/docs/cxfrs-component.adoc
@@ -58,13 +58,11 @@ The CXF-RS component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| filter
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -80,76 +78,47 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| beanId | | String | To lookup an existing configured CxfRsEndpoint. Must used bean: as prefix.
-| address | | String | The service publish address.
+| Name | Description | Default | Type
+| **beanId** | To lookup an existing configured CxfRsEndpoint. Must used bean: as prefix. | | String
+| **address** | The service publish address. | | String
|=======================================================================
#### Query Parameters (29 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| features | | List | Set the feature list to the CxfRs endpoint.
-
-| loggingFeatureEnabled | false | boolean | This option enables CXF Logging Feature which writes inbound and outbound REST messages to log.
-
-| loggingSizeLimit | | int | To limit the total size of number of bytes the logger will output when logging feature has been enabled.
-
-| modelRef | | String | 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
-
-| providers | | String | 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.
-
-| resourceClasses | | List | The resource classes which you want to export as REST service. Multiple classes can be separated by comma.
-
-| schemaLocations | | List | Sets the locations of the schema(s) which can be used to validate the incoming XML or JAXB-driven JSON.
-
-| skipFaultLogging | false | boolean | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches.
- 4+^s| consumer
-| bindingStyle | Default | BindingStyle | 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.
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| publishedEndpointUrl | | String | This option can override the endpointUrl that published from the WADL which can be accessed with resource address url plus _wadl
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session
-
-| hostnameVerifier | | HostnameVerifier | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry.
-
-| sslContextParameters | | SSLContextParameters | The Camel SSL setting reference. Use the notation to reference the SSL Context.
-
-| throwExceptionOnFailure | true | boolean | This option tells the CxfRsProducer to inspect return codes and will generate an Exception if the return code is larger than 207.
- 4+^s| producer (advanced)
-| httpClientAPI | true | boolean | 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
-
-| ignoreDeleteMethodMessageBody | false | boolean | This option is used to tell CxfRsProducer to ignore the message body of the DELETE method when using HTTP API.
-
-| maxClientCacheSize | 10 | int | This option allows you to configure the maximum size of the cache. The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider.
- 4+^s| advanced
-| binding | | CxfRsBinding | To use a custom CxfBinding to control the binding between Camel Message and CXF Message.
-
-| bus | | Bus | To use a custom configured CXF Bus.
-
-| continuationTimeout | 30000 | long | 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.
-
-| cxfRsEndpointConfigurer | | CxfRsEndpointConfigurer | 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 configureServer/Client method of CxfEndpointConfigurer.
-
-| defaultBus | false | boolean | Will set the default bus when CXF endpoint create a bus by itself
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
-
-| performInvocation | false | boolean | 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.
-
-| propagateContexts | false | boolean | 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.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **features** (common) | Set the feature list to the CxfRs endpoint. | | List
+| **loggingFeatureEnabled** (common) | This option enables CXF Logging Feature which writes inbound and outbound REST messages to log. | false | boolean
+| **loggingSizeLimit** (common) | To limit the total size of number of bytes the logger will output when logging feature has been enabled. | | int
+| **modelRef** (common) | 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 | | String
+| **providers** (common) | 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. | | String
+| **resourceClasses** (common) | The resource classes which you want to export as REST service. Multiple classes can be separated by comma. | | List
+| **schemaLocations** (common) | Sets the locations of the schema(s) which can be used to validate the incoming XML or JAXB-driven JSON. | | List
+| **skipFaultLogging** (common) | This option controls whether the PhaseInterceptorChain skips logging the Fault that it catches. | false | boolean
+| **bindingStyle** (consumer) | 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. | Default | BindingStyle
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **publishedEndpointUrl** (consumer) | This option can override the endpointUrl that published from the WADL which can be accessed with resource address url plus _wadl | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler
+| **hostnameVerifier** (producer) | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry. | | HostnameVerifier
+| **sslContextParameters** (producer) | The Camel SSL setting reference. Use the notation to reference the SSL Context. | | SSLContextParameters
+| **throwExceptionOnFailure** (producer) | This option tells the CxfRsProducer to inspect return codes and will generate an Exception if the return code is larger than 207. | true | boolean
+| **httpClientAPI** (producer) | 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 | true | boolean
+| **ignoreDeleteMethodMessage Body** (producer) | This option is used to tell CxfRsProducer to ignore the message body of the DELETE method when using HTTP API. | false | boolean
+| **maxClientCacheSize** (producer) | This option allows you to configure the maximum size of the cache. The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider. | 10 | int
+| **binding** (advanced) | To use a custom CxfBinding to control the binding between Camel Message and CXF Message. | | CxfRsBinding
+| **bus** (advanced) | To use a custom configured CXF Bus. | | Bus
+| **continuationTimeout** (advanced) | 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. | 30000 | long
+| **cxfRsEndpointConfigurer** (advanced) | 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 configureServer/Client method of CxfEndpointConfigurer. | | CxfRsEndpoint Configurer
+| **defaultBus** (advanced) | Will set the default bus when CXF endpoint create a bus by itself | false | boolean
+| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy
+| **performInvocation** (advanced) | 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. | false | boolean
+| **propagateContexts** (advanced) | 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. | false | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-disruptor/src/main/docs/disruptor-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-disruptor/src/main/docs/disruptor-component.adoc b/components/camel-disruptor/src/main/docs/disruptor-component.adoc
index d54487a..0c8e2d0 100644
--- a/components/camel-disruptor/src/main/docs/disruptor-component.adoc
+++ b/components/camel-disruptor/src/main/docs/disruptor-component.adoc
@@ -98,25 +98,17 @@ The Disruptor component supports 8 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| defaultConcurrentConsumers | 1 | int | To configure the default number of concurrent consumers
-
-| defaultMultipleConsumers | false | boolean | To configure the default value for multiple consumers
- 4+^s| producer
-| defaultProducerType | Multi | DisruptorProducerType | To configure the default value for DisruptorProducerType The default value is Multi.
- 4+^s| consumer
-| defaultWaitStrategy | Blocking | DisruptorWaitStrategy | To configure the default value for DisruptorWaitStrategy The default value is Blocking.
- 4+^s| producer
-| defaultBlockWhenFull | true | boolean | To configure the default value for block when full The default value is true.
- 4+^s| common
-| queueSize | | int | To configure the ring buffer size
-
-| bufferSize | 1024 | int | To configure the ring buffer size
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **defaultConcurrent Consumers** (consumer) | To configure the default number of concurrent consumers | 1 | int
+| **defaultMultiple Consumers** (consumer) | To configure the default value for multiple consumers | false | boolean
+| **defaultProducerType** (producer) | To configure the default value for DisruptorProducerType The default value is Multi. | Multi | DisruptorProducerType
+| **defaultWaitStrategy** (consumer) | To configure the default value for DisruptorWaitStrategy The default value is Blocking. | Blocking | DisruptorWaitStrategy
+| **defaultBlockWhenFull** (producer) | To configure the default value for block when full The default value is true. | true | boolean
+| **queueSize** (common) | To configure the ring buffer size | | int
+| **bufferSize** (common) | To configure the ring buffer size | 1024 | int
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -132,41 +124,29 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* Name of queue
+| Name | Description | Default | Type
+| **name** | *Required* Name of queue | | String
|=======================================================================
#### Query Parameters (12 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| size | 1024 | int | 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.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| concurrentConsumers | 1 | int | Number of concurrent threads processing exchanges.
-
-| multipleConsumers | false | boolean | 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.
-
-| waitStrategy | Blocking | DisruptorWaitStrategy | Defines the strategy used by consumer threads to wait on new exchanges to be published. The options allowed are:Blocking Sleeping BusySpin and Yielding.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| blockWhenFull | false | boolean | 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.
-
-| producerType | Multi | DisruptorProducerType | 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.
-
-| timeout | 30000 | long | 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.
-
-| waitForTaskToComplete | IfReplyExpected | WaitForTaskToComplete | 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.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **size** (common) | 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. | 1024 | int
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **concurrentConsumers** (consumer) | Number of concurrent threads processing exchanges. | 1 | int
+| **multipleConsumers** (consumer) | 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. | false | boolean
+| **waitStrategy** (consumer) | Defines the strategy used by consumer threads to wait on new exchanges to be published. The options allowed are:Blocking Sleeping BusySpin and Yielding. | Blocking | DisruptorWaitStrategy
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **blockWhenFull** (producer) | 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. | false | boolean
+| **producerType** (producer) | 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. | Multi | DisruptorProducerType
+| **timeout** (producer) | 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. | 30000 | long
+| **waitForTaskToComplete** (producer) | 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. | IfReplyExpected | WaitForTaskToComplete
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-dns/src/main/docs/dns-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-dns/src/main/docs/dns-component.adoc b/components/camel-dns/src/main/docs/dns-component.adoc
index 6a25b3c..2e25c4c 100644
--- a/components/camel-dns/src/main/docs/dns-component.adoc
+++ b/components/camel-dns/src/main/docs/dns-component.adoc
@@ -60,19 +60,18 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| dnsType | | DnsType | *Required* The type of the lookup.
+| Name | Description | Default | Type
+| **dnsType** | *Required* The type of the lookup. | | DnsType
|=======================================================================
#### Query Parameters (1 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-docker/src/main/docs/docker-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-docker/src/main/docs/docker-component.adoc b/components/camel-docker/src/main/docs/docker-component.adoc
index fa18edf..3a59a9d 100644
--- a/components/camel-docker/src/main/docs/docker-component.adoc
+++ b/components/camel-docker/src/main/docs/docker-component.adoc
@@ -26,13 +26,11 @@ The Docker component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | DockerConfiguration | To use the shared docker configuration
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use the shared docker configuration | | DockerConfiguration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -46,57 +44,37 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| operation | | DockerOperation | *Required* Which operation to use
+| Name | Description | Default | Type
+| **operation** | *Required* Which operation to use | | DockerOperation
|=======================================================================
#### Query Parameters (20 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| email | | String | Email address associated with the user
-
-| host | localhost | String | *Required* Docker host
-
-| port | 2375 | Integer | *Required* Docker port
-
-| requestTimeout | | Integer | Request timeout for response (in seconds)
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| cmdExecFactory | com.github.dockerjava.jaxrs.JerseyDockerCmdExecFactory | String | The fully qualified class name of the DockerCmdExecFactory implementation to use
-
-| followRedirectFilter | false | boolean | Whether to follow redirect filter
-
-| loggingFilter | false | boolean | Whether to use logging filter
-
-| maxPerRouteConnections | 100 | Integer | Maximum route connections
-
-| maxTotalConnections | 100 | Integer | Maximum total connections
-
-| serverAddress | https://index.docker.io/v1/ | String | Server address for docker registry.
-
-| socket | true | boolean | Socket connection mode
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| certPath | | String | Location containing the SSL certificate chain
-
-| password | | String | Password to authenticate with
-
-| secure | false | boolean | Use HTTPS communication
-
-| tlsVerify | false | boolean | Check TLS
-
-| username | | String | User name to authenticate with
+| Name | Description | Default | Type
+| **email** (common) | Email address associated with the user | | String
+| **host** (common) | *Required* Docker host | localhost | String
+| **port** (common) | *Required* Docker port | 2375 | Integer
+| **requestTimeout** (common) | Request timeout for response (in seconds) | | Integer
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **cmdExecFactory** (advanced) | The fully qualified class name of the DockerCmdExecFactory implementation to use | com.github.dockerjava.jaxrs.JerseyDockerCmdExecFactory | String
+| **followRedirectFilter** (advanced) | Whether to follow redirect filter | false | boolean
+| **loggingFilter** (advanced) | Whether to use logging filter | false | boolean
+| **maxPerRouteConnections** (advanced) | Maximum route connections | 100 | Integer
+| **maxTotalConnections** (advanced) | Maximum total connections | 100 | Integer
+| **serverAddress** (advanced) | Server address for docker registry. | https://index.docker.io/v1/ | String
+| **socket** (advanced) | Socket connection mode | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **certPath** (security) | Location containing the SSL certificate chain | | String
+| **password** (security) | Password to authenticate with | | String
+| **secure** (security) | Use HTTPS communication | false | boolean
+| **tlsVerify** (security) | Check TLS | false | boolean
+| **username** (security) | User name to authenticate with | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-dozer/src/main/docs/dozer-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-dozer/src/main/docs/dozer-component.adoc b/components/camel-dozer/src/main/docs/dozer-component.adoc
index 0ce9604..e46f818 100644
--- a/components/camel-dozer/src/main/docs/dozer-component.adoc
+++ b/components/camel-dozer/src/main/docs/dozer-component.adoc
@@ -68,31 +68,24 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* A human readable name of the mapping.
+| Name | Description | Default | Type
+| **name** | *Required* A human readable name of the mapping. | | String
|=======================================================================
#### Query Parameters (7 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| mappingConfiguration | | DozerBeanMapperConfiguration | 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).
-
-| mappingFile | dozerBeanMapping.xml | String | 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.
-
-| marshalId | | String | The id of a dataFormat defined within the Camel Context to use for marshalling the mapping output to a non-Java type.
-
-| sourceModel | | String | 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.
-
-| targetModel | | String | *Required* Fully-qualified class name for the target type used in the mapping.
-
-| unmarshalId | | String | The id of a dataFormat defined within the Camel Context to use for unmarshalling the mapping input from a non-Java type.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **mappingConfiguration** (producer) | 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). | | DozerBeanMapper Configuration
+| **mappingFile** (producer) | 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. | dozerBeanMapping.xml | String
+| **marshalId** (producer) | The id of a dataFormat defined within the Camel Context to use for marshalling the mapping output to a non-Java type. | | String
+| **sourceModel** (producer) | 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. | | String
+| **targetModel** (producer) | *Required* Fully-qualified class name for the target type used in the mapping. | | String
+| **unmarshalId** (producer) | The id of a dataFormat defined within the Camel Context to use for unmarshalling the mapping input from a non-Java type. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-drill/src/main/docs/drill-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-drill/src/main/docs/drill-component.adoc b/components/camel-drill/src/main/docs/drill-component.adoc
index a714b34..d2e41c2 100644
--- a/components/camel-drill/src/main/docs/drill-component.adoc
+++ b/components/camel-drill/src/main/docs/drill-component.adoc
@@ -50,27 +50,22 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* ZooKeeper host name or IP address. Use local instead of a host name or IP address to connect to the local Drillbit
+| Name | Description | Default | Type
+| **host** | *Required* ZooKeeper host name or IP address. Use local instead of a host name or IP address to connect to the local Drillbit | | String
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| clusterId | | String | Cluster ID https://drill.apache.org/docs/using-the-jdbc-driver/determining-the-cluster-id
-
-| directory | | String | Drill directory in ZooKeeper
-
-| mode | ZK | DrillConnectionMode | Connection mode: zk: Zookeeper drillbit: Drillbit direct connection https://drill.apache.org/docs/using-the-jdbc-driver/
-
-| port | | Integer | ZooKeeper port number
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **clusterId** (producer) | Cluster ID https://drill.apache.org/docs/using-the-jdbc-driver/determining-the-cluster-id | | String
+| **directory** (producer) | Drill directory in ZooKeeper | | String
+| **mode** (producer) | Connection mode: zk: Zookeeper drillbit: Drillbit direct connection https://drill.apache.org/docs/using-the-jdbc-driver/ | ZK | DrillConnectionMode
+| **port** (producer) | ZooKeeper port number | | Integer
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-dropbox/src/main/docs/dropbox-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-dropbox/src/main/docs/dropbox-component.adoc b/components/camel-dropbox/src/main/docs/dropbox-component.adoc
index 7da17a4..3281c55 100644
--- a/components/camel-dropbox/src/main/docs/dropbox-component.adoc
+++ b/components/camel-dropbox/src/main/docs/dropbox-component.adoc
@@ -77,41 +77,29 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| operation | | DropboxOperation | *Required* The specific action (typically is a CRUD action) to perform on Dropbox remote folder.
+| Name | Description | Default | Type
+| **operation** | *Required* The specific action (typically is a CRUD action) to perform on Dropbox remote folder. | | DropboxOperation
|=======================================================================
#### Query Parameters (12 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
-|=======================================================================
-| Name | Default | Java Type | Description
-
-| accessToken | | String | *Required* The access token to make API requests for a specific Dropbox user
-
-| client | | DbxClient | To use an existing DbxClient instance as DropBox client.
-
-| clientIdentifier | | String | *Required* Name of the app registered to make API requests
-
-| localPath | | String | Folder or file to upload on Dropbox from the local filesystem.
-
-| newRemotePath | | String | Destination file or folder
-
-| query | | String | 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.
-
-| remotePath | | String | Original file or folder to move
-
-| uploadMode | | DropboxUploadMode | 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.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+[width="100%",cols="2,5,^1,2",options="header"]
+|=======================================================================
+| Name | Description | Default | Type
+| **accessToken** (common) | *Required* The access token to make API requests for a specific Dropbox user | | String
+| **client** (common) | To use an existing DbxClient instance as DropBox client. | | DbxClient
+| **clientIdentifier** (common) | *Required* Name of the app registered to make API requests | | String
+| **localPath** (common) | Folder or file to upload on Dropbox from the local filesystem. | | String
+| **newRemotePath** (common) | Destination file or folder | | String
+| **query** (common) | 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. | | String
+| **remotePath** (common) | Original file or folder to move | | String
+| **uploadMode** (common) | 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. | | DropboxUploadMode
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ehcache/src/main/docs/ehcache-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ehcache/src/main/docs/ehcache-component.adoc b/components/camel-ehcache/src/main/docs/ehcache-component.adoc
index aa41c03..09f7b82 100644
--- a/components/camel-ehcache/src/main/docs/ehcache-component.adoc
+++ b/components/camel-ehcache/src/main/docs/ehcache-component.adoc
@@ -51,47 +51,32 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| cacheName | | String | *Required* the cache name
+| Name | Description | Default | Type
+| **cacheName** | *Required* the cache name | | String
|=======================================================================
#### Query Parameters (15 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| cacheManager | | CacheManager | The cache manager
-
-| configUri | | String | URI pointing to the Ehcache XML configuration file's location
-
-| createCacheIfNotExist | true | boolean | Configure if a cache need to be created if it does exist or can't be pre-configured.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| eventFiring | ASYNCHRONOUS | EventFiring | Set the the delivery mode (synchronous asynchronous)
-
-| eventOrdering | ORDERED | EventOrdering | Set the the delivery mode (ordered unordered)
-
-| eventTypes | EVICTED,EXPIRED,REMOVED,CREATED,UPDATED | Set | Set the type of events to listen for
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| action | | String | To configure the default cache action. If an action is set in the message header then the operation from the header takes precedence.
-
-| key | | Object | To configure the default action key. If a key is set in the message header then the key from the header takes precedence.
- 4+^s| advanced
-| configuration | | CacheConfiguration<?,?> | The default cache configuration to be used to create caches.
-
-| keyType | java.lang.Object | String | The cache key type default Object.class
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| valueType | java.lang.Object | String | The cache value type default Object.class
+| Name | Description | Default | Type
+| **cacheManager** (common) | The cache manager | | CacheManager
+| **configUri** (common) | URI pointing to the Ehcache XML configuration file's location | | String
+| **createCacheIfNotExist** (common) | Configure if a cache need to be created if it does exist or can't be pre-configured. | true | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **eventFiring** (consumer) | Set the the delivery mode (synchronous asynchronous) | ASYNCHRONOUS | EventFiring
+| **eventOrdering** (consumer) | Set the the delivery mode (ordered unordered) | ORDERED | EventOrdering
+| **eventTypes** (consumer) | Set the type of events to listen for | EVICTED,EXPIRED,REMOVED,CREATED,UPDATED | Set
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **action** (producer) | To configure the default cache action. If an action is set in the message header then the operation from the header takes precedence. | | String
+| **key** (producer) | To configure the default action key. If a key is set in the message header then the key from the header takes precedence. | | Object
+| **configuration** (advanced) | The default cache configuration to be used to create caches. | | CacheConfiguration<?,?>
+| **keyType** (advanced) | The cache key type default Object.class | java.lang.Object | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **valueType** (advanced) | The cache value type default Object.class | java.lang.Object | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ejb/src/main/docs/ejb-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ejb/src/main/docs/ejb-component.adoc b/components/camel-ejb/src/main/docs/ejb-component.adoc
index bfc1395..bd0a44d 100644
--- a/components/camel-ejb/src/main/docs/ejb-component.adoc
+++ b/components/camel-ejb/src/main/docs/ejb-component.adoc
@@ -36,15 +36,12 @@ The EJB component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| producer
-| context | | Context | The Context to use for looking up the EJBs
-
-| properties | | Properties | Properties for creating javax.naming.Context if a context has not been configured.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **context** (producer) | The Context to use for looking up the EJBs | | Context
+| **properties** (producer) | Properties for creating javax.naming.Context if a context has not been configured. | | Properties
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -60,27 +57,22 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| beanName | | String | *Required* Sets the name of the bean to invoke
+| Name | Description | Default | Type
+| **beanName** | *Required* Sets the name of the bean to invoke | | String
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| method | | String | Sets the name of the method to invoke on the bean
- 4+^s| advanced
-| cache | false | boolean | 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.
-
-| multiParameterArray | false | boolean | How to treat the parameters which are passed from the message body.true means the message body should be an array of parameters. Note: This option is used internally by Camel and is not intended for end users to use.
-
-| parameters | | Map | Used for configuring additional properties on the bean
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **method** (producer) | Sets the name of the method to invoke on the bean | | String
+| **cache** (advanced) | 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. | false | boolean
+| **multiParameterArray** (advanced) | How to treat the parameters which are passed from the message body.true means the message body should be an array of parameters. Note: This option is used internally by Camel and is not intended for end users to use. | false | boolean
+| **parameters** (advanced) | Used for configuring additional properties on the bean | | Map
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
[24/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc b/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc
index 1882a07..d59412d 100644
--- a/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc
@@ -43,21 +43,19 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| streamName | | String | *Required* Name of the stream
+| Name | Description | Default | Type
+| **streamName** | *Required* Name of the stream | | String
|=======================================================================
#### Query Parameters (2 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| amazonKinesisFirehoseClient | | AmazonKinesisFirehose | *Required* Amazon Kinesis Firehose client to use for all requests for this endpoint
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **amazonKinesisFirehoseClient** (producer) | *Required* Amazon Kinesis Firehose client to use for all requests for this endpoint | | AmazonKinesisFirehose
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-aws/src/main/docs/aws-s3-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-s3-component.adoc b/components/camel-aws/src/main/docs/aws-s3-component.adoc
index 7c68df7..f893a9f 100644
--- a/components/camel-aws/src/main/docs/aws-s3-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-s3-component.adoc
@@ -57,97 +57,57 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| bucketNameOrArn | | String | *Required* Bucket name or ARN
+| Name | Description | Default | Type
+| **bucketNameOrArn** | *Required* Bucket name or ARN | | String
|=======================================================================
#### Query Parameters (40 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| accessKey | | String | Amazon AWS Access Key
-
-| amazonS3Client | | AmazonS3 | Reference to a com.amazonaws.services.sqs.AmazonS3 in the link:registry.htmlRegistry.
-
-| amazonS3Endpoint | | String | The region with which the AWS-S3 client wants to work with.
-
-| pathStyleAccess | false | boolean | Whether or not the S3 client should use path style access
-
-| policy | | String | Camel 2.8.4: The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3setBucketPolicy() method.
-
-| proxyHost | | String | Camel 2.16: To define a proxy host when instantiating the SQS client
-
-| proxyPort | | Integer | Camel 2.16: Specify a proxy port to be used inside the client definition.
-
-| secretKey | | String | Amazon AWS Secret Key
- 4+^s| consumer
-| autocloseBody | true | boolean | 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.
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| deleteAfterRead | true | boolean | 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 link S3ConstantsBUCKET_NAME and link S3ConstantsKEY headers or only the link S3ConstantsKEY header.
-
-| fileName | | String | To get the object from the bucket with the given file name
-
-| includeBody | true | boolean | 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.
-
-| maxMessagesPerPoll | 10 | int | 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.
-
-| prefix | | String | Camel 2.10.1: The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| producer
-| deleteAfterWrite | false | boolean | Camel 2.11.0: Delete file object after the S3 file has been uploaded
-
-| multiPartUpload | false | boolean | Camel 2.15.0: If it is true camel will upload the file with multi part format the part size is decided by the option of partSize
-
-| operation | | S3Operations | Camel 2.18: The operation to do in case the user don't want to do only an upload
-
-| partSize | 26214400 | long | Camel 2.15.0: Setup the partSize which is used in multi part upload the default size is 25M.
-
-| region | | String | The region where the bucket is located. This option is used in the com.amazonaws.services.s3.model.CreateBucketRequest.
-
-| serverSideEncryption | | String | Camel 2.16: Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256.
-
-| storageClass | | String | Camel 2.8.4: The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **accessKey** (common) | Amazon AWS Access Key | | String
+| **amazonS3Client** (common) | Reference to a com.amazonaws.services.sqs.AmazonS3 in the link:registry.htmlRegistry. | | AmazonS3
+| **amazonS3Endpoint** (common) | The region with which the AWS-S3 client wants to work with. | | String
+| **pathStyleAccess** (common) | Whether or not the S3 client should use path style access | false | boolean
+| **policy** (common) | Camel 2.8.4: The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3setBucketPolicy() method. | | String
+| **proxyHost** (common) | Camel 2.16: To define a proxy host when instantiating the SQS client | | String
+| **proxyPort** (common) | Camel 2.16: Specify a proxy port to be used inside the client definition. | | Integer
+| **secretKey** (common) | Amazon AWS Secret Key | | String
+| **autocloseBody** (consumer) | 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. | true | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **deleteAfterRead** (consumer) | 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 link S3ConstantsBUCKET_NAME and link S3ConstantsKEY headers or only the link S3ConstantsKEY header. | true | boolean
+| **fileName** (consumer) | To get the object from the bucket with the given file name | | String
+| **includeBody** (consumer) | 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. | true | boolean
+| **maxMessagesPerPoll** (consumer) | 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. | 10 | int
+| **prefix** (consumer) | Camel 2.10.1: The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. | | String
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **deleteAfterWrite** (producer) | Camel 2.11.0: Delete file object after the S3 file has been uploaded | false | boolean
+| **multiPartUpload** (producer) | Camel 2.15.0: If it is true camel will upload the file with multi part format the part size is decided by the option of partSize | false | boolean
+| **operation** (producer) | Camel 2.18: The operation to do in case the user don't want to do only an upload | | S3Operations
+| **partSize** (producer) | Camel 2.15.0: Setup the partSize which is used in multi part upload the default size is 25M. | 26214400 | long
+| **region** (producer) | The region where the bucket is located. This option is used in the com.amazonaws.services.s3.model.CreateBucketRequest. | | String
+| **serverSideEncryption** (producer) | Camel 2.16: Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256. | | String
+| **storageClass** (producer) | Camel 2.8.4: The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-aws/src/main/docs/aws-sdb-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-sdb-component.adoc b/components/camel-aws/src/main/docs/aws-sdb-component.adoc
index 66205ca..36635b7 100644
--- a/components/camel-aws/src/main/docs/aws-sdb-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-sdb-component.adoc
@@ -40,37 +40,27 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| domainName | | String | *Required* The name of the domain currently worked with.
+| Name | Description | Default | Type
+| **domainName** | *Required* The name of the domain currently worked with. | | String
|=======================================================================
#### Query Parameters (10 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| accessKey | | String | Amazon AWS Access Key
-
-| amazonSDBClient | | AmazonSimpleDB | To use the AmazonSimpleDB as the client
-
-| amazonSdbEndpoint | | String | The region with which the AWS-SDB client wants to work with.
-
-| consistentRead | false | boolean | Determines whether or not strong consistency should be enforced when data is read.
-
-| maxNumberOfDomains | | Integer | The maximum number of domain names you want returned. The range is 1 to 100.
-
-| operation | PutAttributes | SdbOperations | Operation to perform
-
-| proxyHost | | String | To define a proxy host when instantiating the SQS client
-
-| proxyPort | | Integer | To define a proxy port when instantiating the SQS client
-
-| secretKey | | String | Amazon AWS Secret Key
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **accessKey** (producer) | Amazon AWS Access Key | | String
+| **amazonSDBClient** (producer) | To use the AmazonSimpleDB as the client | | AmazonSimpleDB
+| **amazonSdbEndpoint** (producer) | The region with which the AWS-SDB client wants to work with. | | String
+| **consistentRead** (producer) | Determines whether or not strong consistency should be enforced when data is read. | false | boolean
+| **maxNumberOfDomains** (producer) | The maximum number of domain names you want returned. The range is 1 to 100. | | Integer
+| **operation** (producer) | Operation to perform | PutAttributes | SdbOperations
+| **proxyHost** (producer) | To define a proxy host when instantiating the SQS client | | String
+| **proxyPort** (producer) | To define a proxy port when instantiating the SQS client | | Integer
+| **secretKey** (producer) | Amazon AWS Secret Key | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-aws/src/main/docs/aws-ses-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-ses-component.adoc b/components/camel-aws/src/main/docs/aws-ses-component.adoc
index d7f3ed0..597cf18 100644
--- a/components/camel-aws/src/main/docs/aws-ses-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-ses-component.adoc
@@ -40,39 +40,28 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| from | | String | *Required* The sender's email address.
+| Name | Description | Default | Type
+| **from** | *Required* The sender's email address. | | String
|=======================================================================
#### Query Parameters (11 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| accessKey | | String | Amazon AWS Access Key
-
-| amazonSESClient | | AmazonSimpleEmailService | To use the AmazonSimpleEmailService as the client
-
-| amazonSESEndpoint | | String | The region with which the AWS-SES client wants to work with.
-
-| proxyHost | | String | To define a proxy host when instantiating the SQS client
-
-| proxyPort | | Integer | To define a proxy port when instantiating the SQS client
-
-| replyToAddresses | | List | List of reply-to email address(es) for the message override it using 'CamelAwsSesReplyToAddresses' header.
-
-| returnPath | | String | The email address to which bounce notifications are to be forwarded override it using 'CamelAwsSesReturnPath' header.
-
-| secretKey | | String | Amazon AWS Secret Key
-
-| subject | | String | The subject which is used if the message header 'CamelAwsSesSubject' is not present.
-
-| to | | List | List of destination email address. Can be overriden with 'CamelAwsSesTo' header.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **accessKey** (producer) | Amazon AWS Access Key | | String
+| **amazonSESClient** (producer) | To use the AmazonSimpleEmailService as the client | | AmazonSimpleEmail Service
+| **amazonSESEndpoint** (producer) | The region with which the AWS-SES client wants to work with. | | String
+| **proxyHost** (producer) | To define a proxy host when instantiating the SQS client | | String
+| **proxyPort** (producer) | To define a proxy port when instantiating the SQS client | | Integer
+| **replyToAddresses** (producer) | List of reply-to email address(es) for the message override it using 'CamelAwsSesReplyToAddresses' header. | | List
+| **returnPath** (producer) | The email address to which bounce notifications are to be forwarded override it using 'CamelAwsSesReturnPath' header. | | String
+| **secretKey** (producer) | Amazon AWS Secret Key | | String
+| **subject** (producer) | The subject which is used if the message header 'CamelAwsSesSubject' is not present. | | String
+| **to** (producer) | List of destination email address. Can be overriden with 'CamelAwsSesTo' header. | | List
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-aws/src/main/docs/aws-sns-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-sns-component.adoc b/components/camel-aws/src/main/docs/aws-sns-component.adoc
index 7b92571..69a7a1d 100644
--- a/components/camel-aws/src/main/docs/aws-sns-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-sns-component.adoc
@@ -44,39 +44,28 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| topicNameOrArn | | String | *Required* Topic name or ARN
+| Name | Description | Default | Type
+| **topicNameOrArn** | *Required* Topic name or ARN | | String
|=======================================================================
#### Query Parameters (11 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| accessKey | | String | Amazon AWS Access Key
-
-| amazonSNSClient | | AmazonSNS | To use the AmazonSNS as the client
-
-| amazonSNSEndpoint | | String | The region with which the AWS-SNS client wants to work with.
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to map headers to/from Camel.
-
-| messageStructure | | String | The message structure to use such as json
-
-| policy | | String | The policy for this queue
-
-| proxyHost | | String | To define a proxy host when instantiating the SQS client
-
-| proxyPort | | Integer | To define a proxy port when instantiating the SQS client
-
-| secretKey | | String | Amazon AWS Secret Key
-
-| subject | | String | The subject which is used if the message header 'CamelAwsSnsSubject' is not present.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **accessKey** (producer) | Amazon AWS Access Key | | String
+| **amazonSNSClient** (producer) | To use the AmazonSNS as the client | | AmazonSNS
+| **amazonSNSEndpoint** (producer) | The region with which the AWS-SNS client wants to work with. | | String
+| **headerFilterStrategy** (producer) | To use a custom HeaderFilterStrategy to map headers to/from Camel. | | HeaderFilterStrategy
+| **messageStructure** (producer) | The message structure to use such as json | | String
+| **policy** (producer) | The policy for this queue | | String
+| **proxyHost** (producer) | To define a proxy host when instantiating the SQS client | | String
+| **proxyPort** (producer) | To define a proxy port when instantiating the SQS client | | Integer
+| **secretKey** (producer) | Amazon AWS Secret Key | | String
+| **subject** (producer) | The subject which is used if the message header 'CamelAwsSnsSubject' is not present. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-aws/src/main/docs/aws-sqs-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-sqs-component.adoc b/components/camel-aws/src/main/docs/aws-sqs-component.adoc
index 6c9b0a5..29abe52 100644
--- a/components/camel-aws/src/main/docs/aws-sqs-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-sqs-component.adoc
@@ -45,105 +45,61 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| queueNameOrArn | | String | *Required* Queue name or ARN
+| Name | Description | Default | Type
+| **queueNameOrArn** | *Required* Queue name or ARN | | String
|=======================================================================
#### Query Parameters (44 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| accessKey | | String | Amazon AWS Access Key
-
-| amazonSQSClient | | AmazonSQS | To use the AmazonSQS as client
-
-| amazonSQSEndpoint | | String | The region with which the AWS-SQS client wants to work with. Only works if Camel creates the AWS-SQS client i.e. if you explicitly set amazonSQSClient then this setting will have no effect. You would have to set it on the client you create directly
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to map headers to/from Camel.
-
-| queueOwnerAWSAccountId | | String | Specify the queue owner aws account id when you need to connect the queue with different account owner.
-
-| region | | String | Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL.
-
-| secretKey | | String | Amazon AWS Secret Key
- 4+^s| consumer
-| attributeNames | | String | A list of attribute names to receive when consuming. Multiple names can be separated by comma.
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| concurrentConsumers | 1 | int | Allows you to use multiple threads to poll the sqs queue to increase throughput
-
-| defaultVisibilityTimeout | | Integer | The default visibility timeout (in seconds)
-
-| deleteAfterRead | true | boolean | Delete message from SQS after it has been read
-
-| deleteIfFiltered | true | boolean | 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.
-
-| extendMessageVisibility | false | boolean | 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.
-
-| maxMessagesPerPoll | | int | 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.
-
-| messageAttributeNames | | String | A list of message attribute names to receive when consuming. Multiple names can be separated by comma.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| visibilityTimeout | | Integer | 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.
-
-| waitTimeSeconds | | Integer | 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.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| producer
-| delaySeconds | | Integer | Delay sending messages for a number of seconds.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| proxy
-| proxyHost | | String | To define a proxy host when instantiating the SQS client
-
-| proxyPort | | Integer | To define a proxy port when instantiating the SQS client
- 4+^s| queue
-| maximumMessageSize | | Integer | The maximumMessageSize (in bytes) an SQS message can contain for this queue.
-
-| messageRetentionPeriod | | Integer | The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.
-
-| policy | | String | The policy for this queue
-
-| receiveMessageWaitTimeSeconds | | Integer | If you do not specify WaitTimeSeconds in the request the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.
-
-| redrivePolicy | | String | Specify the policy that send message to DeadLetter queue. See detail at Amazon docs.
+| Name | Description | Default | Type
+| **accessKey** (common) | Amazon AWS Access Key | | String
+| **amazonSQSClient** (common) | To use the AmazonSQS as client | | AmazonSQS
+| **amazonSQSEndpoint** (common) | The region with which the AWS-SQS client wants to work with. Only works if Camel creates the AWS-SQS client i.e. if you explicitly set amazonSQSClient then this setting will have no effect. You would have to set it on the client you create directly | | String
+| **headerFilterStrategy** (common) | To use a custom HeaderFilterStrategy to map headers to/from Camel. | | HeaderFilterStrategy
+| **queueOwnerAWSAccountId** (common) | Specify the queue owner aws account id when you need to connect the queue with different account owner. | | String
+| **region** (common) | Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. | | String
+| **secretKey** (common) | Amazon AWS Secret Key | | String
+| **attributeNames** (consumer) | A list of attribute names to receive when consuming. Multiple names can be separated by comma. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **concurrentConsumers** (consumer) | Allows you to use multiple threads to poll the sqs queue to increase throughput | 1 | int
+| **defaultVisibilityTimeout** (consumer) | The default visibility timeout (in seconds) | | Integer
+| **deleteAfterRead** (consumer) | Delete message from SQS after it has been read | true | boolean
+| **deleteIfFiltered** (consumer) | 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. | true | boolean
+| **extendMessageVisibility** (consumer) | 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. | false | boolean
+| **maxMessagesPerPoll** (consumer) | 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. | | int
+| **messageAttributeNames** (consumer) | A list of message attribute names to receive when consuming. Multiple names can be separated by comma. | | String
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **visibilityTimeout** (consumer) | 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. | | Integer
+| **waitTimeSeconds** (consumer) | 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. | | Integer
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **delaySeconds** (producer) | Delay sending messages for a number of seconds. | | Integer
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **proxyHost** (proxy) | To define a proxy host when instantiating the SQS client | | String
+| **proxyPort** (proxy) | To define a proxy port when instantiating the SQS client | | Integer
+| **maximumMessageSize** (queue) | The maximumMessageSize (in bytes) an SQS message can contain for this queue. | | Integer
+| **messageRetentionPeriod** (queue) | The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. | | Integer
+| **policy** (queue) | The policy for this queue | | String
+| **receiveMessageWaitTime Seconds** (queue) | If you do not specify WaitTimeSeconds in the request the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. | | Integer
+| **redrivePolicy** (queue) | Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-aws/src/main/docs/aws-swf-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-aws/src/main/docs/aws-swf-component.adoc b/components/camel-aws/src/main/docs/aws-swf-component.adoc
index a741189..7caac89 100644
--- a/components/camel-aws/src/main/docs/aws-swf-component.adoc
+++ b/components/camel-aws/src/main/docs/aws-swf-component.adoc
@@ -40,75 +40,46 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| type | | String | *Required* Activity or workflow
+| Name | Description | Default | Type
+| **type** | *Required* Activity or workflow | | String
|=======================================================================
#### Query Parameters (29 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| accessKey | | String | Amazon AWS Access Key.
-
-| amazonSWClient | | AmazonSimpleWorkflowClient | To use the given AmazonSimpleWorkflowClient as client
-
-| dataConverter | | DataConverter | An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data.
-
-| domainName | | String | The workflow domain to use.
-
-| eventName | | String | The workflow or activity event name to use.
-
-| secretKey | | String | Amazon AWS Secret Key.
-
-| version | | String | The workflow or activity event version to use.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| clientConfigurationParameters | | Map | To configure the ClientConfiguration using the key/values from the Map.
-
-| startWorkflowOptionsParameters | | Map | To configure the StartWorkflowOptions using the key/values from the Map.
-
-| sWClientParameters | | Map | To configure the AmazonSimpleWorkflowClient using the key/values from the Map.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| activity
-| activityList | | String | The list name to consume activities from.
-
-| activitySchedulingOptions | | ActivitySchedulingOptions | Activity scheduling options
-
-| activityThreadPoolSize | 100 | int | Maximum number of threads in work pool for activity.
-
-| activityTypeExecutionOptions | | ActivityTypeExecutionOptions | Activity execution options
-
-| activityTypeRegistrationOptions | | ActivityTypeRegistrationOptions | Activity registration options
- 4+^s| workflow
-| childPolicy | | String | The policy to use on child workflows when terminating a workflow.
-
-| executionStartToCloseTimeout | 3600 | String | Set the execution start to close timeout.
-
-| operation | START | String | Workflow operation
-
-| signalName | | String | The name of the signal to send to the workflow.
-
-| stateResultType | | String | The type of the result when a workflow state is queried.
-
-| taskStartToCloseTimeout | 600 | String | Set the task start to close timeout.
-
-| terminationDetails | | String | Details for terminating a workflow.
-
-| terminationReason | | String | The reason for terminating a workflow.
-
-| workflowList | | String | The list name to consume workflows from.
-
-| workflowTypeRegistrationOptions | | WorkflowTypeRegistrationOptions | Workflow registration options
+| Name | Description | Default | Type
+| **accessKey** (common) | Amazon AWS Access Key. | | String
+| **amazonSWClient** (common) | To use the given AmazonSimpleWorkflowClient as client | | AmazonSimpleWorkflow Client
+| **dataConverter** (common) | An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data. | | DataConverter
+| **domainName** (common) | The workflow domain to use. | | String
+| **eventName** (common) | The workflow or activity event name to use. | | String
+| **secretKey** (common) | Amazon AWS Secret Key. | | String
+| **version** (common) | The workflow or activity event version to use. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **clientConfiguration Parameters** (advanced) | To configure the ClientConfiguration using the key/values from the Map. | | Map
+| **startWorkflowOptions Parameters** (advanced) | To configure the StartWorkflowOptions using the key/values from the Map. | | Map
+| **sWClientParameters** (advanced) | To configure the AmazonSimpleWorkflowClient using the key/values from the Map. | | Map
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **activityList** (activity) | The list name to consume activities from. | | String
+| **activitySchedulingOptions** (activity) | Activity scheduling options | | ActivityScheduling Options
+| **activityThreadPoolSize** (activity) | Maximum number of threads in work pool for activity. | 100 | int
+| **activityTypeExecution Options** (activity) | Activity execution options | | ActivityTypeExecution Options
+| **activityTypeRegistration Options** (activity) | Activity registration options | | ActivityType RegistrationOptions
+| **childPolicy** (workflow) | The policy to use on child workflows when terminating a workflow. | | String
+| **executionStartToClose Timeout** (workflow) | Set the execution start to close timeout. | 3600 | String
+| **operation** (workflow) | Workflow operation | START | String
+| **signalName** (workflow) | The name of the signal to send to the workflow. | | String
+| **stateResultType** (workflow) | The type of the result when a workflow state is queried. | | String
+| **taskStartToCloseTimeout** (workflow) | Set the task start to close timeout. | 600 | String
+| **terminationDetails** (workflow) | Details for terminating a workflow. | | String
+| **terminationReason** (workflow) | The reason for terminating a workflow. | | String
+| **workflowList** (workflow) | The list name to consume workflows from. | | String
+| **workflowTypeRegistration Options** (workflow) | Workflow registration options | | WorkflowType RegistrationOptions
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-azure/src/main/docs/azure-blob-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-azure/src/main/docs/azure-blob-component.adoc b/components/camel-azure/src/main/docs/azure-blob-component.adoc
index 4514db4..34aed4b 100644
--- a/components/camel-azure/src/main/docs/azure-blob-component.adoc
+++ b/components/camel-azure/src/main/docs/azure-blob-component.adoc
@@ -56,55 +56,36 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| containerOrBlobUri | | String | *Required* Container or Blob compact Uri
+| Name | Description | Default | Type
+| **containerOrBlobUri** | *Required* Container or Blob compact Uri | | String
|=======================================================================
#### Query Parameters (19 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| azureBlobClient | | CloudBlob | The blob service client
-
-| blobOffset | 0 | Long | Set the blob offset for the upload or download operations default is 0
-
-| blobType | blockblob | BlobType | Set a blob type 'blockblob' is default
-
-| closeStreamAfterRead | true | boolean | Close the stream after read or keep it open default is true
-
-| credentials | | StorageCredentials | Set the storage credentials required in most cases
-
-| dataLength | | Long | Set the data length for the download or page blob upload operations
-
-| fileDir | | String | Set the file directory where the downloaded blobs will be saved to
-
-| publicForRead | false | boolean | Storage resources can be public for reading their content if this property is enabled then the credentials do not have to be set
-
-| streamReadSize | | int | Set the minimum read size in bytes when reading the blob content
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| blobMetadata | | Map | Set the blob meta-data
-
-| blobPrefix | | String | Set a prefix which can be used for listing the blobs
-
-| closeStreamAfterWrite | true | boolean | Close the stream after write or keep it open default is true
-
-| operation | listBlobs | BlobServiceOperations | Blob service operation hint to the producer
-
-| streamWriteSize | | int | Set the size of the buffer for writing block and page blocks
-
-| useFlatListing | true | boolean | Specify if the flat or hierarchical blob listing should be used
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **azureBlobClient** (common) | The blob service client | | CloudBlob
+| **blobOffset** (common) | Set the blob offset for the upload or download operations default is 0 | 0 | Long
+| **blobType** (common) | Set a blob type 'blockblob' is default | blockblob | BlobType
+| **closeStreamAfterRead** (common) | Close the stream after read or keep it open default is true | true | boolean
+| **credentials** (common) | Set the storage credentials required in most cases | | StorageCredentials
+| **dataLength** (common) | Set the data length for the download or page blob upload operations | | Long
+| **fileDir** (common) | Set the file directory where the downloaded blobs will be saved to | | String
+| **publicForRead** (common) | Storage resources can be public for reading their content if this property is enabled then the credentials do not have to be set | false | boolean
+| **streamReadSize** (common) | Set the minimum read size in bytes when reading the blob content | | int
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **blobMetadata** (producer) | Set the blob meta-data | | Map
+| **blobPrefix** (producer) | Set a prefix which can be used for listing the blobs | | String
+| **closeStreamAfterWrite** (producer) | Close the stream after write or keep it open default is true | true | boolean
+| **operation** (producer) | Blob service operation hint to the producer | listBlobs | BlobServiceOperations
+| **streamWriteSize** (producer) | Set the size of the buffer for writing block and page blocks | | int
+| **useFlatListing** (producer) | Specify if the flat or hierarchical blob listing should be used | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-azure/src/main/docs/azure-queue-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-azure/src/main/docs/azure-queue-component.adoc b/components/camel-azure/src/main/docs/azure-queue-component.adoc
index 55e273b..6390541 100644
--- a/components/camel-azure/src/main/docs/azure-queue-component.adoc
+++ b/components/camel-azure/src/main/docs/azure-queue-component.adoc
@@ -56,37 +56,27 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| containerAndQueueUri | | String | *Required* Container Queue compact Uri
+| Name | Description | Default | Type
+| **containerAndQueueUri** | *Required* Container Queue compact Uri | | String
|=======================================================================
#### Query Parameters (10 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| azureQueueClient | | CloudQueue | The queue service client
-
-| credentials | | StorageCredentials | Set the storage credentials required in most cases
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| messageTimeToLive | | int | Message Time To Live in seconds
-
-| messageVisibilityDelay | | int | Message Visibility Delay in seconds
-
-| operation | listQueues | QueueServiceOperations | Queue service operation hint to the producer
-
-| queuePrefix | | String | Set a prefix which can be used for listing the queues
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **azureQueueClient** (common) | The queue service client | | CloudQueue
+| **credentials** (common) | Set the storage credentials required in most cases | | StorageCredentials
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **messageTimeToLive** (producer) | Message Time To Live in seconds | | int
+| **messageVisibilityDelay** (producer) | Message Visibility Delay in seconds | | int
+| **operation** (producer) | Queue service operation hint to the producer | listQueues | QueueServiceOperations
+| **queuePrefix** (producer) | Set a prefix which can be used for listing the queues | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc b/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc
index aa94cca..1e02812 100644
--- a/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc
+++ b/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc
@@ -58,29 +58,23 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| label | | String | *Required* Where label is an arbitrary text value describing the endpoint
+| Name | Description | Default | Type
+| **label** | *Required* Where label is an arbitrary text value describing the endpoint | | String
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| constraintValidatorFactory | | ConstraintValidatorFactory | To use a custom ConstraintValidatorFactory
-
-| group | javax.validation.groups.Default | String | To use a custom validation group
-
-| messageInterpolator | | MessageInterpolator | To use a custom MessageInterpolator
-
-| traversableResolver | | TraversableResolver | To use a custom TraversableResolver
-
-| validationProviderResolver | | ValidationProviderResolver | To use a a custom ValidationProviderResolver
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **constraintValidatorFactory** (producer) | To use a custom ConstraintValidatorFactory | | ConstraintValidator Factory
+| **group** (producer) | To use a custom validation group | javax.validation.groups.Default | String
+| **messageInterpolator** (producer) | To use a custom MessageInterpolator | | MessageInterpolator
+| **traversableResolver** (producer) | To use a custom TraversableResolver | | TraversableResolver
+| **validationProviderResolver** (producer) | To use a a custom ValidationProviderResolver | | ValidationProvider Resolver
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc b/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc
index e252045..1236823 100644
--- a/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc
+++ b/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc
@@ -61,13 +61,11 @@ The Beanstalk component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| connectionSettingsFactory | | ConnectionSettingsFactory | Custom ConnectionSettingsFactory. Specify which ConnectionSettingsFactory to use to make connections to Beanstalkd. Especially useful for unit testing without beanstalkd daemon (you can mock ConnectionSettings)
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **connectionSettings Factory** (common) | Custom ConnectionSettingsFactory. Specify which ConnectionSettingsFactory to use to make connections to Beanstalkd. Especially useful for unit testing without beanstalkd daemon (you can mock ConnectionSettings) | | ConnectionSettings Factory
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -83,69 +81,43 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| connectionSettings | | String | Connection settings host:port/tube
+| Name | Description | Default | Type
+| **connectionSettings** | Connection settings host:port/tube | | String
|=======================================================================
#### Query Parameters (26 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| command | | BeanstalkCommand | 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.
-
-| jobDelay | 0 | int | Job delay in seconds.
-
-| jobPriority | 1000 | long | Job priority. (0 is the highest see Beanstalk protocol)
-
-| jobTimeToRun | 60 | int | Job time to run in seconds. (when 0 the beanstalkd daemon raises it to 1 automatically see Beanstalk protocol)
- 4+^s| consumer
-| awaitJob | true | boolean | Whether to wait for job to complete before ack the job from beanstalk
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| onFailure | | BeanstalkCommand | Command to use when processing failed.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| useBlockIO | true | boolean | Whether to use blockIO.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **command** (common) | 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. | | BeanstalkCommand
+| **jobDelay** (common) | Job delay in seconds. | 0 | int
+| **jobPriority** (common) | Job priority. (0 is the highest see Beanstalk protocol) | 1000 | long
+| **jobTimeToRun** (common) | Job time to run in seconds. (when 0 the beanstalkd daemon raises it to 1 automatically see Beanstalk protocol) | 60 | int
+| **awaitJob** (consumer) | Whether to wait for job to complete before ack the job from beanstalk | true | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **onFailure** (consumer) | Command to use when processing failed. | | BeanstalkCommand
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **useBlockIO** (consumer) | Whether to use blockIO. | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-bonita/src/main/docs/bonita-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-bonita/src/main/docs/bonita-component.adoc b/components/camel-bonita/src/main/docs/bonita-component.adoc
index 8eac646..5443f2c 100644
--- a/components/camel-bonita/src/main/docs/bonita-component.adoc
+++ b/components/camel-bonita/src/main/docs/bonita-component.adoc
@@ -29,35 +29,26 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| operation | | BonitaOperation | *Required* Operation to use
+| Name | Description | Default | Type
+| **operation** | *Required* Operation to use | | BonitaOperation
|=======================================================================
#### Query Parameters (9 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| hostname | localhost | String | Hostname where Bonita engine runs
-
-| port | 8080 | String | Port of the server hosting Bonita engine
-
-| processName | | String | Name of the process involved in the operation
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| password | | String | Password to authenticate to Bonita engine.
-
-| username | | String | Username to authenticate to Bonita engine.
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **hostname** (consumer) | Hostname where Bonita engine runs | localhost | String
+| **port** (consumer) | Port of the server hosting Bonita engine | 8080 | String
+| **processName** (consumer) | Name of the process involved in the operation | | String
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **password** (security) | Password to authenticate to Bonita engine. | | String
+| **username** (security) | Username to authenticate to Bonita engine. | | String
|=======================================================================
// endpoint options: END
[21/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc b/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc
index bd0e135..dadb762 100644
--- a/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc
+++ b/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc
@@ -35,13 +35,11 @@ The Elasticsearch component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| client | | Client | To use an existing configured Elasticsearch client instead of creating a client per endpoint.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **client** (advanced) | To use an existing configured Elasticsearch client instead of creating a client per endpoint. | | Client
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -58,39 +56,28 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| clusterName | | String | *Required* Name of cluster or use local for local mode
+| Name | Description | Default | Type
+| **clusterName** | *Required* Name of cluster or use local for local mode | | String
|=======================================================================
#### Query Parameters (11 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| clientTransportSniff | true | Boolean | Is the client allowed to sniff the rest of the cluster or not (default true). This setting map to the client.transport.sniff setting.
-
-| consistencyLevel | DEFAULT | WriteConsistencyLevel | The write consistency level to use with INDEX and BULK operations (can be any of ONE QUORUM ALL or DEFAULT)
-
-| data | | Boolean | Is the node going to be allowed to allocate data (shards) to it or not. This setting map to the node.data setting.
-
-| indexName | | String | The name of the index to act against
-
-| indexType | | String | The type of the index to act against
-
-| ip | | String | The TransportClient remote host ip to use
-
-| operation | | String | What operation to perform
-
-| pathHome | ${user.home}/.elasticsearch | String | The path.home property of ElasticSearch configuration. You need to provide a valid path otherwise the default $user.home/.elasticsearch will be used.
-
-| port | 9300 | int | The TransportClient remote port to use (defaults to 9300)
-
-| transportAddresses | | String | Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for transportAddresses to be considered instead.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **clientTransportSniff** (producer) | Is the client allowed to sniff the rest of the cluster or not (default true). This setting map to the client.transport.sniff setting. | true | Boolean
+| **consistencyLevel** (producer) | The write consistency level to use with INDEX and BULK operations (can be any of ONE QUORUM ALL or DEFAULT) | DEFAULT | WriteConsistencyLevel
+| **data** (producer) | Is the node going to be allowed to allocate data (shards) to it or not. This setting map to the node.data setting. | | Boolean
+| **indexName** (producer) | The name of the index to act against | | String
+| **indexType** (producer) | The type of the index to act against | | String
+| **ip** (producer) | The TransportClient remote host ip to use | | String
+| **operation** (producer) | What operation to perform | | String
+| **pathHome** (producer) | The path.home property of ElasticSearch configuration. You need to provide a valid path otherwise the default $user.home/.elasticsearch will be used. | ${user.home}/.elasticsearch | String
+| **port** (producer) | The TransportClient remote port to use (defaults to 9300) | 9300 | int
+| **transportAddresses** (producer) | Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for transportAddresses to be considered instead. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc b/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc
index 58ec2cc..76590b1 100644
--- a/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc
+++ b/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc
@@ -47,35 +47,26 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| clusterName | | String | *Required* Name of the cluster
+| Name | Description | Default | Type
+| **clusterName** | *Required* Name of the cluster | | String
|=======================================================================
#### Query Parameters (9 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| clientTransportSniff | true | Boolean | Is the client allowed to sniff the rest of the cluster or not (default true). This setting map to the client.transport.sniff setting.
-
-| indexName | | String | The name of the index to act against
-
-| indexType | | String | The type of the index to act against
-
-| ip | | String | The TransportClient remote host ip to use
-
-| operation | | ElasticsearchOperation | What operation to perform
-
-| port | 9300 | int | The TransportClient remote port to use (defaults to 9300)
-
-| transportAddresses | | String | Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for transportAddresses to be considered instead.
-
-| waitForActiveShards | 1 | int | Index creation waits for the write consistency number of shards to be available
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **clientTransportSniff** (producer) | Is the client allowed to sniff the rest of the cluster or not (default true). This setting map to the client.transport.sniff setting. | true | Boolean
+| **indexName** (producer) | The name of the index to act against | | String
+| **indexType** (producer) | The type of the index to act against | | String
+| **ip** (producer) | The TransportClient remote host ip to use | | String
+| **operation** (producer) | What operation to perform | | ElasticsearchOperation
+| **port** (producer) | The TransportClient remote port to use (defaults to 9300) | 9300 | int
+| **transportAddresses** (producer) | Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for transportAddresses to be considered instead. | | String
+| **waitForActiveShards** (producer) | Index creation waits for the write consistency number of shards to be available | 1 | int
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-elsql/src/main/docs/elsql-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-elsql/src/main/docs/elsql-component.adoc b/components/camel-elsql/src/main/docs/elsql-component.adoc
index 17ce69e..0efcb8b 100644
--- a/components/camel-elsql/src/main/docs/elsql-component.adoc
+++ b/components/camel-elsql/src/main/docs/elsql-component.adoc
@@ -53,19 +53,14 @@ The ElSQL component supports 5 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| databaseVendor | | ElSqlDatabaseVendor | To use a vendor specific com.opengamma.elsql.ElSqlConfig
-
-| dataSource | | DataSource | Sets the DataSource to use to communicate with the database.
- 4+^s| advanced
-| elSqlConfig | | ElSqlConfig | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead.
- 4+^s| common
-| resourceUri | | String | 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.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **databaseVendor** (common) | To use a vendor specific com.opengamma.elsql.ElSqlConfig | | ElSqlDatabaseVendor
+| **dataSource** (common) | Sets the DataSource to use to communicate with the database. | | DataSource
+| **elSqlConfig** (advanced) | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead. | | ElSqlConfig
+| **resourceUri** (common) | 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. | | String
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -78,112 +73,65 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| elsqlName | | String | *Required* The name of the elsql to use (is NAMED in the elsql file)
-| resourceUri | | String | 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.
+| Name | Description | Default | Type
+| **elsqlName** | *Required* The name of the elsql to use (is NAMED in the elsql file) | | String
+| **resourceUri** | 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. | | String
|=======================================================================
#### Query Parameters (47 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| allowNamedParameters | true | boolean | Whether to allow using named parameters in the queries.
-
-| databaseVendor | | ElSqlDatabaseVendor | To use a vendor specific com.opengamma.elsql.ElSqlConfig
-
-| dataSource | | DataSource | Sets the DataSource to use to communicate with the database.
-
-| dataSourceRef | | String | Sets the reference to a DataSource to lookup from the registry to use for communicating with the database.
-
-| outputClass | | String | Specify the full package and class name to use as conversion when outputType=SelectOne.
-
-| outputHeader | | String | 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.
-
-| outputType | SelectList | SqlOutputType | 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.
-
-| separator | , | char | 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
- 4+^s| consumer
-| breakBatchOnConsumeFail | false | boolean | Sets whether to break batch if onConsume failed.
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| expectedUpdateCount | -1 | int | Sets an expected update count to validate when using onConsume.
-
-| maxMessagesPerPoll | | int | Sets the maximum number of messages to poll
-
-| onConsume | | String | 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.
-
-| onConsumeBatchComplete | | String | After processing the entire batch this query can be executed to bulk update rows etc. The query cannot have parameters.
-
-| onConsumeFailed | | String | 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.
-
-| routeEmptyResultSet | false | boolean | 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.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
-
-| transacted | false | boolean | 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.
-
-| useIterator | true | boolean | Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
-
-| processingStrategy | | SqlProcessingStrategy | Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch.
- 4+^s| producer
-| batch | false | boolean | Enables or disables batch mode
-
-| noop | false | boolean | 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
-
-| useMessageBodyForSql | false | boolean | 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.
- 4+^s| producer (advanced)
-| alwaysPopulateStatement | false | boolean | 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.
-
-| parametersCount | | int | 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.
- 4+^s| advanced
-| elSqlConfig | | ElSqlConfig | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead.
-
-| placeholder | # | String | 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).
-
-| prepareStatementStrategy | | SqlPrepareStatementStrategy | Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| templateOptions | | Map | Configures the Spring JdbcTemplate with the key/values from the Map
-
-| usePlaceholder | true | boolean | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries.
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **allowNamedParameters** (common) | Whether to allow using named parameters in the queries. | true | boolean
+| **databaseVendor** (common) | To use a vendor specific com.opengamma.elsql.ElSqlConfig | | ElSqlDatabaseVendor
+| **dataSource** (common) | Sets the DataSource to use to communicate with the database. | | DataSource
+| **dataSourceRef** (common) | Sets the reference to a DataSource to lookup from the registry to use for communicating with the database. | | String
+| **outputClass** (common) | Specify the full package and class name to use as conversion when outputType=SelectOne. | | String
+| **outputHeader** (common) | 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. | | String
+| **outputType** (common) | 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. | SelectList | SqlOutputType
+| **separator** (common) | 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 | , | char
+| **breakBatchOnConsumeFail** (consumer) | Sets whether to break batch if onConsume failed. | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **expectedUpdateCount** (consumer) | Sets an expected update count to validate when using onConsume. | -1 | int
+| **maxMessagesPerPoll** (consumer) | Sets the maximum number of messages to poll | | int
+| **onConsume** (consumer) | 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. | | String
+| **onConsumeBatchComplete** (consumer) | After processing the entire batch this query can be executed to bulk update rows etc. The query cannot have parameters. | | String
+| **onConsumeFailed** (consumer) | 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. | | String
+| **routeEmptyResultSet** (consumer) | 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. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **transacted** (consumer) | 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. | false | boolean
+| **useIterator** (consumer) | Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true. | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **processingStrategy** (consumer) | Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch. | | SqlProcessingStrategy
+| **batch** (producer) | Enables or disables batch mode | false | boolean
+| **noop** (producer) | 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 | false | boolean
+| **useMessageBodyForSql** (producer) | 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. | false | boolean
+| **alwaysPopulateStatement** (producer) | 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. | false | boolean
+| **parametersCount** (producer) | 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. | | int
+| **elSqlConfig** (advanced) | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead. | | ElSqlConfig
+| **placeholder** (advanced) | 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). | # | String
+| **prepareStatementStrategy** (advanced) | Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement. | | SqlPrepareStatement Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **templateOptions** (advanced) | Configures the Spring JdbcTemplate with the key/values from the Map | | Map
+| **usePlaceholder** (advanced) | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. | true | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-etcd/src/main/docs/etcd-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-etcd/src/main/docs/etcd-component.adoc b/components/camel-etcd/src/main/docs/etcd-component.adoc
index 925b8ea..1b45013 100644
--- a/components/camel-etcd/src/main/docs/etcd-component.adoc
+++ b/components/camel-etcd/src/main/docs/etcd-component.adoc
@@ -26,75 +26,46 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| namespace | | EtcdNamespace | *Required* The API namespace to use
-| path | | String | The path the endpoint refers to
+| Name | Description | Default | Type
+| **namespace** | *Required* The API namespace to use | | EtcdNamespace
+| **path** | The path the endpoint refers to | | String
|=======================================================================
#### Query Parameters (29 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| recursive | false | boolean | To apply an action recursively.
-
-| servicePath | /services/ | String | The path to look for for service discovery
-
-| timeout | | Long | To set the maximum time an action could take to complete.
-
-| uris | http://localhost:2379,http://localhost:4001 | String | To set the URIs the client connects.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| sendEmptyExchangeOnTimeout | false | boolean | To send an empty message in case of timeout watching for a key.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| fromIndex | 0 | Long | The index to watch from
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| producer
-| timeToLive | | Integer | To set the lifespan of a key in milliseconds.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| security
-| password | | String | The password to use for basic authentication.
-
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters.
-
-| userName | | String | The user name to use for basic authentication.
+| Name | Description | Default | Type
+| **recursive** (common) | To apply an action recursively. | false | boolean
+| **servicePath** (common) | The path to look for for service discovery | /services/ | String
+| **timeout** (common) | To set the maximum time an action could take to complete. | | Long
+| **uris** (common) | To set the URIs the client connects. | http://localhost:2379,http://localhost:4001 | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **sendEmptyExchangeOnTimeout** (consumer) | To send an empty message in case of timeout watching for a key. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **fromIndex** (consumer) | The index to watch from | 0 | Long
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **timeToLive** (producer) | To set the lifespan of a key in milliseconds. | | Integer
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **password** (security) | The password to use for basic authentication. | | String
+| **sslContextParameters** (security) | To configure security using SSLContextParameters. | | SSLContextParameters
+| **userName** (security) | The user name to use for basic authentication. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc b/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc
index de78d74..9fedc56 100644
--- a/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc
+++ b/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc
@@ -37,13 +37,11 @@ The OSGi EventAdmin component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| bundleContext | | BundleContext | The OSGi BundleContext is automatic injected by Camel
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **bundleContext** (common) | The OSGi BundleContext is automatic injected by Camel | | BundleContext
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -56,27 +54,22 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| topic | | String | Name of topic to listen or send to
+| Name | Description | Default | Type
+| **topic** | Name of topic to listen or send to | | String
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| send | false | boolean | Whether to use 'send' or 'synchronous' deliver. Default false (async delivery)
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **send** (common) | Whether to use 'send' or 'synchronous' deliver. Default false (async delivery) | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-exec/src/main/docs/exec-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-exec/src/main/docs/exec-component.adoc b/components/camel-exec/src/main/docs/exec-component.adoc
index 73d0f46..57b952f 100644
--- a/components/camel-exec/src/main/docs/exec-component.adoc
+++ b/components/camel-exec/src/main/docs/exec-component.adoc
@@ -46,33 +46,25 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| executable | | String | *Required* Sets the executable to be executed. The executable must not be empty or null.
+| Name | Description | Default | Type
+| **executable** | *Required* Sets the executable to be executed. The executable must not be empty or null. | | String
|=======================================================================
#### Query Parameters (8 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| args | | String | The arguments may be one or many whitespace-separated tokens.
-
-| binding | | ExecBinding | A reference to a org.apache.commons.exec.ExecBinding in the Registry.
-
-| commandExecutor | | ExecCommandExecutor | 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.
-
-| outFile | | String | 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.
-
-| timeout | | long | 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.
-
-| useStderrOnEmptyStdout | false | boolean | 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.
-
-| workingDir | | String | The directory in which the command should be executed. If null the working directory of the current process will be used.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **args** (producer) | The arguments may be one or many whitespace-separated tokens. | | String
+| **binding** (producer) | A reference to a org.apache.commons.exec.ExecBinding in the Registry. | | ExecBinding
+| **commandExecutor** (producer) | 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. | | ExecCommandExecutor
+| **outFile** (producer) | 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. | | String
+| **timeout** (producer) | 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. | | long
+| **useStderrOnEmptyStdout** (producer) | 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. | false | boolean
+| **workingDir** (producer) | The directory in which the command should be executed. If null the working directory of the current process will be used. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-facebook/src/main/docs/facebook-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-facebook/src/main/docs/facebook-component.adoc b/components/camel-facebook/src/main/docs/facebook-component.adoc
index a482af1..1823609 100644
--- a/components/camel-facebook/src/main/docs/facebook-component.adoc
+++ b/components/camel-facebook/src/main/docs/facebook-component.adoc
@@ -56,13 +56,11 @@ The Facebook component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| configuration | | FacebookConfiguration | To use the shared configuration
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (advanced) | To use the shared configuration | | FacebookConfiguration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -79,221 +77,119 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| methodName | | String | *Required* What operation to perform
+| Name | Description | Default | Type
+| **methodName** | *Required* What operation to perform | | String
|=======================================================================
#### Query Parameters (102 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| achievementURL | | URL | The unique URL of the achievement
-
-| albumId | | String | The album ID
-
-| albumUpdate | | AlbumUpdate | The facebook Album to be created or updated
-
-| appId | | String | The ID of the Facebook Application
-
-| center | | GeoLocation | Location latitude and longitude
-
-| checkinId | | String | The checkin ID
-
-| checkinUpdate | | CheckinUpdate | The checkin to be created. Deprecated instead create a Post with an attached location
-
-| clientURL | | String | Facebook4J API client URL
-
-| clientVersion | | String | Facebook4J client API version
-
-| commentId | | String | The comment ID
-
-| commentUpdate | | CommentUpdate | The facebook Comment to be created or updated
-
-| debugEnabled | false | Boolean | Enables deubg output. Effective only with the embedded logger
-
-| description | | String | The description text
-
-| distance | | Integer | Distance in meters
-
-| domainId | | String | The domain ID
-
-| domainName | | String | The domain name
-
-| domainNames | | List | The domain names
-
-| eventId | | String | The event ID
-
-| eventUpdate | | EventUpdate | The event to be created or updated
-
-| friendId | | String | The friend ID
-
-| friendlistId | | String | The friend list ID
-
-| friendlistName | | String | The friend list Name
-
-| friendUserId | | String | The friend user ID
-
-| groupId | | String | The group ID
-
-| gzipEnabled | true | Boolean | Use Facebook GZIP encoding
-
-| httpConnectionTimeout | 20000 | Integer | Http connection timeout in milliseconds
-
-| httpDefaultMaxPerRoute | 2 | Integer | HTTP maximum connections per route
-
-| httpMaxTotalConnections | 20 | Integer | HTTP maximum total connections
-
-| httpReadTimeout | 120000 | Integer | Http read timeout in milliseconds
-
-| httpRetryCount | 0 | Integer | Number of HTTP retries
-
-| httpRetryIntervalSeconds | 5 | Integer | HTTP retry interval in seconds
-
-| httpStreamingReadTimeout | 40000 | Integer | HTTP streaming read timeout in milliseconds
-
-| ids | | List | The ids of users
-
-| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body
-
-| includeRead | | Boolean | Enables notifications that the user has already read in addition to unread ones
-
-| isHidden | | Boolean | Whether hidden
-
-| jsonStoreEnabled | false | Boolean | If set to true raw JSON forms will be stored in DataObjectFactory
-
-| link | | URL | Link URL
-
-| linkId | | String | Link ID
-
-| locale | | Locale | Desired FQL locale
-
-| mbeanEnabled | false | Boolean | If set to true Facebook4J mbean will be registerd
-
-| message | | String | The message text
-
-| messageId | | String | The message ID
-
-| metric | | String | The metric name
-
-| milestoneId | | String | The milestone id
-
-| name | | String | Test user name must be of the form 'first last'
-
-| noteId | | String | The note ID
-
-| notificationId | | String | The notification ID
-
-| objectId | | String | The insight object ID
-
-| offerId | | String | The offer id
-
-| optionDescription | | String | The question's answer option description
-
-| pageId | | String | The page id
-
-| permissionName | | String | The permission name
-
-| permissions | | String | Test user permissions in the format perm1perm2...
-
-| photoId | | String | The photo ID
-
-| pictureId | | Integer | The picture id
-
-| pictureId2 | | Integer | The picture2 id
-
-| pictureSize | | PictureSize | The picture size
-
-| placeId | | String | The place ID
-
-| postId | | String | The post ID
-
-| postUpdate | | PostUpdate | The post to create or update
-
-| prettyDebugEnabled | false | Boolean | Prettify JSON debug output if set to true
-
-| queries | | Map | FQL queries
-
-| query | | String | FQL query or search terms for search endpoints
-
-| questionId | | String | The question id
-
-| reading | | Reading | Optional reading parameters. See Reading Options(reading)
-
-| readingOptions | | Map | To configure Reading using key/value pairs from the Map.
-
-| restBaseURL | https://graph.facebook.com/ | String | API base URL
-
-| scoreValue | | Integer | The numeric score with value
-
-| size | | PictureSize | The picture size one of large normal small or square
-
-| source | | Media | The media content from either a java.io.File or java.io.Inputstream
-
-| subject | | String | The note of the subject
-
-| tabId | | String | The tab id
-
-| tagUpdate | | TagUpdate | Photo tag information
-
-| testUser1 | | TestUser | Test user 1
-
-| testUser2 | | TestUser | Test user 2
-
-| testUserId | | String | The ID of the test user
-
-| title | | String | The title text
-
-| toUserId | | String | The ID of the user to tag
-
-| toUserIds | | List | The IDs of the users to tag
-
-| userId | | String | The Facebook user ID
-
-| userId1 | | String | The ID of a user 1
-
-| userId2 | | String | The ID of a user 2
-
-| userIds | | List | The IDs of users to invite to event
-
-| userLocale | | String | The test user locale
-
-| useSSL | true | Boolean | Use SSL
-
-| videoBaseURL | https://graph-video.facebook.com/ | String | Video API base URL
-
-| videoId | | String | The video ID
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| proxy
-| httpProxyHost | | String | HTTP proxy server host name
-
-| httpProxyPassword | | String | HTTP proxy server password
-
-| httpProxyPort | | Integer | HTTP proxy server port
-
-| httpProxyUser | | String | HTTP proxy server user name
- 4+^s| security
-| oAuthAccessToken | | String | The user access token
-
-| oAuthAccessTokenURL | https://graph.facebook.com/oauth/access_token | String | OAuth access token URL
-
-| oAuthAppId | | String | The application Id
-
-| oAuthAppSecret | | String | The application Secret
-
-| oAuthAuthorizationURL | https://www.facebook.com/dialog/oauth | String | OAuth authorization URL
-
-| oAuthPermissions | | String | Default OAuth permissions. Comma separated permission names. See https://developers.facebook.com/docs/reference/login/permissions for the detail
+| Name | Description | Default | Type
+| **achievementURL** (common) | The unique URL of the achievement | | URL
+| **albumId** (common) | The album ID | | String
+| **albumUpdate** (common) | The facebook Album to be created or updated | | AlbumUpdate
+| **appId** (common) | The ID of the Facebook Application | | String
+| **center** (common) | Location latitude and longitude | | GeoLocation
+| **checkinId** (common) | The checkin ID | | String
+| **checkinUpdate** (common) | The checkin to be created. Deprecated instead create a Post with an attached location | | CheckinUpdate
+| **clientURL** (common) | Facebook4J API client URL | | String
+| **clientVersion** (common) | Facebook4J client API version | | String
+| **commentId** (common) | The comment ID | | String
+| **commentUpdate** (common) | The facebook Comment to be created or updated | | CommentUpdate
+| **debugEnabled** (common) | Enables deubg output. Effective only with the embedded logger | false | Boolean
+| **description** (common) | The description text | | String
+| **distance** (common) | Distance in meters | | Integer
+| **domainId** (common) | The domain ID | | String
+| **domainName** (common) | The domain name | | String
+| **domainNames** (common) | The domain names | | List
+| **eventId** (common) | The event ID | | String
+| **eventUpdate** (common) | The event to be created or updated | | EventUpdate
+| **friendId** (common) | The friend ID | | String
+| **friendlistId** (common) | The friend list ID | | String
+| **friendlistName** (common) | The friend list Name | | String
+| **friendUserId** (common) | The friend user ID | | String
+| **groupId** (common) | The group ID | | String
+| **gzipEnabled** (common) | Use Facebook GZIP encoding | true | Boolean
+| **httpConnectionTimeout** (common) | Http connection timeout in milliseconds | 20000 | Integer
+| **httpDefaultMaxPerRoute** (common) | HTTP maximum connections per route | 2 | Integer
+| **httpMaxTotalConnections** (common) | HTTP maximum total connections | 20 | Integer
+| **httpReadTimeout** (common) | Http read timeout in milliseconds | 120000 | Integer
+| **httpRetryCount** (common) | Number of HTTP retries | 0 | Integer
+| **httpRetryIntervalSeconds** (common) | HTTP retry interval in seconds | 5 | Integer
+| **httpStreamingReadTimeout** (common) | HTTP streaming read timeout in milliseconds | 40000 | Integer
+| **ids** (common) | The ids of users | | List
+| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String
+| **includeRead** (common) | Enables notifications that the user has already read in addition to unread ones | | Boolean
+| **isHidden** (common) | Whether hidden | | Boolean
+| **jsonStoreEnabled** (common) | If set to true raw JSON forms will be stored in DataObjectFactory | false | Boolean
+| **link** (common) | Link URL | | URL
+| **linkId** (common) | Link ID | | String
+| **locale** (common) | Desired FQL locale | | Locale
+| **mbeanEnabled** (common) | If set to true Facebook4J mbean will be registerd | false | Boolean
+| **message** (common) | The message text | | String
+| **messageId** (common) | The message ID | | String
+| **metric** (common) | The metric name | | String
+| **milestoneId** (common) | The milestone id | | String
+| **name** (common) | Test user name must be of the form 'first last' | | String
+| **noteId** (common) | The note ID | | String
+| **notificationId** (common) | The notification ID | | String
+| **objectId** (common) | The insight object ID | | String
+| **offerId** (common) | The offer id | | String
+| **optionDescription** (common) | The question's answer option description | | String
+| **pageId** (common) | The page id | | String
+| **permissionName** (common) | The permission name | | String
+| **permissions** (common) | Test user permissions in the format perm1perm2... | | String
+| **photoId** (common) | The photo ID | | String
+| **pictureId** (common) | The picture id | | Integer
+| **pictureId2** (common) | The picture2 id | | Integer
+| **pictureSize** (common) | The picture size | | PictureSize
+| **placeId** (common) | The place ID | | String
+| **postId** (common) | The post ID | | String
+| **postUpdate** (common) | The post to create or update | | PostUpdate
+| **prettyDebugEnabled** (common) | Prettify JSON debug output if set to true | false | Boolean
+| **queries** (common) | FQL queries | | Map
+| **query** (common) | FQL query or search terms for search endpoints | | String
+| **questionId** (common) | The question id | | String
+| **reading** (common) | Optional reading parameters. See Reading Options(reading) | | Reading
+| **readingOptions** (common) | To configure Reading using key/value pairs from the Map. | | Map
+| **restBaseURL** (common) | API base URL | https://graph.facebook.com/ | String
+| **scoreValue** (common) | The numeric score with value | | Integer
+| **size** (common) | The picture size one of large normal small or square | | PictureSize
+| **source** (common) | The media content from either a java.io.File or java.io.Inputstream | | Media
+| **subject** (common) | The note of the subject | | String
+| **tabId** (common) | The tab id | | String
+| **tagUpdate** (common) | Photo tag information | | TagUpdate
+| **testUser1** (common) | Test user 1 | | TestUser
+| **testUser2** (common) | Test user 2 | | TestUser
+| **testUserId** (common) | The ID of the test user | | String
+| **title** (common) | The title text | | String
+| **toUserId** (common) | The ID of the user to tag | | String
+| **toUserIds** (common) | The IDs of the users to tag | | List
+| **userId** (common) | The Facebook user ID | | String
+| **userId1** (common) | The ID of a user 1 | | String
+| **userId2** (common) | The ID of a user 2 | | String
+| **userIds** (common) | The IDs of users to invite to event | | List
+| **userLocale** (common) | The test user locale | | String
+| **useSSL** (common) | Use SSL | true | Boolean
+| **videoBaseURL** (common) | Video API base URL | https://graph-video.facebook.com/ | String
+| **videoId** (common) | The video ID | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **httpProxyHost** (proxy) | HTTP proxy server host name | | String
+| **httpProxyPassword** (proxy) | HTTP proxy server password | | String
+| **httpProxyPort** (proxy) | HTTP proxy server port | | Integer
+| **httpProxyUser** (proxy) | HTTP proxy server user name | | String
+| **oAuthAccessToken** (security) | The user access token | | String
+| **oAuthAccessTokenURL** (security) | OAuth access token URL | https://graph.facebook.com/oauth/access_token | String
+| **oAuthAppId** (security) | The application Id | | String
+| **oAuthAppSecret** (security) | The application Secret | | String
+| **oAuthAuthorizationURL** (security) | OAuth authorization URL | https://www.facebook.com/dialog/oauth | String
+| **oAuthPermissions** (security) | Default OAuth permissions. Comma separated permission names. See https://developers.facebook.com/docs/reference/login/permissions for the detail | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-flatpack/src/main/docs/flatpack-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-flatpack/src/main/docs/flatpack-component.adoc b/components/camel-flatpack/src/main/docs/flatpack-component.adoc
index 2ec6b1b..5a48d6c 100644
--- a/components/camel-flatpack/src/main/docs/flatpack-component.adoc
+++ b/components/camel-flatpack/src/main/docs/flatpack-component.adoc
@@ -53,68 +53,43 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| type | delim | FlatpackType | Whether to use fixed or delimiter
-| resourceUri | | String | *Required* URL for loading the flatpack mapping file from classpath or file system
+| Name | Description | Default | Type
+| **type** | Whether to use fixed or delimiter | delim | FlatpackType
+| **resourceUri** | *Required* URL for loading the flatpack mapping file from classpath or file system | | String
|=======================================================================
#### Query Parameters (25 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| allowShortLines | false | boolean | Allows for lines to be shorter than expected and ignores the extra characters
-
-| delimiter | , | char | The default character delimiter for delimited files.
-
-| ignoreExtraColumns | false | boolean | Allows for lines to be longer than expected and ignores the extra characters
-
-| ignoreFirstRecord | true | boolean | Whether the first line is ignored for delimited files (for the column headers).
-
-| splitRows | true | boolean | Sets the Component to send each row as a separate exchange once parsed
-
-| textQualifier | | char | The text qualifier for delimited files.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **allowShortLines** (common) | Allows for lines to be shorter than expected and ignores the extra characters | false | boolean
+| **delimiter** (common) | The default character delimiter for delimited files. | , | char
+| **ignoreExtraColumns** (common) | Allows for lines to be longer than expected and ignores the extra characters | false | boolean
+| **ignoreFirstRecord** (common) | Whether the first line is ignored for delimited files (for the column headers). | true | boolean
+| **splitRows** (common) | Sets the Component to send each row as a separate exchange once parsed | true | boolean
+| **textQualifier** (common) | The text qualifier for delimited files. | | char
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-flink/src/main/docs/flink-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-flink/src/main/docs/flink-component.adoc b/components/camel-flink/src/main/docs/flink-component.adoc
index 976349c..c581d61 100644
--- a/components/camel-flink/src/main/docs/flink-component.adoc
+++ b/components/camel-flink/src/main/docs/flink-component.adoc
@@ -47,29 +47,23 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| endpointType | | EndpointType | *Required* Type of the endpoint (dataset datastream).
+| Name | Description | Default | Type
+| **endpointType** | *Required* Type of the endpoint (dataset datastream). | | EndpointType
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| collect | true | boolean | Indicates if results should be collected or counted.
-
-| dataSet | | DataSet | DataSet to compute against.
-
-| dataSetCallback | | DataSetCallback | Function performing action against a DataSet.
-
-| dataStream | | DataStream | DataStream to compute against.
-
-| dataStreamCallback | | DataStreamCallback | Function performing action against a DataStream.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **collect** (producer) | Indicates if results should be collected or counted. | true | boolean
+| **dataSet** (producer) | DataSet to compute against. | | DataSet
+| **dataSetCallback** (producer) | Function performing action against a DataSet. | | DataSetCallback
+| **dataStream** (producer) | DataStream to compute against. | | DataStream
+| **dataStreamCallback** (producer) | Function performing action against a DataStream. | | DataStreamCallback
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
@@ -85,19 +79,14 @@ The Apache Flink component supports 5 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| producer
-| dataSet | | DataSet | DataSet to compute against.
-
-| dataStream | | DataStream | DataStream to compute against.
-
-| dataSetCallback | | DataSetCallback | Function performing action against a DataSet.
-
-| dataStreamCallback | | DataStreamCallback | Function performing action against a DataStream.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **dataSet** (producer) | DataSet to compute against. | | DataSet
+| **dataStream** (producer) | DataStream to compute against. | | DataStream
+| **dataSetCallback** (producer) | Function performing action against a DataSet. | | DataSetCallback
+| **dataStreamCallback** (producer) | Function performing action against a DataStream. | | DataStreamCallback
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-fop/src/main/docs/fop-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-fop/src/main/docs/fop-component.adoc b/components/camel-fop/src/main/docs/fop-component.adoc
index f2c784f..0b79ace 100644
--- a/components/camel-fop/src/main/docs/fop-component.adoc
+++ b/components/camel-fop/src/main/docs/fop-component.adoc
@@ -76,23 +76,20 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| outputType | | FopOutputType | *Required* The primary output format is PDF but other output formats are also supported.
+| Name | Description | Default | Type
+| **outputType** | *Required* The primary output format is PDF but other output formats are also supported. | | FopOutputType
|=======================================================================
#### Query Parameters (3 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| fopFactory | | FopFactory | Allows to use a custom configured or implementation of org.apache.fop.apps.FopFactory.
-
-| userConfigURL | | String | The location of a configuration file which can be loaded from classpath or file system.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **fopFactory** (producer) | Allows to use a custom configured or implementation of org.apache.fop.apps.FopFactory. | | FopFactory
+| **userConfigURL** (producer) | The location of a configuration file which can be loaded from classpath or file system. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
[09/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc b/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc
index d687bdf..364c7e4 100644
--- a/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc
+++ b/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc
@@ -79,23 +79,16 @@ The Netty4 HTTP component supports 7 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| nettyHttpBinding | | NettyHttpBinding | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API.
- 4+^s| common
-| configuration | | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints.
- 4+^s| advanced
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.
- 4+^s| security
-| securityConfiguration | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources.
- 4+^s| advanced
-| maximumPoolSize | 16 | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16.
-
-| executorService | | EventExecutorGroup | To use the given EventExecutorGroup
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **nettyHttpBinding** (advanced) | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API. | | NettyHttpBinding
+| **configuration** (common) | To use the NettyConfiguration as configuration when creating endpoints. | | NettyHttpConfiguration
+| **headerFilterStrategy** (advanced) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. | | HeaderFilterStrategy
+| **securityConfiguration** (security) | Refers to a org.apache.camel.component.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. | | NettyHttpSecurity Configuration
+| **maximumPoolSize** (advanced) | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. | 16 | int
+| **executorService** (advanced) | To use the given EventExecutorGroup | | EventExecutorGroup
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -117,178 +110,99 @@ with the following path and query parameters:
#### Path Parameters (4 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| protocol | | String | *Required* The protocol to use which is either http or https
-| host | | String | *Required* The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer.
-| port | | int | The host port number
-| path | | String | Resource path
+| Name | Description | Default | Type
+| **protocol** | *Required* The protocol to use which is either http or https | | String
+| **host** | *Required* The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. | | String
+| **port** | The host port number | | int
+| **path** | Resource path | | String
|=======================================================================
#### Query Parameters (79 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeEndpoint | false | boolean | If the option is true the producer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange).
-
-| disconnect | false | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer.
-
-| keepAlive | true | boolean | Setting to ensure socket is not closed due to inactivity
-
-| reuseAddress | true | boolean | Setting to facilitate socket multiplexing
-
-| sync | true | boolean | Setting to set endpoint as one-way or request-response
-
-| tcpNoDelay | true | boolean | Setting to improve TCP protocol performance
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| matchOnUriPrefix | false | boolean | Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found.
-
-| send503whenSuspended | true | boolean | Whether to send back HTTP status code 503 when the consumer has been suspended. If the option is false then the Netty Acceptor is unbound when the consumer is suspended so clients cannot connect anymore.
- 4+^s| consumer (advanced)
-| backlog | | int | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting.
-
-| bossCount | 1 | int | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty
-
-| bossGroup | | EventLoopGroup | Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint
-
-| chunkedMaxContentLength | 1048576 | int | Value in bytes the max content length per chunked frame received on the Netty HTTP server.
-
-| compression | false | boolean | Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers.
-
-| disconnectOnNoReply | true | boolean | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| httpMethodRestrict | | String | To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma.
-
-| mapHeaders | true | boolean | If this option is enabled then during binding from Netty to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.netty.http.NettyHttpMessage message with the method getHttpRequest() that returns the Netty HTTP request io.netty.handler.codec.http.HttpRequest instance.
-
-| maxHeaderSize | 8192 | int | The maximum length of all headers. If the sum of the length of each header exceeds this value a io.netty.handler.codec.TooLongFrameException will be raised.
-
-| nettyServerBootstrapFactory | | NettyServerBootstrapFactory | To use a custom NettyServerBootstrapFactory
-
-| nettySharedHttpServer | | NettySharedHttpServer | To use a shared Netty HTTP server. See Netty HTTP Server Example for more details.
-
-| noReplyLogLevel | WARN | LoggingLevel | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back.
-
-| serverClosedChannelExceptionCaughtLogLevel | DEBUG | LoggingLevel | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server.
-
-| serverExceptionCaughtLogLevel | WARN | LoggingLevel | If the server (NettyConsumer) catches an exception then its logged using this logging level.
-
-| serverInitializerFactory | | ServerInitializerFactory | To use a custom ServerInitializerFactory
-
-| traceEnabled | false | boolean | Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off.
-
-| urlDecodeHeaders | false | boolean | If this option is enabled then during binding from Netty to Camel Message then the header values will be URL decoded (eg 20 will be a space character. Notice this option is used by the default org.apache.camel.component.netty.http.NettyHttpBinding and therefore if you implement a custom org.apache.camel.component.netty4.http.NettyHttpBinding then you would need to decode the headers accordingly to this option.
-
-| usingExecutorService | true | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel.
- 4+^s| producer
-| connectTimeout | 10000 | int | Time to wait for a socket connection to be available. Value is in millis.
-
-| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session
-
-| requestTimeout | | long | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout.
-
-| reuseChannel | false | boolean | This option allows producers to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useable if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key link NettyConstantsNETTY_CHANNEL which allows you to obtain the channel during routing and use it as well.
-
-| throwExceptionOnFailure | true | boolean | 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.
- 4+^s| producer (advanced)
-| clientInitializerFactory | | ClientInitializerFactory | To use a custom ClientInitializerFactory
-
-| lazyChannelCreation | true | boolean | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started.
-
-| okStatusCodeRange | 200-299 | String | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. The default range is 200-299
-
-| producerPoolEnabled | true | boolean | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply.
-
-| producerPoolMaxActive | -1 | int | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit.
-
-| producerPoolMaxIdle | 100 | int | Sets the cap on the number of idle instances in the pool.
-
-| producerPoolMinEvictableIdle | 300000 | long | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor.
-
-| producerPoolMinIdle | | int | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects.
-
-| useRelativePath | false | boolean | Sets whether to use a relative path in HTTP requests.
- 4+^s| advanced
-| allowSerializedHeaders | false | boolean | Only used for TCP when transferExchange is true. When set to true serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level.
-
-| bootstrapConfiguration | | NettyServerBootstrapConfiguration | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint.
-
-| channelGroup | | ChannelGroup | To use a explicit ChannelGroup.
-
-| configuration | | NettyHttpConfiguration | To use a custom configured NettyHttpConfiguration for configuring this endpoint.
-
-| disableStreamCache | false | boolean | Determines whether or not the raw input stream from Netty HttpRequestgetContent() or HttpResponsetgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty 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. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Netty raw stream. Also Netty will auto-close the Netty stream when the Netty HTTP server/HTTP client is done processing which means that if the asynchronous routing engine is in use then any asynchronous thread that may continue routing the org.apache.camel.Exchange may n
ot be able to read the Netty stream because Netty has closed it.
-
-| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.
-
-| nativeTransport | false | boolean | Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html
-
-| nettyHttpBinding | | NettyHttpBinding | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API.
-
-| options | | Map | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used.
-
-| receiveBufferSize | 65536 | int | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes.
-
-| receiveBufferSizePredictor | | int | Configures the buffer size predictor. See details at Jetty documentation and this mail thread.
-
-| sendBufferSize | 65536 | int | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| transferException | false | boolean | 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.
-
-| transferExchange | false | boolean | Only used for TCP. You can transfer the exchange over the wire instead of just the body. 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.
-
-| workerCount | | int | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty
-
-| workerGroup | | EventLoopGroup | To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads.
- 4+^s| codec
-| decoder | | ChannelHandler | To use a single decoder. This options is deprecated use encoders instead.
-
-| decoders | | String | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup.
-
-| encoder | | ChannelHandler | To use a single encoder. This options is deprecated use encoders instead.
-
-| encoders | | String | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup.
- 4+^s| security
-| enabledProtocols | TLSv1,TLSv1.1,TLSv1.2 | String | Which protocols to enable when using SSL
-
-| keyStoreFile | | File | Client side certificate keystore to be used for encryption
-
-| keyStoreFormat | | String | Keystore format to be used for payload encryption. Defaults to JKS if not set
-
-| keyStoreResource | | String | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems.
-
-| needClientAuth | false | boolean | Configures whether the server needs client authentication when using SSL.
-
-| passphrase | | String | Password setting to use in order to encrypt/decrypt payloads sent using SSH
-
-| securityConfiguration | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources.
-
-| securityOptions | | Map | To configure NettyHttpSecurityConfiguration using key/value pairs from the map
-
-| securityProvider | | String | Security provider to be used for payload encryption. Defaults to SunX509 if not set.
-
-| ssl | false | boolean | Setting to specify whether SSL encryption is applied to this endpoint
-
-| sslClientCertHeaders | false | boolean | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range.
-
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
-
-| sslHandler | | SslHandler | Reference to a class that could be used to return an SSL Handler
-
-| trustStoreFile | | File | Server side certificate keystore to be used for encryption
-
-| trustStoreResource | | String | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems.
+| Name | Description | Default | Type
+| **bridgeEndpoint** (common) | If the option is true the producer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange). | false | boolean
+| **disconnect** (common) | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | false | boolean
+| **keepAlive** (common) | Setting to ensure socket is not closed due to inactivity | true | boolean
+| **reuseAddress** (common) | Setting to facilitate socket multiplexing | true | boolean
+| **sync** (common) | Setting to set endpoint as one-way or request-response | true | boolean
+| **tcpNoDelay** (common) | Setting to improve TCP protocol performance | true | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **matchOnUriPrefix** (consumer) | Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. | false | boolean
+| **send503whenSuspended** (consumer) | Whether to send back HTTP status code 503 when the consumer has been suspended. If the option is false then the Netty Acceptor is unbound when the consumer is suspended so clients cannot connect anymore. | true | boolean
+| **backlog** (consumer) | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting. | | int
+| **bossCount** (consumer) | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty | 1 | int
+| **bossGroup** (consumer) | Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint | | EventLoopGroup
+| **chunkedMaxContentLength** (consumer) | Value in bytes the max content length per chunked frame received on the Netty HTTP server. | 1048576 | int
+| **compression** (consumer) | Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers. | false | boolean
+| **disconnectOnNoReply** (consumer) | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **httpMethodRestrict** (consumer) | To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma. | | String
+| **mapHeaders** (consumer) | If this option is enabled then during binding from Netty to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.netty.http.NettyHttpMessage message with the method getHttpRequest() that returns the Netty HTTP request io.netty.handler.codec.http.HttpRequest instance. | true | boolean
+| **maxHeaderSize** (consumer) | The maximum length of all headers. If the sum of the length of each header exceeds this value a io.netty.handler.codec.TooLongFrameException will be raised. | 8192 | int
+| **nettyServerBootstrapFactory** (consumer) | To use a custom NettyServerBootstrapFactory | | NettyServerBootstrap Factory
+| **nettySharedHttpServer** (consumer) | To use a shared Netty HTTP server. See Netty HTTP Server Example for more details. | | NettySharedHttpServer
+| **noReplyLogLevel** (consumer) | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. | WARN | LoggingLevel
+| **serverClosedChannel ExceptionCaughtLogLevel** (consumer) | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. | DEBUG | LoggingLevel
+| **serverExceptionCaughtLog Level** (consumer) | If the server (NettyConsumer) catches an exception then its logged using this logging level. | WARN | LoggingLevel
+| **serverInitializerFactory** (consumer) | To use a custom ServerInitializerFactory | | ServerInitializer Factory
+| **traceEnabled** (consumer) | Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off. | false | boolean
+| **urlDecodeHeaders** (consumer) | If this option is enabled then during binding from Netty to Camel Message then the header values will be URL decoded (eg 20 will be a space character. Notice this option is used by the default org.apache.camel.component.netty.http.NettyHttpBinding and therefore if you implement a custom org.apache.camel.component.netty4.http.NettyHttpBinding then you would need to decode the headers accordingly to this option. | false | boolean
+| **usingExecutorService** (consumer) | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. | true | boolean
+| **connectTimeout** (producer) | Time to wait for a socket connection to be available. Value is in millis. | 10000 | int
+| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler
+| **requestTimeout** (producer) | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. | | long
+| **reuseChannel** (producer) | This option allows producers to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useable if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key link NettyConstantsNETTY_CHANNEL which allows you to obtain the channel during routing and use it as well. | false | boolean
+| **throwExceptionOnFailure** (producer) | 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. | true | boolean
+| **clientInitializerFactory** (producer) | To use a custom ClientInitializerFactory | | ClientInitializer Factory
+| **lazyChannelCreation** (producer) | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. | true | boolean
+| **okStatusCodeRange** (producer) | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. The default range is 200-299 | 200-299 | String
+| **producerPoolEnabled** (producer) | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply. | true | boolean
+| **producerPoolMaxActive** (producer) | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit. | -1 | int
+| **producerPoolMaxIdle** (producer) | Sets the cap on the number of idle instances in the pool. | 100 | int
+| **producerPoolMinEvictable Idle** (producer) | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. | 300000 | long
+| **producerPoolMinIdle** (producer) | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. | | int
+| **useRelativePath** (producer) | Sets whether to use a relative path in HTTP requests. | false | boolean
+| **allowSerializedHeaders** (advanced) | Only used for TCP when transferExchange is true. When set to true serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level. | false | boolean
+| **bootstrapConfiguration** (advanced) | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. | | NettyServerBootstrap Configuration
+| **channelGroup** (advanced) | To use a explicit ChannelGroup. | | ChannelGroup
+| **configuration** (advanced) | To use a custom configured NettyHttpConfiguration for configuring this endpoint. | | NettyHttpConfiguration
+| **disableStreamCache** (advanced) | Determines whether or not the raw input stream from Netty HttpRequestgetContent() or HttpResponsetgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty 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. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Netty raw stream. Also Netty will auto-close the Netty stream when the Netty HTTP server/HTTP client is done processing which means that if the asynchronous routing engine is in use then any asynchronous thread that may continue routing the org.apache.camel.Exchange may not
be able to read the Netty stream because Netty has closed it. | false | boolean
+| **headerFilterStrategy** (advanced) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. | | HeaderFilterStrategy
+| **nativeTransport** (advanced) | Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html | false | boolean
+| **nettyHttpBinding** (advanced) | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API. | | NettyHttpBinding
+| **options** (advanced) | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. | | Map
+| **receiveBufferSize** (advanced) | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. | 65536 | int
+| **receiveBufferSizePredictor** (advanced) | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. | | int
+| **sendBufferSize** (advanced) | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. | 65536 | int
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **transferException** (advanced) | 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. | false | boolean
+| **transferExchange** (advanced) | Only used for TCP. You can transfer the exchange over the wire instead of just the body. 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. | false | boolean
+| **workerCount** (advanced) | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty | | int
+| **workerGroup** (advanced) | To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads. | | EventLoopGroup
+| **decoder** (codec) | To use a single decoder. This options is deprecated use encoders instead. | | ChannelHandler
+| **decoders** (codec) | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. | | String
+| **encoder** (codec) | To use a single encoder. This options is deprecated use encoders instead. | | ChannelHandler
+| **encoders** (codec) | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. | | String
+| **enabledProtocols** (security) | Which protocols to enable when using SSL | TLSv1,TLSv1.1,TLSv1.2 | String
+| **keyStoreFile** (security) | Client side certificate keystore to be used for encryption | | File
+| **keyStoreFormat** (security) | Keystore format to be used for payload encryption. Defaults to JKS if not set | | String
+| **keyStoreResource** (security) | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. | | String
+| **needClientAuth** (security) | Configures whether the server needs client authentication when using SSL. | false | boolean
+| **passphrase** (security) | Password setting to use in order to encrypt/decrypt payloads sent using SSH | | String
+| **securityConfiguration** (security) | Refers to a org.apache.camel.component.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. | | NettyHttpSecurity Configuration
+| **securityOptions** (security) | To configure NettyHttpSecurityConfiguration using key/value pairs from the map | | Map
+| **securityProvider** (security) | Security provider to be used for payload encryption. Defaults to SunX509 if not set. | | String
+| **ssl** (security) | Setting to specify whether SSL encryption is applied to this endpoint | false | boolean
+| **sslClientCertHeaders** (security) | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range. | false | boolean
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
+| **sslHandler** (security) | Reference to a class that could be used to return an SSL Handler | | SslHandler
+| **trustStoreFile** (security) | Server side certificate keystore to be used for encryption | | File
+| **trustStoreResource** (security) | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-netty4/src/main/docs/netty4-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-netty4/src/main/docs/netty4-component.adoc b/components/camel-netty4/src/main/docs/netty4-component.adoc
index 10593de..3bbb49c 100644
--- a/components/camel-netty4/src/main/docs/netty4-component.adoc
+++ b/components/camel-netty4/src/main/docs/netty4-component.adoc
@@ -57,17 +57,13 @@ The Netty4 component supports 4 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| maximumPoolSize | 16 | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16.
-
-| configuration | | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints.
-
-| executorService | | EventExecutorGroup | To use the given EventExecutorGroup
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **maximumPoolSize** (advanced) | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. | 16 | int
+| **configuration** (advanced) | To use the NettyConfiguration as configuration when creating endpoints. | | NettyConfiguration
+| **executorService** (advanced) | To use the given EventExecutorGroup | | EventExecutorGroup
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -90,161 +86,90 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| protocol | | String | *Required* The protocol to use which can be tcp or udp.
-| host | | String | *Required* The hostname. For the consumer the hostname is localhost or 0.0.0.0 For the producer the hostname is the remote host to connect to
-| port | | int | *Required* The host port number
+| Name | Description | Default | Type
+| **protocol** | *Required* The protocol to use which can be tcp or udp. | | String
+| **host** | *Required* The hostname. For the consumer the hostname is localhost or 0.0.0.0 For the producer the hostname is the remote host to connect to | | String
+| **port** | *Required* The host port number | | int
|=======================================================================
#### Query Parameters (71 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| disconnect | false | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer.
-
-| keepAlive | true | boolean | Setting to ensure socket is not closed due to inactivity
-
-| reuseAddress | true | boolean | Setting to facilitate socket multiplexing
-
-| sync | true | boolean | Setting to set endpoint as one-way or request-response
-
-| tcpNoDelay | true | boolean | Setting to improve TCP protocol performance
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| broadcast | false | boolean | Setting to choose Multicast over UDP
-
-| clientMode | false | boolean | If the clientMode is true netty consumer will connect the address as a TCP client.
-
-| reconnect | true | boolean | Used only in clientMode in consumer the consumer will attempt to reconnect on disconnection if this is enabled
-
-| reconnectInterval | 10000 | int | Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection
- 4+^s| consumer (advanced)
-| backlog | | int | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting.
-
-| bossCount | 1 | int | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty
-
-| bossGroup | | EventLoopGroup | Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint
-
-| disconnectOnNoReply | true | boolean | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| nettyServerBootstrapFactory | | NettyServerBootstrapFactory | To use a custom NettyServerBootstrapFactory
-
-| networkInterface | | String | When using UDP then this option can be used to specify a network interface by its name such as eth0 to join a multicast group.
-
-| noReplyLogLevel | WARN | LoggingLevel | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back.
-
-| serverClosedChannelExceptionCaughtLogLevel | DEBUG | LoggingLevel | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server.
-
-| serverExceptionCaughtLogLevel | WARN | LoggingLevel | If the server (NettyConsumer) catches an exception then its logged using this logging level.
-
-| serverInitializerFactory | | ServerInitializerFactory | To use a custom ServerInitializerFactory
-
-| usingExecutorService | true | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel.
- 4+^s| producer
-| connectTimeout | 10000 | int | Time to wait for a socket connection to be available. Value is in millis.
-
-| requestTimeout | | long | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout.
-
-| reuseChannel | false | boolean | This option allows producers to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useable if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key link NettyConstantsNETTY_CHANNEL which allows you to obtain the channel during routing and use it as well.
- 4+^s| producer (advanced)
-| clientInitializerFactory | | ClientInitializerFactory | To use a custom ClientInitializerFactory
-
-| lazyChannelCreation | true | boolean | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started.
-
-| producerPoolEnabled | true | boolean | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply.
-
-| producerPoolMaxActive | -1 | int | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit.
-
-| producerPoolMaxIdle | 100 | int | Sets the cap on the number of idle instances in the pool.
-
-| producerPoolMinEvictableIdle | 300000 | long | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor.
-
-| producerPoolMinIdle | | int | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects.
-
-| udpConnectionlessSending | false | boolean | This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port.
-
-| useByteBuf | false | boolean | If the useByteBuf is true netty producer will turn the message body into ByteBuf before sending it out.
- 4+^s| advanced
-| allowSerializedHeaders | false | boolean | Only used for TCP when transferExchange is true. When set to true serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level.
-
-| bootstrapConfiguration | | NettyServerBootstrapConfiguration | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint.
-
-| channelGroup | | ChannelGroup | To use a explicit ChannelGroup.
-
-| nativeTransport | false | boolean | Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html
-
-| options | | Map | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used.
-
-| receiveBufferSize | 65536 | int | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes.
-
-| receiveBufferSizePredictor | | int | Configures the buffer size predictor. See details at Jetty documentation and this mail thread.
-
-| sendBufferSize | 65536 | int | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| transferExchange | false | boolean | Only used for TCP. You can transfer the exchange over the wire instead of just the body. 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.
-
-| udpByteArrayCodec | false | boolean | For UDP only. If enabled the using byte array codec instead of Java serialization protocol.
-
-| workerCount | | int | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty
-
-| workerGroup | | EventLoopGroup | To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads.
- 4+^s| codec
-| allowDefaultCodec | true | boolean | The netty component installs a default codec if both encoder/deocder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain.
-
-| autoAppendDelimiter | true | boolean | Whether or not to auto append missing end delimiter when sending using the textline codec.
-
-| decoder | | ChannelHandler | A custom ChannelHandler class that can be used to perform special marshalling of inbound payloads.
-
-| decoderMaxLineLength | 1024 | int | The max line length to use for the textline codec.
-
-| decoders | | String | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup.
-
-| delimiter | LINE | TextLineDelimiter | The delimiter to use for the textline codec. Possible values are LINE and NULL.
-
-| encoder | | ChannelHandler | A custom ChannelHandler class that can be used to perform special marshalling of outbound payloads.
-
-| encoders | | String | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup.
-
-| encoding | | String | The encoding (a charset name) to use for the textline codec. If not provided Camel will use the JVM default Charset.
-
-| textline | false | boolean | Only used for TCP. If no codec is specified you can use this flag to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP.
- 4+^s| security
-| enabledProtocols | TLSv1,TLSv1.1,TLSv1.2 | String | Which protocols to enable when using SSL
-
-| keyStoreFile | | File | Client side certificate keystore to be used for encryption
-
-| keyStoreFormat | | String | Keystore format to be used for payload encryption. Defaults to JKS if not set
-
-| keyStoreResource | | String | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems.
-
-| needClientAuth | false | boolean | Configures whether the server needs client authentication when using SSL.
-
-| passphrase | | String | Password setting to use in order to encrypt/decrypt payloads sent using SSH
-
-| securityProvider | | String | Security provider to be used for payload encryption. Defaults to SunX509 if not set.
-
-| ssl | false | boolean | Setting to specify whether SSL encryption is applied to this endpoint
-
-| sslClientCertHeaders | false | boolean | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range.
-
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
-
-| sslHandler | | SslHandler | Reference to a class that could be used to return an SSL Handler
-
-| trustStoreFile | | File | Server side certificate keystore to be used for encryption
-
-| trustStoreResource | | String | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems.
+| Name | Description | Default | Type
+| **disconnect** (common) | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | false | boolean
+| **keepAlive** (common) | Setting to ensure socket is not closed due to inactivity | true | boolean
+| **reuseAddress** (common) | Setting to facilitate socket multiplexing | true | boolean
+| **sync** (common) | Setting to set endpoint as one-way or request-response | true | boolean
+| **tcpNoDelay** (common) | Setting to improve TCP protocol performance | true | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **broadcast** (consumer) | Setting to choose Multicast over UDP | false | boolean
+| **clientMode** (consumer) | If the clientMode is true netty consumer will connect the address as a TCP client. | false | boolean
+| **reconnect** (consumer) | Used only in clientMode in consumer the consumer will attempt to reconnect on disconnection if this is enabled | true | boolean
+| **reconnectInterval** (consumer) | Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection | 10000 | int
+| **backlog** (consumer) | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting. | | int
+| **bossCount** (consumer) | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty | 1 | int
+| **bossGroup** (consumer) | Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint | | EventLoopGroup
+| **disconnectOnNoReply** (consumer) | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. | true | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **nettyServerBootstrapFactory** (consumer) | To use a custom NettyServerBootstrapFactory | | NettyServerBootstrap Factory
+| **networkInterface** (consumer) | When using UDP then this option can be used to specify a network interface by its name such as eth0 to join a multicast group. | | String
+| **noReplyLogLevel** (consumer) | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. | WARN | LoggingLevel
+| **serverClosedChannel ExceptionCaughtLogLevel** (consumer) | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. | DEBUG | LoggingLevel
+| **serverExceptionCaughtLog Level** (consumer) | If the server (NettyConsumer) catches an exception then its logged using this logging level. | WARN | LoggingLevel
+| **serverInitializerFactory** (consumer) | To use a custom ServerInitializerFactory | | ServerInitializer Factory
+| **usingExecutorService** (consumer) | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. | true | boolean
+| **connectTimeout** (producer) | Time to wait for a socket connection to be available. Value is in millis. | 10000 | int
+| **requestTimeout** (producer) | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. | | long
+| **reuseChannel** (producer) | This option allows producers to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useable if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key link NettyConstantsNETTY_CHANNEL which allows you to obtain the channel during routing and use it as well. | false | boolean
+| **clientInitializerFactory** (producer) | To use a custom ClientInitializerFactory | | ClientInitializer Factory
+| **lazyChannelCreation** (producer) | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. | true | boolean
+| **producerPoolEnabled** (producer) | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply. | true | boolean
+| **producerPoolMaxActive** (producer) | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit. | -1 | int
+| **producerPoolMaxIdle** (producer) | Sets the cap on the number of idle instances in the pool. | 100 | int
+| **producerPoolMinEvictable Idle** (producer) | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. | 300000 | long
+| **producerPoolMinIdle** (producer) | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. | | int
+| **udpConnectionlessSending** (producer) | This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port. | false | boolean
+| **useByteBuf** (producer) | If the useByteBuf is true netty producer will turn the message body into ByteBuf before sending it out. | false | boolean
+| **allowSerializedHeaders** (advanced) | Only used for TCP when transferExchange is true. When set to true serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level. | false | boolean
+| **bootstrapConfiguration** (advanced) | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. | | NettyServerBootstrap Configuration
+| **channelGroup** (advanced) | To use a explicit ChannelGroup. | | ChannelGroup
+| **nativeTransport** (advanced) | Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html | false | boolean
+| **options** (advanced) | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. | | Map
+| **receiveBufferSize** (advanced) | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. | 65536 | int
+| **receiveBufferSizePredictor** (advanced) | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. | | int
+| **sendBufferSize** (advanced) | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. | 65536 | int
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **transferExchange** (advanced) | Only used for TCP. You can transfer the exchange over the wire instead of just the body. 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. | false | boolean
+| **udpByteArrayCodec** (advanced) | For UDP only. If enabled the using byte array codec instead of Java serialization protocol. | false | boolean
+| **workerCount** (advanced) | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty | | int
+| **workerGroup** (advanced) | To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads. | | EventLoopGroup
+| **allowDefaultCodec** (codec) | The netty component installs a default codec if both encoder/deocder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. | true | boolean
+| **autoAppendDelimiter** (codec) | Whether or not to auto append missing end delimiter when sending using the textline codec. | true | boolean
+| **decoder** (codec) | A custom ChannelHandler class that can be used to perform special marshalling of inbound payloads. | | ChannelHandler
+| **decoderMaxLineLength** (codec) | The max line length to use for the textline codec. | 1024 | int
+| **decoders** (codec) | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. | | String
+| **delimiter** (codec) | The delimiter to use for the textline codec. Possible values are LINE and NULL. | LINE | TextLineDelimiter
+| **encoder** (codec) | A custom ChannelHandler class that can be used to perform special marshalling of outbound payloads. | | ChannelHandler
+| **encoders** (codec) | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. | | String
+| **encoding** (codec) | The encoding (a charset name) to use for the textline codec. If not provided Camel will use the JVM default Charset. | | String
+| **textline** (codec) | Only used for TCP. If no codec is specified you can use this flag to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP. | false | boolean
+| **enabledProtocols** (security) | Which protocols to enable when using SSL | TLSv1,TLSv1.1,TLSv1.2 | String
+| **keyStoreFile** (security) | Client side certificate keystore to be used for encryption | | File
+| **keyStoreFormat** (security) | Keystore format to be used for payload encryption. Defaults to JKS if not set | | String
+| **keyStoreResource** (security) | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. | | String
+| **needClientAuth** (security) | Configures whether the server needs client authentication when using SSL. | false | boolean
+| **passphrase** (security) | Password setting to use in order to encrypt/decrypt payloads sent using SSH | | String
+| **securityProvider** (security) | Security provider to be used for payload encryption. Defaults to SunX509 if not set. | | String
+| **ssl** (security) | Setting to specify whether SSL encryption is applied to this endpoint | false | boolean
+| **sslClientCertHeaders** (security) | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range. | false | boolean
+| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters
+| **sslHandler** (security) | Reference to a class that could be used to return an SSL Handler | | SslHandler
+| **trustStoreFile** (security) | Server side certificate keystore to be used for encryption | | File
+| **trustStoreResource** (security) | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. | | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc
index 55a0a48..8bb4a14 100644
--- a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc
+++ b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc
@@ -47,13 +47,11 @@ The Olingo2 component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| configuration | | Olingo2Configuration | To use the shared configuration
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **configuration** (common) | To use the shared configuration | | Olingo2Configuration
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -71,46 +69,32 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| apiName | | Olingo2ApiName | *Required* What kind of operation to perform
-| methodName | | String | *Required* What sub operation to use for the selected operation
+| Name | Description | Default | Type
+| **apiName** | *Required* What kind of operation to perform | | Olingo2ApiName
+| **methodName** | *Required* What sub operation to use for the selected operation | | String
|=======================================================================
#### Query Parameters (14 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| connectTimeout | 30000 | int | HTTP connection creation timeout in milliseconds defaults to 30000 (30 seconds)
-
-| contentType | application/json;charset=utf-8 | String | Content-Type header value can be used to specify JSON or XML message format defaults to application/json;charset=utf-8
-
-| httpAsyncClientBuilder | | HttpAsyncClientBuilder | Custom HTTP async client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely
-
-| httpClientBuilder | | HttpClientBuilder | Custom HTTP client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely
-
-| httpHeaders | | Map | Custom HTTP headers to inject into every request this could include OAuth tokens etc.
-
-| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body
-
-| proxy | | HttpHost | HTTP proxy server configuration
-
-| serviceUri | | String | Target OData service base URI e.g. http://services.odata.org/OData/OData.svc
-
-| socketTimeout | 30000 | int | HTTP request timeout in milliseconds defaults to 30000 (30 seconds)
-
-| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **connectTimeout** (common) | HTTP connection creation timeout in milliseconds defaults to 30000 (30 seconds) | 30000 | int
+| **contentType** (common) | Content-Type header value can be used to specify JSON or XML message format defaults to application/json;charset=utf-8 | application/json;charset=utf-8 | String
+| **httpAsyncClientBuilder** (common) | Custom HTTP async client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely | | HttpAsyncClientBuilder
+| **httpClientBuilder** (common) | Custom HTTP client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely | | HttpClientBuilder
+| **httpHeaders** (common) | Custom HTTP headers to inject into every request this could include OAuth tokens etc. | | Map
+| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String
+| **proxy** (common) | HTTP proxy server configuration | | HttpHost
+| **serviceUri** (common) | Target OData service base URI e.g. http://services.odata.org/OData/OData.svc | | String
+| **socketTimeout** (common) | HTTP request timeout in milliseconds defaults to 30000 (30 seconds) | 30000 | int
+| **sslContextParameters** (common) | To configure security using SSLContextParameters | | SSLContextParameters
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openshift/src/main/docs/openshift-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-openshift/src/main/docs/openshift-component.adoc b/components/camel-openshift/src/main/docs/openshift-component.adoc
index 384799e..cee927f 100644
--- a/components/camel-openshift/src/main/docs/openshift-component.adoc
+++ b/components/camel-openshift/src/main/docs/openshift-component.adoc
@@ -37,19 +37,14 @@ The OpenShift component supports 5 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| security
-| username | | String | The username to login to openshift server.
-
-| password | | String | The password for login to openshift server.
- 4+^s| common
-| domain | | String | Domain name. If not specified then the default domain is used.
-
-| server | | String | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **username** (security) | The username to login to openshift server. | | String
+| **password** (security) | The password for login to openshift server. | | String
+| **domain** (common) | Domain name. If not specified then the default domain is used. | | String
+| **server** (common) | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used. | | String
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -65,69 +60,43 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| clientId | | String | *Required* The client id
+| Name | Description | Default | Type
+| **clientId** | *Required* The client id | | String
|=======================================================================
#### Query Parameters (26 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| domain | | String | Domain name. If not specified then the default domain is used.
-
-| password | | String | *Required* The password for login to openshift server.
-
-| server | | String | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used.
-
-| username | | String | *Required* The username to login to openshift server.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
- 4+^s| producer
-| application | | String | The application name to start stop restart or get the state.
-
-| mode | | String | Whether to output the message body as a pojo or json. For pojo the message is a List type.
-
-| operation | | String | The operation to perform which can be: list start stop restart and state. The list operation returns information about all the applications in json format. The state operation returns the state such as: started stopped etc. The other operations does not return any value.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
-
-| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+| Name | Description | Default | Type
+| **domain** (common) | Domain name. If not specified then the default domain is used. | | String
+| **password** (common) | *Required* The password for login to openshift server. | | String
+| **server** (common) | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used. | | String
+| **username** (common) | *Required* The username to login to openshift server. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy
+| **application** (producer) | The application name to start stop restart or get the state. | | String
+| **mode** (producer) | Whether to output the message body as a pojo or json. For pojo the message is a List type. | | String
+| **operation** (producer) | The operation to perform which can be: list start stop restart and state. The list operation returns information about all the applications in json format. The state operation returns the state such as: started stopped etc. The other operations does not return any value. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|=======================================================================
// endpoint options: END
[30/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/db81a114
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/db81a114
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/db81a114
Branch: refs/heads/master
Commit: db81a114ec9287b8f09dfecb60a5db443d4337ae
Parents: e43230a
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Mar 17 17:23:52 2017 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Mar 17 17:23:52 2017 +0100
----------------------------------------------------------------------
camel-core/src/main/docs/bean-component.adoc | 25 +-
camel-core/src/main/docs/binding-component.adoc | 24 +-
camel-core/src/main/docs/browse-component.adoc | 22 +-
camel-core/src/main/docs/class-component.adoc | 25 +-
.../src/main/docs/controlbus-component.adoc | 27 +-
.../src/main/docs/dataformat-component.adoc | 15 +-
camel-core/src/main/docs/dataset-component.adoc | 67 +--
camel-core/src/main/docs/direct-component.adoc | 44 +-
.../src/main/docs/direct-vm-component.adoc | 56 +--
camel-core/src/main/docs/file-component.adoc | 250 ++++------
.../src/main/docs/language-component.adoc | 30 +-
camel-core/src/main/docs/log-component.adoc | 95 ++--
camel-core/src/main/docs/mock-component.adoc | 40 +-
.../src/main/docs/properties-component.adoc | 83 ++-
camel-core/src/main/docs/ref-component.adoc | 22 +-
.../src/main/docs/rest-api-component.adoc | 30 +-
camel-core/src/main/docs/rest-component.adoc | 72 +--
.../src/main/docs/scheduler-component.adoc | 80 ++-
camel-core/src/main/docs/seda-component.adoc | 74 +--
camel-core/src/main/docs/stub-component.adoc | 74 +--
camel-core/src/main/docs/test-component.adoc | 52 +-
camel-core/src/main/docs/timer-component.adoc | 46 +-
.../src/main/docs/validator-component.adoc | 53 +-
camel-core/src/main/docs/vm-component.adoc | 74 +--
camel-core/src/main/docs/xslt-component.adoc | 92 ++--
.../src/main/docs/ahc-ws-component.adoc | 89 ++--
.../camel-ahc/src/main/docs/ahc-component.adoc | 74 +--
.../src/main/docs/amqp-component.adoc | 500 +++++++------------
.../src/main/docs/apns-component.adoc | 80 ++-
.../src/main/docs/asterisk-component.adoc | 34 +-
.../src/main/docs/atmos-component.adoc | 48 +-
.../docs/atmosphere-websocket-component.adoc | 149 ++----
.../src/main/docs/atom-component.adoc | 91 ++--
.../src/main/docs/avro-component.adoc | 56 +--
.../src/main/docs/aws-cw-component.adoc | 43 +-
.../src/main/docs/aws-ddb-component.adoc | 49 +-
.../src/main/docs/aws-ddbstream-component.adoc | 79 ++-
.../src/main/docs/aws-ec2-component.adoc | 34 +-
.../src/main/docs/aws-kinesis-component.adoc | 82 ++-
.../docs/aws-kinesis-firehose-component.adoc | 16 +-
.../src/main/docs/aws-s3-component.adoc | 130 ++---
.../src/main/docs/aws-sdb-component.adoc | 40 +-
.../src/main/docs/aws-ses-component.adoc | 43 +-
.../src/main/docs/aws-sns-component.adoc | 43 +-
.../src/main/docs/aws-sqs-component.adoc | 142 ++----
.../src/main/docs/aws-swf-component.adoc | 97 ++--
.../src/main/docs/azure-blob-component.adoc | 67 +--
.../src/main/docs/azure-queue-component.adoc | 40 +-
.../src/main/docs/bean-validator-component.adoc | 28 +-
.../src/main/docs/beanstalk-component.adoc | 98 ++--
.../src/main/docs/bonita-component.adoc | 37 +-
.../src/main/docs/box-component.adoc | 84 ++--
.../src/main/docs/braintree-component.adoc | 61 +--
.../src/main/docs/cache-component.adoc | 83 ++-
.../src/main/docs/cql-component.adoc | 58 +--
.../main/docs/chronicle-engine-component.adoc | 48 +-
.../src/main/docs/chunk-component.adoc | 31 +-
.../src/main/docs/cm-sms-component.adoc | 25 +-
.../src/main/docs/cmis-component.adoc | 59 +--
.../src/main/docs/coap-component.adoc | 25 +-
.../src/main/docs/cometd-component.adoc | 87 ++--
.../src/main/docs/consul-component.adoc | 73 +--
.../src/main/docs/context-component.adoc | 24 +-
.../src/main/docs/couchbase-component.adoc | 156 ++----
.../src/main/docs/couchdb-component.adoc | 52 +-
.../src/main/docs/crypto-component.adoc | 79 ++-
.../camel-cxf/src/main/docs/cxf-component.adoc | 127 ++---
.../src/main/docs/cxfrs-component.adoc | 109 ++--
.../src/main/docs/disruptor-component.adoc | 74 +--
.../camel-dns/src/main/docs/dns-component.adoc | 13 +-
.../src/main/docs/docker-component.adoc | 80 ++-
.../src/main/docs/dozer-component.adoc | 31 +-
.../src/main/docs/drill-component.adoc | 25 +-
.../src/main/docs/dropbox-component.adoc | 48 +-
.../src/main/docs/ehcache-component.adoc | 55 +-
.../camel-ejb/src/main/docs/ejb-component.adoc | 38 +-
.../src/main/docs/elasticsearch-component.adoc | 53 +-
.../src/main/docs/elasticsearch5-component.adoc | 37 +-
.../src/main/docs/elsql-component.adoc | 172 +++----
.../src/main/docs/etcd-component.adoc | 99 ++--
.../src/main/docs/eventadmin-component.adoc | 35 +-
.../src/main/docs/exec-component.adoc | 34 +-
.../src/main/docs/facebook-component.adoc | 326 ++++--------
.../src/main/docs/flatpack-component.adoc | 87 ++--
.../src/main/docs/flink-component.adoc | 47 +-
.../camel-fop/src/main/docs/fop-component.adoc | 19 +-
.../src/main/docs/freemarker-component.adoc | 35 +-
.../camel-ftp/src/main/docs/ftp-component.adoc | 320 ++++--------
.../camel-ftp/src/main/docs/ftps-component.adoc | 344 +++++--------
.../camel-ftp/src/main/docs/sftp-component.adoc | 341 +++++--------
.../src/main/docs/ganglia-component.adoc | 61 +--
.../src/main/docs/geocoder-component.adoc | 54 +-
.../camel-git/src/main/docs/git-component.adoc | 49 +-
.../src/main/docs/github-component.adoc | 48 +-
.../main/docs/google-calendar-component.adoc | 67 +--
.../src/main/docs/google-drive-component.adoc | 61 +--
.../src/main/docs/google-mail-component.adoc | 58 +--
.../src/main/docs/google-pubsub-component.adoc | 49 +-
.../src/main/docs/gora-component.adoc | 73 +--
.../src/main/docs/grape-component.adoc | 16 +-
.../src/main/docs/guava-eventbus-component.adoc | 41 +-
.../src/main/docs/hazelcast-component.adoc | 61 +--
.../src/main/docs/hbase-component.adoc | 71 +--
.../src/main/docs/hdfs-component.adoc | 138 ++---
.../src/main/docs/hdfs2-component.adoc | 138 ++---
.../src/main/docs/hipchat-component.adoc | 77 ++-
.../src/main/docs/http-component.adoc | 149 ++----
.../src/main/docs/http4-component.adoc | 200 +++-----
.../src/main/docs/ibatis-component.adoc | 107 ++--
.../src/main/docs/infinispan-component.adoc | 52 +-
.../src/main/docs/influxdb-component.adoc | 28 +-
.../camel-irc/src/main/docs/irc-component.adoc | 84 ++--
.../src/main/docs/ironmq-component.adoc | 100 ++--
.../src/main/docs/javaspace-component.adoc | 40 +-
.../src/main/docs/jbpm-component.adoc | 85 ++--
.../src/main/docs/jcache-component.adoc | 95 ++--
.../src/main/docs/jclouds-component.adoc | 70 +--
.../camel-jcr/src/main/docs/jcr-component.adoc | 54 +-
.../src/main/docs/jdbc-component.adoc | 59 +--
.../src/main/docs/jetty-component.adoc | 275 ++++------
.../src/main/docs/jgroups-component.adoc | 44 +-
.../src/main/docs/jing-component.adoc | 16 +-
.../src/main/docs/jira-component.adoc | 37 +-
.../camel-jmx/src/main/docs/jmx-component.adoc | 97 ++--
.../src/main/docs/jolt-component.adoc | 35 +-
.../camel-jpa/src/main/docs/jpa-component.adoc | 155 ++----
.../camel-jsch/src/main/docs/scp-component.adoc | 81 ++-
.../src/main/docs/jt400-component.adoc | 115 ++---
.../src/main/docs/kafka-component.adoc | 272 ++++------
.../src/main/docs/kestrel-component.adoc | 40 +-
.../src/main/docs/krati-component.adoc | 97 ++--
.../src/main/docs/kubernetes-component.adoc | 91 ++--
.../src/main/docs/ldap-component.adoc | 25 +-
.../src/main/docs/linkedin-component.adoc | 66 +--
.../src/main/docs/lucene-component.adoc | 37 +-
.../src/main/docs/lumberjack-component.adoc | 37 +-
.../src/main/docs/mail-component.adoc | 208 +++-----
.../src/main/docs/metrics-component.adoc | 43 +-
.../src/main/docs/mina-component.adoc | 87 ++--
.../src/main/docs/mina2-component.adoc | 102 ++--
.../src/main/docs/mllp-component.adoc | 78 ++-
.../src/main/docs/mongodb-gridfs-component.adoc | 61 +--
.../src/main/docs/mongodb-component.adoc | 79 ++-
.../src/main/docs/mongodb3-component.adoc | 67 +--
.../src/main/docs/mqtt-component.adoc | 143 ++----
.../camel-msv/src/main/docs/msv-component.adoc | 56 +--
.../src/main/docs/mustache-component.adoc | 35 +-
.../src/main/docs/mvel-component.adoc | 19 +-
.../src/main/docs/mybatis-component.adoc | 110 ++--
.../src/main/docs/nagios-component.adoc | 40 +-
.../src/main/docs/nats-component.adoc | 76 +--
.../src/main/docs/netty-http-component.adoc | 272 ++++------
.../src/main/docs/netty-component.adoc | 228 +++------
.../src/main/docs/netty4-http-component.adoc | 278 ++++-------
.../src/main/docs/netty4-component.adoc | 243 ++++-----
.../src/main/docs/olingo2-component.adoc | 64 +--
.../src/main/docs/openshift-component.adoc | 107 ++--
.../main/docs/openstack-cinder-component.adoc | 37 +-
.../main/docs/openstack-glance-component.adoc | 34 +-
.../main/docs/openstack-keystone-component.adoc | 34 +-
.../main/docs/openstack-neutron-component.adoc | 37 +-
.../src/main/docs/openstack-nova-component.adoc | 37 +-
.../main/docs/openstack-swift-component.adoc | 37 +-
.../src/main/docs/optaplanner-component.adoc | 31 +-
.../src/main/docs/paho-component.adoc | 59 +--
.../src/main/docs/paxlogging-component.adoc | 32 +-
.../camel-pdf/src/main/docs/pdf-component.adoc | 37 +-
.../src/main/docs/pgevent-component.adoc | 37 +-
.../src/main/docs/lpr-component.adoc | 47 +-
.../src/main/docs/quartz-component.adoc | 79 ++-
.../src/main/docs/quartz2-component.adoc | 106 ++--
.../src/main/docs/quickfix-component.adoc | 50 +-
.../src/main/docs/rabbitmq-component.adoc | 185 +++----
.../main/docs/reactive-streams-component.adoc | 53 +-
.../src/main/docs/rest-swagger-component.adoc | 55 +-
.../src/main/docs/restlet-component.adoc | 137 ++---
.../camel-rmi/src/main/docs/rmi-component.adoc | 32 +-
.../src/main/docs/routebox-component.adoc | 61 +--
.../camel-rss/src/main/docs/rss-component.adoc | 91 ++--
.../src/main/docs/salesforce-component.adoc | 214 +++-----
.../src/main/docs/sap-netweaver-component.adoc | 28 +-
.../src/main/docs/xquery-component.adoc | 119 ++---
.../src/main/docs/schematron-component.adoc | 22 +-
.../src/main/docs/servicenow-component.adoc | 158 ++----
.../src/main/docs/servlet-component.adoc | 101 ++--
.../camel-sip/src/main/docs/sip-component.adoc | 142 ++----
.../src/main/docs/sjms-batch-component.adoc | 95 ++--
.../src/main/docs/sjms-component.adoc | 163 +++---
.../src/main/docs/sjms2-component.adoc | 172 +++----
.../src/main/docs/slack-component.adoc | 35 +-
.../src/main/docs/smpp-component.adoc | 136 ++---
.../src/main/docs/snmp-component.adoc | 114 ++---
.../src/main/docs/solr-component.adoc | 49 +-
.../src/main/docs/spark-rest-component.adoc | 85 ++--
.../src/main/docs/spark-component.adoc | 41 +-
.../src/main/docs/splunk-component.adoc | 146 ++----
.../src/main/docs/spring-batch-component.adoc | 35 +-
.../main/docs/spring-integration-component.adoc | 31 +-
.../src/main/docs/spring-ldap-component.adoc | 19 +-
.../src/main/docs/spring-redis-component.adoc | 42 +-
.../src/main/docs/spring-ws-component.adoc | 80 ++-
.../src/main/docs/spring-event-component.adoc | 35 +-
.../camel-sql/src/main/docs/sql-component.adoc | 158 ++----
.../src/main/docs/sql-stored-component.adoc | 38 +-
.../camel-ssh/src/main/docs/ssh-component.adoc | 130 ++---
.../src/main/docs/stax-component.adoc | 13 +-
.../src/main/docs/stomp-component.adoc | 59 +--
.../src/main/docs/stream-component.adoc | 64 +--
.../main/docs/string-template-component.adoc | 22 +-
.../src/main/docs/telegram-component.adoc | 88 ++--
.../src/main/docs/tika-component.adoc | 25 +-
.../src/main/docs/twitter-component.adoc | 167 +++----
.../src/main/docs/undertow-component.adoc | 74 +--
.../src/main/docs/velocity-component.adoc | 35 +-
.../src/main/docs/vertx-component.adoc | 50 +-
.../src/main/docs/weather-component.adoc | 139 ++----
.../src/main/docs/websocket-component.adoc | 111 ++--
.../src/main/docs/xmlrpc-component.adoc | 64 +--
.../src/main/docs/xmlsecurity-component.adoc | 130 ++---
.../src/main/docs/xmpp-component.adoc | 68 +--
.../src/main/docs/yammer-component.adoc | 113 ++---
.../main/docs/zookeeper-master-component.adoc | 49 +-
.../src/main/docs/zookeeper-component.adoc | 58 +--
.../springboot/AMQPComponentConfiguration.java | 13 -
.../EventComponentAutoConfiguration.java | 34 +-
225 files changed, 6578 insertions(+), 11750 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/bean-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/bean-component.adoc b/camel-core/src/main/docs/bean-component.adoc
index 4730c4f..d634d11 100644
--- a/camel-core/src/main/docs/bean-component.adoc
+++ b/camel-core/src/main/docs/bean-component.adoc
@@ -32,27 +32,22 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| beanName | | String | *Required* Sets the name of the bean to invoke
+| Name | Description | Default | Type
+| **beanName** | *Required* Sets the name of the bean to invoke | | String
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| method | | String | Sets the name of the method to invoke on the bean
- 4+^s| advanced
-| cache | false | boolean | 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.
-
-| multiParameterArray | false | boolean | How to treat the parameters which are passed from the message body; if it is true the message body should be an array of parameters. Note: This option is used internally by Camel and is not intended for end users to use.
-
-| parameters | | Map | Used for configuring additional properties on the bean
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **method** (producer) | Sets the name of the method to invoke on the bean | | String
+| **cache** (advanced) | 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. | false | boolean
+| **multiParameterArray** (advanced) | How to treat the parameters which are passed from the message body; if it is true the message body should be an array of parameters. Note: This option is used internally by Camel and is not intended for end users to use. | false | boolean
+| **parameters** (advanced) | Used for configuring additional properties on the bean | | Map
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/binding-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/binding-component.adoc b/camel-core/src/main/docs/binding-component.adoc
index 5517f23..02ea78f 100644
--- a/camel-core/src/main/docs/binding-component.adoc
+++ b/camel-core/src/main/docs/binding-component.adoc
@@ -34,26 +34,22 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| bindingName | | String | *Required* Name of the binding to lookup in the Camel registry.
-| delegateUri | | String | *Required* Uri of the delegate endpoint.
+| Name | Description | Default | Type
+| **bindingName** | *Required* Name of the binding to lookup in the Camel registry. | | String
+| **delegateUri** | *Required* Uri of the delegate endpoint. | | String
|=======================================================================
#### Query Parameters (4 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/browse-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/browse-component.adoc b/camel-core/src/main/docs/browse-component.adoc
index 5d55090..6ab242e 100644
--- a/camel-core/src/main/docs/browse-component.adoc
+++ b/camel-core/src/main/docs/browse-component.adoc
@@ -35,25 +35,21 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* A name which can be any string to uniquely identify the endpoint
+| Name | Description | Default | Type
+| **name** | *Required* A name which can be any string to uniquely identify the endpoint | | String
|=======================================================================
#### Query Parameters (4 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/class-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/class-component.adoc b/camel-core/src/main/docs/class-component.adoc
index c071165..9724888 100644
--- a/camel-core/src/main/docs/class-component.adoc
+++ b/camel-core/src/main/docs/class-component.adoc
@@ -35,27 +35,22 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| beanName | | String | *Required* Sets the name of the bean to invoke
+| Name | Description | Default | Type
+| **beanName** | *Required* Sets the name of the bean to invoke | | String
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| method | | String | Sets the name of the method to invoke on the bean
- 4+^s| advanced
-| cache | false | boolean | 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.
-
-| multiParameterArray | false | boolean | How to treat the parameters which are passed from the message body; if it is true the message body should be an array of parameters. Note: This option is used internally by Camel and is not intended for end users to use.
-
-| parameters | | Map | Used for configuring additional properties on the bean
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **method** (producer) | Sets the name of the method to invoke on the bean | | String
+| **cache** (advanced) | 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. | false | boolean
+| **multiParameterArray** (advanced) | How to treat the parameters which are passed from the message body; if it is true the message body should be an array of parameters. Note: This option is used internally by Camel and is not intended for end users to use. | false | boolean
+| **parameters** (advanced) | Used for configuring additional properties on the bean | | Map
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/controlbus-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/controlbus-component.adoc b/camel-core/src/main/docs/controlbus-component.adoc
index 5a760d3..c08e0ea 100644
--- a/camel-core/src/main/docs/controlbus-component.adoc
+++ b/camel-core/src/main/docs/controlbus-component.adoc
@@ -76,28 +76,23 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| command | | String | *Required* Command can be either route or language
-| language | | Language | 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.
+| Name | Description | Default | Type
+| **command** | *Required* Command can be either route or language | | String
+| **language** | 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. | | Language
|=======================================================================
#### Query Parameters (5 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| action | | String | 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.
-
-| async | false | boolean | 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.
-
-| loggingLevel | INFO | LoggingLevel | Logging level used for logging when task is done or if any exceptions occurred during processing the task.
-
-| routeId | | String | To specify a route by its id. The special keyword current indicates the current route.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **action** (producer) | 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. | | String
+| **async** (producer) | 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. | false | boolean
+| **loggingLevel** (producer) | Logging level used for logging when task is done or if any exceptions occurred during processing the task. | INFO | LoggingLevel
+| **routeId** (producer) | To specify a route by its id. The special keyword current indicates the current route. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/dataformat-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/dataformat-component.adoc b/camel-core/src/main/docs/dataformat-component.adoc
index 0d76c60..72c0c2b 100644
--- a/camel-core/src/main/docs/dataformat-component.adoc
+++ b/camel-core/src/main/docs/dataformat-component.adoc
@@ -36,20 +36,19 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* Name of data format
-| operation | | String | *Required* Operation to use either marshal or unmarshal
+| Name | Description | Default | Type
+| **name** | *Required* Name of data format | | String
+| **operation** | *Required* Operation to use either marshal or unmarshal | | String
|=======================================================================
#### Query Parameters (1 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/dataset-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/dataset-component.adoc b/camel-core/src/main/docs/dataset-component.adoc
index d6ea10d..1a9acde 100644
--- a/camel-core/src/main/docs/dataset-component.adoc
+++ b/camel-core/src/main/docs/dataset-component.adoc
@@ -58,55 +58,36 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | DataSet | *Required* Name of DataSet to lookup in the registry
+| Name | Description | Default | Type
+| **name** | *Required* Name of DataSet to lookup in the registry | | DataSet
|=======================================================================
#### Query Parameters (19 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| dataSetIndex | lenient | String | 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
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| initialDelay | 1000 | long | Time period in millis to wait before starting sending messages.
-
-| minRate | 0 | int | Wait until the DataSet contains at least this number of messages
-
-| preloadSize | 0 | long | Sets how many messages should be preloaded (sent) before the route completes its initialization
-
-| produceDelay | 3 | long | Allows a delay to be specified which causes a delay when a message is sent by the consumer (to simulate slow processing)
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
- 4+^s| producer
-| assertPeriod | 0 | long | 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 link 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 link setAssertPeriod(long) method for. By default this period is disabled.
-
-| consumeDelay | 0 | long | Allows a delay to be specified which causes a delay when a message is consumed by the producer (to simulate slow processing)
-
-| expectedCount | -1 | int | 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 link 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 link 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 link setAssertPeriod(long) method for further details.
-
-| reportGroup | | int | A number that is used to turn on throughput logging based on groups of the size.
-
-| resultMinimumWaitTime | 0 | long | Sets the minimum expected amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied
-
-| resultWaitTime | 0 | long | Sets the maximum amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied
-
-| retainFirst | -1 | int | 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 link 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 link getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received.
-
-| retainLast | -1 | int | 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 link 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 link getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received.
-
-| sleepForEmptyTest | 0 | long | Allows a sleep to be specified to wait to check that this endpoint really is empty when link expectedMessageCount(int) is called with zero
- 4+^s| producer (advanced)
-| copyOnExchange | true | boolean | Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **dataSetIndex** (common) | 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 | lenient | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **initialDelay** (consumer) | Time period in millis to wait before starting sending messages. | 1000 | long
+| **minRate** (consumer) | Wait until the DataSet contains at least this number of messages | 0 | int
+| **preloadSize** (consumer) | Sets how many messages should be preloaded (sent) before the route completes its initialization | 0 | long
+| **produceDelay** (consumer) | Allows a delay to be specified which causes a delay when a message is sent by the consumer (to simulate slow processing) | 3 | long
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **assertPeriod** (producer) | 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 link 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 link setAssertPeriod(long) method for. By default this period is disabled. | 0 | long
+| **consumeDelay** (producer) | Allows a delay to be specified which causes a delay when a message is consumed by the producer (to simulate slow processing) | 0 | long
+| **expectedCount** (producer) | 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 link 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 link 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 link setAssertPeriod(long) method for further details. | -1 | int
+| **reportGroup** (producer) | A number that is used to turn on throughput logging based on groups of the size. | | int
+| **resultMinimumWaitTime** (producer) | Sets the minimum expected amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied | 0 | long
+| **resultWaitTime** (producer) | Sets the maximum amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied | 0 | long
+| **retainFirst** (producer) | 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 link 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 link getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received. | -1 | int
+| **retainLast** (producer) | 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 link 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 link getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received. | -1 | int
+| **sleepForEmptyTest** (producer) | Allows a sleep to be specified to wait to check that this endpoint really is empty when link expectedMessageCount(int) is called with zero | 0 | long
+| **copyOnExchange** (producer) | Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/direct-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/direct-component.adoc b/camel-core/src/main/docs/direct-component.adoc
index 5cdc245..c1a6cda 100644
--- a/camel-core/src/main/docs/direct-component.adoc
+++ b/camel-core/src/main/docs/direct-component.adoc
@@ -33,15 +33,12 @@ The Direct component supports 3 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| producer
-| block | false | boolean | 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.
-
-| timeout | 30000 | long | The timeout value to use if block is enabled.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **block** (producer) | 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. | false | boolean
+| **timeout** (producer) | The timeout value to use if block is enabled. | 30000 | long
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -57,31 +54,24 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* Name of direct endpoint
+| Name | Description | Default | Type
+| **name** | *Required* Name of direct endpoint | | String
|=======================================================================
#### Query Parameters (7 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
- 4+^s| producer
-| block | false | boolean | 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.
-
-| failIfNoConsumers | false | boolean | Whether the producer should fail by throwing an exception when sending to a DIRECT endpoint with no active consumers.
-
-| timeout | 30000 | long | The timeout value to use if block is enabled.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **block** (producer) | 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. | false | boolean
+| **failIfNoConsumers** (producer) | Whether the producer should fail by throwing an exception when sending to a DIRECT endpoint with no active consumers. | false | boolean
+| **timeout** (producer) | The timeout value to use if block is enabled. | 30000 | long
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/direct-vm-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/direct-vm-component.adoc b/camel-core/src/main/docs/direct-vm-component.adoc
index b78d22f..62a5231 100644
--- a/camel-core/src/main/docs/direct-vm-component.adoc
+++ b/camel-core/src/main/docs/direct-vm-component.adoc
@@ -44,19 +44,14 @@ The Direct VM component supports 5 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| producer
-| block | false | boolean | 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.
-
-| timeout | 30000 | long | The timeout value to use if block is enabled.
- 4+^s| common
-| headerFilterStrategy | | HeaderFilterStrategy | Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none.
- 4+^s| advanced
-| propagateProperties | true | boolean | Whether to propagate or not properties from the producer side to the consumer side and vice versa. Default value: true.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **block** (producer) | 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. | false | boolean
+| **timeout** (producer) | The timeout value to use if block is enabled. | 30000 | long
+| **headerFilterStrategy** (common) | Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none. | | HeaderFilterStrategy
+| **propagateProperties** (advanced) | Whether to propagate or not properties from the producer side to the consumer side and vice versa. Default value: true. | true | boolean
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -72,35 +67,26 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* Name of direct-vm endpoint
+| Name | Description | Default | Type
+| **name** | *Required* Name of direct-vm endpoint | | String
|=======================================================================
#### Query Parameters (9 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
- 4+^s| producer
-| block | false | boolean | 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.
-
-| failIfNoConsumers | false | boolean | Whether the producer should fail by throwing an exception when sending to a Direct-VM endpoint with no active consumers.
-
-| timeout | 30000 | long | The timeout value to use if block is enabled.
- 4+^s| producer (advanced)
-| headerFilterStrategy | | HeaderFilterStrategy | Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none.
- 4+^s| advanced
-| propagateProperties | true | boolean | Whether to propagate or not properties from the producer side to the consumer side and vice versa. Default value: true.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **block** (producer) | 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. | false | boolean
+| **failIfNoConsumers** (producer) | Whether the producer should fail by throwing an exception when sending to a Direct-VM endpoint with no active consumers. | false | boolean
+| **timeout** (producer) | The timeout value to use if block is enabled. | 30000 | long
+| **headerFilterStrategy** (producer) | Sets a HeaderFilterStrategy that will only be applied on producer endpoints (on both directions: request and response). Default value: none. | | HeaderFilterStrategy
+| **propagateProperties** (advanced) | Whether to propagate or not properties from the producer side to the consumer side and vice versa. Default value: true. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
[08/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc
index 8d206d5..c680006 100644
--- a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc
+++ b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc
@@ -47,35 +47,26 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* OpenStack host url
+| Name | Description | Default | Type
+| **host** | *Required* OpenStack host url | | String
|=======================================================================
#### Query Parameters (9 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| apiVersion | V3 | String | OpenStack API version
-
-| config | | Config | OpenStack configuration
-
-| domain | default | String | Authentication domain
-
-| operation | | String | The operation to do
-
-| password | | String | *Required* OpenStack password
-
-| project | | String | *Required* The project ID
-
-| subsystem | | String | *Required* OpenStack Cinder subsystem
-
-| username | | String | *Required* OpenStack username
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **apiVersion** (producer) | OpenStack API version | V3 | String
+| **config** (producer) | OpenStack configuration | | Config
+| **domain** (producer) | Authentication domain | default | String
+| **operation** (producer) | The operation to do | | String
+| **password** (producer) | *Required* OpenStack password | | String
+| **project** (producer) | *Required* The project ID | | String
+| **subsystem** (producer) | *Required* OpenStack Cinder subsystem | | String
+| **username** (producer) | *Required* OpenStack username | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openstack/src/main/docs/openstack-glance-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc
index 1607f18..96cf78b 100644
--- a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc
+++ b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc
@@ -47,33 +47,25 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* OpenStack host url
+| Name | Description | Default | Type
+| **host** | *Required* OpenStack host url | | String
|=======================================================================
#### Query Parameters (8 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| apiVersion | V3 | String | OpenStack API version
-
-| config | | Config | OpenStack configuration
-
-| domain | default | String | Authentication domain
-
-| operation | | String | The operation to do
-
-| password | | String | *Required* OpenStack password
-
-| project | | String | *Required* The project ID
-
-| username | | String | *Required* OpenStack username
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **apiVersion** (producer) | OpenStack API version | V3 | String
+| **config** (producer) | OpenStack configuration | | Config
+| **domain** (producer) | Authentication domain | default | String
+| **operation** (producer) | The operation to do | | String
+| **password** (producer) | *Required* OpenStack password | | String
+| **project** (producer) | *Required* The project ID | | String
+| **username** (producer) | *Required* OpenStack username | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc
index 394075b..e9ad266 100644
--- a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc
+++ b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc
@@ -49,33 +49,25 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* OpenStack host url
+| Name | Description | Default | Type
+| **host** | *Required* OpenStack host url | | String
|=======================================================================
#### Query Parameters (8 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| config | | Config | OpenStack configuration
-
-| domain | default | String | Authentication domain
-
-| operation | | String | The operation to do
-
-| password | | String | *Required* OpenStack password
-
-| project | | String | *Required* The project ID
-
-| subsystem | | String | *Required* OpenStack Keystone subsystem
-
-| username | | String | *Required* OpenStack username
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **config** (producer) | OpenStack configuration | | Config
+| **domain** (producer) | Authentication domain | default | String
+| **operation** (producer) | The operation to do | | String
+| **password** (producer) | *Required* OpenStack password | | String
+| **project** (producer) | *Required* The project ID | | String
+| **subsystem** (producer) | *Required* OpenStack Keystone subsystem | | String
+| **username** (producer) | *Required* OpenStack username | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc
index 1e800fb..d5893bf 100644
--- a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc
+++ b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc
@@ -47,35 +47,26 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* OpenStack host url
+| Name | Description | Default | Type
+| **host** | *Required* OpenStack host url | | String
|=======================================================================
#### Query Parameters (9 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| apiVersion | V3 | String | OpenStack API version
-
-| config | | Config | OpenStack configuration
-
-| domain | default | String | Authentication domain
-
-| operation | | String | The operation to do
-
-| password | | String | *Required* OpenStack password
-
-| project | | String | *Required* The project ID
-
-| subsystem | | String | *Required* OpenStack Neutron subsystem
-
-| username | | String | *Required* OpenStack username
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **apiVersion** (producer) | OpenStack API version | V3 | String
+| **config** (producer) | OpenStack configuration | | Config
+| **domain** (producer) | Authentication domain | default | String
+| **operation** (producer) | The operation to do | | String
+| **password** (producer) | *Required* OpenStack password | | String
+| **project** (producer) | *Required* The project ID | | String
+| **subsystem** (producer) | *Required* OpenStack Neutron subsystem | | String
+| **username** (producer) | *Required* OpenStack username | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openstack/src/main/docs/openstack-nova-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-openstack/src/main/docs/openstack-nova-component.adoc b/components/camel-openstack/src/main/docs/openstack-nova-component.adoc
index d1f26de..4b49103 100644
--- a/components/camel-openstack/src/main/docs/openstack-nova-component.adoc
+++ b/components/camel-openstack/src/main/docs/openstack-nova-component.adoc
@@ -47,35 +47,26 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* OpenStack host url
+| Name | Description | Default | Type
+| **host** | *Required* OpenStack host url | | String
|=======================================================================
#### Query Parameters (9 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| apiVersion | V3 | String | OpenStack API version
-
-| config | | Config | OpenStack configuration
-
-| domain | default | String | Authentication domain
-
-| operation | | String | The operation to do
-
-| password | | String | *Required* OpenStack password
-
-| project | | String | *Required* The project ID
-
-| subsystem | | String | *Required* OpenStack Nova subsystem
-
-| username | | String | *Required* OpenStack username
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **apiVersion** (producer) | OpenStack API version | V3 | String
+| **config** (producer) | OpenStack configuration | | Config
+| **domain** (producer) | Authentication domain | default | String
+| **operation** (producer) | The operation to do | | String
+| **password** (producer) | *Required* OpenStack password | | String
+| **project** (producer) | *Required* The project ID | | String
+| **subsystem** (producer) | *Required* OpenStack Nova subsystem | | String
+| **username** (producer) | *Required* OpenStack username | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openstack/src/main/docs/openstack-swift-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-openstack/src/main/docs/openstack-swift-component.adoc b/components/camel-openstack/src/main/docs/openstack-swift-component.adoc
index 7c28b11..e6091e8 100644
--- a/components/camel-openstack/src/main/docs/openstack-swift-component.adoc
+++ b/components/camel-openstack/src/main/docs/openstack-swift-component.adoc
@@ -47,35 +47,26 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | | String | *Required* OpenStack host url
+| Name | Description | Default | Type
+| **host** | *Required* OpenStack host url | | String
|=======================================================================
#### Query Parameters (9 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| apiVersion | V3 | String | OpenStack API version
-
-| config | | Config | OpenStack configuration
-
-| domain | default | String | Authentication domain
-
-| operation | | String | The operation to do
-
-| password | | String | *Required* OpenStack password
-
-| project | | String | *Required* The project ID
-
-| subsystem | | String | *Required* OpenStack Swift subsystem
-
-| username | | String | *Required* OpenStack username
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **apiVersion** (producer) | OpenStack API version | V3 | String
+| **config** (producer) | OpenStack configuration | | Config
+| **domain** (producer) | Authentication domain | default | String
+| **operation** (producer) | The operation to do | | String
+| **password** (producer) | *Required* OpenStack password | | String
+| **project** (producer) | *Required* The project ID | | String
+| **subsystem** (producer) | *Required* OpenStack Swift subsystem | | String
+| **username** (producer) | *Required* OpenStack username | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc
index bea1a7c..300926a 100644
--- a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc
+++ b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc
@@ -53,31 +53,24 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| configFile | | String | *Required* Specifies the location to the solver file
+| Name | Description | Default | Type
+| **configFile** | *Required* Specifies the location to the solver file | | String
|=======================================================================
#### Query Parameters (7 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| solverId | DEFAULT_SOLVER | String | Specifies the solverId to user for the solver instance key
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| producer
-| async | false | boolean | Specifies to perform operations in async mode
-
-| threadPoolSize | 10 | int | Specifies the thread pool size to use when async is true
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **solverId** (common) | Specifies the solverId to user for the solver instance key | DEFAULT_SOLVER | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **async** (producer) | Specifies to perform operations in async mode | false | boolean
+| **threadPoolSize** (producer) | Specifies the thread pool size to use when async is true | 10 | int
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-paho/src/main/docs/paho-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-paho/src/main/docs/paho-component.adoc b/components/camel-paho/src/main/docs/paho-component.adoc
index d9cd6d2..8c3f578 100644
--- a/components/camel-paho/src/main/docs/paho-component.adoc
+++ b/components/camel-paho/src/main/docs/paho-component.adoc
@@ -121,17 +121,13 @@ The Paho component supports 4 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| brokerUrl | | String | The URL of the MQTT broker.
-
-| clientId | | String | MQTT client identifier.
- 4+^s| advanced
-| connectOptions | | MqttConnectOptions | Client connection options
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **brokerUrl** (common) | The URL of the MQTT broker. | | String
+| **clientId** (common) | MQTT client identifier. | | String
+| **connectOptions** (advanced) | Client connection options | | MqttConnectOptions
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -147,39 +143,28 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| topic | | String | *Required* Name of the topic
+| Name | Description | Default | Type
+| **topic** | *Required* Name of the topic | | String
|=======================================================================
#### Query Parameters (11 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| brokerUrl | tcp://localhost:1883 | String | The URL of the MQTT broker.
-
-| clientId | | String | MQTT client identifier.
-
-| connectOptions | | MqttConnectOptions | Client connection options
-
-| filePersistenceDirectory | | String | Base directory used by the file persistence provider.
-
-| persistence | MEMORY | PahoPersistence | Client persistence to be used - memory or file.
-
-| qos | 2 | int | Client quality of service level (0-2).
-
-| retained | false | boolean | Retain option
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **brokerUrl** (common) | The URL of the MQTT broker. | tcp://localhost:1883 | String
+| **clientId** (common) | MQTT client identifier. | | String
+| **connectOptions** (common) | Client connection options | | MqttConnectOptions
+| **filePersistenceDirectory** (common) | Base directory used by the file persistence provider. | | String
+| **persistence** (common) | Client persistence to be used - memory or file. | MEMORY | PahoPersistence
+| **qos** (common) | Client quality of service level (0-2). | 2 | int
+| **retained** (common) | Retain option | false | boolean
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc b/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc
index 5974329..4dd6cfa 100644
--- a/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc
+++ b/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc
@@ -41,13 +41,11 @@ The OSGi PAX Logging component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| consumer
-| bundleContext | | BundleContext | The OSGi BundleContext is automatic injected by Camel
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **bundleContext** (consumer) | The OSGi BundleContext is automatic injected by Camel | | BundleContext
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -63,25 +61,21 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| appender | | String | *Required* Appender is the name of the pax appender that need to be configured in the PaxLogging service configuration.
+| Name | Description | Default | Type
+| **appender** | *Required* Appender is the name of the pax appender that need to be configured in the PaxLogging service configuration. | | String
|=======================================================================
#### Query Parameters (4 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-pdf/src/main/docs/pdf-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-pdf/src/main/docs/pdf-component.adoc b/components/camel-pdf/src/main/docs/pdf-component.adoc
index f9eb779..452f850 100644
--- a/components/camel-pdf/src/main/docs/pdf-component.adoc
+++ b/components/camel-pdf/src/main/docs/pdf-component.adoc
@@ -48,35 +48,26 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| operation | | PdfOperation | *Required* Operation type
+| Name | Description | Default | Type
+| **operation** | *Required* Operation type | | PdfOperation
|=======================================================================
#### Query Parameters (9 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| font | Helvetica | PDFont | Font
-
-| fontSize | 14 | float | Font size in pixels
-
-| marginBottom | 20 | int | Margin bottom in pixels
-
-| marginLeft | 20 | int | Margin left in pixels
-
-| marginRight | 40 | int | Margin right in pixels
-
-| marginTop | 20 | int | Margin top in pixels
-
-| pageSize | PAGE_SIZE_A4 | PDRectangle | Page size
-
-| textProcessingFactory | lineTermination | TextProcessingFactory | Text processing to use. autoFormatting: Text is getting sliced by words then max amount of words that fits in the line will be written into pdf document. With this strategy all words that doesn't fit in the line will be moved to the new line. lineTermination: Builds set of classes for line-termination writing strategy. Text getting sliced by line termination symbol and then it will be written regardless it fits in the line or not.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **font** (producer) | Font | Helvetica | PDFont
+| **fontSize** (producer) | Font size in pixels | 14 | float
+| **marginBottom** (producer) | Margin bottom in pixels | 20 | int
+| **marginLeft** (producer) | Margin left in pixels | 20 | int
+| **marginRight** (producer) | Margin right in pixels | 40 | int
+| **marginTop** (producer) | Margin top in pixels | 20 | int
+| **pageSize** (producer) | Page size | PAGE_SIZE_A4 | PDRectangle
+| **textProcessingFactory** (producer) | Text processing to use. autoFormatting: Text is getting sliced by words then max amount of words that fits in the line will be written into pdf document. With this strategy all words that doesn't fit in the line will be moved to the new line. lineTermination: Builds set of classes for line-termination writing strategy. Text getting sliced by line termination symbol and then it will be written regardless it fits in the line or not. | lineTermination | TextProcessingFactory
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-pgevent/src/main/docs/pgevent-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-pgevent/src/main/docs/pgevent-component.adoc b/components/camel-pgevent/src/main/docs/pgevent-component.adoc
index 3ee8d3b..9c4e6d2 100644
--- a/components/camel-pgevent/src/main/docs/pgevent-component.adoc
+++ b/components/camel-pgevent/src/main/docs/pgevent-component.adoc
@@ -51,34 +51,27 @@ with the following path and query parameters:
#### Path Parameters (4 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| host | localhost | String | To connect using hostname and port to the database.
-| port | 5432 | Integer | To connect using hostname and port to the database.
-| database | | String | *Required* The database name
-| channel | | String | *Required* The channel name
+| Name | Description | Default | Type
+| **host** | To connect using hostname and port to the database. | localhost | String
+| **port** | To connect using hostname and port to the database. | 5432 | Integer
+| **database** | *Required* The database name | | String
+| **channel** | *Required* The channel name | | String
|=======================================================================
#### Query Parameters (7 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| datasource | | DataSource | To connect using the given javax.sql.DataSource instead of using hostname and port.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| security
-| pass | | String | Password for login
-
-| user | postgres | String | Username for login
+| Name | Description | Default | Type
+| **datasource** (common) | To connect using the given javax.sql.DataSource instead of using hostname and port. | | DataSource
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **pass** (security) | Password for login | | String
+| **user** (security) | Username for login | postgres | String
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-printer/src/main/docs/lpr-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-printer/src/main/docs/lpr-component.adoc b/components/camel-printer/src/main/docs/lpr-component.adoc
index 47e63c3..58987a9 100644
--- a/components/camel-printer/src/main/docs/lpr-component.adoc
+++ b/components/camel-printer/src/main/docs/lpr-component.adoc
@@ -60,41 +60,30 @@ with the following path and query parameters:
#### Path Parameters (3 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| hostname | | String | *Required* Hostname of the printer
-| port | | int | Port number of the printer
-| printername | | String | Name of the printer
+| Name | Description | Default | Type
+| **hostname** | *Required* Hostname of the printer | | String
+| **port** | Port number of the printer | | int
+| **printername** | Name of the printer | | String
|=======================================================================
#### Query Parameters (11 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| copies | 1 | int | Number of copies to print
-
-| docFlavor | | DocFlavor | Sets DocFlavor to use.
-
-| flavor | | String | Sets DocFlavor to use.
-
-| mediaSize | na-letter | String | Sets the stationary as defined by enumeration names in the javax.print.attribute.standard.MediaSizeName API. The default setting is to use North American Letter sized stationary. The value's case is ignored e.g. values of iso_a4 and ISO_A4 may be used.
-
-| mediaTray | | String | Sets MediaTray supported by the javax.print.DocFlavor API for example uppermiddle etc.
-
-| mimeType | | String | Sets mimeTypes supported by the javax.print.DocFlavor API
-
-| orientation | portrait | String | Sets the page orientation.
-
-| printerPrefix | | String | Sets the prefix name of the printer it is useful when the printer name does not start with //hostname/printer
-
-| sendToPrinter | true | boolean | etting this option to false prevents sending of the print data to the printer
-
-| sides | one-sided | String | Sets one sided or two sided printing based on the javax.print.attribute.standard.Sides API
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **copies** (producer) | Number of copies to print | 1 | int
+| **docFlavor** (producer) | Sets DocFlavor to use. | | DocFlavor
+| **flavor** (producer) | Sets DocFlavor to use. | | String
+| **mediaSize** (producer) | Sets the stationary as defined by enumeration names in the javax.print.attribute.standard.MediaSizeName API. The default setting is to use North American Letter sized stationary. The value's case is ignored e.g. values of iso_a4 and ISO_A4 may be used. | na-letter | String
+| **mediaTray** (producer) | Sets MediaTray supported by the javax.print.DocFlavor API for example uppermiddle etc. | | String
+| **mimeType** (producer) | Sets mimeTypes supported by the javax.print.DocFlavor API | | String
+| **orientation** (producer) | Sets the page orientation. | portrait | String
+| **printerPrefix** (producer) | Sets the prefix name of the printer it is useful when the printer name does not start with //hostname/printer | | String
+| **sendToPrinter** (producer) | etting this option to false prevents sending of the print data to the printer | true | boolean
+| **sides** (producer) | Sets one sided or two sided printing based on the javax.print.attribute.standard.Sides API | one-sided | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-quartz/src/main/docs/quartz-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-quartz/src/main/docs/quartz-component.adoc b/components/camel-quartz/src/main/docs/quartz-component.adoc
index 6b93372..30601f3 100644
--- a/components/camel-quartz/src/main/docs/quartz-component.adoc
+++ b/components/camel-quartz/src/main/docs/quartz-component.adoc
@@ -50,25 +50,17 @@ The Quartz component supports 8 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| factory | | SchedulerFactory | To use the custom SchedulerFactory which is used to create the Scheduler.
-
-| scheduler | | Scheduler | To use the custom configured Quartz scheduler instead of creating a new Scheduler.
- 4+^s| consumer
-| properties | | Properties | Properties to configure the Quartz scheduler.
-
-| propertiesFile | | String | File name of the properties to load from the classpath
- 4+^s| scheduler
-| startDelayedSeconds | | int | Seconds to wait before starting the quartz scheduler.
- 4+^s| consumer
-| autoStartScheduler | true | boolean | Whether or not the scheduler should be auto started. This options is default true
-
-| enableJmx | true | boolean | Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **factory** (advanced) | To use the custom SchedulerFactory which is used to create the Scheduler. | | SchedulerFactory
+| **scheduler** (advanced) | To use the custom configured Quartz scheduler instead of creating a new Scheduler. | | Scheduler
+| **properties** (consumer) | Properties to configure the Quartz scheduler. | | Properties
+| **propertiesFile** (consumer) | File name of the properties to load from the classpath | | String
+| **startDelayedSeconds** (scheduler) | Seconds to wait before starting the quartz scheduler. | | int
+| **autoStartScheduler** (consumer) | Whether or not the scheduler should be auto started. This options is default true | true | boolean
+| **enableJmx** (consumer) | Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true | true | boolean
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -84,44 +76,31 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| groupName | Camel | String | The quartz group name to use. The combination of group name and timer name should be unique.
-| timerName | | String | *Required* The quartz timer name to use. The combination of group name and timer name should be unique.
+| Name | Description | Default | Type
+| **groupName** | The quartz group name to use. The combination of group name and timer name should be unique. | Camel | String
+| **timerName** | *Required* The quartz timer name to use. The combination of group name and timer name should be unique. | | String
|=======================================================================
#### Query Parameters (13 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| cron | | String | Specifies a cron expression to define when to trigger.
-
-| deleteJob | true | boolean | If set to true then the trigger automatically delete when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true.
-
-| fireNow | false | boolean | Whether to fire the scheduler asap when its started using the simple trigger (this option does not support cron)
-
-| pauseJob | false | boolean | If set to true then the trigger automatically pauses when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true.
-
-| startDelayedSeconds | | int | Seconds to wait before starting the quartz scheduler.
-
-| stateful | false | boolean | Uses a Quartz StatefulJob instead of the default job.
-
-| usingFixedCamelContextName | false | boolean | If it is true JobDataMap uses the CamelContext name directly to reference the CamelContext if it is false JobDataMap uses use the CamelContext management name which could be changed during the deploy time.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| jobParameters | | Map | To configure additional options on the job.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| triggerParameters | | Map | To configure additional options on the trigger.
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **cron** (consumer) | Specifies a cron expression to define when to trigger. | | String
+| **deleteJob** (consumer) | If set to true then the trigger automatically delete when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. | true | boolean
+| **fireNow** (consumer) | Whether to fire the scheduler asap when its started using the simple trigger (this option does not support cron) | false | boolean
+| **pauseJob** (consumer) | If set to true then the trigger automatically pauses when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. | false | boolean
+| **startDelayedSeconds** (consumer) | Seconds to wait before starting the quartz scheduler. | | int
+| **stateful** (consumer) | Uses a Quartz StatefulJob instead of the default job. | false | boolean
+| **usingFixedCamelContextName** (consumer) | If it is true JobDataMap uses the CamelContext name directly to reference the CamelContext if it is false JobDataMap uses use the CamelContext management name which could be changed during the deploy time. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **jobParameters** (advanced) | To configure additional options on the job. | | Map
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **triggerParameters** (advanced) | To configure additional options on the trigger. | | Map
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-quartz2/src/main/docs/quartz2-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-quartz2/src/main/docs/quartz2-component.adoc b/components/camel-quartz2/src/main/docs/quartz2-component.adoc
index b0080e4..b5fc149 100644
--- a/components/camel-quartz2/src/main/docs/quartz2-component.adoc
+++ b/components/camel-quartz2/src/main/docs/quartz2-component.adoc
@@ -51,31 +51,20 @@ The Quartz2 component supports 11 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| scheduler
-| autoStartScheduler | true | boolean | Whether or not the scheduler should be auto started. This options is default true
-
-| startDelayedSeconds | | int | Seconds to wait before starting the quartz scheduler.
- 4+^s| consumer
-| prefixJobNameWithEndpointId | false | boolean | Whether to prefix the quartz job with the endpoint id. This option is default false.
-
-| enableJmx | true | boolean | Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true
-
-| properties | | Properties | Properties to configure the Quartz scheduler.
-
-| propertiesFile | | String | File name of the properties to load from the classpath
-
-| prefixInstanceName | true | boolean | Whether to prefix the Quartz Scheduler instance name with the CamelContext name. This is enabled by default to let each CamelContext use its own Quartz scheduler instance by default. You can set this option to false to reuse Quartz scheduler instances between multiple CamelContext's.
- 4+^s| scheduler
-| interruptJobsOnShutdown | false | boolean | Whether to interrupt jobs on shutdown which forces the scheduler to shutdown quicker and attempt to interrupt any running jobs. If this is enabled then any running jobs can fail due to being interrupted.
- 4+^s| advanced
-| schedulerFactory | | SchedulerFactory | To use the custom SchedulerFactory which is used to create the Scheduler.
-
-| scheduler | | Scheduler | To use the custom configured Quartz scheduler instead of creating a new Scheduler.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **autoStartScheduler** (scheduler) | Whether or not the scheduler should be auto started. This options is default true | true | boolean
+| **startDelayedSeconds** (scheduler) | Seconds to wait before starting the quartz scheduler. | | int
+| **prefixJobNameWith EndpointId** (consumer) | Whether to prefix the quartz job with the endpoint id. This option is default false. | false | boolean
+| **enableJmx** (consumer) | Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true | true | boolean
+| **properties** (consumer) | Properties to configure the Quartz scheduler. | | Properties
+| **propertiesFile** (consumer) | File name of the properties to load from the classpath | | String
+| **prefixInstanceName** (consumer) | Whether to prefix the Quartz Scheduler instance name with the CamelContext name. This is enabled by default to let each CamelContext use its own Quartz scheduler instance by default. You can set this option to false to reuse Quartz scheduler instances between multiple CamelContext's. | true | boolean
+| **interruptJobsOn Shutdown** (scheduler) | Whether to interrupt jobs on shutdown which forces the scheduler to shutdown quicker and attempt to interrupt any running jobs. If this is enabled then any running jobs can fail due to being interrupted. | false | boolean
+| **schedulerFactory** (advanced) | To use the custom SchedulerFactory which is used to create the Scheduler. | | SchedulerFactory
+| **scheduler** (advanced) | To use the custom configured Quartz scheduler instead of creating a new Scheduler. | | Scheduler
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -91,56 +80,37 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| groupName | Camel | String | The quartz group name to use. The combination of group name and timer name should be unique.
-| triggerName | | String | *Required* The quartz timer name to use. The combination of group name and timer name should be unique.
+| Name | Description | Default | Type
+| **groupName** | The quartz group name to use. The combination of group name and timer name should be unique. | Camel | String
+| **triggerName** | *Required* The quartz timer name to use. The combination of group name and timer name should be unique. | | String
|=======================================================================
#### Query Parameters (19 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| cron | | String | Specifies a cron expression to define when to trigger.
-
-| deleteJob | true | boolean | If set to true then the trigger automatically delete when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true.
-
-| durableJob | false | boolean | Whether or not the job should remain stored after it is orphaned (no triggers point to it).
-
-| pauseJob | false | boolean | If set to true then the trigger automatically pauses when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true.
-
-| recoverableJob | false | boolean | Instructs the scheduler whether or not the job should be re-executed if a 'recovery' or 'fail-over' situation is encountered.
-
-| stateful | false | boolean | Uses a Quartz PersistJobDataAfterExecution and DisallowConcurrentExecution instead of the default job.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| customCalendar | | Calendar | Specifies a custom calendar to avoid specific range of date
-
-| jobParameters | | Map | To configure additional options on the job.
-
-| prefixJobNameWithEndpointId | false | boolean | Whether the job name should be prefixed with endpoint id
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
-
-| triggerParameters | | Map | To configure additional options on the trigger.
-
-| usingFixedCamelContextName | false | boolean | If it is true JobDataMap uses the CamelContext name directly to reference the CamelContext if it is false JobDataMap uses use the CamelContext management name which could be changed during the deploy time.
- 4+^s| scheduler
-| autoStartScheduler | true | boolean | Whether or not the scheduler should be auto started.
-
-| fireNow | false | boolean | If it is true will fire the trigger when the route is start when using SimpleTrigger.
-
-| startDelayedSeconds | | int | Seconds to wait before starting the quartz scheduler.
-
-| triggerStartDelay | 500 | long | In case of scheduler has already started we want the trigger start slightly after current time to ensure endpoint is fully started before the job kicks in.
+| Name | Description | Default | Type
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **cron** (consumer) | Specifies a cron expression to define when to trigger. | | String
+| **deleteJob** (consumer) | If set to true then the trigger automatically delete when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. | true | boolean
+| **durableJob** (consumer) | Whether or not the job should remain stored after it is orphaned (no triggers point to it). | false | boolean
+| **pauseJob** (consumer) | If set to true then the trigger automatically pauses when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. | false | boolean
+| **recoverableJob** (consumer) | Instructs the scheduler whether or not the job should be re-executed if a 'recovery' or 'fail-over' situation is encountered. | false | boolean
+| **stateful** (consumer) | Uses a Quartz PersistJobDataAfterExecution and DisallowConcurrentExecution instead of the default job. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **customCalendar** (advanced) | Specifies a custom calendar to avoid specific range of date | | Calendar
+| **jobParameters** (advanced) | To configure additional options on the job. | | Map
+| **prefixJobNameWithEndpoint Id** (advanced) | Whether the job name should be prefixed with endpoint id | false | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **triggerParameters** (advanced) | To configure additional options on the trigger. | | Map
+| **usingFixedCamelContextName** (advanced) | If it is true JobDataMap uses the CamelContext name directly to reference the CamelContext if it is false JobDataMap uses use the CamelContext management name which could be changed during the deploy time. | false | boolean
+| **autoStartScheduler** (scheduler) | Whether or not the scheduler should be auto started. | true | boolean
+| **fireNow** (scheduler) | If it is true will fire the trigger when the route is start when using SimpleTrigger. | false | boolean
+| **startDelayedSeconds** (scheduler) | Seconds to wait before starting the quartz scheduler. | | int
+| **triggerStartDelay** (scheduler) | In case of scheduler has already started we want the trigger start slightly after current time to ensure endpoint is fully started before the job kicks in. | 500 | long
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-quickfix/src/main/docs/quickfix-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-quickfix/src/main/docs/quickfix-component.adoc b/components/camel-quickfix/src/main/docs/quickfix-component.adoc
index 8bd9308..07bb862 100644
--- a/components/camel-quickfix/src/main/docs/quickfix-component.adoc
+++ b/components/camel-quickfix/src/main/docs/quickfix-component.adoc
@@ -81,21 +81,15 @@ The QuickFix component supports 6 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| messageFactory | | MessageFactory | To use the given MessageFactory
-
-| logFactory | | LogFactory | To use the given LogFactory
-
-| messageStoreFactory | | MessageStoreFactory | To use the given MessageStoreFactory
- 4+^s| common
-| configurations | | Map | To use the given map of pre configured QuickFix configurations mapped to the key
-
-| lazyCreateEngines | false | boolean | If set to true the engines will be created and started when needed (when first message is send)
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **messageFactory** (advanced) | To use the given MessageFactory | | MessageFactory
+| **logFactory** (advanced) | To use the given LogFactory | | LogFactory
+| **messageStoreFactory** (advanced) | To use the given MessageStoreFactory | | MessageStoreFactory
+| **configurations** (common) | To use the given map of pre configured QuickFix configurations mapped to the key | | Map
+| **lazyCreateEngines** (common) | If set to true the engines will be created and started when needed (when first message is send) | false | boolean
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -108,29 +102,23 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| configurationName | | String | *Required* The configFile is the name of the QuickFIX/J configuration to use for the FIX engine (located as a resource found in your classpath).
+| Name | Description | Default | Type
+| **configurationName** | *Required* The configFile is the name of the QuickFIX/J configuration to use for the FIX engine (located as a resource found in your classpath). | | String
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| lazyCreateEngine | false | boolean | This option allows to create QuickFIX/J engine on demand. Value true means the engine is started when first message is send or there's consumer configured in route definition. When false value is used the engine is started at the endpoint creation. When this parameter is missing the value of component's property lazyCreateEngines is being used.
-
-| sessionID | | SessionID | The optional sessionID identifies a specific FIX session. The format of the sessionID is: (BeginString):(SenderCompID)/(SenderSubID)/(SenderLocationID)-(TargetCompID)/(TargetSubID)/(TargetLocationID)
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **lazyCreateEngine** (common) | This option allows to create QuickFIX/J engine on demand. Value true means the engine is started when first message is send or there's consumer configured in route definition. When false value is used the engine is started at the endpoint creation. When this parameter is missing the value of component's property lazyCreateEngines is being used. | false | boolean
+| **sessionID** (common) | The optional sessionID identifies a specific FIX session. The format of the sessionID is: (BeginString):(SenderCompID)/(SenderSubID)/(SenderLocationID)-(TargetCompID)/(TargetSubID)/(TargetLocationID) | | SessionID
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
[29/30] camel git commit: Component docs - Adjust tables yet again.
Almost there in github to make it read all description and default value
without scrolling.
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/file-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/file-component.adoc b/camel-core/src/main/docs/file-component.adoc
index 4e870ad..0416228 100644
--- a/camel-core/src/main/docs/file-component.adoc
+++ b/camel-core/src/main/docs/file-component.adoc
@@ -68,177 +68,97 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| directoryName | | File | *Required* The starting directory
+| Name | Description | Default | Type
+| **directoryName** | *Required* The starting directory | | File
|=======================================================================
#### Query Parameters (80 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| charset | | String | 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.
-
-| doneFileName | | String | 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.
-
-| fileName | | String | 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 s
tore CamelFileName and have to restore it afterwards.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| delete | false | boolean | If true the file will be deleted after it is processed successfully.
-
-| moveFailed | | String | 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.
-
-| noop | false | boolean | 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.
-
-| preMove | | String | 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.
-
-| recursive | false | boolean | If a directory will look for files in all the sub-directories as well.
-
-| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
- 4+^s| consumer (advanced)
-| directoryMustExist | false | boolean | Similar to startingDirectoryMustExist but this applies during polling recursive sub directories.
-
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
-
-| extendedAttributes | | String | To define which file attributes of interest. Like posix:permissionsposix:ownerbasic:lastAccessTime it supports basic wildcard like posix: basic:lastAccessTime
-
-| inProgressRepository | | String> | 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.
-
-| localWorkDirectory | | String | 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.
-
-| onCompletionExceptionHandler | | ExceptionHandler | 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.
-
-| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. In other words the error occurred while the polling was gathering information for instance access to a file network failed so Camel cannot access it to scan for files. The default implementation will log the caused exception at WARN level and ignore it.
-
-| probeContentType | false | boolean | Whether to enable probing of the content type. If enable then the consumer uses link FilesprobeContentType(java.nio.file.Path) to determine the content-type of the file and store that as a header with key link ExchangeFILE_CONTENT_TYPE on the Message.
-
-| processStrategy | | GenericFileProcessStrategy<T> | 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.
-
-| startingDirectoryMustExist | false | boolean | 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.
- 4+^s| producer
-| fileExist | Override | GenericFileExist | 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 Camel 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.
-
-| flatten | false | boolean | 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.
-
-| moveExisting | | String | 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.
-
-| tempFileName | | String | 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.
-
-| tempPrefix | | String | 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.
- 4+^s| producer (advanced)
-| allowNullBody | false | boolean | 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.
-
-| chmod | | String | 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.
-
-| chmodDirectory | | String | 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.
-
-| eagerDeleteTargetFile | true | boolean | 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.
-
-| forceWrites | true | boolean | 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.
-
-| keepLastModified | false | boolean | 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.
- 4+^s| advanced
-| autoCreate | true | boolean | 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.
-
-| bufferSize | 131072 | int | Write buffer sized in bytes.
-
-| copyAndDeleteOnRenameFail | true | boolean | 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.
-
-| renameUsingCopy | false | boolean | 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.
-
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| filter
-| antExclude | | String | 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.
-
-| antFilterCaseSensitive | true | boolean | Sets case sensitive flag on ant fiter
-
-| antInclude | | String | Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format.
-
-| eagerMaxMessagesPerPoll | true | boolean | 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.
-
-| exclude | | String | 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
-
-| filter | | GenericFileFilter<T> | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method.
-
-| filterDirectory | | String | 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
-
-| filterFile | | String | Filters the file based on Simple language. For example to filter on file size you can use $file:size 5000
-
-| idempotent | false | Boolean | 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.
-
-| idempotentKey | | String | 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
-
-| idempotentRepository | | String> | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true.
-
-| include | | String | 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
-
-| maxDepth | 2147483647 | int | The maximum depth to traverse when recursively processing a directory.
-
-| maxMessagesPerPoll | | int | 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.
-
-| minDepth | | int | 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.
-
-| move | | String | 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.
- 4+^s| lock
-| exclusiveReadLockStrategy | | GenericFileExclusiveReadLockStrategy<T> | Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation.
-
-| readLock | | String | 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 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 wher
e 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.
-
-| readLockCheckInterval | 1000 | long | 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.
-
-| readLockDeleteOrphanLockFiles | true | boolean | 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.
-
-| readLockLoggingLevel | WARN | LoggingLevel | Logging level used when a read lock could not be acquired. By default a WARN 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 rename.
-
-| readLockMarkerFile | true | boolean | 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.
-
-| readLockMinAge | 0 | long | This option applied only for readLock=change. This option 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.
-
-| readLockMinLength | 1 | long | This option applied only for readLock=changed. This option 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.
-
-| readLockRemoveOnCommit | false | boolean | This option applied only for readLock=idempotent. This option 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.
-
-| readLockRemoveOnRollback | true | boolean | This option applied only for readLock=idempotent. This option 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).
-
-| readLockTimeout | 10000 | long | 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.
- 4+^s| scheduler
-| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
-
-| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
-
-| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
-
-| delay | 500 | long | Milliseconds before the next poll. The default value is 500. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
-
-| initialDelay | 1000 | long | Milliseconds before the first poll starts. The default value is 1000. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
-
-| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
-
-| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. This option allows you to share a thread pool among multiple consumers.
-
-| scheduler | none | ScheduledPollConsumerScheduler | Allow to plugin a custom org.apache.camel.spi.ScheduledPollConsumerScheduler to use as the scheduler for firing when the polling consumer runs. The default implementation uses the ScheduledExecutorService and there is a Quartz2 and Spring based which supports CRON expressions. Notice: If using a custom scheduler then the options for initialDelay useFixedDelay timeUnit and scheduledExecutorService may not be in use. Use the text quartz2 to refer to use the Quartz2 scheduler; and use the text spring to use the Spring based; and use the text myScheduler to refer to a custom scheduler by its id in the Registry. See Quartz2 page for an example.
-
-| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
-
-| startScheduler | true | boolean | Whether the scheduler should be auto started.
-
-| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
-
-| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
- 4+^s| sort
-| shuffle | false | boolean | To shuffle the list of files (sort in random order)
-
-| sortBy | | String | 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.
-
-| sorter | | GenericFile<T>> | Pluggable sorter as a java.util.Comparator class.
+| Name | Description | Default | Type
+| **charset** (common) | 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. | | String
+| **doneFileName** (common) | 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. | | String
+| **fileName** (common) | 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. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **delete** (consumer) | If true the file will be deleted after it is processed successfully. | false | boolean
+| **moveFailed** (consumer) | 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. | | String
+| **noop** (consumer) | 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. | false | boolean
+| **preMove** (consumer) | 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. | | String
+| **recursive** (consumer) | If a directory will look for files in all the sub-directories as well. | false | boolean
+| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
+| **directoryMustExist** (consumer) | Similar to startingDirectoryMustExist but this applies during polling recursive sub directories. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **extendedAttributes** (consumer) | To define which file attributes of interest. Like posix:permissionsposix:ownerbasic:lastAccessTime it supports basic wildcard like posix: basic:lastAccessTime | | String
+| **inProgressRepository** (consumer) | 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. | | String>
+| **localWorkDirectory** (consumer) | 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. | | String
+| **onCompletionException Handler** (consumer) | 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. | | ExceptionHandler
+| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. In other words the error occurred while the polling was gathering information for instance access to a file network failed so Camel cannot access it to scan for files. The default implementation will log the caused exception at WARN level and ignore it. | | PollingConsumerPoll Strategy
+| **probeContentType** (consumer) | Whether to enable probing of the content type. If enable then the consumer uses link FilesprobeContentType(java.nio.file.Path) to determine the content-type of the file and store that as a header with key link ExchangeFILE_CONTENT_TYPE on the Message. | false | boolean
+| **processStrategy** (consumer) | 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. | | GenericFileProcess Strategy<T>
+| **startingDirectoryMustExist** (consumer) | 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. | false | boolean
+| **fileExist** (producer) | 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 Camel 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. | Override | Ge
nericFileExist
+| **flatten** (producer) | 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. | false | boolean
+| **moveExisting** (producer) | 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. | | String
+| **tempFileName** (producer) | 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. | | String
+| **tempPrefix** (producer) | 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. | | String
+| **allowNullBody** (producer) | 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. | false | boolean
+| **chmod** (producer) | 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. | | String
+| **chmodDirectory** (producer) | 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. | | String
+| **eagerDeleteTargetFile** (producer) | 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. | true | boolean
+| **forceWrites** (producer) | 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. | true | boolean
+| **keepLastModified** (producer) | 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. | false | boolean
+| **autoCreate** (advanced) | 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. | true | boolean
+| **bufferSize** (advanced) | Write buffer sized in bytes. | 131072 | int
+| **copyAndDeleteOnRenameFail** (advanced) | 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. | true | boolean
+| **renameUsingCopy** (advanced) | 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. | false | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **antExclude** (filter) | 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. | | String
+| **antFilterCaseSensitive** (filter) | Sets case sensitive flag on ant fiter | true | boolean
+| **antInclude** (filter) | Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format. | | String
+| **eagerMaxMessagesPerPoll** (filter) | 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. | true | boolean
+| **exclude** (filter) | 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 | | String
+| **filter** (filter) | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. | | GenericFileFilter<T>
+| **filterDirectory** (filter) | 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 | | String
+| **filterFile** (filter) | Filters the file based on Simple language. For example to filter on file size you can use $file:size 5000 | | String
+| **idempotent** (filter) | 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. | false | Boolean
+| **idempotentKey** (filter) | 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 | | String
+| **idempotentRepository** (filter) | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. | | String>
+| **include** (filter) | 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 | | String
+| **maxDepth** (filter) | The maximum depth to traverse when recursively processing a directory. | 2147483647 | int
+| **maxMessagesPerPoll** (filter) | 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. | | int
+| **minDepth** (filter) | 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. | | int
+| **move** (filter) | 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. | | String
+| **exclusiveReadLockStrategy** (lock) | Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation. | | GenericFileExclusive ReadLockStrategy<T>
+| **readLock** (lock) | 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 the FTP component. This approach should be avoided when accessing a r
emote 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. | | String
+| **readLockCheckInterval** (lock) | 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. | 1000 | long
+| **readLockDeleteOrphanLock Files** (lock) | 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. | true | boolean
+| **readLockLoggingLevel** (lock) | Logging level used when a read lock could not be acquired. By default a WARN 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 rename. | WARN | LoggingLevel
+| **readLockMarkerFile** (lock) | 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. | true | boolean
+| **readLockMinAge** (lock) | This option applied only for readLock=change. This option 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. | 0 | long
+| **readLockMinLength** (lock) | This option applied only for readLock=changed. This option 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. | 1 | long
+| **readLockRemoveOnCommit** (lock) | This option applied only for readLock=idempotent. This option 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. | false | boolean
+| **readLockRemoveOnRollback** (lock) | This option applied only for readLock=idempotent. This option 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). | true | boolean
+| **readLockTimeout** (lock) | 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. | 10000 | long
+| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| **delay** (scheduler) | Milliseconds before the next poll. The default value is 500. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
+| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
+| **initialDelay** (scheduler) | Milliseconds before the first poll starts. The default value is 1000. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
+| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
+| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. This option allows you to share a thread pool among multiple consumers. | | ScheduledExecutor Service
+| **scheduler** (scheduler) | Allow to plugin a custom org.apache.camel.spi.ScheduledPollConsumerScheduler to use as the scheduler for firing when the polling consumer runs. The default implementation uses the ScheduledExecutorService and there is a Quartz2 and Spring based which supports CRON expressions. Notice: If using a custom scheduler then the options for initialDelay useFixedDelay timeUnit and scheduledExecutorService may not be in use. Use the text quartz2 to refer to use the Quartz2 scheduler; and use the text spring to use the Spring based; and use the text myScheduler to refer to a custom scheduler by its id in the Registry. See Quartz2 page for an example. | none | ScheduledPollConsumer Scheduler
+| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map
+| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
+| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
+| **shuffle** (sort) | To shuffle the list of files (sort in random order) | false | boolean
+| **sortBy** (sort) | 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. | | String
+| **sorter** (sort) | Pluggable sorter as a java.util.Comparator class. | | GenericFile<T>>
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/language-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/language-component.adoc b/camel-core/src/main/docs/language-component.adoc
index 143d38f..682c4e7 100644
--- a/camel-core/src/main/docs/language-component.adoc
+++ b/camel-core/src/main/docs/language-component.adoc
@@ -50,30 +50,24 @@ with the following path and query parameters:
#### Path Parameters (2 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| languageName | | String | *Required* Sets the name of the language to use
-| resourceUri | | String | Path to the resource or a reference to lookup a bean in the Registry to use as the resource
+| Name | Description | Default | Type
+| **languageName** | *Required* Sets the name of the language to use | | String
+| **resourceUri** | Path to the resource or a reference to lookup a bean in the Registry to use as the resource | | String
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| binary | false | boolean | Whether the script is binary content or text content. By default the script is read as text content (eg java.lang.String)
-
-| cacheScript | false | boolean | 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.
-
-| contentCache | false | boolean | Sets whether to use resource content cache or not.
-
-| script | | String | Sets the script to execute
-
-| transform | true | boolean | Whether or not the result of the script should be used as message body. This options is default true.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **binary** (producer) | Whether the script is binary content or text content. By default the script is read as text content (eg java.lang.String) | false | boolean
+| **cacheScript** (producer) | 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. | false | boolean
+| **contentCache** (producer) | Sets whether to use resource content cache or not. | false | boolean
+| **script** (producer) | Sets the script to execute | | String
+| **transform** (producer) | Whether or not the result of the script should be used as message body. This options is default true. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/log-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/log-component.adoc b/camel-core/src/main/docs/log-component.adoc
index 552982e..224a4e8 100644
--- a/camel-core/src/main/docs/log-component.adoc
+++ b/camel-core/src/main/docs/log-component.adoc
@@ -60,13 +60,11 @@ The Log component supports 2 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| advanced
-| exchangeFormatter | | ExchangeFormatter | Sets a custom ExchangeFormatter to convert the Exchange to a String suitable for logging. If not specified we default to DefaultExchangeFormatter.
-
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **exchangeFormatter** (advanced) | Sets a custom ExchangeFormatter to convert the Exchange to a String suitable for logging. If not specified we default to DefaultExchangeFormatter. | | ExchangeFormatter
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -82,67 +80,42 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| loggerName | | String | *Required* The logger name to use
+| Name | Description | Default | Type
+| **loggerName** | *Required* The logger name to use | | String
|=======================================================================
#### Query Parameters (25 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| groupActiveOnly | true | Boolean | If true will hide stats when no new messages have been received for a time interval if false show stats regardless of message traffic.
-
-| groupDelay | | Long | Set the initial delay for stats (in millis)
-
-| groupInterval | | Long | If specified will group message stats by this time interval (in millis)
-
-| groupSize | | Integer | An integer that specifies a group size for throughput logging.
-
-| level | INFO | String | Logging level to use. The default value is INFO.
-
-| marker | | String | An optional Marker name to use.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
- 4+^s| formatting
-| maxChars | 10000 | int | Limits the number of characters logged per line.
-
-| multiline | false | boolean | If enabled then each information is outputted on a newline.
-
-| showAll | false | boolean | Quick option for turning all options on. (multiline maxChars has to be manually set if to be used)
-
-| showBody | true | boolean | Show the message body.
-
-| showBodyType | true | boolean | Show the body Java type.
-
-| showCaughtException | false | boolean | f the exchange has a caught exception show the exception message (no stack trace). A caught exception is stored as a property on the exchange (using the key link org.apache.camel.ExchangeEXCEPTION_CAUGHT and for instance a doCatch can catch exceptions.
-
-| showException | false | boolean | If the exchange has an exception show the exception message (no stacktrace)
-
-| showExchangeId | false | boolean | Show the unique exchange ID.
-
-| showExchangePattern | true | boolean | Shows the Message Exchange Pattern (or MEP for short).
-
-| showFiles | false | boolean | If enabled Camel will output files
-
-| showFuture | false | boolean | If enabled Camel will on Future objects wait for it to complete to obtain the payload to be logged.
-
-| showHeaders | false | boolean | Show the message headers.
-
-| showOut | false | boolean | If the exchange has an out message show the out message.
-
-| showProperties | false | boolean | Show the exchange properties.
-
-| showStackTrace | false | boolean | Show the stack trace if an exchange has an exception. Only effective if one of showAll showException or showCaughtException are enabled.
-
-| showStreams | false | boolean | Whether Camel should show stream bodies or not (eg such as java.io.InputStream). Beware if you enable this option then you may not be able later to access the message body as the stream have already been read by this logger. To remedy this you will have to use Stream Caching.
-
-| skipBodyLineSeparator | true | boolean | Whether to skip line separators when logging the message body. This allows to log the message body in one line setting this option to false will preserve any line separators from the body which then will log the body as is.
-
-| style | Default | OutputStyle | Sets the outputs style to use.
+| Name | Description | Default | Type
+| **groupActiveOnly** (producer) | If true will hide stats when no new messages have been received for a time interval if false show stats regardless of message traffic. | true | Boolean
+| **groupDelay** (producer) | Set the initial delay for stats (in millis) | | Long
+| **groupInterval** (producer) | If specified will group message stats by this time interval (in millis) | | Long
+| **groupSize** (producer) | An integer that specifies a group size for throughput logging. | | Integer
+| **level** (producer) | Logging level to use. The default value is INFO. | INFO | String
+| **marker** (producer) | An optional Marker name to use. | | String
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| **maxChars** (formatting) | Limits the number of characters logged per line. | 10000 | int
+| **multiline** (formatting) | If enabled then each information is outputted on a newline. | false | boolean
+| **showAll** (formatting) | Quick option for turning all options on. (multiline maxChars has to be manually set if to be used) | false | boolean
+| **showBody** (formatting) | Show the message body. | true | boolean
+| **showBodyType** (formatting) | Show the body Java type. | true | boolean
+| **showCaughtException** (formatting) | f the exchange has a caught exception show the exception message (no stack trace). A caught exception is stored as a property on the exchange (using the key link org.apache.camel.ExchangeEXCEPTION_CAUGHT and for instance a doCatch can catch exceptions. | false | boolean
+| **showException** (formatting) | If the exchange has an exception show the exception message (no stacktrace) | false | boolean
+| **showExchangeId** (formatting) | Show the unique exchange ID. | false | boolean
+| **showExchangePattern** (formatting) | Shows the Message Exchange Pattern (or MEP for short). | true | boolean
+| **showFiles** (formatting) | If enabled Camel will output files | false | boolean
+| **showFuture** (formatting) | If enabled Camel will on Future objects wait for it to complete to obtain the payload to be logged. | false | boolean
+| **showHeaders** (formatting) | Show the message headers. | false | boolean
+| **showOut** (formatting) | If the exchange has an out message show the out message. | false | boolean
+| **showProperties** (formatting) | Show the exchange properties. | false | boolean
+| **showStackTrace** (formatting) | Show the stack trace if an exchange has an exception. Only effective if one of showAll showException or showCaughtException are enabled. | false | boolean
+| **showStreams** (formatting) | Whether Camel should show stream bodies or not (eg such as java.io.InputStream). Beware if you enable this option then you may not be able later to access the message body as the stream have already been read by this logger. To remedy this you will have to use Stream Caching. | false | boolean
+| **skipBodyLineSeparator** (formatting) | Whether to skip line separators when logging the message body. This allows to log the message body in one line setting this option to false will preserve any line separators from the body which then will log the body as is. | true | boolean
+| **style** (formatting) | Sets the outputs style to use. | Default | OutputStyle
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/mock-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/mock-component.adoc b/camel-core/src/main/docs/mock-component.adoc
index 22efb45..4ae11fc 100644
--- a/camel-core/src/main/docs/mock-component.adoc
+++ b/camel-core/src/main/docs/mock-component.adoc
@@ -101,37 +101,27 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| name | | String | *Required* Name of mock endpoint
+| Name | Description | Default | Type
+| **name** | *Required* Name of mock endpoint | | String
|=======================================================================
#### Query Parameters (10 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| assertPeriod | 0 | long | 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 link 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 link setAssertPeriod(long) method for. By default this period is disabled.
-
-| expectedCount | -1 | int | 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 link 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 link 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 link setAssertPeriod(long) method for further details.
-
-| reportGroup | | int | A number that is used to turn on throughput logging based on groups of the size.
-
-| resultMinimumWaitTime | 0 | long | Sets the minimum expected amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied
-
-| resultWaitTime | 0 | long | Sets the maximum amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied
-
-| retainFirst | -1 | int | 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 link 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 link getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received.
-
-| retainLast | -1 | int | 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 link 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 link getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received.
-
-| sleepForEmptyTest | 0 | long | Allows a sleep to be specified to wait to check that this endpoint really is empty when link expectedMessageCount(int) is called with zero
- 4+^s| producer (advanced)
-| copyOnExchange | true | boolean | Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **assertPeriod** (producer) | 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 link 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 link setAssertPeriod(long) method for. By default this period is disabled. | 0 | long
+| **expectedCount** (producer) | 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 link 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 link 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 link setAssertPeriod(long) method for further details. | -1 | int
+| **reportGroup** (producer) | A number that is used to turn on throughput logging based on groups of the size. | | int
+| **resultMinimumWaitTime** (producer) | Sets the minimum expected amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied | 0 | long
+| **resultWaitTime** (producer) | Sets the maximum amount of time (in millis) the link assertIsSatisfied() will wait on a latch until it is satisfied | 0 | long
+| **retainFirst** (producer) | 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 link 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 link getReceivedCounter() will still return 5000 but there is only the first 10 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received. | -1 | int
+| **retainLast** (producer) | 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 link 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 link getReceivedCounter() will still return 5000 but there is only the last 20 Exchanges in the link getExchanges() and link getReceivedExchanges() methods. When using this method then some of the other expectation methods is not supported for example the link expectedBodiesReceived(Object...) sets a expectation on the first number of bodies received. You can configure both link setRetainFirst(int) and link setRetainLast(int) methods to limit both the first and last received. | -1 | int
+| **sleepForEmptyTest** (producer) | Allows a sleep to be specified to wait to check that this endpoint really is empty when link expectedMessageCount(int) is called with zero | 0 | long
+| **copyOnExchange** (producer) | Sets whether to make a deep copy of the incoming Exchange when received at this mock endpoint. Is by default true. | true | boolean
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/properties-component.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/properties-component.adoc b/camel-core/src/main/docs/properties-component.adoc
index 1cfe2b5..a43b18b 100644
--- a/camel-core/src/main/docs/properties-component.adoc
+++ b/camel-core/src/main/docs/properties-component.adoc
@@ -18,43 +18,26 @@ The Properties component supports 17 options which are listed below.
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
- 4+^s| common
-| locations | | List | A list of locations to load properties. This option will override any default locations and only use the locations from this option.
-
-| location | | String | A list of locations to load properties. You can use comma to separate multiple locations. This option will override any default locations and only use the locations from this option.
-
-| encoding | | String | Encoding to use when loading properties file from the file system or classpath. If no encoding has been set then the properties files is loaded using ISO-8859-1 encoding (latin-1) as documented by link java.util.Propertiesload(java.io.InputStream)
-
-| propertiesResolver | | PropertiesResolver | To use a custom PropertiesResolver
-
-| propertiesParser | | PropertiesParser | To use a custom PropertiesParser
-
-| cache | true | boolean | Whether or not to cache loaded properties. The default value is true.
-
-| propertyPrefix | | String | Optional prefix prepended to property names before resolution.
-
-| propertySuffix | | String | Optional suffix appended to property names before resolution.
-
-| fallbackToUnaugmentedProperty | true | boolean | If true first attempt resolution of property name augmented with propertyPrefix and propertySuffix before falling back the plain property name specified. If false only the augmented property name is searched.
-
-| defaultFallbackEnabled | true | boolean | If false the component does not attempt to find a default for the key by looking after the colon separator.
-
-| ignoreMissingLocation | false | boolean | Whether to silently ignore if a location cannot be located such as a properties file not found.
-
-| prefixToken | {{ | String | Sets the value of the prefix token used to identify properties to replace. Setting a value of null restores the default token (link link DEFAULT_PREFIX_TOKEN).
-
-| suffixToken | }} | String | Sets the value of the suffix token used to identify properties to replace. Setting a value of null restores the default token (link link DEFAULT_SUFFIX_TOKEN).
-
-| initialProperties | | Properties | Sets initial properties which will be used before any locations are resolved.
-
-| overrideProperties | | Properties | Sets a special list of override properties that take precedence and will use first if a property exist.
-
-| systemPropertiesMode | 2 | int | Sets the system property mode.
- 4+^s| advanced
-| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.
+| Name | Description | Default | Type
+| **locations** (common) | A list of locations to load properties. This option will override any default locations and only use the locations from this option. | | List
+| **location** (common) | A list of locations to load properties. You can use comma to separate multiple locations. This option will override any default locations and only use the locations from this option. | | String
+| **encoding** (common) | Encoding to use when loading properties file from the file system or classpath. If no encoding has been set then the properties files is loaded using ISO-8859-1 encoding (latin-1) as documented by link java.util.Propertiesload(java.io.InputStream) | | String
+| **propertiesResolver** (common) | To use a custom PropertiesResolver | | PropertiesResolver
+| **propertiesParser** (common) | To use a custom PropertiesParser | | PropertiesParser
+| **cache** (common) | Whether or not to cache loaded properties. The default value is true. | true | boolean
+| **propertyPrefix** (common) | Optional prefix prepended to property names before resolution. | | String
+| **propertySuffix** (common) | Optional suffix appended to property names before resolution. | | String
+| **fallbackToUnaugmented Property** (common) | If true first attempt resolution of property name augmented with propertyPrefix and propertySuffix before falling back the plain property name specified. If false only the augmented property name is searched. | true | boolean
+| **defaultFallbackEnabled** (common) | If false the component does not attempt to find a default for the key by looking after the colon separator. | true | boolean
+| **ignoreMissingLocation** (common) | Whether to silently ignore if a location cannot be located such as a properties file not found. | false | boolean
+| **prefixToken** (common) | Sets the value of the prefix token used to identify properties to replace. Setting a value of null restores the default token (link link DEFAULT_PREFIX_TOKEN). | {{ | String
+| **suffixToken** (common) | Sets the value of the suffix token used to identify properties to replace. Setting a value of null restores the default token (link link DEFAULT_SUFFIX_TOKEN). | }} | String
+| **initialProperties** (common) | Sets initial properties which will be used before any locations are resolved. | | Properties
+| **overrideProperties** (common) | Sets a special list of override properties that take precedence and will use first if a property exist. | | Properties
+| **systemPropertiesMode** (common) | Sets the system property mode. | 2 | int
+| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
|=======================================================================
// component options: END
@@ -68,29 +51,23 @@ with the following path and query parameters:
#### Path Parameters (1 parameters):
-[width="100%",cols="2,1,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-| key | | String | *Required* Property key to use as placeholder
+| Name | Description | Default | Type
+| **key** | *Required* Property key to use as placeholder | | String
|=======================================================================
#### Query Parameters (6 parameters):
-[width="100%",cols="2,1m,1m,6",options="header"]
+[width="100%",cols="2,5,^1,2",options="header"]
|=======================================================================
-| Name | Default | Java Type | Description
-
-| ignoreMissingLocation | false | boolean | Whether to silently ignore if a location cannot be located such as a properties file not found.
-
-| locations | | String | A list of locations to load properties. You can use comma to separate multiple locations. This option will override any default locations and only use the locations from this option.
- 4+^s| consumer
-| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
- 4+^s| consumer (advanced)
-| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
-
-| exchangePattern | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
- 4+^s| advanced
-| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| Name | Description | Default | Type
+| **ignoreMissingLocation** (common) | Whether to silently ignore if a location cannot be located such as a properties file not found. | false | boolean
+| **locations** (common) | A list of locations to load properties. You can use comma to separate multiple locations. This option will override any default locations and only use the locations from this option. | | String
+| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | false | boolean
+| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | | ExceptionHandler
+| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern
+| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|=======================================================================
// endpoint options: END