Added camel-netty4-http docs to Gitbook
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/cbf2a7fc Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/cbf2a7fc Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/cbf2a7fc Branch: refs/heads/kube-lb Commit: cbf2a7fc4193ecd49b4089fe1580045e97186fee Parents: a2012bb Author: Andrea Cosentino <anco...@gmail.com> Authored: Thu May 12 17:16:45 2016 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Mon May 16 09:59:33 2016 +0200 ---------------------------------------------------------------------- .../src/main/docs/netty4-http.adoc | 519 +++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 520 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/cbf2a7fc/components/camel-netty4-http/src/main/docs/netty4-http.adoc ---------------------------------------------------------------------- diff --git a/components/camel-netty4-http/src/main/docs/netty4-http.adoc b/components/camel-netty4-http/src/main/docs/netty4-http.adoc new file mode 100644 index 0000000..9a4b320 --- /dev/null +++ b/components/camel-netty4-http/src/main/docs/netty4-http.adoc @@ -0,0 +1,519 @@ +[[Netty4HTTP-Netty4HTTPComponent]] +Netty4 HTTP Component +~~~~~~~~~~~~~~~~~~~~~ + +*Available as of Camel 2.14* + +The *netty4-http* component is an extension to link:netty4.html[Netty4] +component to facilitiate HTTP transport with link:netty4.html[Netty4]. + +This camel component supports both producer and consumer endpoints. + + +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] +------------------------------------------------------------ +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-netty4-http</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +------------------------------------------------------------ + +[[Netty4HTTP-URIformat]] +URI format +^^^^^^^^^^ + +The URI scheme for a netty component is as follows + +[source,java] +------------------------------------------- +netty4-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 - +`netty4-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). + +[[Netty4HTTP-HTTPOptions]] +HTTP Options +^^^^^^^^^^^^ + + +INFO: *A lot more options*. *Important:* This component inherits all the options from +link:netty4.html[Netty4]. So make sure to look at +the link:netty4.html[Netty4] documentation as well. + + Notice that some options from link:netty4.html[Netty4] is not +applicable when using this Netty4 HTTP component, such as options +related to UDP transport. + + +// component options: START +The Netty4 HTTP component supports 6 options which are listed below. + + + +[width="100%",cols="2s,1m,8",options="header"] +|======================================================================= +| Name | Java Type | Description +| nettyHttpBinding | NettyHttpBinding | To use a custom org.apache.camel.component.netty4.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.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. +| maximumPoolSize | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. +| configuration | NettyConfiguration | To use the NettyConfiguration as configuration when creating endpoints. +| executorService | EventExecutorGroup | To use the given EventExecutorGroup +|======================================================================= +// component options: END + + + +// endpoint options: START +The Netty4 HTTP component supports 80 endpoint options which are listed below: + +[width="100%",cols="2s,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). +| decoder | common | | ChannelHandler | To use a single decoder. This options is deprecated use encoders instead. +| decoders | common | | 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. +| disconnect | common | false | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. +| encoder | common | | ChannelHandler | To use a single encoder. This options is deprecated use encoders instead. +| encoders | common | | 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. +| 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 +| bossGroup | consumer (advanced) | | EventLoopGroup | Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint +| 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. +| 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. +| 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 io.netty.handler.codec.http.HttpRequest instance. +| maxHeaderSize | consumer (advanced) | 8192 | int | The maximum length of all headers. If the sum of the length of each header exceeds this value a io.netty.handler.codec.TooLongFrameException will be raised. +| nettyServerBootstrapFactory | 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. +| 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. +| serverInitializerFactory | consumer (advanced) | | ServerInitializerFactory | To use a custom ServerInitializerFactory +| 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.netty4.http.NettyHttpBinding then you would need to decode the headers accordingly to this option. +| usingExecutorService | consumer (advanced) | true | boolean | Whether to use ordered thread pool to ensure events are processed orderly on the same channel. +| 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 +| workerGroup | consumer (advanced) | | EventLoopGroup | To use a explicit EventLoopGroup 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. +| connectTimeout | producer | 10000 | int | 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. +| reuseChannel | producer | false | boolean | This option allows producers to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useable if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key link NettyConstantsNETTY_CHANNEL which allows you to obtain the channel during routing and use it as well. +| throwExceptionOnFailure | 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. +| clientInitializerFactory | producer (advanced) | | ClientInitializerFactory | To use a custom ClientInitializerFactory +| 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. +| useRelativePath | producer (advanced) | false | boolean | Sets whether to use a relative path in HTTP requests. +| 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. +| disableStreamCache | advanced | false | boolean | Determines whether or not the raw input stream from Netty HttpRequestgetContent() or HttpResponsetgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Netty raw stream. Also Netty will auto-close the Netty stream when the Netty HTTP server/HTTP client is done processing which means that if the asynchronous routing engine is in use then any asynchronous thread that may continue routing the org.apache.camel.Exc hange may not be able to read the Netty stream because Netty has closed it. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| 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.netty4.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 | int | 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 | int | 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. +| 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 | | 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.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. +| securityOptions | security | | Map | To configure NettyHttpSecurityConfiguration using key/value pairs from the map +| securityProvider | security | | 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. +|======================================================================= +// endpoint options: END + + +[[Netty4HTTP-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 `io.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` |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 Netty4 HTTP endpoint: + +The description in the table takes offset in a route having: +`from("netty4-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` |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"`. +|======================================================================= + +[[Netty4HTTP-AccesstoNettytypes]] +Access to Netty types +^^^^^^^^^^^^^^^^^^^^^ + +This component uses the +`org.apache.camel.component.netty4.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] +---------------------------------------------------------------------------------------------------------- +io.netty.handler.codec.http.HttpRequest request = exchange.getIn(NettyHttpMessage.class).getHttpRequest(); +---------------------------------------------------------------------------------------------------------- + +[[Netty4HTTP-Examples]] +Examples +^^^^^^^^ + +In the route below we use Netty4 HTTP as a HTTP server, which returns +back a hardcoded "Bye World" message. + +[source,java] +----------------------------------------------- + from("netty4-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("netty4-http:http://localhost:8080/foo";, "Hello World", String.class); + System.out.println(out); +------------------------------------------------------------------------------------------------------------ + +And we get back "Bye World" as the output. + +[[Netty4HTTP-HowdoIletNettymatchwildcards]] +How do I let Netty match wildcards +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +By default Netty4 HTTP will only match on exact uri's. But you can +instruct Netty to match prefixes. For example + +[source,java] +----------------------------------------------------------- +from("netty4-http:http://0.0.0.0:8123/foo";).to("mock:foo"); +----------------------------------------------------------- + +In the route above Netty4 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("netty4-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("netty4-http:http://0.0.0.0:8123?matchOnUriPrefix=true";).to("mock:foo"); +----------------------------------------------------------------------------- + +[[Netty4HTTP-Usingmultiplerouteswithsameport]] +Using multiple routes with same port +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In the same link:camelcontext.html[CamelContext] you can have multiple +routes from Netty4 HTTP that shares the same port (eg a +`io.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 `io.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.netty4.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("netty4-http:http://0.0.0.0:{{port}}/foo";) + .to("mock:foo") + .transform().constant("Bye World"); + +from("netty4-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.netty4.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("netty4-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("netty4-http:http://0.0.0.0:{{port}}/bar?ssl=true";) + .to("mock:bar") + .transform().constant("Bye Camel"); +-------------------------------------------------------------------------------------- + +[[Netty4HTTP-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.netty4.NettyServerBootstrapConfiguration` +type, we can use the `bootstrapConfiguration` option on the Netty4 HTTP +consumers to refer and reuse the same options across all consumers. + +[source,xml] +----------------------------------------------------------------------------------------------------------------- +<bean id="nettyHttpBootstrapOptions" class="org.apache.camel.component.netty4.NettyServerBootstrapConfiguration"> + <property name="backlog" value="200"/> + <property name="connectionTimeout" value="20000"/> + <property name="workerCount" value="16"/> +</bean> +----------------------------------------------------------------------------------------------------------------- + +And in the routes you refer to this option as shown below + +[source,xml] +---------------------------------------------------------------------------------------------------------- +<route> + <from uri="netty4-http:http://0.0.0.0:{{port}}/foo?bootstrapConfiguration=#nettyHttpBootstrapOptions"/> + ... +</route> + +<route> + <from uri="netty4-http:http://0.0.0.0:{{port}}/bar?bootstrapConfiguration=#nettyHttpBootstrapOptions"/> + ... +</route> + +<route> + <from uri="netty4-http:http://0.0.0.0:{{port}}/beer?bootstrapConfiguration=#nettyHttpBootstrapOptions"/> + ... +</route> +---------------------------------------------------------------------------------------------------------- + +[[Netty4HTTP-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. + +[[Netty4HTTP-UsingHTTPBasicAuthentication]] +Using HTTP Basic Authentication +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The Netty HTTP consumer supports HTTP basic authentication by specifying +the security realm name to use, as shown below + +[source,java] +------------------------------------------------------------------------------------------ +<route> + <from uri="netty4-http:http://0.0.0.0:{{port}}/foo?securityConfiguration.realm=karaf"/> + ... +</route> +------------------------------------------------------------------------------------------ + +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. + +[[Netty4HTTP-SpecifyingACLonwebresources]] +Specifying ACL on web resources ++++++++++++++++++++++++++++++++ + +The `org.apache.camel.component.netty4.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] +------------------------------------------------------------------------------------------------- + <bean id="constraint" class="org.apache.camel.component.netty4.http.SecurityConstraintMapping"> + <!-- inclusions defines url -> roles restrictions --> + <!-- a * should be used for any role accepted (or even no roles) --> + <property name="inclusions"> + <map> + <entry key="/*" value="*"/> + <entry key="/admin/*" value="admin"/> + <entry key="/guest/*" value="admin,guest"/> + </map> + </property> + <!-- exclusions is used to define public urls, which requires no authentication --> + <property name="exclusions"> + <set> + <value>/public/*</value> + </set> + </property> + </bean> +------------------------------------------------------------------------------------------------- + +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] +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +<route> + <from uri="netty4-http:http://0.0.0.0:{{port}}/foo?matchOnUriPrefix=true&securityConfiguration.realm=karaf&securityConfiguration.securityConstraint=#constraint"/> + ... +</route> +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +[[Netty4HTTP-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] + http://git-wip-us.apache.org/repos/asf/camel/blob/cbf2a7fc/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index 6708794..97b0199 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -206,6 +206,7 @@ * [Nagios](nagios.adoc) * [Netty](netty.adoc) * [Netty4](netty4.adoc) + * [Netty4 HTTP](netty4-http.adoc) * [NATS](nats.adoc) * [Properties](properties.adoc) * [Quickfix](quickfix.adoc)
