--- apiVersion: v1 kind: List items: - apiVersion: v1 kind: ConfigMap metadata: labels: funktion.fabric8.io/kind: Connector provider: fabric8 project: connector-netty-http version: 1.1.21 group: io.fabric8.funktion.connector name: netty-http data: deployment.yml: | --- apiVersion: extensions/v1beta1 kind: Deployment metadata: labels: funktion.fabric8.io/kind: Subscription connector: netty-http spec: replicas: 1 template: metadata: labels: funktion.fabric8.io/kind: Subscription connector: netty-http spec: containers: - image: fabric8/connector-netty-http:1.1.21 name: connector schema.yml: | --- component: kind: component scheme: netty-http extendsScheme: netty syntax: netty-http:protocol:host:port/path title: Netty HTTP description: Netty HTTP server and client using the Netty 3.x library. label: http deprecated: true async: true lenientProperties: true javaType: org.apache.camel.component.netty.http.NettyHttpComponent groupId: org.apache.camel artifactId: camel-netty-http version: 2.18.1 componentProperties: nettyHttpBinding: kind: property type: object javaType: org.apache.camel.component.netty.http.NettyHttpBinding deprecated: false secret: false description: To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. headerFilterStrategy: kind: property type: object javaType: org.apache.camel.spi.HeaderFilterStrategy deprecated: false secret: false description: To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. securityConfiguration: kind: property type: object javaType: org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration deprecated: false secret: false description: Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. configuration: kind: property type: object javaType: org.apache.camel.component.netty.NettyConfiguration deprecated: false secret: false description: To use the NettyConfiguration as configuration when creating endpoints. maximumPoolSize: kind: property type: integer javaType: int deprecated: false secret: false description: The core pool size for the ordered thread pool if its in use. The default value is 16. properties: protocol: kind: path group: common required: true type: string javaType: java.lang.String enum: - http - https deprecated: false secret: false description: The protocol to use which is either http or https host: kind: path group: common required: true type: string javaType: java.lang.String deprecated: false secret: false description: The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. port: kind: path group: common type: integer javaType: int deprecated: false secret: false description: The host port number path: kind: path group: common type: string javaType: java.lang.String deprecated: false secret: false description: Resource path bridgeEndpoint: kind: parameter group: common type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: 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: kind: parameter group: common type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. keepAlive: kind: parameter group: common type: boolean javaType: boolean deprecated: false secret: false defaultValue: true description: Setting to ensure socket is not closed due to inactivity reuseAddress: kind: parameter group: common type: boolean javaType: boolean deprecated: false secret: false defaultValue: true description: Setting to facilitate socket multiplexing sync: kind: parameter group: common type: boolean javaType: boolean deprecated: false secret: false defaultValue: true description: Setting to set endpoint as one-way or request-response tcpNoDelay: kind: parameter group: common type: boolean javaType: boolean deprecated: false secret: false defaultValue: true description: Setting to improve TCP protocol performance bridgeErrorHandler: kind: parameter group: consumer label: consumer type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: false description: 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/ERROR level and ignored. matchOnUriPrefix: kind: parameter group: consumer label: consumer type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. send503whenSuspended: kind: parameter group: consumer label: consumer type: boolean javaType: boolean deprecated: false secret: false defaultValue: true description: 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: kind: parameter group: consumer (advanced) label: consumer,advanced type: integer javaType: int deprecated: false secret: false description: 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: kind: parameter group: consumer (advanced) label: consumer,advanced type: integer javaType: int deprecated: false secret: false defaultValue: "1" description: When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty bossPool: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.jboss.netty.channel.socket.nio.BossPool deprecated: false secret: false description: To use a explicit org.jboss.netty.channel.socket.nio.BossPool as the boss thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own boss pool with 1 core thread. channelGroup: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.jboss.netty.channel.group.ChannelGroup deprecated: false secret: false description: To use a explicit ChannelGroup. chunkedMaxContentLength: kind: parameter group: consumer (advanced) label: consumer,advanced type: integer javaType: int deprecated: false secret: false defaultValue: "1048576" description: Value in bytes the max content length per chunked frame received on the Netty HTTP server. compression: kind: parameter group: consumer (advanced) label: consumer,advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers. disableStreamCache: kind: parameter group: consumer (advanced) label: consumer,advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Determines whether or not the raw input stream from Netty HttpRequestgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Netty raw stream. disconnectOnNoReply: kind: parameter group: consumer (advanced) label: consumer,advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: true description: If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. exceptionHandler: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.apache.camel.spi.ExceptionHandler optionalPrefix: consumer. deprecated: false secret: false description: 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/ERROR level and ignored. exchangePattern: kind: parameter group: consumer (advanced) label: consumer,advanced type: string javaType: org.apache.camel.ExchangePattern enum: - InOnly - RobustInOnly - InOut - InOptionalOut - OutOnly - RobustOutOnly - OutIn - OutOptionalIn deprecated: false secret: false description: Sets the exchange pattern when the consumer creates an exchange. httpMethodRestrict: kind: parameter group: consumer (advanced) label: consumer,advanced type: string javaType: java.lang.String deprecated: false secret: false description: To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma. mapHeaders: kind: parameter group: consumer (advanced) label: consumer,advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: true description: If this option is enabled then during binding from Netty to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.netty.http.NettyHttpMessage message with the method getHttpRequest() that returns the Netty HTTP request org.jboss.netty.handler.codec.http.HttpRequest instance. maxChannelMemorySize: kind: parameter group: consumer (advanced) label: consumer,advanced type: integer javaType: long deprecated: false secret: false defaultValue: "10485760" description: The maximum total size of the queued events per channel when using orderedThreadPoolExecutor. Specify 0 to disable. maxHeaderSize: kind: parameter group: consumer (advanced) label: consumer,advanced type: integer javaType: int deprecated: false secret: false defaultValue: "8192" description: The maximum length of all headers. If the sum of the length of each header exceeds this value a TooLongFrameException will be raised. maxTotalMemorySize: kind: parameter group: consumer (advanced) label: consumer,advanced type: integer javaType: long deprecated: false secret: false defaultValue: "209715200" description: The maximum total size of the queued events for this pool when using orderedThreadPoolExecutor. Specify 0 to disable. nettyServerBootstrapFactory: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.apache.camel.component.netty.NettyServerBootstrapFactory deprecated: false secret: false description: To use a custom NettyServerBootstrapFactory nettySharedHttpServer: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.apache.camel.component.netty.http.NettySharedHttpServer deprecated: false secret: false description: To use a shared Netty HTTP server. See Netty HTTP Server Example for more details. noReplyLogLevel: kind: parameter group: consumer (advanced) label: consumer,advanced type: string javaType: org.apache.camel.LoggingLevel enum: - TRACE - DEBUG - INFO - WARN - ERROR - OFF deprecated: false secret: false defaultValue: WARN description: If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. orderedThreadPoolExecutor: kind: parameter group: consumer (advanced) label: consumer,advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: true description: Whether to use ordered thread pool to ensure events are processed orderly on the same channel. See details at the netty javadoc of org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor for more details. serverClosedChannelExceptionCaughtLogLevel: kind: parameter group: consumer (advanced) label: consumer,advanced type: string javaType: org.apache.camel.LoggingLevel enum: - TRACE - DEBUG - INFO - WARN - ERROR - OFF deprecated: false secret: false defaultValue: DEBUG description: 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: kind: parameter group: consumer (advanced) label: consumer,advanced type: string javaType: org.apache.camel.LoggingLevel enum: - TRACE - DEBUG - INFO - WARN - ERROR - OFF deprecated: false secret: false defaultValue: WARN description: If the server (NettyConsumer) catches an exception then its logged using this logging level. serverPipelineFactory: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.apache.camel.component.netty.ServerPipelineFactory deprecated: false secret: false description: To use a custom ServerPipelineFactory traceEnabled: kind: parameter group: consumer (advanced) label: consumer,advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off. urlDecodeHeaders: kind: parameter group: consumer (advanced) label: consumer,advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: If this option is enabled then during binding from Netty to Camel Message then the header values will be URL decoded (eg 20 will be a space character. Notice this option is used by the default org.apache.camel.component.netty.http.NettyHttpBinding and therefore if you implement a custom org.apache.camel.component.netty.http.NettyHttpBinding then you would need to decode the headers accordingly to this option. workerCount: kind: parameter group: consumer (advanced) label: consumer,advanced type: integer javaType: int deprecated: false secret: false description: When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty workerPool: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.jboss.netty.channel.socket.nio.WorkerPool deprecated: false secret: false description: To use a explicit org.jboss.netty.channel.socket.nio.WorkerPool as the worker thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own worker pool with 2 x cpu count core threads. connectTimeout: kind: parameter group: producer label: producer type: integer javaType: long deprecated: false secret: false defaultValue: "10000" description: Time to wait for a socket connection to be available. Value is in millis. requestTimeout: kind: parameter group: producer label: producer type: integer javaType: long deprecated: false secret: false description: 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: kind: parameter group: producer label: producer type: boolean javaType: boolean deprecated: false secret: false defaultValue: true description: 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. clientPipelineFactory: kind: parameter group: producer (advanced) label: producer,advanced type: object javaType: org.apache.camel.component.netty.ClientPipelineFactory deprecated: false secret: false description: To use a custom ClientPipelineFactory lazyChannelCreation: kind: parameter group: producer (advanced) label: producer,advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: true description: Channels can be lazily created to avoid exceptions if the remote server is not up and running when the Camel producer is started. okStatusCodeRange: kind: parameter group: producer (advanced) label: producer,advanced type: string javaType: java.lang.String deprecated: false secret: false defaultValue: 200-299 description: 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: kind: parameter group: producer (advanced) label: producer,advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: true description: '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: kind: parameter group: producer (advanced) label: producer,advanced type: integer javaType: int deprecated: false secret: false defaultValue: -1 description: 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: kind: parameter group: producer (advanced) label: producer,advanced type: integer javaType: int deprecated: false secret: false defaultValue: "100" description: Sets the cap on the number of idle instances in the pool. producerPoolMinEvictableIdle: kind: parameter group: producer (advanced) label: producer,advanced type: integer javaType: long deprecated: false secret: false defaultValue: "300000" description: 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: kind: parameter group: producer (advanced) label: producer,advanced type: integer javaType: int deprecated: false secret: false description: Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. useChannelBuffer: kind: parameter group: producer (advanced) label: producer,advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: If the useChannelBuffer is true netty producer will turn the message body into ChannelBuffer before sending it out. useRelativePath: kind: parameter group: producer (advanced) label: producer,advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Sets whether to use a relative path in HTTP requests. Some third party backend systems such as IBM Datapower do not support absolute URIs in HTTP POSTs and setting this option to true can work around this problem. bootstrapConfiguration: kind: parameter group: advanced label: advanced type: object javaType: org.apache.camel.component.netty.NettyServerBootstrapConfiguration deprecated: false secret: false description: To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. configuration: kind: parameter group: advanced label: advanced type: object javaType: org.apache.camel.component.netty.http.NettyHttpConfiguration deprecated: false secret: false description: To use a custom configured NettyHttpConfiguration for configuring this endpoint. headerFilterStrategy: kind: parameter group: advanced label: advanced type: object javaType: org.apache.camel.spi.HeaderFilterStrategy deprecated: false secret: false description: To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. nettyHttpBinding: kind: parameter group: advanced label: advanced type: object javaType: org.apache.camel.component.netty.http.NettyHttpBinding deprecated: false secret: false description: To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. options: kind: parameter group: advanced label: advanced type: object javaType: java.util.Map prefix: option. multiValue: true deprecated: false secret: false description: 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: kind: parameter group: advanced label: advanced type: integer javaType: long deprecated: false secret: false defaultValue: "65536" description: The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. receiveBufferSizePredictor: kind: parameter group: advanced label: advanced type: integer javaType: int deprecated: false secret: false description: Configures the buffer size predictor. See details at Jetty documentation and this mail thread. sendBufferSize: kind: parameter group: advanced label: advanced type: integer javaType: long deprecated: false secret: false defaultValue: "65536" description: The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. synchronous: kind: parameter group: advanced label: advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). transferException: kind: parameter group: advanced label: advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: 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: kind: parameter group: advanced label: advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: '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.' decoder: kind: parameter group: codec label: codec type: object javaType: org.jboss.netty.channel.ChannelHandler deprecated: true secret: false description: To use a single decoder. This options is deprecated use encoders instead. decoders: kind: parameter group: codec label: codec type: string javaType: java.lang.String deprecated: false secret: false description: 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: kind: parameter group: codec label: codec type: object javaType: org.jboss.netty.channel.ChannelHandler deprecated: true secret: false description: To use a single encoder. This options is deprecated use encoders instead. encoders: kind: parameter group: codec label: codec type: string javaType: java.lang.String deprecated: false secret: false description: 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: kind: parameter group: security label: security type: string javaType: java.lang.String deprecated: false secret: false defaultValue: TLSv1,TLSv1.1,TLSv1.2 description: Which protocols to enable when using SSL keyStoreFile: kind: parameter group: security label: security type: string javaType: java.io.File deprecated: false secret: false description: Client side certificate keystore to be used for encryption keyStoreFormat: kind: parameter group: security label: security type: string javaType: java.lang.String deprecated: false secret: false defaultValue: JKS description: Keystore format to be used for payload encryption. Defaults to JKS if not set keyStoreResource: kind: parameter group: security label: security type: string javaType: java.lang.String deprecated: false secret: false description: '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: kind: parameter group: security label: consumer,security type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Configures whether the server needs client authentication when using SSL. passphrase: kind: parameter group: security label: security type: string javaType: java.lang.String deprecated: false secret: false description: Password setting to use in order to encrypt/decrypt payloads sent using SSH securityConfiguration: kind: parameter group: security label: consumer,security type: object javaType: org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration deprecated: false secret: false description: Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. securityOptions: kind: parameter group: security label: consumer,security type: object javaType: java.util.Map prefix: securityConfiguration. multiValue: true deprecated: false secret: false description: To configure NettyHttpSecurityConfiguration using key/value pairs from the map securityProvider: kind: parameter group: security label: security type: string javaType: java.lang.String deprecated: false secret: false defaultValue: SunX509 description: Security provider to be used for payload encryption. Defaults to SunX509 if not set. ssl: kind: parameter group: security label: security type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Setting to specify whether SSL encryption is applied to this endpoint sslClientCertHeaders: kind: parameter group: security label: security type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: 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: kind: parameter group: security label: security type: object javaType: org.apache.camel.util.jsse.SSLContextParameters deprecated: false secret: false description: To configure security using SSLContextParameters sslHandler: kind: parameter group: security label: security type: object javaType: org.jboss.netty.handler.ssl.SslHandler deprecated: false secret: false description: Reference to a class that could be used to return an SSL Handler trustStoreFile: kind: parameter group: security label: security type: string javaType: java.io.File deprecated: false secret: false description: Server side certificate keystore to be used for encryption trustStoreResource: kind: parameter group: security label: security type: string javaType: java.lang.String deprecated: false secret: false description: '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.' documentation.adoc: |+ [[NettyHTTP-NettyHTTPComponent]] Netty HTTP Component ~~~~~~~~~~~~~~~~~~~~ *Available as of Camel 2.12* The *netty-http* component is an extension to link:netty.html[Netty] component to facilitiate HTTP transport with link:netty.html[Netty]. This camel component supports both producer and consumer endpoints. WARNING: This component is deprecated. You should use link:netty4-http.html[Netty4 HTTP]. INFO: *Stream*. Netty is stream based, which means the input it receives is submitted to Camel as a stream. That means you will only be able to read the content of the stream *once*. If you find a situation where the message body appears to be empty or you need to access the data multiple times (eg: doing multicasting, or redelivery error handling) you should use link:stream-caching.html[Stream caching] or convert the message body to a `String` which is safe to be re-read multiple times. Notice Netty4 HTTP reads the entire stream into memory using `io.netty.handler.codec.http.HttpObjectAggregator` to build the entire full http message. But the resulting message is still a stream based message which is readable once. Maven users will need to add the following dependency to their `pom.xml` for this component: [source,xml] ------------------------------------------------------------ org.apache.camel camel-netty-http x.x.x ------------------------------------------------------------ [[NettyHTTP-URIformat]] URI format ^^^^^^^^^^ The URI scheme for a netty component is as follows [source,java] ------------------------------------------ netty-http:http://localhost:8080[?options] ------------------------------------------ You can append query options to the URI in the following format, `?option=value&option=value&...` INFO: *Query parameters vs endpoint options*. You may be wondering how Camel recognizes URI query parameters and endpoint options. For example you might create endpoint URI as follows - `netty-http:http//example.com?myParam=myValue&compression=true` . In this example `myParam` is the HTTP parameter, while `compression` is the Camel endpoint option. The strategy used by Camel in such situations is to resolve available endpoint options and remove them from the URI. It means that for the discussed example, the HTTP request sent by Netty HTTP producer to the endpoint will look as follows -??`http//example.com?myParam=myValue` , because `compression` endpoint option will be resolved and removed from the target URL. Keep also in mind that you cannot specify endpoint options using dynamic headers (like `CamelHttpQuery`). Endpoint options can be specified only at the endpoint URI definition level (like `to` or `from` DSL elements). [[NettyHTTP-HTTPOptions]] HTTP Options ^^^^^^^^^^^^ INFO: *A lot more options*. *Important:* This component inherits all the options from link:netty.html[Netty]. So make sure to look at the link:netty.html[Netty] documentation as well. + Notice that some options from link:netty.html[Netty] is not applicable when using this link:netty-http.html[Netty HTTP] component, such as options related to UDP transport. // component options: START The Netty HTTP component supports 5 options which are listed below. {% raw %} [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description | nettyHttpBinding | NettyHttpBinding | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. | headerFilterStrategy | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. | securityConfiguration | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. | configuration | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. | maximumPoolSize | int | The core pool size for the ordered thread pool if its in use. The default value is 16. |======================================================================= {% endraw %} // component options: END // endpoint options: START The Netty HTTP component supports 82 endpoint options which are listed below: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description | protocol | common | | String | *Required* The protocol to use which is either http or https | host | common | | 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 | common | | int | The host port number | path | common | | String | Resource path | bridgeEndpoint | common | 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 | common | false | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | keepAlive | common | true | boolean | Setting to ensure socket is not closed due to inactivity | reuseAddress | common | true | boolean | Setting to facilitate socket multiplexing | sync | common | true | boolean | Setting to set endpoint as one-way or request-response | tcpNoDelay | common | true | boolean | Setting to improve TCP protocol performance | bridgeErrorHandler | consumer | 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/ERROR level and ignored. | matchOnUriPrefix | consumer | 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 | consumer | 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. | backlog | consumer (advanced) | | 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 | consumer (advanced) | 1 | int | When netty works on nio mode it uses default bossCount parameter from Netty which is 1. User can use this operation to override the default bossCount from Netty | bossPool | consumer (advanced) | | BossPool | To use a explicit org.jboss.netty.channel.socket.nio.BossPool as the boss thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own boss pool with 1 core thread. | channelGroup | consumer (advanced) | | ChannelGroup | To use a explicit ChannelGroup. | chunkedMaxContentLength | consumer (advanced) | 1048576 | int | Value in bytes the max content length per chunked frame received on the Netty HTTP server. | compression | consumer (advanced) | false | boolean | Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers. | disableStreamCache | consumer (advanced) | false | boolean | Determines whether or not the raw input stream from Netty HttpRequestgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Netty raw stream. | disconnectOnNoReply | consumer (advanced) | true | boolean | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. | exceptionHandler | consumer (advanced) | | 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/ERROR level and ignored. | exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. | httpMethodRestrict | consumer (advanced) | | String | To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma. | mapHeaders | consumer (advanced) | true | boolean | If this option is enabled then during binding from Netty to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.netty.http.NettyHttpMessage message with the method getHttpRequest() that returns the Netty HTTP request org.jboss.netty.handler.codec.http.HttpRequest instance. | maxChannelMemorySize | consumer (advanced) | 10485760 | long | The maximum total size of the queued events per channel when using orderedThreadPoolExecutor. Specify 0 to disable. | maxHeaderSize | consumer (advanced) | 8192 | int | The maximum length of all headers. If the sum of the length of each header exceeds this value a TooLongFrameException will be raised. | maxTotalMemorySize | consumer (advanced) | 209715200 | long | The maximum total size of the queued events for this pool when using orderedThreadPoolExecutor. Specify 0 to disable. | nettyServerBootstrapFactory | consumer (advanced) | | NettyServerBootstrapFactory | To use a custom NettyServerBootstrapFactory | nettySharedHttpServer | consumer (advanced) | | NettySharedHttpServer | To use a shared Netty HTTP server. See Netty HTTP Server Example for more details. | noReplyLogLevel | consumer (advanced) | WARN | LoggingLevel | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. | orderedThreadPoolExecutor | consumer (advanced) | true | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. See details at the netty javadoc of org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor for more details. | serverClosedChannelExceptionCaughtLogLevel | consumer (advanced) | 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 | consumer (advanced) | WARN | LoggingLevel | If the server (NettyConsumer) catches an exception then its logged using this logging level. | serverPipelineFactory | consumer (advanced) | | ServerPipelineFactory | To use a custom ServerPipelineFactory | traceEnabled | consumer (advanced) | false | boolean | Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off. | urlDecodeHeaders | consumer (advanced) | false | boolean | If this option is enabled then during binding from Netty to Camel Message then the header values will be URL decoded (eg 20 will be a space character. Notice this option is used by the default org.apache.camel.component.netty.http.NettyHttpBinding and therefore if you implement a custom org.apache.camel.component.netty.http.NettyHttpBinding then you would need to decode the headers accordingly to this option. | workerCount | consumer (advanced) | | int | When netty works on nio mode it uses default workerCount parameter from Netty which is cpu_core_threads2. User can use this operation to override the default workerCount from Netty | workerPool | consumer (advanced) | | WorkerPool | To use a explicit org.jboss.netty.channel.socket.nio.WorkerPool as the worker thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own worker pool with 2 x cpu count core threads. | connectTimeout | producer | 10000 | long | Time to wait for a socket connection to be available. Value is in millis. | requestTimeout | producer | | long | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. | throwExceptionOnFailure | producer | 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. | clientPipelineFactory | producer (advanced) | | ClientPipelineFactory | To use a custom ClientPipelineFactory | lazyChannelCreation | producer (advanced) | 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 | producer (advanced) | 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 | producer (advanced) | 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 | producer (advanced) | -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 | producer (advanced) | 100 | int | Sets the cap on the number of idle instances in the pool. | producerPoolMinEvictableIdle | producer (advanced) | 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 | producer (advanced) | | int | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. | useChannelBuffer | producer (advanced) | false | boolean | If the useChannelBuffer is true netty producer will turn the message body into ChannelBuffer before sending it out. | useRelativePath | producer (advanced) | false | boolean | Sets whether to use a relative path in HTTP requests. Some third party backend systems such as IBM Datapower do not support absolute URIs in HTTP POSTs and setting this option to true can work around this problem. | bootstrapConfiguration | advanced | | NettyServerBootstrapConfiguration | To use a custom configured NettyServerBootstrapConfiguration for configuring this endpoint. | configuration | advanced | | NettyHttpConfiguration | To use a custom configured NettyHttpConfiguration for configuring this endpoint. | headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. | nettyHttpBinding | advanced | | NettyHttpBinding | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. | options | advanced | | 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 | advanced | 65536 | long | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. | receiveBufferSizePredictor | advanced | | int | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. | sendBufferSize | advanced | 65536 | long | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | transferException | advanced | 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 | advanced | 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. | decoder | codec | | ChannelHandler | To use a single decoder. This options is deprecated use encoders instead. | decoders | codec | | 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 | codec | | ChannelHandler | To use a single encoder. This options is deprecated use encoders instead. | encoders | codec | | 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 | security | TLSv1,TLSv1.1,TLSv1.2 | String | Which protocols to enable when using SSL | keyStoreFile | security | | File | Client side certificate keystore to be used for encryption | keyStoreFormat | security | JKS | String | Keystore format to be used for payload encryption. Defaults to JKS if not set | keyStoreResource | security | | 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 | security | false | boolean | Configures whether the server needs client authentication when using SSL. | passphrase | security | | String | Password setting to use in order to encrypt/decrypt payloads sent using SSH | securityConfiguration | security | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. | securityOptions | security | | Map | To configure NettyHttpSecurityConfiguration using key/value pairs from the map | securityProvider | security | SunX509 | String | Security provider to be used for payload encryption. Defaults to SunX509 if not set. | ssl | security | false | boolean | Setting to specify whether SSL encryption is applied to this endpoint | sslClientCertHeaders | security | 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 | security | | SSLContextParameters | To configure security using SSLContextParameters | sslHandler | security | | SslHandler | Reference to a class that could be used to return an SSL Handler | trustStoreFile | security | | File | Server side certificate keystore to be used for encryption | trustStoreResource | security | | 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. |======================================================================= {% endraw %} // endpoint options: END [[NettyHTTP-MessageHeaders]] Message Headers ^^^^^^^^^^^^^^^ The following headers can be used on the producer to control the HTTP request. [width="100%",cols="10%,10%,80%",options="header",] |======================================================================= |Name |Type |Description |`CamelHttpMethod` |`String` |Allow to control what HTTP method to use such as GET, POST, TRACE etc. The type can also be a `org.jboss.netty.handler.codec.http.HttpMethod` instance. |`CamelHttpQuery` |`String` |Allows to provide URI query parameters as a `String` value that overrides the endpoint configuration. Separate multiple parameters using the & sign. For example: `foo=bar&beer=yes`. |`CamelHttpPath` |`String` |*Camel 2.13.1/2.12.4:* Allows to provide URI context-path and query parameters as a `String` value that overrides the endpoint configuration. This allows to reuse the same producer for calling same remote http server, but using a dynamic context-path and query parameters. |`Content-Type` |`String` |To set the content-type of the HTTP body. For example: `text/plain; charset="UTF-8"`. |`CamelHttpResponseCode` |`int` |Allows to set the HTTP Status code to use. By default 200 is used for success, and 500 for failure. |======================================================================= The following headers is provided as meta-data when a route starts from an link:netty-http.html[Netty HTTP] endpoint: The description in the table takes offset in a route having: `from("netty-http:http:0.0.0.0:8080/myapp")...` [width="100%",cols="10%,10%,80%",options="header",] |======================================================================= |Name |Type |Description |`CamelHttpMethod` |`String` |The HTTP method used, such as GET, POST, TRACE etc. |`CamelHttpUrl` |`String` |The URL including protocol, host and port, etc |`CamelHttpUri` |`String` |The URI without protocol, host and port, etc |`CamelHttpQuery` |`String` |Any query parameters, such as `foo=bar&beer=yes` |`CamelHttpRawQuery` |`String` |*Camel 2.13.0*: Any query parameters, such as `foo=bar&beer=yes`. Stored in the raw form, as they arrived to the consumer (i.e. before URL decoding). |`CamelHttpPath` |`String` |Additional context-path. This value is empty if the client called the context-path `/myapp`. If the client calls `/myapp/mystuff`, then this header value is `/mystuff`. In other words its the value after the context-path configured on the route endpoint. |`CamelHttpCharacterEncoding` |`String` |The charset from the content-type header. |`CamelHttpAuthentication` |`String` |If the user was authenticated using HTTP Basic then this header is added with the value `Basic`. |`Content-Type` |`String` | The content type if provided. For example: `text/plain; charset="UTF-8"`. |======================================================================= [[NettyHTTP-AccesstoNettytypes]] Access to Netty types ^^^^^^^^^^^^^^^^^^^^^ This component uses the `org.apache.camel.component.netty.http.NettyHttpMessage` as the message implementation on the link:exchange.html[Exchange]. This allows end users to get access to the original Netty request/response instances if needed, as shown below. Mind that the original response may not be accessible at all times. [source,java] ----------------------------------------------------------------------------------------------------------------- org.jboss.netty.handler.codec.http.HttpRequest request = exchange.getIn(NettyHttpMessage.class).getHttpRequest(); ----------------------------------------------------------------------------------------------------------------- [[NettyHTTP-Examples]] Examples ^^^^^^^^ In the route below we use link:netty-http.html[Netty HTTP] as a HTTP server, which returns back a hardcoded "Bye World" message. [source,java] ---------------------------------------------- from("netty-http:http://0.0.0.0:8080/foo") .transform().constant("Bye World"); ---------------------------------------------- And we can call this HTTP server using Camel also, with the link:producertemplate.html[ProducerTemplate] as shown below: [source,java] ----------------------------------------------------------------------------------------------------------- String out = template.requestBody("netty-http:http://localhost:8080/foo", "Hello World", String.class); System.out.println(out); ----------------------------------------------------------------------------------------------------------- And we get back "Bye World" as the output. [[NettyHTTP-HowdoIletNettymatchwildcards]] How do I let Netty match wildcards ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ By default link:netty-http.html[Netty HTTP] will only match on exact uri's. But you can instruct Netty to match prefixes. For example [source,java] ---------------------------------------------------------- from("netty-http:http://0.0.0.0:8123/foo").to("mock:foo"); ---------------------------------------------------------- In the route above link:netty-http.html[Netty HTTP] will only match if the uri is an exact match, so it will match if you enter + `http://0.0.0.0:8123/foo` but not match if you do `http://0.0.0.0:8123/foo/bar`. So if you want to enable wildcard matching you do as follows: [source,java] -------------------------------------------------------------------------------- from("netty-http:http://0.0.0.0:8123/foo?matchOnUriPrefix=true").to("mock:foo"); -------------------------------------------------------------------------------- So now Netty matches any endpoints with starts with `foo`. To match *any* endpoint you can do: [source,java] ---------------------------------------------------------------------------- from("netty-http:http://0.0.0.0:8123?matchOnUriPrefix=true").to("mock:foo"); ---------------------------------------------------------------------------- [[NettyHTTP-Usingmultiplerouteswithsameport]] Using multiple routes with same port ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In the same link:camelcontext.html[CamelContext] you can have multiple routes from link:netty-http.html[Netty HTTP] that shares the same port (eg a `org.jboss.netty.bootstrap.ServerBootstrap` instance). Doing this requires a number of bootstrap options to be identical in the routes, as the routes will share the same `org.jboss.netty.bootstrap.ServerBootstrap` instance. The instance will be configured with the options from the first route created. The options the routes must be identical configured is all the options defined in the `org.apache.camel.component.netty.NettyServerBootstrapConfiguration` configuration class. If you have configured another route with different options, Camel will throw an exception on startup, indicating the options is not identical. To mitigate this ensure all options is identical. Here is an example with two routes that share the same port. *Two routes sharing the same port* [source,java] ---------------------------------------------- from("netty-http:http://0.0.0.0:{{port}}/foo") .to("mock:foo") .transform().constant("Bye World"); from("netty-http:http://0.0.0.0:{{port}}/bar") .to("mock:bar") .transform().constant("Bye Camel"); ---------------------------------------------- And here is an example of a mis configured 2nd route that do not have identical `org.apache.camel.component.netty.NettyServerBootstrapConfiguration` option as the 1st route. This will cause Camel to fail on startup. *Two routes sharing the same port, but the 2nd route is misconfigured and will fail on starting* [source,java] -------------------------------------------------------------------------------------- from("netty-http:http://0.0.0.0:{{port}}/foo") .to("mock:foo") .transform().constant("Bye World"); // we cannot have a 2nd route on same port with SSL enabled, when the 1st route is NOT from("netty-http:http://0.0.0.0:{{port}}/bar?ssl=true") .to("mock:bar") .transform().constant("Bye Camel"); -------------------------------------------------------------------------------------- [[NettyHTTP-Reusingsameserverbootstrapconfigurationwithmultipleroutes]] Reusing same server bootstrap configuration with multiple routes ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ By configuring the common server bootstrap option in an single instance of a `org.apache.camel.component.netty.NettyServerBootstrapConfiguration` type, we can use the `bootstrapConfiguration` option on the link:netty-http.html[Netty HTTP] consumers to refer and reuse the same options across all consumers. [source,xml] ---------------------------------------------------------------------------------------------------------------- ---------------------------------------------------------------------------------------------------------------- And in the routes you refer to this option as shown below [source,xml] --------------------------------------------------------------------------------------------------------- ... ... ... --------------------------------------------------------------------------------------------------------- [[NettyHTTP-ReusingsameserverbootstrapconfigurationwithmultipleroutesacrossmultiplebundlesinOSGicontainer]] Reusing same server bootstrap configuration with multiple routes across multiple bundles in OSGi container ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ See the link:netty-http-server-example.html[Netty HTTP Server Example] for more details and example how to do that. [[NettyHTTP-UsingHTTPBasicAuthentication]] Using HTTP Basic Authentication ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The link:netty-http.html[Netty HTTP] consumer supports HTTP basic authentication by specifying the security realm name to use, as shown below [source,java] ----------------------------------------------------------------------------------------- ... ----------------------------------------------------------------------------------------- The realm name is mandatory to enable basic authentication. By default the JAAS based authenticator is used, which will use the realm name specified (karaf in the example above) and use the JAAS realm and the JAAS \{\{LoginModule}}s of this realm for authentication. End user of Apache Karaf / ServiceMix has a karaf realm out of the box, and hence why the example above would work out of the box in these containers. [[NettyHTTP-SpecifyingACLonwebresources]] Specifying ACL on web resources +++++++++++++++++++++++++++++++ The `org.apache.camel.component.netty.http.SecurityConstraint` allows to define constrains on web resources. And the `org.apache.camel.component.netty.http.SecurityConstraintMapping` is provided out of the box, allowing to easily define inclusions and exclusions with roles. For example as shown below in the XML DSL, we define the constraint bean: [source,xml] ------------------------------------------------------------------------------------------------ /public/* ------------------------------------------------------------------------------------------------ The constraint above is define so that * access to /* is restricted and any roles is accepted (also if user has no roles) * access to /admin/* requires the admin role * access to /guest/* requires the admin or guest role * access to /public/* is an exclusion which means no authentication is needed, and is therefore public for everyone without logging in To use this constraint we just need to refer to the bean id as shown below: [source,xml] ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ... ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [[NettyHTTP-SeeAlso]] See Also ^^^^^^^^ * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] * link:getting-started.html[Getting Started] * link:netty.html[Netty] * link:netty-http-server-example.html[Netty HTTP Server Example] * link:jetty.html[Jetty]