http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/components/camel-crypto/src/main/docs/crypto-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-crypto/src/main/docs/crypto-component.adoc b/components/camel-crypto/src/main/docs/crypto-component.adoc index 2cabaf3..0a993e6 100644 --- a/components/camel-crypto/src/main/docs/crypto-component.adoc +++ b/components/camel-crypto/src/main/docs/crypto-component.adoc @@ -18,7 +18,7 @@ Options ^^^^^^^ // component options: START -The Crypto (JCE) component supports 21 options which are listed below. +The Crypto (JCE) component supports 1 options which are listed below. @@ -26,27 +26,7 @@ The Crypto (JCE) component supports 21 options which are listed below. [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description -| configuration | DigitalSignatureConfiguration | To use the shared DigitalSignatureConfiguration as configuration. Properties of the shared configuration can also be set individually. -| name | String | The logical name of this operation. -| algorithm | String | Sets the JCE name of the Algorithm that should be used for the signer. -| alias | String | Sets the alias used to query the KeyStore for keys and link Certificate Certificates to be used in signing and verifying exchanges. This value can be provided at runtime via the message header link DigitalSignatureConstantsKEYSTORE_ALIAS -| privateKey | PrivateKey | Set the PrivateKey that should be used to sign the exchange -| privateKeyName | String | Sets the reference name for a PrivateKey that can be fond in the registry. -| publicKey | PublicKey | Set the PublicKey that should be used to verify the signature in the exchange. -| publicKeyName | String | Sets the reference name for a publicKey that can be fond in the registry. -| certificate | Certificate | Set the Certificate that should be used to verify the signature in the exchange based on its payload. -| certificateName | String | Sets the reference name for a PrivateKey that can be fond in the registry. -| keystore | KeyStore | Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges. A KeyStore is typically used with an alias either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore then this single entry will be used. -| keystoreName | String | Sets the reference name for a Keystore that can be fond in the registry. -| password | char[] | Sets the password used to access an aliased PrivateKey in the KeyStore. -| keyStoreParameters | KeyStoreParameters | Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges based on the given KeyStoreParameters. A KeyStore is typically used with an alias either one supplied in the Route definition or dynamically via the message header CamelSignatureKeyStoreAlias. If no alias is supplied and there is only a single entry in the Keystore then this single entry will be used. -| secureRandomName | String | Sets the reference name for a SecureRandom that can be fond in the registry. -| secureRandom | SecureRandom | Set the SecureRandom used to initialize the Signature service -| bufferSize | Integer | Set the size of the buffer used to read in the Exchange payload data. -| provider | String | Set the id of the security provider that provides the configured Signature algorithm. -| signatureHeaderName | String | Set the name of the message header that should be used to store the base64 encoded signature. This defaults to 'CamelDigitalSignature' -| clearHeaders | boolean | Determines if the Signature specific headers be cleared after signing and verification. Defaults to true and should only be made otherwise at your extreme peril as vital private information such as Keys and passwords may escape if unset. -| cryptoOperation | String | Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto:sign sets sign as the operation. +| configuration | DigitalSignatureConfiguration | To use the shared DigitalSignatureConfiguration as configuration |======================================================================= {% endraw %} // component options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/components/camel-docker/src/main/docs/docker-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-docker/src/main/docs/docker-component.adoc b/components/camel-docker/src/main/docs/docker-component.adoc index 0a14fc4..e03136b 100644 --- a/components/camel-docker/src/main/docs/docker-component.adoc +++ b/components/camel-docker/src/main/docs/docker-component.adoc @@ -38,7 +38,7 @@ The Docker component supports 1 options which are listed below. [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description -| configuration | DockerConfiguration | To use the shared docker configuration. Properties of the shared configuration can also be set individually. +| configuration | DockerConfiguration | To use the shared docker configuration |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/components/camel-facebook/src/main/docs/facebook-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-facebook/src/main/docs/facebook-component.adoc b/components/camel-facebook/src/main/docs/facebook-component.adoc index a94d1ec..5bec884 100644 --- a/components/camel-facebook/src/main/docs/facebook-component.adoc +++ b/components/camel-facebook/src/main/docs/facebook-component.adoc @@ -58,7 +58,7 @@ to application APIs. // component options: START -The Facebook component supports 28 options which are listed below. +The Facebook component supports 1 options which are listed below. @@ -66,34 +66,7 @@ The Facebook component supports 28 options which are listed below. [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description -| configuration | FacebookConfiguration | To use the shared configuration. Properties of the shared configuration can also be set individually. -| oAuthAccessToken | String | The user access token -| oAuthAccessTokenURL | String | OAuth access token URL -| oAuthAppId | String | The application Id -| oAuthAppSecret | String | The application Secret -| oAuthAuthorizationURL | String | OAuth authorization URL -| clientURL | String | Facebook4J API client URL -| clientVersion | String | Facebook4J client API version -| debugEnabled | Boolean | Enables deubg output. Effective only with the embedded logger -| gzipEnabled | Boolean | Use Facebook GZIP encoding -| httpConnectionTimeout | Integer | Http connection timeout in milliseconds -| httpDefaultMaxPerRoute | Integer | HTTP maximum connections per route -| httpMaxTotalConnections | Integer | HTTP maximum total connections -| httpProxyHost | String | HTTP proxy server host name -| httpProxyPassword | String | HTTP proxy server password -| httpProxyPort | Integer | HTTP proxy server port -| httpProxyUser | String | HTTP proxy server user name -| httpReadTimeout | Integer | Http read timeout in milliseconds -| httpRetryCount | Integer | Number of HTTP retries -| httpRetryIntervalSeconds | Integer | HTTP retry interval in seconds -| httpStreamingReadTimeout | Integer | HTTP streaming read timeout in milliseconds -| jsonStoreEnabled | Boolean | If set to true raw JSON forms will be stored in DataObjectFactory -| mbeanEnabled | Boolean | If set to true Facebook4J mbean will be registerd -| oAuthPermissions | String | Default OAuth permissions. Comma separated permission names. See https://developers.facebook.com/docs/reference/login/permissions for the detail -| prettyDebugEnabled | Boolean | Prettify JSON debug output if set to true -| restBaseURL | String | API base URL -| useSSL | Boolean | Use SSL -| videoBaseURL | String | Video API base URL +| configuration | FacebookConfiguration | To use the shared configuration |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/components/camel-ganglia/src/main/docs/ganglia-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ganglia/src/main/docs/ganglia-component.adoc b/components/camel-ganglia/src/main/docs/ganglia-component.adoc index 4d8eaed..7b887b1 100644 --- a/components/camel-ganglia/src/main/docs/ganglia-component.adoc +++ b/components/camel-ganglia/src/main/docs/ganglia-component.adoc @@ -58,7 +58,7 @@ Ganglia component and endpoint URI options // component options: START -The Ganglia component supports 15 options which are listed below. +The Ganglia component supports 1 options which are listed below. @@ -66,21 +66,7 @@ The Ganglia component supports 15 options which are listed below. [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description -| configuration | GangliaConfiguration | To use the shared configuration. Properties of the shared configuration can also be set individually. -| host | String | Host name for Ganglia server -| port | int | Port for Ganglia server -| mode | UDPAddressingMode | Send the UDP metric packets using MULTICAST or UNICAST -| ttl | int | If using multicast set the TTL of the packets -| wireFormat31x | boolean | Use the wire format of Ganglia 3.1.0 and later versions. Set this to false to use Ganglia 3.0.x or earlier. -| spoofHostname | String | Spoofing information IP:hostname -| groupName | String | The group that the metric belongs to. -| prefix | String | Prefix the metric name with this string and an underscore. -| metricName | String | The name to use for the metric. -| type | GMetricType | The type of value -| slope | GMetricSlope | The slope -| units | String | Any unit of measurement that qualifies the metric e.g. widgets litres bytes. Do not include a prefix such as k (kilo) or m (milli) other tools may scale the units later. The value should be unscaled. -| tmax | int | Maximum time in seconds that the value can be considered current. After this Ganglia considers the value to have expired. -| dmax | int | Minumum time in seconds before Ganglia will purge the metric value if it expires. Set to 0 and the value will remain in Ganglia indefinitely until a gmond agent restart. +| configuration | GangliaConfiguration | To use the shared configuration |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc index f2ee048..2a89ba0 100644 --- a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc +++ b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc @@ -43,7 +43,7 @@ for this component: // component options: START -The Google Calendar component supports 13 options which are listed below. +The Google Calendar component supports 2 options which are listed below. @@ -51,19 +51,8 @@ The Google Calendar component supports 13 options which are listed below. [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description -| configuration | GoogleCalendarConfiguration | To use the shared configuration. Properties of the shared configuration can also be set individually. +| configuration | GoogleCalendarConfiguration | To use the shared configuration | clientFactory | GoogleCalendarClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory -| apiName | GoogleCalendarApiName | What kind of operation to perform -| methodName | String | What sub operation to use for the selected operation -| clientId | String | Client ID of the calendar application -| emailAddress | String | The emailAddress of the Google Service Account. -| clientSecret | String | Client secret of the calendar application -| accessToken | String | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. -| refreshToken | String | OAuth 2 refresh token. Using this the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. -| applicationName | String | Google calendar application name. Example would be camel-google-calendar/1.0 -| scopes | List | Specifies the level of permissions you want a calendar application to have to a user account. See https://developers.google.com/google-apps/calendar/auth for more info. -| p12FileName | String | The name of the p12 file which has the private key to use with the Google Service Account. -| user | String | The email address of the user the application is trying to impersonate in the service account flow |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/components/camel-google-drive/src/main/docs/google-drive-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-google-drive/src/main/docs/google-drive-component.adoc b/components/camel-google-drive/src/main/docs/google-drive-component.adoc index 244c06c..1da796f 100644 --- a/components/camel-google-drive/src/main/docs/google-drive-component.adoc +++ b/components/camel-google-drive/src/main/docs/google-drive-component.adoc @@ -68,7 +68,7 @@ GoogleDriveComponent // component options: START -The Google Drive component supports 10 options which are listed below. +The Google Drive component supports 2 options which are listed below. @@ -76,16 +76,8 @@ The Google Drive component supports 10 options which are listed below. [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description -| configuration | GoogleDriveConfiguration | To use the shared configuration. Properties of the shared configuration can also be set individually. +| configuration | GoogleDriveConfiguration | To use the shared configuration | clientFactory | GoogleDriveClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory -| apiName | GoogleDriveApiName | What kind of operation to perform -| methodName | String | What sub operation to use for the selected operation -| clientId | String | Client ID of the drive application -| clientSecret | String | Client secret of the drive application -| accessToken | String | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. -| refreshToken | String | OAuth 2 refresh token. Using this the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. -| applicationName | String | Google drive application name. Example would be camel-google-drive/1.0 -| scopes | List | Specifies the level of permissions you want a drive application to have to a user account. See https://developers.google.com/drive/web/scopes for more info. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/components/camel-google-mail/src/main/docs/google-mail-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-google-mail/src/main/docs/google-mail-component.adoc b/components/camel-google-mail/src/main/docs/google-mail-component.adoc index f29e98a..40c99b1 100644 --- a/components/camel-google-mail/src/main/docs/google-mail-component.adoc +++ b/components/camel-google-mail/src/main/docs/google-mail-component.adoc @@ -65,7 +65,7 @@ GoogleMailComponent // component options: START -The Google Mail component supports 10 options which are listed below. +The Google Mail component supports 2 options which are listed below. @@ -73,16 +73,8 @@ The Google Mail component supports 10 options which are listed below. [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description -| configuration | GoogleMailConfiguration | To use the shared configuration. Properties of the shared configuration can also be set individually. +| configuration | GoogleMailConfiguration | To use the shared configuration | clientFactory | GoogleMailClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleMailClientFactory -| apiName | GoogleMailApiName | What kind of operation to perform -| methodName | String | What sub operation to use for the selected operation -| clientId | String | Client ID of the mail application -| clientSecret | String | Client secret of the mail application -| accessToken | String | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. -| refreshToken | String | OAuth 2 refresh token. Using this the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. -| applicationName | String | Google mail application name. Example would be camel-google-mail/1.0 -| scopes | List | Specifies the level of permissions you want a mail application to have to a user account. See https://developers.google.com/gmail/api/auth/scopes for more info. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/components/camel-kestrel/src/main/docs/kestrel-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-kestrel/src/main/docs/kestrel-component.adoc b/components/camel-kestrel/src/main/docs/kestrel-component.adoc index 8062079..4eb0c4d 100644 --- a/components/camel-kestrel/src/main/docs/kestrel-component.adoc +++ b/components/camel-kestrel/src/main/docs/kestrel-component.adoc @@ -70,7 +70,7 @@ Options // component options: START -The Kestrel component supports 4 options which are listed below. +The Kestrel component supports 1 options which are listed below. @@ -79,9 +79,6 @@ The Kestrel component supports 4 options which are listed below. |======================================================================= | Name | Java Type | Description | configuration | KestrelConfiguration | To use a shared configured configuration as base for creating new endpoints. -| addresses | String[] | The addresses -| waitTimeMs | int | The wait time in milliseconds -| concurrentConsumers | int | The number of concurrent consumers |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc index 6a964af..5a1bdbb 100644 --- a/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc +++ b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc @@ -58,7 +58,7 @@ LinkedInComponent // component options: START -The Linkedin component supports 12 options which are listed below. +The Linkedin component supports 1 options which are listed below. @@ -67,17 +67,6 @@ The Linkedin component supports 12 options which are listed below. |======================================================================= | Name | Java Type | Description | configuration | LinkedInConfiguration | To use the shared configuration -| apiName | LinkedInApiName | What kind of operation to perform -| methodName | String | What sub operation to use for the selected operation -| userName | String | LinkedIn user account name MUST be provided -| userPassword | String | LinkedIn account password -| secureStorage | OAuthSecureStorage | Callback interface for providing an OAuth token or to store the token generated by the component. The callback should return null on the first call and then save the created token in the saveToken() callback. If the callback returns null the first time a userPassword MUST be provided -| clientId | String | LinkedIn application client ID -| clientSecret | String | LinkedIn application client secret -| scopes | OAuthScope[] | List of LinkedIn scopes as specified at https://developer.linkedin.com/documents/authenticationgranting -| redirectUri | String | Application redirect URI although the component never redirects to this page to avoid having to have a functioning redirect server. So for testing one could use https://localhost -| httpParams | Map | Custom HTTP params for example proxy host and port use constants from AllClientPNames -| lazyAuth | boolean | Flag to enable/disable lazy OAuth default is true. when enabled OAuth token retrieval or generation is not done until the first REST call |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/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 92d3930..86a06e2 100644 --- a/components/camel-lucene/src/main/docs/lucene-component.adoc +++ b/components/camel-lucene/src/main/docs/lucene-component.adoc @@ -57,7 +57,7 @@ Insert Options // component options: START -The Lucene component supports 7 options which are listed below. +The Lucene component supports 1 options which are listed below. @@ -65,13 +65,7 @@ The Lucene component supports 7 options which are listed below. [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description -| config | LuceneConfiguration | To use a shared lucene configuration. Properties of the shared configuration can also be set individually. -| host | String | The URL to the lucene server -| operation | LuceneOperation | Operation to do such as insert or query. -| sourceDirectory | File | An optional directory containing files to be used to be analyzed and added to the index at producer startup. -| indexDirectory | File | A file system directory in which index files are created upon analysis of the document by the specified analyzer -| analyzer | Analyzer | An Analyzer builds TokenStreams which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box -| maxHits | int | An integer value that limits the result set of the search operation +| config | LuceneConfiguration | To use a shared lucene configuration |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/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 5ca70fe..96d614a 100644 --- a/components/camel-mail/src/main/docs/mail-component.adoc +++ b/components/camel-mail/src/main/docs/mail-component.adoc @@ -80,7 +80,7 @@ You can append query options to the URI in the following format, // component options: START -The Mail component supports 38 options which are listed below. +The Mail component supports 2 options which are listed below. @@ -88,44 +88,8 @@ The Mail component supports 38 options which are listed below. [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description -| configuration | MailConfiguration | Sets the Mail configuration. Properties of the shared configuration can also be set individually. +| configuration | MailConfiguration | Sets the Mail configuration | contentTypeResolver | ContentTypeResolver | Resolver to determine Content-Type for file attachments. -| javaMailSender | JavaMailSender | To use a custom JavaMailSender for sending emails. -| host | String | The mail server host name -| javaMailProperties | Properties | Sets the java mail options. Will clear any default properties and only use the properties provided for this method. -| 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. -| password | String | The password for login -| subject | String | The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option. -| port | int | The port number of the mail server -| protocol | String | The protocol for communicating with the mail server -| 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. -| username | String | The username for login -| from | String | The from email address -| delete | 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. -| mapMailMessage | 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). -| folderName | String | The folder to poll. -| ignoreUriScheme | 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. -| unseen | boolean | Whether to limit by unseen mails only. -| to | String | Sets the To email address. Separate multiple email addresses with comma. -| cc | String | Sets the CC email address. Separate multiple email addresses with comma. -| bcc | String | Sets the BCC email address. Separate multiple email addresses with comma. -| replyTo | String | The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma. -| fetchSize | 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. -| debugMode | boolean | Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default. -| connectionTimeout | int | The connection timeout in milliseconds. -| dummyTrustManager | boolean | To use a dummy security setting for trusting all certificates. Should only be used for development mode and not production. -| contentType | String | The mail message content type. Use text/html for HTML mails. -| alternativeBodyHeader | 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. -| useInlineAttachments | boolean | Whether to use disposition inline or attachment. -| ignoreUnsupportedCharset | 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. -| disconnect | boolean | Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll. -| closeFolder | 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. -| sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters. -| 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. -| peek | 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. -| skipFailedMessage | 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. -| handleFailedMessage | 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. -| attachmentsContentTransferEncodingResolver | AttachmentsContentTransferEncodingResolver | To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/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 aeea588..0dcb739 100644 --- a/components/camel-mina/src/main/docs/mina-component.adoc +++ b/components/camel-mina/src/main/docs/mina-component.adoc @@ -68,7 +68,7 @@ Options // component options: START -The Mina component supports 21 options which are listed below. +The Mina component supports 1 options which are listed below. @@ -76,27 +76,7 @@ The Mina component supports 21 options which are listed below. [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description -| configuration | MinaConfiguration | To use the shared mina configuration. Properties of the shared configuration can also be set individually. -| protocol | String | Protocol to use -| host | String | Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server. -| port | int | Port number -| sync | boolean | Setting to set endpoint as one-way or request-response. -| textline | 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. -| codec | ProtocolCodecFactory | To use a custom minda codec implementation. -| 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 -| timeout | 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. -| lazySessionCreation | boolean | Sessions can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. -| transferExchange | 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. -| encoderMaxLineLength | 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. -| decoderMaxLineLength | int | To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024. -| minaLogger | boolean | You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output. -| filters | List | You can set a list of Mina IoFilters to use. -| allowDefaultCodec | 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. -| disconnect | boolean | Whether or not to disconnect(close) from Mina session right after use. Can be used for both consumer and producer. -| disconnectOnNoReply | boolean | If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back. -| noReplyLogLevel | LoggingLevel | If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back. -| clientMode | boolean | If the clientMode is true mina consumer will connect the address as a TCP client. +| configuration | MinaConfiguration | To use the shared mina configuration. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/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 e3ca7fd..d624be9 100644 --- a/components/camel-mina2/src/main/docs/mina2-component.adoc +++ b/components/camel-mina2/src/main/docs/mina2-component.adoc @@ -69,7 +69,7 @@ Options // component options: START -The Mina2 component supports 26 options which are listed below. +The Mina2 component supports 1 options which are listed below. @@ -77,32 +77,7 @@ The Mina2 component supports 26 options which are listed below. [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description -| configuration | Mina2Configuration | To use the shared mina configuration. Properties of the shared configuration can also be set individually. -| protocol | String | Protocol to use -| host | String | Hostname to use. Use localhost or 0.0.0.0 for local server as consumer. For producer use the hostname or ip address of the remote server. -| port | int | Port number -| sync | boolean | Setting to set endpoint as one-way or request-response. -| textline | 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. -| codec | ProtocolCodecFactory | To use a custom minda codec implementation. -| 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 -| timeout | 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. -| lazySessionCreation | boolean | Sessions can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. -| transferExchange | 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. -| encoderMaxLineLength | 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. -| decoderMaxLineLength | int | To set the textline protocol decoder max line length. By default the default value of Mina itself is used which are 1024. -| minaLogger | boolean | You can enable the Apache MINA logging filter. Apache MINA uses slf4j logging at INFO level to log all input and output. -| filters | List | You can set a list of Mina IoFilters to use. -| allowDefaultCodec | 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. -| disconnect | boolean | Whether or not to disconnect(close) from Mina session right after use. Can be used for both consumer and producer. -| disconnectOnNoReply | boolean | If sync is enabled then this option dictates MinaConsumer if it should disconnect where there is no reply to send back. -| noReplyLogLevel | LoggingLevel | If sync is enabled this option dictates MinaConsumer which logging level to use when logging a there is no reply to send back. -| sslContextParameters | SSLContextParameters | To configure SSL security. -| autoStartTls | boolean | Whether to auto start SSL handshake. -| maximumPoolSize | int | Number of worker threads in the worker pool for TCP and UDP -| orderedThreadPoolExecutor | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. -| cachedAddress | boolean | Whether to create the InetAddress once and reuse. Setting this to false allows to pickup DNS changes in the network. -| clientMode | boolean | If the clientMode is true mina consumer will connect the address as a TCP client. +| configuration | Mina2Configuration | To use the shared mina configuration. |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/components/camel-nagios/src/main/docs/nagios-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-nagios/src/main/docs/nagios-component.adoc b/components/camel-nagios/src/main/docs/nagios-component.adoc index 3762623..2e44d29 100644 --- a/components/camel-nagios/src/main/docs/nagios-component.adoc +++ b/components/camel-nagios/src/main/docs/nagios-component.adoc @@ -44,7 +44,7 @@ Options // component options: START -The Nagios component supports 7 options which are listed below. +The Nagios component supports 1 options which are listed below. @@ -52,13 +52,7 @@ The Nagios component supports 7 options which are listed below. [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description -| configuration | NagiosConfiguration | To use a shared configuraiton. Properties of the shared configuration can also be set individually. -| host | String | This is the address of the Nagios host where checks should be send. -| port | int | The port number of the host. -| connectionTimeout | int | Connection timeout in millis. -| timeout | int | Sending timeout in millis. -| password | String | Password to be authenticated when sending checks to Nagios. -| encryptionMethod | NagiosEncryptionMethod | To specify an encryption method. +| configuration | NagiosConfiguration | To use a shared NagiosConfiguration |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/components/camel-netty-http/src/main/docs/netty-http-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty-http/src/main/docs/netty-http-component.adoc b/components/camel-netty-http/src/main/docs/netty-http-component.adoc index 67b4cd5..ee90c80 100644 --- a/components/camel-netty-http/src/main/docs/netty-http-component.adoc +++ b/components/camel-netty-http/src/main/docs/netty-http-component.adoc @@ -82,7 +82,7 @@ options related to UDP transport. // component options: START -The Netty HTTP component supports 68 options which are listed below. +The Netty HTTP component supports 5 options which are listed below. @@ -93,71 +93,8 @@ The Netty HTTP component supports 68 options which are listed below. | nettyHttpBinding | NettyHttpBinding | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. | headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. | securityConfiguration | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. -| configuration | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. Properties of the shared configuration can also be set individually. +| configuration | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. | maximumPoolSize | int | The core pool size for the ordered thread pool if its in use. The default value is 16. -| orderedThreadPoolExecutor | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. See details at the netty javadoc of org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor for more details. -| producerPoolMaxActive | int | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit. -| producerPoolMinIdle | int | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. -| producerPoolMaxIdle | int | Sets the cap on the number of idle instances in the pool. -| producerPoolMinEvictableIdle | long | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. -| producerPoolEnabled | boolean | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply. -| udpConnectionlessSending | boolean | This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port. -| clientMode | boolean | If the clientMode is true netty consumer will connect the address as a TCP client. -| useChannelBuffer | boolean | If the useChannelBuffer is true netty producer will turn the message body into ChannelBuffer before sending it out. -| maxChannelMemorySize | long | The maximum total size of the queued events per channel when using orderedThreadPoolExecutor. Specify 0 to disable. -| maxTotalMemorySize | long | The maximum total size of the queued events for this pool when using orderedThreadPoolExecutor. Specify 0 to disable. -| protocol | String | The protocol to use which can be tcp or udp. -| host | String | The hostname. For the consumer the hostname is localhost or 0.0.0.0 For the producer the hostname is the remote host to connect to -| port | int | The host port number -| broadcast | boolean | Setting to choose Multicast over UDP -| sendBufferSize | long | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. -| receiveBufferSize | long | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. -| receiveBufferSizePredictor | int | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. -| workerCount | int | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty -| bossCount | int | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty -| keepAlive | boolean | Setting to ensure socket is not closed due to inactivity -| tcpNoDelay | boolean | Setting to improve TCP protocol performance -| reuseAddress | boolean | Setting to facilitate socket multiplexing -| connectTimeout | long | Time to wait for a socket connection to be available. Value is in millis. -| backlog | int | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting. -| ssl | boolean | Setting to specify whether SSL encryption is applied to this endpoint -| sslClientCertHeaders | boolean | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range. -| sslHandler | SslHandler | Reference to a class that could be used to return an SSL Handler -| sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters -| needClientAuth | boolean | Configures whether the server needs client authentication when using SSL. -| keyStoreResource | String | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. -| trustStoreResource | String | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. -| keyStoreFormat | String | Keystore format to be used for payload encryption. Defaults to JKS if not set -| securityProvider | String | Security provider to be used for payload encryption. Defaults to SunX509 if not set. -| passphrase | String | Password setting to use in order to encrypt/decrypt payloads sent using SSH -| serverPipelineFactory | ServerPipelineFactory | To use a custom ServerPipelineFactory -| requestTimeout | long | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. -| nettyServerBootstrapFactory | NettyServerBootstrapFactory | To use a custom NettyServerBootstrapFactory -| sync | boolean | Setting to set endpoint as one-way or request-response -| textline | 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. -| options | Map | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. -| decoderMaxLineLength | int | The max line length to use for the textline codec. -| bossPool | BossPool | To use a explicit org.jboss.netty.channel.socket.nio.BossPool as the boss thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own boss pool with 1 core thread. -| delimiter | TextLineDelimiter | The delimiter to use for the textline codec. Possible values are LINE and NULL. -| autoAppendDelimiter | boolean | Whether or not to auto append missing end delimiter when sending using the textline codec. -| workerPool | WorkerPool | To use a explicit org.jboss.netty.channel.socket.nio.WorkerPool as the worker thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own worker pool with 2 x cpu count core threads. -| channelGroup | ChannelGroup | To use a explicit ChannelGroup. -| encoding | String | The encoding (a charset name) to use for the textline codec. If not provided Camel will use the JVM default Charset. -| networkInterface | String | When using UDP then this option can be used to specify a network interface by its name such as eth0 to join a multicast group. -| decoders | List | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. -| enabledProtocols | String | Which protocols to enable when using SSL -| encoders | List | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. -| encoder | ChannelHandler | A custom ChannelHandler class that can be used to perform special marshalling of outbound payloads. Must override org.jboss.netty.channel.ChannelDownStreamHandler. -| decoder | ChannelHandler | A custom ChannelHandler class that can be used to perform special marshalling of inbound payloads. Must override org.jboss.netty.channel.ChannelUpStreamHandler. -| disconnect | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. -| lazyChannelCreation | boolean | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. -| transferExchange | 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. -| disconnectOnNoReply | boolean | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. -| noReplyLogLevel | LoggingLevel | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. -| serverExceptionCaughtLogLevel | LoggingLevel | If the server (NettyConsumer) catches an exception then its logged using this logging level. -| serverClosedChannelExceptionCaughtLogLevel | LoggingLevel | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. -| allowDefaultCodec | boolean | The netty component installs a default codec if both encoder/deocder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. -| clientPipelineFactory | ClientPipelineFactory | To use a custom ClientPipelineFactory |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/components/camel-netty/src/main/docs/netty-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty/src/main/docs/netty-component.adoc b/components/camel-netty/src/main/docs/netty-component.adoc index 96a8f6d..73af65d 100644 --- a/components/camel-netty/src/main/docs/netty-component.adoc +++ b/components/camel-netty/src/main/docs/netty-component.adoc @@ -62,7 +62,7 @@ Options // component options: START -The Netty component supports 65 options which are listed below. +The Netty component supports 2 options which are listed below. @@ -70,71 +70,8 @@ The Netty component supports 65 options which are listed below. [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description -| configuration | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. Properties of the shared configuration can also be set individually. +| configuration | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. | maximumPoolSize | int | The core pool size for the ordered thread pool if its in use. The default value is 16. -| orderedThreadPoolExecutor | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. See details at the netty javadoc of org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor for more details. -| producerPoolMaxActive | int | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit. -| producerPoolMinIdle | int | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. -| producerPoolMaxIdle | int | Sets the cap on the number of idle instances in the pool. -| producerPoolMinEvictableIdle | long | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. -| producerPoolEnabled | boolean | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply. -| udpConnectionlessSending | boolean | This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port. -| clientMode | boolean | If the clientMode is true netty consumer will connect the address as a TCP client. -| useChannelBuffer | boolean | If the useChannelBuffer is true netty producer will turn the message body into ChannelBuffer before sending it out. -| maxChannelMemorySize | long | The maximum total size of the queued events per channel when using orderedThreadPoolExecutor. Specify 0 to disable. -| maxTotalMemorySize | long | The maximum total size of the queued events for this pool when using orderedThreadPoolExecutor. Specify 0 to disable. -| protocol | String | The protocol to use which can be tcp or udp. -| host | String | The hostname. For the consumer the hostname is localhost or 0.0.0.0 For the producer the hostname is the remote host to connect to -| port | int | The host port number -| broadcast | boolean | Setting to choose Multicast over UDP -| sendBufferSize | long | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. -| receiveBufferSize | long | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. -| receiveBufferSizePredictor | int | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. -| workerCount | int | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty -| bossCount | int | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty -| keepAlive | boolean | Setting to ensure socket is not closed due to inactivity -| tcpNoDelay | boolean | Setting to improve TCP protocol performance -| reuseAddress | boolean | Setting to facilitate socket multiplexing -| connectTimeout | long | Time to wait for a socket connection to be available. Value is in millis. -| backlog | int | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting. -| ssl | boolean | Setting to specify whether SSL encryption is applied to this endpoint -| sslClientCertHeaders | boolean | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range. -| sslHandler | SslHandler | Reference to a class that could be used to return an SSL Handler -| sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters -| needClientAuth | boolean | Configures whether the server needs client authentication when using SSL. -| keyStoreResource | String | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. -| trustStoreResource | String | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. -| keyStoreFormat | String | Keystore format to be used for payload encryption. Defaults to JKS if not set -| securityProvider | String | Security provider to be used for payload encryption. Defaults to SunX509 if not set. -| passphrase | String | Password setting to use in order to encrypt/decrypt payloads sent using SSH -| serverPipelineFactory | ServerPipelineFactory | To use a custom ServerPipelineFactory -| requestTimeout | long | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. -| nettyServerBootstrapFactory | NettyServerBootstrapFactory | To use a custom NettyServerBootstrapFactory -| sync | boolean | Setting to set endpoint as one-way or request-response -| textline | 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. -| options | Map | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. -| decoderMaxLineLength | int | The max line length to use for the textline codec. -| bossPool | BossPool | To use a explicit org.jboss.netty.channel.socket.nio.BossPool as the boss thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own boss pool with 1 core thread. -| delimiter | TextLineDelimiter | The delimiter to use for the textline codec. Possible values are LINE and NULL. -| autoAppendDelimiter | boolean | Whether or not to auto append missing end delimiter when sending using the textline codec. -| workerPool | WorkerPool | To use a explicit org.jboss.netty.channel.socket.nio.WorkerPool as the worker thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own worker pool with 2 x cpu count core threads. -| channelGroup | ChannelGroup | To use a explicit ChannelGroup. -| encoding | String | The encoding (a charset name) to use for the textline codec. If not provided Camel will use the JVM default Charset. -| networkInterface | String | When using UDP then this option can be used to specify a network interface by its name such as eth0 to join a multicast group. -| decoders | List | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. -| enabledProtocols | String | Which protocols to enable when using SSL -| encoders | List | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. -| encoder | ChannelHandler | A custom ChannelHandler class that can be used to perform special marshalling of outbound payloads. Must override org.jboss.netty.channel.ChannelDownStreamHandler. -| decoder | ChannelHandler | A custom ChannelHandler class that can be used to perform special marshalling of inbound payloads. Must override org.jboss.netty.channel.ChannelUpStreamHandler. -| disconnect | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. -| lazyChannelCreation | boolean | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. -| transferExchange | 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. -| disconnectOnNoReply | boolean | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. -| noReplyLogLevel | LoggingLevel | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. -| serverExceptionCaughtLogLevel | LoggingLevel | If the server (NettyConsumer) catches an exception then its logged using this logging level. -| serverClosedChannelExceptionCaughtLogLevel | LoggingLevel | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. -| allowDefaultCodec | boolean | The netty component installs a default codec if both encoder/deocder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. -| clientPipelineFactory | ClientPipelineFactory | To use a custom ClientPipelineFactory |======================================================================= {% endraw %} // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/d485f2f0/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc b/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc index 98cec4c..e18fdab 100644 --- a/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc +++ b/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc @@ -81,7 +81,7 @@ related to UDP transport. // component options: START -The Netty4 HTTP component supports 72 options which are listed below. +The Netty4 HTTP component supports 6 options which are listed below. @@ -93,74 +93,8 @@ The Netty4 HTTP component supports 72 options which are listed below. | headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. | securityConfiguration | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. | maximumPoolSize | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. -| configuration | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. Properties of the shared configuration can also be set individually. +| configuration | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. | executorService | EventExecutorGroup | To use the given EventExecutorGroup -| protocol | String | The protocol to use which can be tcp or udp. -| host | String | The hostname. For the consumer the hostname is localhost or 0.0.0.0 For the producer the hostname is the remote host to connect to -| port | int | The host port number -| broadcast | boolean | Setting to choose Multicast over UDP -| sendBufferSize | int | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. -| receiveBufferSize | int | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. -| receiveBufferSizePredictor | int | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. -| workerCount | int | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty -| bossCount | int | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty -| keepAlive | boolean | Setting to ensure socket is not closed due to inactivity -| tcpNoDelay | boolean | Setting to improve TCP protocol performance -| reuseAddress | boolean | Setting to facilitate socket multiplexing -| connectTimeout | int | Time to wait for a socket connection to be available. Value is in millis. -| backlog | int | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting. -| ssl | boolean | Setting to specify whether SSL encryption is applied to this endpoint -| sslClientCertHeaders | boolean | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range. -| sslHandler | SslHandler | Reference to a class that could be used to return an SSL Handler -| sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters -| needClientAuth | boolean | Configures whether the server needs client authentication when using SSL. -| keyStoreResource | String | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. -| trustStoreResource | String | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. -| keyStoreFormat | String | Keystore format to be used for payload encryption. Defaults to JKS if not set -| securityProvider | String | Security provider to be used for payload encryption. Defaults to SunX509 if not set. -| passphrase | String | Password setting to use in order to encrypt/decrypt payloads sent using SSH -| serverInitializerFactory | ServerInitializerFactory | To use a custom ServerInitializerFactory -| nettyServerBootstrapFactory | NettyServerBootstrapFactory | To use a custom NettyServerBootstrapFactory -| requestTimeout | long | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. -| sync | boolean | Setting to set endpoint as one-way or request-response -| options | Map | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. -| textline | 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. -| nativeTransport | boolean | Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html -| decoderMaxLineLength | int | The max line length to use for the textline codec. -| bossGroup | EventLoopGroup | Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint -| delimiter | TextLineDelimiter | The delimiter to use for the textline codec. Possible values are LINE and NULL. -| autoAppendDelimiter | boolean | Whether or not to auto append missing end delimiter when sending using the textline codec. -| workerGroup | EventLoopGroup | To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own boss pool with 1 core thread. -| channelGroup | ChannelGroup | To use a explicit ChannelGroup. -| encoding | String | The encoding (a charset name) to use for the textline codec. If not provided Camel will use the JVM default Charset. -| networkInterface | String | When using UDP then this option can be used to specify a network interface by its name such as eth0 to join a multicast group. -| decoders | List | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. -| enabledProtocols | String | Which protocols to enable when using SSL -| encoders | List | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. -| reconnect | boolean | Used only in clientMode in consumer the consumer will attempt to reconnect on disconnection if this is enabled -| encoder | ChannelHandler | A custom ChannelHandler class that can be used to perform special marshalling of outbound payloads. -| reconnectInterval | int | Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection -| decoder | ChannelHandler | A custom ChannelHandler class that can be used to perform special marshalling of inbound payloads. -| disconnect | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. -| lazyChannelCreation | boolean | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. -| transferExchange | 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. -| disconnectOnNoReply | boolean | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. -| noReplyLogLevel | LoggingLevel | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. -| serverExceptionCaughtLogLevel | LoggingLevel | If the server (NettyConsumer) catches an exception then its logged using this logging level. -| serverClosedChannelExceptionCaughtLogLevel | LoggingLevel | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. -| allowDefaultCodec | boolean | The netty component installs a default codec if both encoder/deocder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. -| clientInitializerFactory | ClientInitializerFactory | To use a custom ClientInitializerFactory -| usingExecutorService | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. -| producerPoolMaxActive | int | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit. -| producerPoolMinIdle | int | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. -| producerPoolMaxIdle | int | Sets the cap on the number of idle instances in the pool. -| producerPoolMinEvictableIdle | long | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. -| producerPoolEnabled | boolean | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply. -| udpConnectionlessSending | boolean | This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port. -| clientMode | boolean | If the clientMode is true netty consumer will connect the address as a TCP client. -| useByteBuf | boolean | If the useByteBuf is true netty producer will turn the message body into ByteBuf before sending it out. -| udpByteArrayCodec | boolean | For UDP only. If enabled the using byte array codec instead of Java serialization protocol. -| reuseChannel | boolean | This option allows producers to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useable if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key link NettyConstantsNETTY_CHANNEL which allows you to obtain the channel during routing and use it as well. |======================================================================= {% endraw %} // component options: END
