Netty HTTP

Netty HTTP server and client using the Netty 4.x.

Metadata

Property	Value
Scheme	`netty-http`
Support Level	Stable
Labels	networking,http
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-netty-http</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`protocol`	string	✓		The protocol to use which is either http, https or proxy (consumer only).
`host`	string	✓		The local hostname such as localhost, or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer.
`port`	integer			The host port number
`path`	string			Resource path
`bridgeEndpoint`	boolean		`false`	If the option is true, the producer will ignore the NettyHttpConstants.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`	boolean		`false`	Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer.
`keepAlive`	boolean		`true`	Setting to ensure socket is not closed due to inactivity
`reuseAddress`	boolean		`true`	Setting to facilitate socket multiplexing
`reuseChannel`	boolean		`false`	This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useful 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 NettyConstants#NETTY_CHANNEL which allows you to obtain the channel during routing and use it as well.
`sync`	boolean		`true`	Setting to set endpoint as one-way or request-response
`tcpNoDelay`	boolean		`true`	Setting to improve TCP protocol performance
`matchOnUriPrefix`	boolean		`false`	Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found.
`muteException`	boolean		`false`	If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace.
`send503whenSuspended`	boolean		`true`	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.
`backlog`	integer			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`	integer		`1`	When netty works on nio mode, it uses default bossCount parameter from Netty, which is 1. User can use this option to override the default bossCount from Netty
`bossGroup`	object			Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.
`chunkedMaxContentLength`	integer		`1048576`	Value in bytes the max content length per chunked frame received on the Netty HTTP server.
`compression`	boolean		`false`	Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers.
`disconnectOnNoReply`	boolean		`true`	If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back.
`exceptionHandler`	object			To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exchangePattern`	object			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.
`logWarnOnBadRequest`	boolean		`true`	Whether Netty HTTP server should log a WARN if decoding the HTTP request failed and a HTTP Status 400 (bad request) is returned.
`mapHeaders`	boolean		`true`	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.
`maxChunkSize`	integer		`8192`	The maximum length of the content or each chunk. If the content length (or the length of each chunk) exceeds this value, the content or chunk will be split into multiple io.netty.handler.codec.http.HttpContents whose length is maxChunkSize at maximum. See io.netty.handler.codec.http.HttpObjectDecoder
`maxHeaderSize`	integer		`8192`	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.
`maxInitialLineLength`	integer		`4096`	The maximum length of the initial line (e.g. {code GET / HTTP/1.0} or {code HTTP/1.0 200 OK}) If the length of the initial line exceeds this value, a TooLongFrameException will be raised. See io.netty.handler.codec.http.HttpObjectDecoder
`nettyServerBootstrapFactory`	object			To use a custom NettyServerBootstrapFactory
`nettySharedHttpServer`	object			To use a shared Netty HTTP server. See Netty HTTP Server Example for more details.
`noReplyLogLevel`	object		`WARN`	If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back.
`serverClosedChannelExceptionCaughtLogLevel`	object		`DEBUG`	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`	object		`WARN`	If the server (NettyConsumer) catches an exception then its logged using this logging level.
`serverInitializerFactory`	object			To use a custom ServerInitializerFactory
`traceEnabled`	boolean		`false`	Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off.
`urlDecodeHeaders`	boolean		`false`	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.
`usingExecutorService`	boolean		`true`	Whether to use ordered thread pool, to ensure events are processed orderly on the same channel.
`connectTimeout`	integer		`10000`	Time to wait for a socket connection to be available. Value is in milliseconds.
`cookieHandler`	object			Configure a cookie handler to maintain a HTTP session
`requestTimeout`	integer			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`	boolean		`true`	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.
`clientInitializerFactory`	object			To use a custom ClientInitializerFactory
`lazyChannelCreation`	boolean		`true`	Channels can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started.
`lazyStartProducer`	boolean		`false`	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.
`okStatusCodeRange`	string		`200-299`	The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included. The default range is 200-299
`producerPoolBlockWhenExhausted`	boolean		`true`	Sets the value for the blockWhenExhausted configuration attribute. It determines whether to block when the borrowObject() method is invoked when the pool is exhausted (the maximum number of active objects has been reached).
`producerPoolEnabled`	boolean		`true`	Whether producer pool is enabled or not. Important: If you turn this off then a single shared connection is used for the producer, also if you are doing request/reply. That means there is a potential issue with interleaved responses if replies comes back out-of-order. Therefore you need to have a correlation id in both the request and reply messages so you can properly correlate the replies to the Camel callback that is responsible for continue processing the message in Camel. To do this you need to implement NettyCamelStateCorrelationManager as correlation manager and configure it via the correlationManager option. See also the correlationManager option for more details.
`producerPoolMaxIdle`	integer		`100`	Sets the cap on the number of idle instances in the pool.
`producerPoolMaxTotal`	integer		`-1`	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. Be careful to not set this value too low (such as 1) as the pool must have space to create a producer such as when performing retries. Be mindful that the option producerPoolBlockWhenExhausted is default true, and the pool will then block when there is no space, which can lead to the application to hang.
`producerPoolMaxWait`	integer		`-1`	Sets the maximum duration (value in millis) the borrowObject() method should block before throwing an exception when the pool is exhausted and producerPoolBlockWhenExhausted is true. When less than 0, the borrowObject() method may block indefinitely.
`producerPoolMinEvictableIdle`	integer		`300000`	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`	integer			Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects.
`useRelativePath`	boolean		`true`	Sets whether to use a relative path in HTTP requests.
`allowSerializedHeaders`	boolean		`false`	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.
`channelGroup`	object			To use a explicit ChannelGroup.
`configuration`	object			To use a custom configured NettyHttpConfiguration for configuring this endpoint.
`disableStreamCache`	boolean		`false`	Determines whether or not the raw input stream from Netty HttpRequest#getContent() or HttpResponset#getContent() 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.
`headerFilterStrategy`	object			To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.
`nativeTransport`	boolean		`false`	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`	object			To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API.
`options`	object			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`	integer		`65536`	The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes.
`receiveBufferSizePredictor`	integer			Configures the buffer size predictor. See details at Jetty documentation and this mail thread.
`sendBufferSize`	integer		`65536`	The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes.
`synchronous`	boolean		`false`	Sets whether synchronous processing should be strictly used
`transferException`	boolean		`false`	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`	boolean		`false`	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.
`unixDomainSocketPath`	string			Path to unix domain socket to use instead of inet socket. Host and port parameters will not be used, however required. It is ok to set dummy values for them. Must be used with nativeTransport=true and clientMode=false.
`workerCount`	integer			When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2). User can use this option to override the default workerCount from Netty.
`workerGroup`	object			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.
`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.
`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.
`enabledProtocols`	string		`TLSv1.2,TLSv1.3`	Which protocols to enable when using SSL
`hostnameVerification`	boolean		`false`	To enable/disable hostname verification on SSLEngine
`keyStoreFile`	string			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`	boolean		`false`	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`	object			Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources.
`securityOptions`	object			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`	boolean		`false`	Setting to specify whether SSL encryption is applied to this endpoint
`sslClientCertHeaders`	boolean		`false`	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`	object			To configure security using SSLContextParameters
`sslHandler`	object			Reference to a class that could be used to return an SSL Handler
`trustStoreFile`	string			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.