This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • Netty HTTP

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added consumer bridge information.

...

Div
classconfluenceTableSmall

Name

Default Value

Description

chunkedMaxContentLength

1mb

Value in bytes the max content length per chunked frame received on the Netty HTTP server.

compression

false

Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers.

headerFilterStrategy

 

To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.

httpMethodRestrict

 

To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma.

mapHeaders

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.

matchOnUriPrefix

false

Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. See further below for more details.

nettyHttpBinding

 

To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API.

bridgeEndpoint

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).

throwExceptionOnFailure

true

Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardles of the HTTP status code.

traceEnabled

false

Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off.

transferException

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.

urlDecodeHeaders

 

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. Notice: This option is default true for Camel 2.12.x, and default false from Camel 2.13 onwards.

nettySharedHttpServer

null

To use a shared Netty HTTP server. See Netty HTTP Server Example for more details.

disableStreamCache

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.

securityConfiguration

null

Consumer only. Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources.

send503whenSuspended

true

Consumer only. 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.

...