Netty HTTP

Netty HTTP

Scheme: netty-http

HTTP based {@link NettyEndpoint}

Name Kind Type Required Deprecated Default Value Enum Values Description
path path java.lang.String true false Resource path
protocol path java.lang.String true false
host path java.lang.String true false
port path int true false
nettyHttpBinding parameter org.apache.camel.component.netty.http.NettyHttpBinding false To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API.
headerFilterStrategy parameter org.apache.camel.spi.HeaderFilterStrategy false To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.
urlDecodeHeaders parameter 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.
mapHeaders parameter boolean false 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 org.jboss.netty.handler.codec.http.HttpRequest instance.
compression parameter boolean false Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers.
throwExceptionOnFailure parameter boolean false 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.
transferException parameter 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.
matchOnUriPrefix parameter boolean false Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found.
bridgeEndpoint parameter boolean false 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).
disableStreamCache parameter boolean false Determines whether or not the raw input stream from Netty HttpRequest#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.
send503whenSuspended parameter boolean false 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.
chunkedMaxContentLength parameter int false 1048576 Value in bytes the max content length per chunked frame received on the Netty HTTP server.
maxHeaderSize parameter int false 8192 The maximum length of all headers. If the sum of the length of each header exceeds this value, a {@link TooLongFrameException} will be raised.
useRelativePath parameter boolean false false Sets whether to use a relative path in HTTP requests.
requestTimeout parameter long false
sync parameter boolean false true
textline parameter boolean false
delimiter parameter org.apache.camel.component.netty.TextLineDelimiter false LINE LINE
NULL
autoAppendDelimiter parameter boolean false true
decoderMaxLineLength parameter int false 1024
encoding parameter java.lang.String false
disconnect parameter boolean false
lazyChannelCreation parameter boolean false true
transferExchange parameter boolean false
disconnectOnNoReply parameter boolean false true
noReplyLogLevel parameter org.apache.camel.LoggingLevel false WARN DEBUG
ERROR
INFO
TRACE
WARN
OFF
serverExceptionCaughtLogLevel parameter org.apache.camel.LoggingLevel false WARN DEBUG
ERROR
INFO
TRACE
WARN
OFF
serverClosedChannelExceptionCaughtLogLevel parameter org.apache.camel.LoggingLevel false DEBUG DEBUG
ERROR
INFO
TRACE
WARN
OFF
allowDefaultCodec parameter boolean false true
clientPipelineFactory parameter org.apache.camel.component.netty.ClientPipelineFactory false
orderedThreadPoolExecutor parameter boolean false true
producerPoolMaxActive parameter int false -1
producerPoolMinIdle parameter int false
producerPoolMaxIdle parameter int false 100
producerPoolMinEvictableIdle parameter long false 300000
producerPoolEnabled parameter boolean false true
udpConnectionlessSending parameter boolean false
clientMode parameter boolean false
broadcast parameter boolean false
sendBufferSize parameter long false 65536
receiveBufferSize parameter long false 65536
receiveBufferSizePredictor parameter int false
bossCount parameter int false 1
workerCount parameter int false
keepAlive parameter boolean false true
tcpNoDelay parameter boolean false true
reuseAddress parameter boolean false true
connectTimeout parameter long false 10000
backlog parameter int false
serverPipelineFactory parameter org.apache.camel.component.netty.ServerPipelineFactory false
nettyServerBootstrapFactory parameter org.apache.camel.component.netty.NettyServerBootstrapFactory false
ssl parameter boolean false
sslClientCertHeaders parameter boolean false
sslHandler parameter org.jboss.netty.handler.ssl.SslHandler false
sslContextParameters parameter org.apache.camel.util.jsse.SSLContextParameters false
needClientAuth parameter boolean false
keyStoreFile parameter java.io.File false
trustStoreFile parameter java.io.File false
keyStoreResource parameter java.lang.String false
trustStoreResource parameter java.lang.String false
keyStoreFormat parameter java.lang.String false JKS
securityProvider parameter java.lang.String false SunX509
enabledProtocols parameter java.lang.String false TLSv1,TLSv1.1,TLSv1.2
passphrase parameter java.lang.String false
networkInterface parameter java.lang.String false
traceEnabled parameter boolean false Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off.
httpMethodRestrict parameter java.lang.String false To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma.
nettySharedHttpServer parameter org.apache.camel.component.netty.http.NettySharedHttpServer false To use a shared Netty HTTP server. See Netty HTTP Server Example for more details.
securityConfiguration parameter org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration false Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources.
exchangePattern parameter org.apache.camel.ExchangePattern false InOnly InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
synchronous parameter boolean false false Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

netty-http consumer

HTTP based {@link NettyConsumer}