http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 c3a3362..a26ef61 100644 --- a/components/camel-mail/src/main/docs/mail-component.adoc +++ b/components/camel-mail/src/main/docs/mail-component.adoc @@ -81,12 +81,15 @@ The Mail component supports 3 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| configuration | advanced | | MailConfiguration | Sets the Mail configuration -| contentTypeResolver | advanced | | ContentTypeResolver | Resolver to determine Content-Type for file attachments. -| resolvePropertyPlaceholders | advanced | 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 | 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. |======================================================================= // component options: END @@ -113,70 +116,131 @@ with the following path and query parameters: #### Query Parameters (61 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| bridgeErrorHandler | consumer | 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 | consumer | 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 | consumer | | 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 | consumer | 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 | consumer | false | boolean | Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll. -| handleFailedMessage | consumer | 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 | consumer | | 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 | consumer | 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 | consumer | 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 | consumer | 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 | consumer | true | boolean | Whether to limit by unseen mails only. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| fetchSize | consumer (advanced) | -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 | consumer (advanced) | INBOX | String | The folder to poll. -| mailUidGenerator | consumer (advanced) | | MailUidGenerator | A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message. -| mapMailMessage | consumer (advanced) | 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 | consumer (advanced) | | 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 | consumer (advanced) | | MailBoxPostProcessAction | Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended. -| bcc | producer | | String | Sets the BCC email address. Separate multiple email addresses with comma. -| cc | producer | | String | Sets the CC email address. Separate multiple email addresses with comma. -| from | producer | camel@localhost | String | The from email address -| replyTo | producer | | String | The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma. -| subject | producer | | String | The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option. -| to | producer | | String | Sets the To email address. Separate multiple email addresses with comma. -| javaMailSender | producer (advanced) | | JavaMailSender | To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails. -| additionalJavaMailProperties | advanced | | 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 | advanced | 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 | advanced | | AttachmentsContentTransferEncodingResolver | To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments. -| binding | advanced | | MailBinding | Sets the binding used to convert from a Camel message to and from a Mail message -| connectionTimeout | advanced | 30000 | int | The connection timeout in milliseconds. -| contentType | advanced | text/plain | String | The mail message content type. Use text/html for HTML mails. -| contentTypeResolver | advanced | | ContentTypeResolver | Resolver to determine Content-Type for file attachments. -| debugMode | advanced | false | boolean | Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default. -| headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. -| ignoreUnsupportedCharset | advanced | 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 | advanced | 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 | advanced | | 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 | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| useInlineAttachments | advanced | false | boolean | Whether to use disposition inline or attachment. -| idempotentRepository | filter | | 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 | filter | 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 | filter | | 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. -| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. -| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. -| backoffMultiplier | scheduler | | 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 | scheduler | 60000 | long | Milliseconds before the next poll. -| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. -| initialDelay | scheduler | 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 | scheduler | 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 | scheduler | | 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 | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component -| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. -| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. -| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. -| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. -| sortTerm | sort | | 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. -| dummyTrustManager | security | false | boolean | To use a dummy security setting for trusting all certificates. Should only be used for development mode and not production. -| password | security | | String | The password for login -| sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters. -| username | security | | String | The username for login +| 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 |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 47cb89c..3b052a5 100644 --- a/components/camel-metrics/src/main/docs/metrics-component.adoc +++ b/components/camel-metrics/src/main/docs/metrics-component.adoc @@ -48,11 +48,13 @@ The Metrics component supports 2 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| metricRegistry | advanced | | MetricRegistry | To use a custom configured MetricRegistry. -| resolvePropertyPlaceholders | advanced | 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 | 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. |======================================================================= // component options: END @@ -75,16 +77,23 @@ with the following path and query parameters: #### Query Parameters (7 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| action | producer | | MetricsTimerAction | Action when using timer type -| decrement | producer | | Long | Decrement value when using counter type -| increment | producer | | Long | Increment value when using counter type -| mark | producer | | Long | Mark when using meter type -| subject | producer | | Object | Subject value when using gauge type -| value | producer | | Long | Value value when using histogram type -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| 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). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 66cdf1b..a239fa0 100644 --- a/components/camel-mina/src/main/docs/mina-component.adoc +++ b/components/camel-mina/src/main/docs/mina-component.adoc @@ -68,11 +68,13 @@ The Mina component supports 2 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| configuration | advanced | | MinaConfiguration | To use the shared mina configuration. -| resolvePropertyPlaceholders | advanced | 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 | 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. |======================================================================= // component options: END @@ -102,30 +104,51 @@ with the following path and query parameters: #### Query Parameters (21 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| disconnect | common | false | boolean | Whether or not to disconnect(close) from Mina session right after use. Can be used for both consumer and producer. -| minaLogger | common | 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 | common | true | boolean | Setting to set endpoint as one-way or request-response. -| timeout | common | 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. -| bridgeErrorHandler | consumer | 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 | consumer | false | boolean | If the clientMode is true mina consumer will connect the address as a TCP client. -| disconnectOnNoReply | consumer (advanced) | true | boolean | If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| noReplyLogLevel | consumer (advanced) | 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. -| lazySessionCreation | producer (advanced) | 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. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| transferExchange | advanced | 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. -| allowDefaultCodec | codec | 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 | codec | | ProtocolCodecFactory | To use a custom minda codec implementation. -| decoderMaxLineLength | codec | 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 | codec | -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 | codec | | 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 | codec | | List | You can set a list of Mina IoFilters to use. -| textline | codec | 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 | codec | | 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 | 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. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 02797af..d6a0434 100644 --- a/components/camel-mina2/src/main/docs/mina2-component.adoc +++ b/components/camel-mina2/src/main/docs/mina2-component.adoc @@ -67,11 +67,13 @@ The Mina2 component supports 2 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| configuration | advanced | | Mina2Configuration | To use the shared mina configuration. -| resolvePropertyPlaceholders | advanced | 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 | 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. |======================================================================= // component options: END @@ -101,35 +103,61 @@ with the following path and query parameters: #### Query Parameters (26 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| disconnect | common | false | boolean | Whether or not to disconnect(close) from Mina session right after use. Can be used for both consumer and producer. -| minaLogger | common | 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 | common | true | boolean | Setting to set endpoint as one-way or request-response. -| timeout | common | 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. -| bridgeErrorHandler | consumer | 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 | consumer | false | boolean | If the clientMode is true mina consumer will connect the address as a TCP client. -| disconnectOnNoReply | consumer (advanced) | true | boolean | If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| noReplyLogLevel | consumer (advanced) | 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. -| cachedAddress | producer (advanced) | true | boolean | Whether to create the InetAddress once and reuse. Setting this to false allows to pickup DNS changes in the network. -| lazySessionCreation | producer (advanced) | 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. -| maximumPoolSize | advanced | 16 | int | Number of worker threads in the worker pool for TCP and UDP -| orderedThreadPoolExecutor | advanced | true | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| transferExchange | advanced | 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. -| allowDefaultCodec | codec | 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 | codec | | ProtocolCodecFactory | To use a custom minda codec implementation. -| decoderMaxLineLength | codec | 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 | codec | -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 | codec | | 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 | codec | | List | You can set a list of Mina IoFilters to use. -| textline | codec | 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 | codec | | 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. -| autoStartTls | security | true | boolean | Whether to auto start SSL handshake. -| sslContextParameters | security | | SSLContextParameters | To configure SSL security. +| 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. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-mllp/src/main/docs/mllp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mllp/src/main/docs/mllp-component.adoc b/components/camel-mllp/src/main/docs/mllp-component.adoc index c55dd3b..39493a2 100644 --- a/components/camel-mllp/src/main/docs/mllp-component.adoc +++ b/components/camel-mllp/src/main/docs/mllp-component.adoc @@ -68,31 +68,53 @@ with the following path and query parameters: #### Query Parameters (22 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| autoAck | common | true | boolean | Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only -| bufferWrites | common | true | boolean | Enable/Disable the validation of HL7 Payloads If enabled MLLP Payloads are buffered and written to the external system in a single write(byte) operation. If disabled the MLLP payload will not be buffered and three write operations will be used. The first operation will write the MLLP start-of-block character 0x0b (ASCII VT) the second operation will write the HL7 payload and the third operation will writh the MLLP end-of-block character and the MLLP end-of-data character 0x1c 0x0d (ASCII FS CR). -| hl7Headers | common | true | boolean | Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only -| keepAlive | common | true | boolean | Enable/disable the SO_KEEPALIVE socket option. -| reuseAddress | common | false | boolean | Enable/disable the SO_REUSEADDR socket option. -| tcpNoDelay | common | true | boolean | Enable/disable the TCP_NODELAY socket option. -| validatePayload | common | false | boolean | Enable/Disable the validation of HL7 Payloads If enabled HL7 Payloads received from external systems will be validated (see Hl7Util.generateInvalidPayloadExceptionMessage for details on the validation). If and invalid payload is detected a MllpInvalidMessageException (for consumers) or a MllpInvalidAcknowledgementException will be thrown. -| bridgeErrorHandler | consumer | 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. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| backlog | advanced | 5 | int | The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full the connection is refused. -| receiveBufferSize | advanced | | Integer | Sets the SO_RCVBUF option to the specified value (in bytes) -| sendBufferSize | advanced | | Integer | Sets the SO_SNDBUF option to the specified value (in bytes) -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| charsetName | codec | | String | Set the CamelCharsetName property on the exchange -| acceptTimeout | timeout | 60000 | int | Timeout (in milliseconds) while waiting for a TCP connection TCP Server Only -| bindRetryInterval | timeout | 5000 | int | TCP Server Only - The number of milliseconds to wait between bind attempts -| bindTimeout | timeout | 30000 | int | TCP Server Only - The number of milliseconds to retry binding to a server port -| connectTimeout | timeout | 30000 | int | Timeout (in milliseconds) for establishing for a TCP connection TCP Client only -| maxReceiveTimeouts | timeout | -1 | int | The maximum number of timeouts (specified by receiveTimeout) allowed before the TCP Connection will be reset. -| readTimeout | timeout | 500 | int | The SO_TIMEOUT value (in milliseconds) used after the start of an MLLP frame has been received -| receiveTimeout | timeout | 10000 | int | The SO_TIMEOUT value (in milliseconds) used when waiting for the start of an MLLP frame +| Name | Default | Java Type | Description + +| autoAck | true | boolean | Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only + +| bufferWrites | true | boolean | Enable/Disable the validation of HL7 Payloads If enabled MLLP Payloads are buffered and written to the external system in a single write(byte) operation. If disabled the MLLP payload will not be buffered and three write operations will be used. The first operation will write the MLLP start-of-block character 0x0b (ASCII VT) the second operation will write the HL7 payload and the third operation will writh the MLLP end-of-block character and the MLLP end-of-data character 0x1c 0x0d (ASCII FS CR). + +| hl7Headers | true | boolean | Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only + +| keepAlive | true | boolean | Enable/disable the SO_KEEPALIVE socket option. + +| reuseAddress | false | boolean | Enable/disable the SO_REUSEADDR socket option. + +| tcpNoDelay | true | boolean | Enable/disable the TCP_NODELAY socket option. + +| validatePayload | false | boolean | Enable/Disable the validation of HL7 Payloads If enabled HL7 Payloads received from external systems will be validated (see Hl7Util.generateInvalidPayloadExceptionMessage for details on the validation). If and invalid payload is detected a MllpInvalidMessageException (for consumers) or a MllpInvalidAcknowledgementException will be thrown. + 4+^s| consumer +| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. + 4+^s| consumer (advanced) +| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + 4+^s| advanced +| backlog | 5 | int | The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full the connection is refused. + +| receiveBufferSize | | Integer | Sets the SO_RCVBUF option to the specified value (in bytes) + +| sendBufferSize | | Integer | Sets the SO_SNDBUF option to the specified value (in bytes) + +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + 4+^s| codec +| charsetName | | String | Set the CamelCharsetName property on the exchange + 4+^s| timeout +| acceptTimeout | 60000 | int | Timeout (in milliseconds) while waiting for a TCP connection TCP Server Only + +| bindRetryInterval | 5000 | int | TCP Server Only - The number of milliseconds to wait between bind attempts + +| bindTimeout | 30000 | int | TCP Server Only - The number of milliseconds to retry binding to a server port + +| connectTimeout | 30000 | int | Timeout (in milliseconds) for establishing for a TCP connection TCP Client only + +| maxReceiveTimeouts | -1 | int | The maximum number of timeouts (specified by receiveTimeout) allowed before the TCP Connection will be reset. + +| readTimeout | 500 | int | The SO_TIMEOUT value (in milliseconds) used after the start of an MLLP frame has been received + +| receiveTimeout | 10000 | int | The SO_TIMEOUT value (in milliseconds) used when waiting for the start of an MLLP frame |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc b/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc index 6ae0e72..44b7d80 100644 --- a/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc +++ b/components/camel-mongodb-gridfs/src/main/docs/mongodb-gridfs-component.adoc @@ -49,26 +49,43 @@ with the following path and query parameters: #### Query Parameters (17 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| bucket | common | fs | String | Sets the name of the GridFS bucket within the database. Default is fs. -| database | common | | String | *Required* Sets the name of the MongoDB database to target -| readPreference | common | | ReadPreference | Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The link com.mongodb.ReadPreferencevalueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest primary or secondary etc. -| writeConcern | common | | WriteConcern | Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the link WriteConcernvalueOf(String) method. -| writeConcernRef | common | | WriteConcern | Set the WriteConcern for write operations on MongoDB passing in the bean ref to a custom WriteConcern which exists in the Registry. You can also use standard WriteConcerns by passing in their key. See the link setWriteConcern(String) setWriteConcern method. -| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. -| delay | consumer | 500 | long | Sets the delay between polls within the Consumer. Default is 500ms -| fileAttributeName | consumer | camel-processed | String | If the QueryType uses a FileAttribute this sets the name of the attribute that is used. Default is camel-processed. -| initialDelay | consumer | 1000 | long | Sets the initialDelay before the consumer will start polling. Default is 1000ms -| persistentTSCollection | consumer | camel-timestamps | String | If the QueryType uses a persistent timestamp this sets the name of the collection within the DB to store the timestamp. -| persistentTSObject | consumer | camel-timestamp | String | If the QueryType uses a persistent timestamp this is the ID of the object in the collection to store the timestamp. -| query | consumer | | String | Additional query parameters (in JSON) that are used to configure the query used for finding files in the GridFsConsumer -| queryStrategy | consumer | TimeStamp | QueryStrategy | Sets the QueryStrategy that is used for polling for new files. Default is Timestamp -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| operation | producer | | String | Sets the operation this endpoint will execute against GridRS. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| bucket | fs | String | Sets the name of the GridFS bucket within the database. Default is fs. + +| database | | String | *Required* Sets the name of the MongoDB database to target + +| readPreference | | ReadPreference | Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The link com.mongodb.ReadPreferencevalueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest primary or secondary etc. + +| writeConcern | | WriteConcern | Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the link WriteConcernvalueOf(String) method. + +| writeConcernRef | | WriteConcern | Set the WriteConcern for write operations on MongoDB passing in the bean ref to a custom WriteConcern which exists in the Registry. You can also use standard WriteConcerns by passing in their key. See the link setWriteConcern(String) setWriteConcern method. + 4+^s| consumer +| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. + +| delay | 500 | long | Sets the delay between polls within the Consumer. Default is 500ms + +| fileAttributeName | camel-processed | String | If the QueryType uses a FileAttribute this sets the name of the attribute that is used. Default is camel-processed. + +| initialDelay | 1000 | long | Sets the initialDelay before the consumer will start polling. Default is 1000ms + +| persistentTSCollection | camel-timestamps | String | If the QueryType uses a persistent timestamp this sets the name of the collection within the DB to store the timestamp. + +| persistentTSObject | camel-timestamp | String | If the QueryType uses a persistent timestamp this is the ID of the object in the collection to store the timestamp. + +| query | | String | Additional query parameters (in JSON) that are used to configure the query used for finding files in the GridFsConsumer + +| queryStrategy | TimeStamp | QueryStrategy | Sets the QueryStrategy that is used for polling for new files. Default is Timestamp + 4+^s| consumer (advanced) +| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + 4+^s| producer +| operation | | String | Sets the operation this endpoint will execute against GridRS. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-mongodb/src/main/docs/mongodb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-mongodb/src/main/docs/mongodb-component.adoc b/components/camel-mongodb/src/main/docs/mongodb-component.adoc index 283e7b5..f19cbe2 100644 --- a/components/camel-mongodb/src/main/docs/mongodb-component.adoc +++ b/components/camel-mongodb/src/main/docs/mongodb-component.adoc @@ -76,32 +76,55 @@ with the following path and query parameters: #### Query Parameters (23 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| collection | common | | String | Sets the name of the MongoDB collection to bind to this endpoint -| collectionIndex | common | | String | Sets the collection index (JSON FORMAT : field1 : order1 field2 : order2) -| createCollection | common | true | boolean | Create collection during initialisation if it doesn't exist. Default is true. -| database | common | | String | Sets the name of the MongoDB database to target -| operation | common | | MongoDbOperation | Sets the operation this endpoint will execute against MongoDB. For possible values see MongoDbOperation. -| outputType | common | | MongoDbOutputType | Convert the output of the producer to the selected type : DBObjectList DBObject or DBCursor. DBObjectList or DBObject applies to findAll. DBCursor applies to all other operations. -| writeConcern | common | ACKNOWLEDGED | WriteConcern | Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the link WriteConcernvalueOf(String) method. -| bridgeErrorHandler | consumer | 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. -| exceptionHandler | consumer (advanced) | | 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 | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| cursorRegenerationDelay | advanced | 1000 | long | MongoDB tailable cursors will block until new data arrives. If no new data is inserted after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor and if the attempt fails how long before the next attempt is made. Default value is 1000ms. -| dynamicity | advanced | false | boolean | Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit. -| readPreference | advanced | | ReadPreference | Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The link ReadPreferencevalueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest primary or secondary etc. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| writeResultAsHeader | advanced | false | boolean | In write operations it determines whether instead of returning WriteResult as the body of the OUT message we transfer the IN message to the OUT and attach the WriteResult as a header. -| persistentId | tail | | String | One tail tracking collection can host many trackers for several tailable consumers. To keep them separate each tracker should have its own unique persistentId. -| persistentTailTracking | tail | false | boolean | Enable persistent tail tracking which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up the endpoint will recover the cursor from the point where it last stopped slurping records. -| persistRecords | tail | -1 | int | Sets the number of tailed records after which the tail tracking data is persisted to MongoDB. -| tailTrackCollection | tail | | String | Collection where tail tracking information will be persisted. If not specified link MongoDbTailTrackingConfigDEFAULT_COLLECTION will be used by default. -| tailTrackDb | tail | | String | Indicates what database the tail tracking mechanism will persist to. If not specified the current database will be picked by default. Dynamicity will not be taken into account even if enabled i.e. the tail tracking database will not vary past endpoint initialisation. -| tailTrackField | tail | | String | Field where the last tracked value will be placed. If not specified link MongoDbTailTrackingConfigDEFAULT_FIELD will be used by default. -| tailTrackIncreasingField | tail | | String | Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField lastValue (possibly recovered from persistent tail tracking). Can be of type Integer Date String etc. NOTE: No support for dot notation at the current time so the field should be at the top level of the document. -| tailTrackingStrategy | tail | LITERAL | MongoDBTailTrackingEnum | Sets the strategy used to extract the increasing field value and to create the query to position the tail cursor. +| Name | Default | Java Type | Description + +| collection | | String | Sets the name of the MongoDB collection to bind to this endpoint + +| collectionIndex | | String | Sets the collection index (JSON FORMAT : field1 : order1 field2 : order2) + +| createCollection | true | boolean | Create collection during initialisation if it doesn't exist. Default is true. + +| database | | String | Sets the name of the MongoDB database to target + +| operation | | MongoDbOperation | Sets the operation this endpoint will execute against MongoDB. For possible values see MongoDbOperation. + +| outputType | | MongoDbOutputType | Convert the output of the producer to the selected type : DBObjectList DBObject or DBCursor. DBObjectList or DBObject applies to findAll. DBCursor applies to all other operations. + +| writeConcern | ACKNOWLEDGED | WriteConcern | Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the link WriteConcernvalueOf(String) method. + 4+^s| consumer +| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. + 4+^s| consumer (advanced) +| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + 4+^s| advanced +| cursorRegenerationDelay | 1000 | long | MongoDB tailable cursors will block until new data arrives. If no new data is inserted after some time the cursor will be automatically freed and closed by the MongoDB server. The client is expected to regenerate the cursor if needed. This value specifies the time to wait before attempting to fetch a new cursor and if the attempt fails how long before the next attempt is made. Default value is 1000ms. + +| dynamicity | false | boolean | Sets whether this endpoint will attempt to dynamically resolve the target database and collection from the incoming Exchange properties. Can be used to override at runtime the database and collection specified on the otherwise static endpoint URI. It is disabled by default to boost performance. Enabling it will take a minimal performance hit. + +| readPreference | | ReadPreference | Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The link ReadPreferencevalueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest primary or secondary etc. + +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + +| writeResultAsHeader | false | boolean | In write operations it determines whether instead of returning WriteResult as the body of the OUT message we transfer the IN message to the OUT and attach the WriteResult as a header. + 4+^s| tail +| persistentId | | String | One tail tracking collection can host many trackers for several tailable consumers. To keep them separate each tracker should have its own unique persistentId. + +| persistentTailTracking | false | boolean | Enable persistent tail tracking which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up the endpoint will recover the cursor from the point where it last stopped slurping records. + +| persistRecords | -1 | int | Sets the number of tailed records after which the tail tracking data is persisted to MongoDB. + +| tailTrackCollection | | String | Collection where tail tracking information will be persisted. If not specified link MongoDbTailTrackingConfigDEFAULT_COLLECTION will be used by default. + +| tailTrackDb | | String | Indicates what database the tail tracking mechanism will persist to. If not specified the current database will be picked by default. Dynamicity will not be taken into account even if enabled i.e. the tail tracking database will not vary past endpoint initialisation. + +| tailTrackField | | String | Field where the last tracked value will be placed. If not specified link MongoDbTailTrackingConfigDEFAULT_FIELD will be used by default. + +| tailTrackIncreasingField | | String | Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated. The cursor will be (re)created with a query of type: tailTrackIncreasingField lastValue (possibly recovered from persistent tail tracking). Can be of type Integer Date String etc. NOTE: No support for dot notation at the current time so the field should be at the top level of the document. + +| tailTrackingStrategy | LITERAL | MongoDBTailTrackingEnum | Sets the strategy used to extract the increasing field value and to create the query to position the tail cursor. |======================================================================= // endpoint options: END
