http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 0314fea..2b1b5fb 100644 --- a/components/camel-lucene/src/main/docs/lucene-component.adoc +++ b/components/camel-lucene/src/main/docs/lucene-component.adoc @@ -1,4 +1,4 @@ -## Lucene Component +== Lucene Component *Available as of Camel version 2.2* @@ -56,11 +56,11 @@ The Lucene component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 @@ -72,30 +72,32 @@ The Lucene component supports 2 options which are listed below. // endpoint options: START The Lucene endpoint is configured using URI syntax: - lucene:host:operation +---- +lucene:host:operation +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **host** | *Required* The URL to the lucene server | | String -| **operation** | *Required* Operation to do such as insert or query. | | LuceneOperation -|======================================================================= +| *host* | *Required* The URL to the lucene server | | String +| *operation* | *Required* Operation to do such as insert or query. | | LuceneOperation +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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/4f4f2e45/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 663cbd3..3144ead 100644 --- a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc +++ b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc @@ -1,4 +1,4 @@ -## Lumberjack Component +== Lumberjack Component *Available as of Camel version 2.18* @@ -42,12 +42,12 @@ The Lumberjack component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | 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 -|======================================================================= +| *sslContextParameters* (security) | Sets the default SSL configuration to use for all the endpoints. You can also configure it directly at the endpoint level. | | SSLContextParameters +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | 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 @@ -59,30 +59,32 @@ The Lumberjack component supports 3 options which are listed below. // endpoint options: START The Lumberjack endpoint is configured using URI syntax: - lumberjack:host:port +---- +lumberjack:host:port +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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/4f4f2e45/components/camel-lzf/src/main/docs/lzf-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-lzf/src/main/docs/lzf-dataformat.adoc b/components/camel-lzf/src/main/docs/lzf-dataformat.adoc index c453c7f..20bf634 100644 --- a/components/camel-lzf/src/main/docs/lzf-dataformat.adoc +++ b/components/camel-lzf/src/main/docs/lzf-dataformat.adoc @@ -1,4 +1,4 @@ -## LZF Deflate Compression DataFormat +== LZF Deflate Compression DataFormat *Available as of Camel version 2.17* @@ -19,11 +19,11 @@ The LZF Deflate Compression dataformat supports 2 options which are listed below [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | usingParallelCompression | false | Boolean | Enable encoding (compress) using multiple processing cores. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END ### Marshal http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 fd0ac47..e3904e0 100644 --- a/components/camel-mail/src/main/docs/mail-component.adoc +++ b/components/camel-mail/src/main/docs/mail-component.adoc @@ -1,4 +1,4 @@ -## Mail Component +== Mail Component *Available as of Camel version 1.0* @@ -82,13 +82,13 @@ The Mail component supports 4 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (advanced) | Sets the Mail configuration | | MailConfiguration -| **contentTypeResolver** (advanced) | Resolver to determine Content-Type for file attachments. | | ContentTypeResolver -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | 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 -|======================================================================= +| *configuration* (advanced) | Sets the Mail configuration | | MailConfiguration +| *contentTypeResolver* (advanced) | Resolver to determine Content-Type for file attachments. | | ContentTypeResolver +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | 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 @@ -99,86 +99,88 @@ The Mail component supports 4 options which are listed below. // endpoint options: START The Mail endpoint is configured using URI syntax: - imap:host:port +---- +imap:host:port +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **host** | *Required* The mail server host name | | String -| **port** | The port number of the mail server | | int -|======================================================================= +| *host* | *Required* The mail server host name | | String +| *port* | The port number of the mail server | | int +|=== -#### Query Parameters (61 parameters): +==== Query Parameters (61 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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/4f4f2e45/components/camel-mail/src/main/docs/mime-multipart-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mail/src/main/docs/mime-multipart-dataformat.adoc b/components/camel-mail/src/main/docs/mime-multipart-dataformat.adoc index 221a34d..117c5ee 100644 --- a/components/camel-mail/src/main/docs/mime-multipart-dataformat.adoc +++ b/components/camel-mail/src/main/docs/mime-multipart-dataformat.adoc @@ -1,4 +1,4 @@ -## MIME Multipart DataFormat +== MIME Multipart DataFormat *Available as of Camel version 2.17* @@ -48,7 +48,7 @@ The MIME Multipart dataformat supports 6 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | multipartSubType | mixed | String | Specify the subtype of the MIME Multipart. Default is mixed. | multipartWithoutAttachment | false | Boolean | Defines whether a message without attachment is also marshaled into a MIME Multipart (with only one body part). Default is false. @@ -56,7 +56,7 @@ The MIME Multipart dataformat supports 6 options which are listed below. | includeHeaders | | String | A regex that defines which Camel headers are also included as MIME headers into the MIME multipart. This will only work if headersInline is set to true. Default is to include no headers | binaryContent | false | Boolean | Defines whether the content of binary parts in the MIME multipart is binary (true) or Base-64 encoded (false) Default is false. | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END ### Message Headers (marshal) http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 89a4857..abd205a 100644 --- a/components/camel-metrics/src/main/docs/metrics-component.adoc +++ b/components/camel-metrics/src/main/docs/metrics-component.adoc @@ -1,4 +1,4 @@ -## Metrics Component +== Metrics Component ifdef::env-github[] *Available as of Camel version 2.14.0* @@ -49,43 +49,45 @@ The Metrics component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 // endpoint options: START The Metrics endpoint is configured using URI syntax: - metrics:metricsType:metricsName +---- +metrics:metricsType:metricsName +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **metricsType** | *Required* Type of metrics | | MetricsType -| **metricsName** | *Required* Name of metrics | | String -|======================================================================= +| *metricsType* | *Required* Type of metrics | | MetricsType +| *metricsName* | *Required* Name of metrics | | String +|=== -#### Query Parameters (7 parameters): +==== Query Parameters (7 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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/4f4f2e45/components/camel-milo/src/main/docs/milo-client-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-milo/src/main/docs/milo-client-component.adoc b/components/camel-milo/src/main/docs/milo-client-component.adoc index 821f261..6142d80 100644 --- a/components/camel-milo/src/main/docs/milo-client-component.adoc +++ b/components/camel-milo/src/main/docs/milo-client-component.adoc @@ -1,4 +1,4 @@ -## OPC UA Client Component +== OPC UA Client Component *Available as of Camel version 2.19* @@ -26,15 +26,15 @@ The OPC UA Client component supports 6 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **defaultConfiguration** (common) | All default options for client | | MiloClientConfiguration -| **applicationName** (common) | Default application name | | String -| **applicationUri** (common) | Default application URI | | String -| **productUri** (common) | Default product URI | | String -| **reconnectTimeout** (common) | Default reconnect timeout | | 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 -|======================================================================= +| *defaultConfiguration* (common) | All default options for client | | MiloClientConfiguration +| *applicationName* (common) | Default application name | | String +| *applicationUri* (common) | Default application URI | | String +| *productUri* (common) | Default product URI | | String +| *reconnectTimeout* (common) | Default reconnect timeout | | 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 @@ -80,47 +80,49 @@ In other words, shared connections located by the combination of endpoint URI an // endpoint options: START The OPC UA Client endpoint is configured using URI syntax: - milo-client:endpointUri +---- +milo-client:endpointUri +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **endpointUri** | *Required* The OPC UA server endpoint | | String -|======================================================================= +| *endpointUri* | *Required* The OPC UA server endpoint | | String +|=== -#### Query Parameters (23 parameters): +==== Query Parameters (23 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **clientId** (common) | A virtual client id to force the creation of a new connection instance | | String -| **defaultAwaitWrites** (common) | Default await setting for writes | false | boolean -| **node** (common) | The node definition (see Node ID) | | ExpandedNodeId -| **samplingInterval** (common) | The sampling interval in milliseconds | | Double -| **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 -| **applicationName** (client) | The application name | Apache Camel adapter for Eclipse Milo | String -| **applicationUri** (client) | The application URI | http://camel.apache.org/EclipseMilo/Client | String -| **channelLifetime** (client) | Channel lifetime in milliseconds | | Long -| **keyAlias** (client) | The name of the key in the keystore file | | String -| **keyPassword** (client) | The key password | | String -| **keyStorePassword** (client) | The keystore password | | String -| **keyStoreType** (client) | The key store type | | String -| **keyStoreUrl** (client) | The URL where the key should be loaded from | | URL -| **maxPendingPublishRequests** (client) | The maximum number of pending publish requests | | Long -| **maxResponseMessageSize** (client) | The maximum number of bytes a response message may have | | Long -| **productUri** (client) | The product URI | http://camel.apache.org/EclipseMilo | String -| **requestTimeout** (client) | Request timeout in milliseconds | | Long -| **secureChannel ReauthenticationEnabled** (client) | Whether secure channel re-authentication is enabled | | Boolean -| **sessionName** (client) | Session name | | String -| **sessionTimeout** (client) | Session timeout in milliseconds | | Long -|======================================================================= +| *clientId* (common) | A virtual client id to force the creation of a new connection instance | | String +| *defaultAwaitWrites* (common) | Default await setting for writes | false | boolean +| *node* (common) | The node definition (see Node ID) | | ExpandedNodeId +| *samplingInterval* (common) | The sampling interval in milliseconds | | Double +| *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 +| *applicationName* (client) | The application name | Apache Camel adapter for Eclipse Milo | String +| *applicationUri* (client) | The application URI | http://camel.apache.org/EclipseMilo/Client | String +| *channelLifetime* (client) | Channel lifetime in milliseconds | | Long +| *keyAlias* (client) | The name of the key in the keystore file | | String +| *keyPassword* (client) | The key password | | String +| *keyStorePassword* (client) | The keystore password | | String +| *keyStoreType* (client) | The key store type | | String +| *keyStoreUrl* (client) | The URL where the key should be loaded from | | URL +| *maxPendingPublishRequests* (client) | The maximum number of pending publish requests | | Long +| *maxResponseMessageSize* (client) | The maximum number of bytes a response message may have | | Long +| *productUri* (client) | The product URI | http://camel.apache.org/EclipseMilo | String +| *requestTimeout* (client) | Request timeout in milliseconds | | Long +| *secureChannel ReauthenticationEnabled* (client) | Whether secure channel re-authentication is enabled | | Boolean +| *sessionName* (client) | Session name | | String +| *sessionTimeout* (client) | Session timeout in milliseconds | | Long +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-milo/src/main/docs/milo-server-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-milo/src/main/docs/milo-server-component.adoc b/components/camel-milo/src/main/docs/milo-server-component.adoc index 98e5fd2..7bfd076 100644 --- a/components/camel-milo/src/main/docs/milo-server-component.adoc +++ b/components/camel-milo/src/main/docs/milo-server-component.adoc @@ -1,4 +1,4 @@ -## OPC UA Server Component +== OPC UA Server Component *Available as of Camel version 2.19* @@ -30,28 +30,28 @@ The OPC UA Server component supports 19 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **namespaceUri** (common) | The URI of the namespace defaults to urn:org:apache:camel | | String -| **applicationName** (common) | The application name | | String -| **applicationUri** (common) | The application URI | | String -| **productUri** (common) | The product URI | | String -| **bindPort** (common) | The TCP port the server binds to | | int -| **strictEndpointUrls Enabled** (common) | Set whether strict endpoint URLs are enforced | false | boolean -| **serverName** (common) | Server name | | String -| **hostname** (common) | Server hostname | | String -| **securityPolicies** (common) | Security policies | | Set -| **securityPoliciesById** (common) | Security policies by URI or name | | String> -| **userAuthentication Credentials** (common) | Set user password combinations in the form of user1:pwd1user2:pwd2 Usernames and passwords will be URL decoded | | String -| **enableAnonymous Authentication** (common) | Enable anonymous authentication disabled by default | false | boolean -| **bindAddresses** (common) | Set the addresses of the local addresses the server should bind to | | String -| **buildInfo** (common) | Server build info | | BuildInfo -| **serverCertificate** (common) | Server certificate | | Result -| **certificateManager** (common) | Server certificate manager | | CertificateManager -| **certificateValidator** (common) | Validator for client certificates | | CertificateValidator> -| **defaultCertificate Validator** (common) | Validator for client certificates using default file based approach | | File -| **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 -|======================================================================= +| *namespaceUri* (common) | The URI of the namespace defaults to urn:org:apache:camel | | String +| *applicationName* (common) | The application name | | String +| *applicationUri* (common) | The application URI | | String +| *productUri* (common) | The product URI | | String +| *bindPort* (common) | The TCP port the server binds to | | int +| *strictEndpointUrls Enabled* (common) | Set whether strict endpoint URLs are enforced | false | boolean +| *serverName* (common) | Server name | | String +| *hostname* (common) | Server hostname | | String +| *securityPolicies* (common) | Security policies | | Set +| *securityPoliciesById* (common) | Security policies by URI or name | | String> +| *userAuthentication Credentials* (common) | Set user password combinations in the form of user1:pwd1user2:pwd2 Usernames and passwords will be URL decoded | | String +| *enableAnonymous Authentication* (common) | Enable anonymous authentication disabled by default | false | boolean +| *bindAddresses* (common) | Set the addresses of the local addresses the server should bind to | | String +| *buildInfo* (common) | Server build info | | BuildInfo +| *serverCertificate* (common) | Server certificate | | Result +| *certificateManager* (common) | Server certificate manager | | CertificateManager +| *certificateValidator* (common) | Validator for client certificates | | CertificateValidator> +| *defaultCertificate Validator* (common) | Validator for client certificates using default file based approach | | File +| *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,28 +76,30 @@ milo-server:itemId[?options] // endpoint options: START The OPC UA Server endpoint is configured using URI syntax: - milo-server:itemId +---- +milo-server:itemId +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **itemId** | *Required* ID of the item | | String -|======================================================================= +| *itemId* | *Required* ID of the item | | String +|=== -#### Query Parameters (4 parameters): +==== Query Parameters (4 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 @@ -110,4 +112,4 @@ with the following path and query parameters: * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] \ No newline at end of file +* link:getting-started.html[Getting Started] http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 cfba369..ff39db0 100644 --- a/components/camel-mina/src/main/docs/mina-component.adoc +++ b/components/camel-mina/src/main/docs/mina-component.adoc @@ -1,4 +1,4 @@ -## Mina Component (deprecated) +== Mina Component (deprecated) *Available as of Camel version 1.0* @@ -69,11 +69,11 @@ The Mina component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 @@ -86,47 +86,49 @@ The Mina component supports 2 options which are listed below. // endpoint options: START The Mina endpoint is configured using URI syntax: - mina:protocol:host:port +---- +mina:protocol:host:port +---- with the following path and query parameters: -#### Path Parameters (3 parameters): +==== Path Parameters (3 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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): +==== Query Parameters (21 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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/4f4f2e45/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 784c191..6f8e819 100644 --- a/components/camel-mina2/src/main/docs/mina2-component.adoc +++ b/components/camel-mina2/src/main/docs/mina2-component.adoc @@ -1,4 +1,4 @@ -## Mina2 Component +== Mina2 Component *Available as of Camel version 2.10* @@ -68,12 +68,12 @@ The Mina2 component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (advanced) | To use the shared mina configuration. | | Mina2Configuration -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | 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 -|======================================================================= +| *configuration* (advanced) | To use the shared mina configuration. | | Mina2Configuration +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | 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 @@ -86,53 +86,55 @@ The Mina2 component supports 3 options which are listed below. // endpoint options: START The Mina2 endpoint is configured using URI syntax: - mina2:protocol:host:port +---- +mina2:protocol:host:port +---- with the following path and query parameters: -#### Path Parameters (3 parameters): +==== Path Parameters (3 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 (27 parameters): +==== Query Parameters (27 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -| **writeTimeout** (common) | Maximum amount of time it should take to send data to the MINA session. Default is 10000 milliseconds. | 10000 | 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 -|======================================================================= +| *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 +| *writeTimeout* (common) | Maximum amount of time it should take to send data to the MINA session. Default is 10000 milliseconds. | 10000 | 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
