http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/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 d687bdf..43b382f 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 @@ -79,23 +79,16 @@ The Netty4 HTTP component supports 7 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| nettyHttpBinding | | NettyHttpBinding | To use a custom org.apache.camel.component.netty4.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.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. - 4+^s| advanced -| maximumPoolSize | 16 | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. - -| executorService | | EventExecutorGroup | To use the given EventExecutorGroup - -| 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.netty4.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.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. | | NettyHttpSecurity Configuration +| **maximumPoolSize** (advanced) | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. | 16 | int +| **executorService** (advanced) | To use the given EventExecutorGroup | | EventExecutorGroup +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -117,178 +110,99 @@ with the following path and query parameters: #### Path Parameters (4 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| protocol | | String | *Required* 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 (79 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",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 - -| bossGroup | | EventLoopGroup | Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint - -| 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. - -| 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 io.netty.handler.codec.http.HttpRequest instance. - -| maxHeaderSize | 8192 | int | The maximum length of all headers. If the sum of the length of each header exceeds this value a io.netty.handler.codec.TooLongFrameException will be raised. - -| 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. - -| 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. - -| serverInitializerFactory | | ServerInitializerFactory | To use a custom ServerInitializerFactory - -| 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.netty4.http.NettyHttpBinding then you would need to decode the headers accordingly to this option. - -| usingExecutorService | true | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. - 4+^s| producer -| connectTimeout | 10000 | int | Time to wait for a socket connection to be available. Value is in millis. - -| cookieHandler | | CookieHandler | Configure a cookie handler to maintain a HTTP session - -| 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. - -| reuseChannel | false | 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. - -| 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) -| clientInitializerFactory | | ClientInitializerFactory | To use a custom ClientInitializerFactory - -| 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. - -| useRelativePath | false | boolean | Sets whether to use a relative path in HTTP requests. - 4+^s| advanced -| allowSerializedHeaders | false | boolean | Only used for TCP when transferExchange is true. When set to true serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level. - -| bootstrapConfiguration | | NettyServerBootstrapConfiguration | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. - -| channelGroup | | ChannelGroup | To use a explicit ChannelGroup. - -| configuration | | NettyHttpConfiguration | To use a custom configured NettyHttpConfiguration for configuring this endpoint. - -| disableStreamCache | false | boolean | Determines whether or not the raw input stream from Netty HttpRequestgetContent() or HttpResponsetgetContent() 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. Also Netty will auto-close the Netty stream when the Netty HTTP server/HTTP client is done processing which means that if the asynchronous routing engine is in use then any asynchronous thread that may continue routing the org.apache.camel.Exchange may n ot be able to read the Netty stream because Netty has closed it. - -| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. - -| nativeTransport | false | 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 - -| nettyHttpBinding | | NettyHttpBinding | To use a custom org.apache.camel.component.netty4.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 | 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. - -| sendBufferSize | 65536 | int | 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. - -| 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 - -| workerGroup | | EventLoopGroup | To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads. - 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 | | 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.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. - -| securityOptions | | Map | To configure NettyHttpSecurityConfiguration using key/value pairs from the map - -| securityProvider | | 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 +| **bossGroup** (consumer) | Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint | | EventLoopGroup +| **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 +| **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 io.netty.handler.codec.http.HttpRequest instance. | true | boolean +| **maxHeaderSize** (consumer) | The maximum length of all headers. If the sum of the length of each header exceeds this value a io.netty.handler.codec.TooLongFrameException will be raised. | 8192 | int +| **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 +| **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 +| **serverInitializerFactory** (consumer) | To use a custom ServerInitializerFactory | | ServerInitializer Factory +| **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.netty4.http.NettyHttpBinding then you would need to decode the headers accordingly to this option. | false | boolean +| **usingExecutorService** (consumer) | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. | true | boolean +| **connectTimeout** (producer) | Time to wait for a socket connection to be available. Value is in millis. | 10000 | int +| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler +| **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 +| **reuseChannel** (producer) | 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. | false | boolean +| **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 +| **clientInitializerFactory** (producer) | To use a custom ClientInitializerFactory | | ClientInitializer Factory +| **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 +| **useRelativePath** (producer) | Sets whether to use a relative path in HTTP requests. | false | boolean +| **allowSerializedHeaders** (advanced) | Only used for TCP when transferExchange is true. When set to true serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level. | false | boolean +| **bootstrapConfiguration** (advanced) | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. | | NettyServerBootstrap Configuration +| **channelGroup** (advanced) | To use a explicit ChannelGroup. | | ChannelGroup +| **configuration** (advanced) | To use a custom configured NettyHttpConfiguration for configuring this endpoint. | | NettyHttpConfiguration +| **disableStreamCache** (advanced) | Determines whether or not the raw input stream from Netty HttpRequestgetContent() or HttpResponsetgetContent() 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. Also Netty will auto-close the Netty stream when the Netty HTTP server/HTTP client is done processing which means that if the asynchronous routing engine is in use then any asynchronous thread that may continue routing the org.apache.camel.Exchange may not be able to read the Netty stream because Netty has closed it. | false | boolean +| **headerFilterStrategy** (advanced) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. | | HeaderFilterStrategy +| **nativeTransport** (advanced) | 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 | false | boolean +| **nettyHttpBinding** (advanced) | To use a custom org.apache.camel.component.netty4.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 | int +| **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 | int +| **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 +| **workerCount** (advanced) | 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 +| **workerGroup** (advanced) | To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads. | | EventLoopGroup +| **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 | | 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.netty4.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. | | 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/bb3764e3/components/camel-netty4/src/main/docs/netty4-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty4/src/main/docs/netty4-component.adoc b/components/camel-netty4/src/main/docs/netty4-component.adoc index 10593de..a99043c 100644 --- a/components/camel-netty4/src/main/docs/netty4-component.adoc +++ b/components/camel-netty4/src/main/docs/netty4-component.adoc @@ -57,17 +57,13 @@ The Netty4 component supports 4 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| maximumPoolSize | 16 | 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. - -| executorService | | EventExecutorGroup | To use the given EventExecutorGroup - -| 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 +| **maximumPoolSize** (advanced) | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. | 16 | int +| **configuration** (advanced) | To use the NettyConfiguration as configuration when creating endpoints. | | NettyConfiguration +| **executorService** (advanced) | To use the given EventExecutorGroup | | EventExecutorGroup +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -90,161 +86,90 @@ with the following path and query parameters: #### Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| protocol | | String | *Required* 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 (71 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| disconnect | false | boolean | Whether or not to disconnect(close) from 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. - -| reconnect | true | boolean | Used only in clientMode in consumer the consumer will attempt to reconnect on disconnection if this is enabled - -| reconnectInterval | 10000 | int | Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection - 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 - -| bossGroup | | EventLoopGroup | Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint - -| 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. - -| 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. - -| 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. - -| serverInitializerFactory | | ServerInitializerFactory | To use a custom ServerInitializerFactory - -| usingExecutorService | true | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. - 4+^s| producer -| connectTimeout | 10000 | int | 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. - -| reuseChannel | false | 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. - 4+^s| producer (advanced) -| clientInitializerFactory | | ClientInitializerFactory | To use a custom ClientInitializerFactory - -| 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. - -| useByteBuf | false | boolean | If the useByteBuf is true netty producer will turn the message body into ByteBuf before sending it out. - 4+^s| advanced -| allowSerializedHeaders | false | boolean | Only used for TCP when transferExchange is true. When set to true serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level. - -| bootstrapConfiguration | | NettyServerBootstrapConfiguration | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. - -| channelGroup | | ChannelGroup | To use a explicit ChannelGroup. - -| nativeTransport | false | 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 - -| 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 | 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. - -| sendBufferSize | 65536 | int | 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. - -| udpByteArrayCodec | false | boolean | For UDP only. If enabled the using byte array codec instead of Java serialization protocol. - -| 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 - -| workerGroup | | EventLoopGroup | To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads. - 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. - -| 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. - -| 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 | | 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 | | 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 +| **reconnect** (consumer) | Used only in clientMode in consumer the consumer will attempt to reconnect on disconnection if this is enabled | true | boolean +| **reconnectInterval** (consumer) | Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection | 10000 | int +| **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 +| **bossGroup** (consumer) | Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint | | EventLoopGroup +| **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 +| **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 +| **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 +| **serverInitializerFactory** (consumer) | To use a custom ServerInitializerFactory | | ServerInitializer Factory +| **usingExecutorService** (consumer) | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. | true | boolean +| **connectTimeout** (producer) | Time to wait for a socket connection to be available. Value is in millis. | 10000 | int +| **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 +| **reuseChannel** (producer) | 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. | false | boolean +| **clientInitializerFactory** (producer) | To use a custom ClientInitializerFactory | | ClientInitializer Factory +| **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 +| **useByteBuf** (producer) | If the useByteBuf is true netty producer will turn the message body into ByteBuf before sending it out. | false | boolean +| **allowSerializedHeaders** (advanced) | Only used for TCP when transferExchange is true. When set to true serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level. | false | boolean +| **bootstrapConfiguration** (advanced) | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. | | NettyServerBootstrap Configuration +| **channelGroup** (advanced) | To use a explicit ChannelGroup. | | ChannelGroup +| **nativeTransport** (advanced) | 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 | false | boolean +| **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 | int +| **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 | int +| **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 +| **udpByteArrayCodec** (advanced) | For UDP only. If enabled the using byte array codec instead of Java serialization protocol. | false | boolean +| **workerCount** (advanced) | 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 +| **workerGroup** (advanced) | To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads. | | EventLoopGroup +| **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. | | 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. | | 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 | | 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. | | 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/bb3764e3/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc index 55a0a48..cfaa486 100644 --- a/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc +++ b/components/camel-olingo2/camel-olingo2-component/src/main/docs/olingo2-component.adoc @@ -47,13 +47,11 @@ The Olingo2 component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| common -| configuration | | Olingo2Configuration | To use the shared configuration - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (common) | To use the shared configuration | | Olingo2Configuration +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -71,46 +69,32 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| apiName | | Olingo2ApiName | *Required* What kind of operation to perform -| methodName | | String | *Required* What sub operation to use for the selected operation +| Name | Description | Default | Type +| **apiName** | *Required* What kind of operation to perform | | Olingo2ApiName +| **methodName** | *Required* What sub operation to use for the selected operation | | String |======================================================================= #### Query Parameters (14 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| connectTimeout | 30000 | int | HTTP connection creation timeout in milliseconds defaults to 30000 (30 seconds) - -| contentType | application/json;charset=utf-8 | String | Content-Type header value can be used to specify JSON or XML message format defaults to application/json;charset=utf-8 - -| httpAsyncClientBuilder | | HttpAsyncClientBuilder | Custom HTTP async client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely - -| httpClientBuilder | | HttpClientBuilder | Custom HTTP client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely - -| httpHeaders | | Map | Custom HTTP headers to inject into every request this could include OAuth tokens etc. - -| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body - -| proxy | | HttpHost | HTTP proxy server configuration - -| serviceUri | | String | Target OData service base URI e.g. http://services.odata.org/OData/OData.svc - -| socketTimeout | 30000 | int | HTTP request timeout in milliseconds defaults to 30000 (30 seconds) - -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **connectTimeout** (common) | HTTP connection creation timeout in milliseconds defaults to 30000 (30 seconds) | 30000 | int +| **contentType** (common) | Content-Type header value can be used to specify JSON or XML message format defaults to application/json;charset=utf-8 | application/json;charset=utf-8 | String +| **httpAsyncClientBuilder** (common) | Custom HTTP async client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely | | HttpAsyncClientBuilder +| **httpClientBuilder** (common) | Custom HTTP client builder for more complex HTTP client configuration overrides connectionTimeout socketTimeout proxy and sslContext. Note that a socketTimeout MUST be specified in the builder otherwise OData requests could block indefinitely | | HttpClientBuilder +| **httpHeaders** (common) | Custom HTTP headers to inject into every request this could include OAuth tokens etc. | | Map +| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | String +| **proxy** (common) | HTTP proxy server configuration | | HttpHost +| **serviceUri** (common) | Target OData service base URI e.g. http://services.odata.org/OData/OData.svc | | String +| **socketTimeout** (common) | HTTP request timeout in milliseconds defaults to 30000 (30 seconds) | 30000 | int +| **sslContextParameters** (common) | To configure security using SSLContextParameters | | SSLContextParameters +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-openshift/src/main/docs/openshift-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openshift/src/main/docs/openshift-component.adoc b/components/camel-openshift/src/main/docs/openshift-component.adoc index 384799e..18ce411 100644 --- a/components/camel-openshift/src/main/docs/openshift-component.adoc +++ b/components/camel-openshift/src/main/docs/openshift-component.adoc @@ -37,19 +37,14 @@ The OpenShift component supports 5 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| security -| username | | String | The username to login to openshift server. - -| password | | String | The password for login to openshift server. - 4+^s| common -| domain | | String | Domain name. If not specified then the default domain is used. - -| server | | String | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **username** (security) | The username to login to openshift server. | | String +| **password** (security) | The password for login to openshift server. | | String +| **domain** (common) | Domain name. If not specified then the default domain is used. | | String +| **server** (common) | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used. | | String +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -65,69 +60,43 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| clientId | | String | *Required* The client id +| Name | Description | Default | Type +| **clientId** | *Required* The client id | | String |======================================================================= #### Query Parameters (26 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| domain | | String | Domain name. If not specified then the default domain is used. - -| password | | String | *Required* The password for login to openshift server. - -| server | | String | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used. - -| username | | String | *Required* The username to login to openshift server. - 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. - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - 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. - -| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. - 4+^s| producer -| application | | String | The application name to start stop restart or get the state. - -| mode | | String | Whether to output the message body as a pojo or json. For pojo the message is a List type. - -| operation | | String | The operation to perform which can be: list start stop restart and state. The list operation returns information about all the applications in json format. The state operation returns the state such as: started stopped etc. The other operations does not return any value. - 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| scheduler -| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. - -| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. - -| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. - -| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). - -| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. - -| initialDelay | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). - -| runLoggingLevel | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. - -| scheduledExecutorService | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. - -| scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component - -| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. - -| startScheduler | true | boolean | Whether the scheduler should be auto started. - -| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. - -| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. +| Name | Description | Default | Type +| **domain** (common) | Domain name. If not specified then the default domain is used. | | String +| **password** (common) | *Required* The password for login to openshift server. | | String +| **server** (common) | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used. | | String +| **username** (common) | *Required* The username to login to openshift server. | | String +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| **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 +| **pollStrategy** (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPoll Strategy +| **application** (producer) | The application name to start stop restart or get the state. | | String +| **mode** (producer) | Whether to output the message body as a pojo or json. For pojo the message is a List type. | | String +| **operation** (producer) | The operation to perform which can be: list start stop restart and state. The list operation returns information about all the applications in json format. The state operation returns the state such as: started stopped etc. The other operations does not return any value. | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| **backoffMultiplier** (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int +| **delay** (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long +| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| **initialDelay** (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long +| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean +| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean |======================================================================= // endpoint options: END
