http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-nagios/src/main/docs/nagios-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-nagios/src/main/docs/nagios-component.adoc b/components/camel-nagios/src/main/docs/nagios-component.adoc index d36c76e..9bc6501 100644 --- a/components/camel-nagios/src/main/docs/nagios-component.adoc +++ b/components/camel-nagios/src/main/docs/nagios-component.adoc @@ -42,13 +42,11 @@ The Nagios component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| configuration | | NagiosConfiguration | To use a shared NagiosConfiguration - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (advanced) | To use a shared NagiosConfiguration | | NagiosConfiguration +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -67,30 +65,24 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | | String | *Required* This is the address of the Nagios host where checks should be send. -| port | | int | *Required* The port number of the host. +| Name | Description | Default | Type +| **host** | *Required* This is the address of the Nagios host where checks should be send. | | String +| **port** | *Required* The port number of the host. | | int |======================================================================= #### Query Parameters (6 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| connectionTimeout | 5000 | int | Connection timeout in millis. - -| sendSync | true | boolean | Whether or not to use synchronous when sending a passive check. Setting it to false will allow Camel to continue routing the message and the passive check message will be send asynchronously. - -| timeout | 5000 | int | Sending timeout in millis. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| encryptionMethod | | NagiosEncryptionMethod | To specify an encryption method. - -| password | | String | Password to be authenticated when sending checks to Nagios. +| Name | Description | Default | Type +| **connectionTimeout** (producer) | Connection timeout in millis. | 5000 | int +| **sendSync** (producer) | Whether or not to use synchronous when sending a passive check. Setting it to false will allow Camel to continue routing the message and the passive check message will be send asynchronously. | true | boolean +| **timeout** (producer) | Sending timeout in millis. | 5000 | int +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **encryptionMethod** (security) | To specify an encryption method. | | NagiosEncryptionMethod +| **password** (security) | Password to be authenticated when sending checks to Nagios. | | String |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-nats/src/main/docs/nats-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-nats/src/main/docs/nats-component.adoc b/components/camel-nats/src/main/docs/nats-component.adoc index 9852eca..82e366e 100644 --- a/components/camel-nats/src/main/docs/nats-component.adoc +++ b/components/camel-nats/src/main/docs/nats-component.adoc @@ -46,61 +46,39 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| servers | | String | *Required* URLs to one or more NAT servers. Use comma to separate URLs when specifying multiple servers. +| Name | Description | Default | Type +| **servers** | *Required* URLs to one or more NAT servers. Use comma to separate URLs when specifying multiple servers. | | String |======================================================================= #### Query Parameters (22 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| flushConnection | false | boolean | Define if we want to flush connection or not - -| flushTimeout | 1000 | int | Set the flush timeout - -| maxReconnectAttempts | 3 | int | Max reconnection attempts - -| noRandomizeServers | false | boolean | Whether or not randomizing the order of servers for the connection attempts - -| pedantic | false | boolean | Whether or not running in pedantic mode (this affects performace) - -| pingInterval | 4000 | int | Ping interval to be aware if connection is still alive (in milliseconds) - -| reconnect | true | boolean | Whether or not using reconnection feature - -| reconnectTimeWait | 2000 | int | Waiting time before attempts reconnection (in milliseconds) - -| topic | | String | *Required* The name of topic we want to use - -| verbose | false | boolean | Whether or not running in verbose mode - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| maxMessages | | String | Stop receiving messages from a topic we are subscribing to after maxMessages - -| poolSize | 10 | int | Consumer pool size - -| queueName | | String | The Queue name if we are using nats for a queue configuration - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| replySubject | | String | the subject to which subscribers should send response - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| secure | false | boolean | Set secure option indicating TLS is required - -| ssl | false | boolean | Whether or not using SSL - -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters - -| tlsDebug | false | boolean | TLS Debug it will add additional console output +| Name | Description | Default | Type +| **flushConnection** (common) | Define if we want to flush connection or not | false | boolean +| **flushTimeout** (common) | Set the flush timeout | 1000 | int +| **maxReconnectAttempts** (common) | Max reconnection attempts | 3 | int +| **noRandomizeServers** (common) | Whether or not randomizing the order of servers for the connection attempts | false | boolean +| **pedantic** (common) | Whether or not running in pedantic mode (this affects performace) | false | boolean +| **pingInterval** (common) | Ping interval to be aware if connection is still alive (in milliseconds) | 4000 | int +| **reconnect** (common) | Whether or not using reconnection feature | true | boolean +| **reconnectTimeWait** (common) | Waiting time before attempts reconnection (in milliseconds) | 2000 | int +| **topic** (common) | *Required* The name of topic we want to use | | String +| **verbose** (common) | Whether or not running in verbose mode | false | boolean +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **maxMessages** (consumer) | Stop receiving messages from a topic we are subscribing to after maxMessages | | String +| **poolSize** (consumer) | Consumer pool size | 10 | int +| **queueName** (consumer) | The Queue name if we are using nats for a queue configuration | | String +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **replySubject** (producer) | the subject to which subscribers should send response | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **secure** (security) | Set secure option indicating TLS is required | false | boolean +| **ssl** (security) | Whether or not using SSL | false | boolean +| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters +| **tlsDebug** (security) | TLS Debug it will add additional console output | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-netty-http/src/main/docs/netty-http-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty-http/src/main/docs/netty-http-component.adoc b/components/camel-netty-http/src/main/docs/netty-http-component.adoc index 9d1f650..6becdcd 100644 --- a/components/camel-netty-http/src/main/docs/netty-http-component.adoc +++ b/components/camel-netty-http/src/main/docs/netty-http-component.adoc @@ -80,21 +80,15 @@ The Netty HTTP component supports 6 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| nettyHttpBinding | | NettyHttpBinding | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. - 4+^s| common -| configuration | | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints. - 4+^s| advanced -| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. - 4+^s| security -| securityConfiguration | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. - 4+^s| advanced -| maximumPoolSize | 16 | int | The core pool size for the ordered thread pool if its in use. The default value is 16. - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **nettyHttpBinding** (advanced) | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. | | NettyHttpBinding +| **configuration** (common) | To use the NettyConfiguration as configuration when creating endpoints. | | NettyHttpConfiguration +| **headerFilterStrategy** (advanced) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. | | HeaderFilterStrategy +| **securityConfiguration** (security) | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. | | NettyHttpSecurity Configuration +| **maximumPoolSize** (advanced) | The core pool size for the ordered thread pool if its in use. The default value is 16. | 16 | int +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -114,176 +108,98 @@ with the following path and query parameters: #### Path Parameters (4 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| protocol | | String | *Required* The protocol to use which is either http or https -| host | | String | *Required* The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. -| port | | int | The host port number -| path | | String | Resource path +| Name | Description | Default | Type +| **protocol** | *Required* The protocol to use which is either http or https | | String +| **host** | *Required* The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. | | String +| **port** | The host port number | | int +| **path** | Resource path | | String |======================================================================= #### Query Parameters (78 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| bridgeEndpoint | false | boolean | If the option is true the producer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange). - -| disconnect | false | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. - -| keepAlive | true | boolean | Setting to ensure socket is not closed due to inactivity - -| reuseAddress | true | boolean | Setting to facilitate socket multiplexing - -| sync | true | boolean | Setting to set endpoint as one-way or request-response - -| tcpNoDelay | true | boolean | Setting to improve TCP protocol performance - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| matchOnUriPrefix | false | boolean | Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. - -| send503whenSuspended | true | boolean | Whether to send back HTTP status code 503 when the consumer has been suspended. If the option is false then the Netty Acceptor is unbound when the consumer is suspended so clients cannot connect anymore. - 4+^s| consumer (advanced) -| backlog | | int | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting. - -| bossCount | 1 | int | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty - -| bossPool | | BossPool | To use a explicit org.jboss.netty.channel.socket.nio.BossPool as the boss thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own boss pool with 1 core thread. - -| channelGroup | | ChannelGroup | To use a explicit ChannelGroup. - -| chunkedMaxContentLength | 1048576 | int | Value in bytes the max content length per chunked frame received on the Netty HTTP server. - -| compression | false | boolean | Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers. - -| disableStreamCache | false | boolean | Determines whether or not the raw input stream from Netty HttpRequestgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Netty raw stream. - -| disconnectOnNoReply | true | boolean | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. - -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| httpMethodRestrict | | String | To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma. - -| mapHeaders | true | boolean | If this option is enabled then during binding from Netty to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.netty.http.NettyHttpMessage message with the method getHttpRequest() that returns the Netty HTTP request org.jboss.netty.handler.codec.http.HttpRequest instance. - -| maxChannelMemorySize | 10485760 | long | The maximum total size of the queued events per channel when using orderedThreadPoolExecutor. Specify 0 to disable. - -| maxHeaderSize | 8192 | int | The maximum length of all headers. If the sum of the length of each header exceeds this value a TooLongFrameException will be raised. - -| maxTotalMemorySize | 209715200 | long | The maximum total size of the queued events for this pool when using orderedThreadPoolExecutor. Specify 0 to disable. - -| nettyServerBootstrapFactory | | NettyServerBootstrapFactory | To use a custom NettyServerBootstrapFactory - -| nettySharedHttpServer | | NettySharedHttpServer | To use a shared Netty HTTP server. See Netty HTTP Server Example for more details. - -| noReplyLogLevel | WARN | LoggingLevel | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. - -| orderedThreadPoolExecutor | true | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. See details at the netty javadoc of org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor for more details. - -| serverClosedChannelExceptionCaughtLogLevel | DEBUG | LoggingLevel | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. - -| serverExceptionCaughtLogLevel | WARN | LoggingLevel | If the server (NettyConsumer) catches an exception then its logged using this logging level. - -| serverPipelineFactory | | ServerPipelineFactory | To use a custom ServerPipelineFactory - -| traceEnabled | false | boolean | Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off. - -| urlDecodeHeaders | false | boolean | If this option is enabled then during binding from Netty to Camel Message then the header values will be URL decoded (eg 20 will be a space character. Notice this option is used by the default org.apache.camel.component.netty.http.NettyHttpBinding and therefore if you implement a custom org.apache.camel.component.netty.http.NettyHttpBinding then you would need to decode the headers accordingly to this option. - -| workerCount | | int | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty - -| workerPool | | WorkerPool | To use a explicit org.jboss.netty.channel.socket.nio.WorkerPool as the worker thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own worker pool with 2 x cpu count core threads. - 4+^s| producer -| connectTimeout | 10000 | long | Time to wait for a socket connection to be available. Value is in millis. - -| requestTimeout | | long | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. - -| throwExceptionOnFailure | true | boolean | Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. - 4+^s| producer (advanced) -| clientPipelineFactory | | ClientPipelineFactory | To use a custom ClientPipelineFactory - -| lazyChannelCreation | true | boolean | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. - -| okStatusCodeRange | 200-299 | String | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. The default range is 200-299 - -| producerPoolEnabled | true | boolean | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply. - -| producerPoolMaxActive | -1 | int | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit. - -| producerPoolMaxIdle | 100 | int | Sets the cap on the number of idle instances in the pool. - -| producerPoolMinEvictableIdle | 300000 | long | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. - -| producerPoolMinIdle | | int | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. - -| useChannelBuffer | false | boolean | If the useChannelBuffer is true netty producer will turn the message body into ChannelBuffer before sending it out. - -| useRelativePath | false | boolean | Sets whether to use a relative path in HTTP requests. Some third party backend systems such as IBM Datapower do not support absolute URIs in HTTP POSTs and setting this option to true can work around this problem. - 4+^s| advanced -| bootstrapConfiguration | | NettyServerBootstrapConfiguration | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. - -| configuration | | NettyHttpConfiguration | To use a custom configured NettyHttpConfiguration for configuring this endpoint. - -| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. - -| nettyHttpBinding | | NettyHttpBinding | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. - -| options | | Map | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. - -| receiveBufferSize | 65536 | long | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. - -| receiveBufferSizePredictor | | int | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. - -| sendBufferSize | 65536 | long | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - -| transferException | false | boolean | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. - -| transferExchange | false | boolean | Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body Out body fault body In headers Out headers fault headers exchange properties exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. - 4+^s| codec -| decoder | | ChannelHandler | To use a single decoder. This options is deprecated use encoders instead. - -| decoders | | String | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. - -| encoder | | ChannelHandler | To use a single encoder. This options is deprecated use encoders instead. - -| encoders | | String | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. - 4+^s| security -| enabledProtocols | TLSv1,TLSv1.1,TLSv1.2 | String | Which protocols to enable when using SSL - -| keyStoreFile | | File | Client side certificate keystore to be used for encryption - -| keyStoreFormat | JKS | String | Keystore format to be used for payload encryption. Defaults to JKS if not set - -| keyStoreResource | | String | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. - -| needClientAuth | false | boolean | Configures whether the server needs client authentication when using SSL. - -| passphrase | | String | Password setting to use in order to encrypt/decrypt payloads sent using SSH - -| securityConfiguration | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. - -| securityOptions | | Map | To configure NettyHttpSecurityConfiguration using key/value pairs from the map - -| securityProvider | SunX509 | String | Security provider to be used for payload encryption. Defaults to SunX509 if not set. - -| ssl | false | boolean | Setting to specify whether SSL encryption is applied to this endpoint - -| sslClientCertHeaders | false | boolean | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range. - -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters - -| sslHandler | | SslHandler | Reference to a class that could be used to return an SSL Handler - -| trustStoreFile | | File | Server side certificate keystore to be used for encryption - -| trustStoreResource | | String | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. +| Name | Description | Default | Type +| **bridgeEndpoint** (common) | If the option is true the producer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange). | false | boolean +| **disconnect** (common) | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | false | boolean +| **keepAlive** (common) | Setting to ensure socket is not closed due to inactivity | true | boolean +| **reuseAddress** (common) | Setting to facilitate socket multiplexing | true | boolean +| **sync** (common) | Setting to set endpoint as one-way or request-response | true | boolean +| **tcpNoDelay** (common) | Setting to improve TCP protocol performance | true | boolean +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **matchOnUriPrefix** (consumer) | Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. | false | boolean +| **send503whenSuspended** (consumer) | Whether to send back HTTP status code 503 when the consumer has been suspended. If the option is false then the Netty Acceptor is unbound when the consumer is suspended so clients cannot connect anymore. | true | boolean +| **backlog** (consumer) | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting. | | int +| **bossCount** (consumer) | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty | 1 | int +| **bossPool** (consumer) | To use a explicit org.jboss.netty.channel.socket.nio.BossPool as the boss thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own boss pool with 1 core thread. | | BossPool +| **channelGroup** (consumer) | To use a explicit ChannelGroup. | | ChannelGroup +| **chunkedMaxContentLength** (consumer) | Value in bytes the max content length per chunked frame received on the Netty HTTP server. | 1048576 | int +| **compression** (consumer) | Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers. | false | boolean +| **disableStreamCache** (consumer) | Determines whether or not the raw input stream from Netty HttpRequestgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Netty raw stream. | false | boolean +| **disconnectOnNoReply** (consumer) | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. | true | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **httpMethodRestrict** (consumer) | To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma. | | String +| **mapHeaders** (consumer) | If this option is enabled then during binding from Netty to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.netty.http.NettyHttpMessage message with the method getHttpRequest() that returns the Netty HTTP request org.jboss.netty.handler.codec.http.HttpRequest instance. | true | boolean +| **maxChannelMemorySize** (consumer) | The maximum total size of the queued events per channel when using orderedThreadPoolExecutor. Specify 0 to disable. | 10485760 | long +| **maxHeaderSize** (consumer) | The maximum length of all headers. If the sum of the length of each header exceeds this value a TooLongFrameException will be raised. | 8192 | int +| **maxTotalMemorySize** (consumer) | The maximum total size of the queued events for this pool when using orderedThreadPoolExecutor. Specify 0 to disable. | 209715200 | long +| **nettyServerBootstrapFactory** (consumer) | To use a custom NettyServerBootstrapFactory | | NettyServerBootstrap Factory +| **nettySharedHttpServer** (consumer) | To use a shared Netty HTTP server. See Netty HTTP Server Example for more details. | | NettySharedHttpServer +| **noReplyLogLevel** (consumer) | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. | WARN | LoggingLevel +| **orderedThreadPoolExecutor** (consumer) | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. See details at the netty javadoc of org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor for more details. | true | boolean +| **serverClosedChannel ExceptionCaughtLogLevel** (consumer) | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. | DEBUG | LoggingLevel +| **serverExceptionCaughtLog Level** (consumer) | If the server (NettyConsumer) catches an exception then its logged using this logging level. | WARN | LoggingLevel +| **serverPipelineFactory** (consumer) | To use a custom ServerPipelineFactory | | ServerPipelineFactory +| **traceEnabled** (consumer) | Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off. | false | boolean +| **urlDecodeHeaders** (consumer) | If this option is enabled then during binding from Netty to Camel Message then the header values will be URL decoded (eg 20 will be a space character. Notice this option is used by the default org.apache.camel.component.netty.http.NettyHttpBinding and therefore if you implement a custom org.apache.camel.component.netty.http.NettyHttpBinding then you would need to decode the headers accordingly to this option. | false | boolean +| **workerCount** (consumer) | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty | | int +| **workerPool** (consumer) | To use a explicit org.jboss.netty.channel.socket.nio.WorkerPool as the worker thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own worker pool with 2 x cpu count core threads. | | WorkerPool +| **connectTimeout** (producer) | Time to wait for a socket connection to be available. Value is in millis. | 10000 | long +| **requestTimeout** (producer) | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. | | long +| **throwExceptionOnFailure** (producer) | Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. | true | boolean +| **clientPipelineFactory** (producer) | To use a custom ClientPipelineFactory | | ClientPipelineFactory +| **lazyChannelCreation** (producer) | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. | true | boolean +| **okStatusCodeRange** (producer) | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included. The default range is 200-299 | 200-299 | String +| **producerPoolEnabled** (producer) | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply. | true | boolean +| **producerPoolMaxActive** (producer) | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit. | -1 | int +| **producerPoolMaxIdle** (producer) | Sets the cap on the number of idle instances in the pool. | 100 | int +| **producerPoolMinEvictable Idle** (producer) | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. | 300000 | long +| **producerPoolMinIdle** (producer) | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. | | int +| **useChannelBuffer** (producer) | If the useChannelBuffer is true netty producer will turn the message body into ChannelBuffer before sending it out. | false | boolean +| **useRelativePath** (producer) | Sets whether to use a relative path in HTTP requests. Some third party backend systems such as IBM Datapower do not support absolute URIs in HTTP POSTs and setting this option to true can work around this problem. | false | boolean +| **bootstrapConfiguration** (advanced) | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. | | NettyServerBootstrap Configuration +| **configuration** (advanced) | To use a custom configured NettyHttpConfiguration for configuring this endpoint. | | NettyHttpConfiguration +| **headerFilterStrategy** (advanced) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. | | HeaderFilterStrategy +| **nettyHttpBinding** (advanced) | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. | | NettyHttpBinding +| **options** (advanced) | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. | | Map +| **receiveBufferSize** (advanced) | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. | 65536 | long +| **receiveBufferSizePredictor** (advanced) | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. | | int +| **sendBufferSize** (advanced) | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. | 65536 | long +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **transferException** (advanced) | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. | false | boolean +| **transferExchange** (advanced) | Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body Out body fault body In headers Out headers fault headers exchange properties exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. | false | boolean +| **decoder** (codec) | To use a single decoder. This options is deprecated use encoders instead. | | ChannelHandler +| **decoders** (codec) | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. | | String +| **encoder** (codec) | To use a single encoder. This options is deprecated use encoders instead. | | ChannelHandler +| **encoders** (codec) | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. | | String +| **enabledProtocols** (security) | Which protocols to enable when using SSL | TLSv1,TLSv1.1,TLSv1.2 | String +| **keyStoreFile** (security) | Client side certificate keystore to be used for encryption | | File +| **keyStoreFormat** (security) | Keystore format to be used for payload encryption. Defaults to JKS if not set | JKS | String +| **keyStoreResource** (security) | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. | | String +| **needClientAuth** (security) | Configures whether the server needs client authentication when using SSL. | false | boolean +| **passphrase** (security) | Password setting to use in order to encrypt/decrypt payloads sent using SSH | | String +| **securityConfiguration** (security) | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. | | NettyHttpSecurity Configuration +| **securityOptions** (security) | To configure NettyHttpSecurityConfiguration using key/value pairs from the map | | Map +| **securityProvider** (security) | Security provider to be used for payload encryption. Defaults to SunX509 if not set. | SunX509 | String +| **ssl** (security) | Setting to specify whether SSL encryption is applied to this endpoint | false | boolean +| **sslClientCertHeaders** (security) | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range. | false | boolean +| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters +| **sslHandler** (security) | Reference to a class that could be used to return an SSL Handler | | SslHandler +| **trustStoreFile** (security) | Server side certificate keystore to be used for encryption | | File +| **trustStoreResource** (security) | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. | | String |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-netty/src/main/docs/netty-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty/src/main/docs/netty-component.adoc b/components/camel-netty/src/main/docs/netty-component.adoc index 24cbfa2..66a0275 100644 --- a/components/camel-netty/src/main/docs/netty-component.adoc +++ b/components/camel-netty/src/main/docs/netty-component.adoc @@ -60,15 +60,12 @@ The Netty component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| configuration | | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. - -| maximumPoolSize | 16 | int | The core pool size for the ordered thread pool if its in use. The default value is 16. - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (advanced) | To use the NettyConfiguration as configuration when creating endpoints. | | NettyConfiguration +| **maximumPoolSize** (advanced) | The core pool size for the ordered thread pool if its in use. The default value is 16. | 16 | int +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -88,153 +85,86 @@ with the following path and query parameters: #### Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| protocol | | String | *Required* The protocol to use which can be tcp or udp. -| host | | String | *Required* The hostname. For the consumer the hostname is localhost or 0.0.0.0 For the producer the hostname is the remote host to connect to -| port | | int | *Required* The host port number +| Name | Description | Default | Type +| **protocol** | *Required* The protocol to use which can be tcp or udp. | | String +| **host** | *Required* The hostname. For the consumer the hostname is localhost or 0.0.0.0 For the producer the hostname is the remote host to connect to | | String +| **port** | *Required* The host port number | | int |======================================================================= #### Query Parameters (67 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| disconnect | false | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. - -| keepAlive | true | boolean | Setting to ensure socket is not closed due to inactivity - -| reuseAddress | true | boolean | Setting to facilitate socket multiplexing - -| sync | true | boolean | Setting to set endpoint as one-way or request-response - -| tcpNoDelay | true | boolean | Setting to improve TCP protocol performance - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| broadcast | false | boolean | Setting to choose Multicast over UDP - -| clientMode | false | boolean | If the clientMode is true netty consumer will connect the address as a TCP client. - 4+^s| consumer (advanced) -| backlog | | int | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting. - -| bossCount | 1 | int | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty - -| bossPool | | BossPool | To use a explicit org.jboss.netty.channel.socket.nio.BossPool as the boss thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own boss pool with 1 core thread. - -| channelGroup | | ChannelGroup | To use a explicit ChannelGroup. - -| disconnectOnNoReply | true | boolean | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. - -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| maxChannelMemorySize | 10485760 | long | The maximum total size of the queued events per channel when using orderedThreadPoolExecutor. Specify 0 to disable. - -| maxTotalMemorySize | 209715200 | long | The maximum total size of the queued events for this pool when using orderedThreadPoolExecutor. Specify 0 to disable. - -| nettyServerBootstrapFactory | | NettyServerBootstrapFactory | To use a custom NettyServerBootstrapFactory - -| networkInterface | | String | When using UDP then this option can be used to specify a network interface by its name such as eth0 to join a multicast group. - -| noReplyLogLevel | WARN | LoggingLevel | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. - -| orderedThreadPoolExecutor | true | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. See details at the netty javadoc of org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor for more details. - -| serverClosedChannelExceptionCaughtLogLevel | DEBUG | LoggingLevel | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. - -| serverExceptionCaughtLogLevel | WARN | LoggingLevel | If the server (NettyConsumer) catches an exception then its logged using this logging level. - -| serverPipelineFactory | | ServerPipelineFactory | To use a custom ServerPipelineFactory - -| workerCount | | int | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty - -| workerPool | | WorkerPool | To use a explicit org.jboss.netty.channel.socket.nio.WorkerPool as the worker thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own worker pool with 2 x cpu count core threads. - 4+^s| producer -| connectTimeout | 10000 | long | Time to wait for a socket connection to be available. Value is in millis. - -| requestTimeout | | long | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. - 4+^s| producer (advanced) -| clientPipelineFactory | | ClientPipelineFactory | To use a custom ClientPipelineFactory - -| lazyChannelCreation | true | boolean | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. - -| producerPoolEnabled | true | boolean | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply. - -| producerPoolMaxActive | -1 | int | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit. - -| producerPoolMaxIdle | 100 | int | Sets the cap on the number of idle instances in the pool. - -| producerPoolMinEvictableIdle | 300000 | long | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. - -| producerPoolMinIdle | | int | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. - -| udpConnectionlessSending | false | boolean | This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port. - -| useChannelBuffer | false | boolean | If the useChannelBuffer is true netty producer will turn the message body into ChannelBuffer before sending it out. - 4+^s| advanced -| bootstrapConfiguration | | NettyServerBootstrapConfiguration | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. - -| options | | Map | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. - -| receiveBufferSize | 65536 | long | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. - -| receiveBufferSizePredictor | | int | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. - -| sendBufferSize | 65536 | long | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - -| transferExchange | false | boolean | Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body Out body fault body In headers Out headers fault headers exchange properties exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. - 4+^s| codec -| allowDefaultCodec | true | boolean | The netty component installs a default codec if both encoder/deocder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. - -| autoAppendDelimiter | true | boolean | Whether or not to auto append missing end delimiter when sending using the textline codec. - -| decoder | | ChannelHandler | A custom ChannelHandler class that can be used to perform special marshalling of inbound payloads. Must override org.jboss.netty.channel.ChannelUpStreamHandler. - -| decoderMaxLineLength | 1024 | int | The max line length to use for the textline codec. - -| decoders | | String | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. - -| delimiter | LINE | TextLineDelimiter | The delimiter to use for the textline codec. Possible values are LINE and NULL. - -| encoder | | ChannelHandler | A custom ChannelHandler class that can be used to perform special marshalling of outbound payloads. Must override org.jboss.netty.channel.ChannelDownStreamHandler. - -| encoders | | String | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. - -| encoding | | String | The encoding (a charset name) to use for the textline codec. If not provided Camel will use the JVM default Charset. - -| textline | false | boolean | Only used for TCP. If no codec is specified you can use this flag to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP. - 4+^s| security -| enabledProtocols | TLSv1,TLSv1.1,TLSv1.2 | String | Which protocols to enable when using SSL - -| keyStoreFile | | File | Client side certificate keystore to be used for encryption - -| keyStoreFormat | JKS | String | Keystore format to be used for payload encryption. Defaults to JKS if not set - -| keyStoreResource | | String | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. - -| needClientAuth | false | boolean | Configures whether the server needs client authentication when using SSL. - -| passphrase | | String | Password setting to use in order to encrypt/decrypt payloads sent using SSH - -| securityProvider | SunX509 | String | Security provider to be used for payload encryption. Defaults to SunX509 if not set. - -| ssl | false | boolean | Setting to specify whether SSL encryption is applied to this endpoint - -| sslClientCertHeaders | false | boolean | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range. - -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters - -| sslHandler | | SslHandler | Reference to a class that could be used to return an SSL Handler - -| trustStoreFile | | File | Server side certificate keystore to be used for encryption - -| trustStoreResource | | String | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. +| Name | Description | Default | Type +| **disconnect** (common) | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | false | boolean +| **keepAlive** (common) | Setting to ensure socket is not closed due to inactivity | true | boolean +| **reuseAddress** (common) | Setting to facilitate socket multiplexing | true | boolean +| **sync** (common) | Setting to set endpoint as one-way or request-response | true | boolean +| **tcpNoDelay** (common) | Setting to improve TCP protocol performance | true | boolean +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **broadcast** (consumer) | Setting to choose Multicast over UDP | false | boolean +| **clientMode** (consumer) | If the clientMode is true netty consumer will connect the address as a TCP client. | false | boolean +| **backlog** (consumer) | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200 500 or 1000 tells the TCP stack how long the accept queue can be If this option is not configured then the backlog depends on OS setting. | | int +| **bossCount** (consumer) | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty | 1 | int +| **bossPool** (consumer) | To use a explicit org.jboss.netty.channel.socket.nio.BossPool as the boss thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own boss pool with 1 core thread. | | BossPool +| **channelGroup** (consumer) | To use a explicit ChannelGroup. | | ChannelGroup +| **disconnectOnNoReply** (consumer) | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. | true | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **maxChannelMemorySize** (consumer) | The maximum total size of the queued events per channel when using orderedThreadPoolExecutor. Specify 0 to disable. | 10485760 | long +| **maxTotalMemorySize** (consumer) | The maximum total size of the queued events for this pool when using orderedThreadPoolExecutor. Specify 0 to disable. | 209715200 | long +| **nettyServerBootstrapFactory** (consumer) | To use a custom NettyServerBootstrapFactory | | NettyServerBootstrap Factory +| **networkInterface** (consumer) | When using UDP then this option can be used to specify a network interface by its name such as eth0 to join a multicast group. | | String +| **noReplyLogLevel** (consumer) | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. | WARN | LoggingLevel +| **orderedThreadPoolExecutor** (consumer) | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. See details at the netty javadoc of org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor for more details. | true | boolean +| **serverClosedChannel ExceptionCaughtLogLevel** (consumer) | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. | DEBUG | LoggingLevel +| **serverExceptionCaughtLog Level** (consumer) | If the server (NettyConsumer) catches an exception then its logged using this logging level. | WARN | LoggingLevel +| **serverPipelineFactory** (consumer) | To use a custom ServerPipelineFactory | | ServerPipelineFactory +| **workerCount** (consumer) | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty | | int +| **workerPool** (consumer) | To use a explicit org.jboss.netty.channel.socket.nio.WorkerPool as the worker thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own worker pool with 2 x cpu count core threads. | | WorkerPool +| **connectTimeout** (producer) | Time to wait for a socket connection to be available. Value is in millis. | 10000 | long +| **requestTimeout** (producer) | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. | | long +| **clientPipelineFactory** (producer) | To use a custom ClientPipelineFactory | | ClientPipelineFactory +| **lazyChannelCreation** (producer) | Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. | true | boolean +| **producerPoolEnabled** (producer) | Whether producer pool is enabled or not. Important: Do not turn this off as the pooling is needed for handling concurrency and reliable request/reply. | true | boolean +| **producerPoolMaxActive** (producer) | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients or idle awaiting checkout) at a given time. Use a negative value for no limit. | -1 | int +| **producerPoolMaxIdle** (producer) | Sets the cap on the number of idle instances in the pool. | 100 | int +| **producerPoolMinEvictable Idle** (producer) | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. | 300000 | long +| **producerPoolMinIdle** (producer) | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. | | int +| **udpConnectionlessSending** (producer) | This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port. | false | boolean +| **useChannelBuffer** (producer) | If the useChannelBuffer is true netty producer will turn the message body into ChannelBuffer before sending it out. | false | boolean +| **bootstrapConfiguration** (advanced) | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. | | NettyServerBootstrap Configuration +| **options** (advanced) | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. | | Map +| **receiveBufferSize** (advanced) | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. | 65536 | long +| **receiveBufferSizePredictor** (advanced) | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. | | int +| **sendBufferSize** (advanced) | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. | 65536 | long +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **transferExchange** (advanced) | Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body Out body fault body In headers Out headers fault headers exchange properties exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. | false | boolean +| **allowDefaultCodec** (codec) | The netty component installs a default codec if both encoder/deocder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. | true | boolean +| **autoAppendDelimiter** (codec) | Whether or not to auto append missing end delimiter when sending using the textline codec. | true | boolean +| **decoder** (codec) | A custom ChannelHandler class that can be used to perform special marshalling of inbound payloads. Must override org.jboss.netty.channel.ChannelUpStreamHandler. | | ChannelHandler +| **decoderMaxLineLength** (codec) | The max line length to use for the textline codec. | 1024 | int +| **decoders** (codec) | A list of decoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. | | String +| **delimiter** (codec) | The delimiter to use for the textline codec. Possible values are LINE and NULL. | LINE | TextLineDelimiter +| **encoder** (codec) | A custom ChannelHandler class that can be used to perform special marshalling of outbound payloads. Must override org.jboss.netty.channel.ChannelDownStreamHandler. | | ChannelHandler +| **encoders** (codec) | A list of encoders to be used. You can use a String which have values separated by comma and have the values be looked up in the Registry. Just remember to prefix the value with so Camel knows it should lookup. | | String +| **encoding** (codec) | The encoding (a charset name) to use for the textline codec. If not provided Camel will use the JVM default Charset. | | String +| **textline** (codec) | Only used for TCP. If no codec is specified you can use this flag to indicate a text line based codec; if not specified or the value is false then Object Serialization is assumed over TCP. | false | boolean +| **enabledProtocols** (security) | Which protocols to enable when using SSL | TLSv1,TLSv1.1,TLSv1.2 | String +| **keyStoreFile** (security) | Client side certificate keystore to be used for encryption | | File +| **keyStoreFormat** (security) | Keystore format to be used for payload encryption. Defaults to JKS if not set | JKS | String +| **keyStoreResource** (security) | Client side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. | | String +| **needClientAuth** (security) | Configures whether the server needs client authentication when using SSL. | false | boolean +| **passphrase** (security) | Password setting to use in order to encrypt/decrypt payloads sent using SSH | | String +| **securityProvider** (security) | Security provider to be used for payload encryption. Defaults to SunX509 if not set. | SunX509 | String +| **ssl** (security) | Setting to specify whether SSL encryption is applied to this endpoint | false | boolean +| **sslClientCertHeaders** (security) | When enabled and in SSL mode then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name issuer name serial number and the valid date range. | false | boolean +| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters +| **sslHandler** (security) | Reference to a class that could be used to return an SSL Handler | | SslHandler +| **trustStoreFile** (security) | Server side certificate keystore to be used for encryption | | File +| **trustStoreResource** (security) | Server side certificate keystore to be used for encryption. Is loaded by default from classpath but you can prefix with classpath: file: or http: to load the resource from different systems. | | String |======================================================================= // endpoint options: END
