http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/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..994b9ab 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,6,1,1",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,6,1,1",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/bb3764e3/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..8419756 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,6,1,1",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,6,1,1",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/bb3764e3/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..4af6fba 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,6,1,1",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 +| **resolvePropertyPlaceholders** (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,6,1,1",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,6,1,1",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/bb3764e3/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..07bb66e 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,6,1,1",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 +| **resolvePropertyPlaceholders** (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,6,1,1",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,6,1,1",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/bb3764e3/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..582e560 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,6,1,1",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 +| **resolvePropertyPlaceholders** (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,6,1,1",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,6,1,1",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/bb3764e3/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..9d628ac 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,6,1,1",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 +| **resolvePropertyPlaceholders** (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,6,1,1",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,6,1,1",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/bb3764e3/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..cb0e014 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,6,1,1",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 +| **resolvePropertyPlaceholders** (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,6,1,1",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,6,1,1",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/bb3764e3/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..8015d91 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,6,1,1",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 +| **resolvePropertyPlaceholders** (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,6,1,1",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,6,1,1",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/bb3764e3/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..aaa6dcc 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,6,1,1",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 +| **resolvePropertyPlaceholders** (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,6,1,1",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,6,1,1",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
