This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
commit 9d84607436d33c22fe54fc755c6a4027363feb23 Author: Andrea Cosentino <[email protected]> AuthorDate: Thu Aug 8 11:11:41 2019 +0200 CAMEL-13792 - Rename components to default names, Camel-netty4-http to camel-netty-http - Fixed docs and regen --- apache-camel/pom.xml | 4 +- apache-camel/src/main/descriptors/common-bin.xml | 2 +- bom/camel-bom/pom.xml | 6 +- .../src/main/docs/netty-http-component.adoc | 68 ++++++------ .../camel-netty/src/main/docs/netty-component.adoc | 2 +- .../src/main/docs/rest-swagger-component.adoc | 2 +- components/readme.adoc | 4 +- docs/components/modules/ROOT/nav.adoc | 2 +- .../modules/ROOT/pages/netty-component.adoc | 2 +- ...tp-component.adoc => netty-http-component.adoc} | 116 ++++++++++----------- .../modules/ROOT/pages/rest-swagger-component.adoc | 2 +- docs/user-manual/modules/ROOT/pages/index.adoc | 2 +- docs/user-manual/modules/ROOT/pages/rest-dsl.adoc | 4 +- parent/pom.xml | 4 +- .../camel-spring-boot-dependencies/pom.xml | 6 +- 15 files changed, 113 insertions(+), 113 deletions(-) diff --git a/apache-camel/pom.xml b/apache-camel/pom.xml index 2abd396..154c55e 100644 --- a/apache-camel/pom.xml +++ b/apache-camel/pom.xml @@ -2557,12 +2557,12 @@ </dependency> <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-netty-starter</artifactId> + <artifactId>camel-netty-http-starter</artifactId> <version>${project.version}</version> </dependency> <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-netty-http-starter</artifactId> + <artifactId>camel-netty-starter</artifactId> <version>${project.version}</version> </dependency> <dependency> diff --git a/apache-camel/src/main/descriptors/common-bin.xml b/apache-camel/src/main/descriptors/common-bin.xml index bdbfd73..b20fa84 100644 --- a/apache-camel/src/main/descriptors/common-bin.xml +++ b/apache-camel/src/main/descriptors/common-bin.xml @@ -571,8 +571,8 @@ <include>org.apache.camel:camel-mybatis-starter</include> <include>org.apache.camel:camel-nagios-starter</include> <include>org.apache.camel:camel-nats-starter</include> - <include>org.apache.camel:camel-netty-starter</include> <include>org.apache.camel:camel-netty-http-starter</include> + <include>org.apache.camel:camel-netty-starter</include> <include>org.apache.camel:camel-nsq-starter</include> <include>org.apache.camel:camel-ognl-starter</include> <include>org.apache.camel:camel-olingo2-starter</include> diff --git a/bom/camel-bom/pom.xml b/bom/camel-bom/pom.xml index 468fdc8..765ba49 100644 --- a/bom/camel-bom/pom.xml +++ b/bom/camel-bom/pom.xml @@ -2015,17 +2015,17 @@ </dependency> <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-netty-starter</artifactId> + <artifactId>camel-netty-http</artifactId> <version>${project.version}</version> </dependency> <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-netty-http</artifactId> + <artifactId>camel-netty-http-starter</artifactId> <version>${project.version}</version> </dependency> <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-netty-http-starter</artifactId> + <artifactId>camel-netty-starter</artifactId> <version>${project.version}</version> </dependency> <dependency> diff --git a/components/camel-netty-http/src/main/docs/netty-http-component.adoc b/components/camel-netty-http/src/main/docs/netty-http-component.adoc index 0269d24..8f77242 100644 --- a/components/camel-netty-http/src/main/docs/netty-http-component.adoc +++ b/components/camel-netty-http/src/main/docs/netty-http-component.adoc @@ -237,7 +237,7 @@ When using Spring Boot make sure to use the following Maven dependency to have s ---- <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-netty4-http-starter</artifactId> + <artifactId>camel-netty-http-starter</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency> @@ -251,39 +251,39 @@ The component supports 33 options, which are listed below. [width="100%",cols="2,5,^1,2",options="header"] |=== | Name | Description | Default | Type -| *camel.component.netty4-http.basic-property-binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | Boolean -| *camel.component.netty4-http.configuration.bridge-endpoint* | 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 consum [...] -| *camel.component.netty4-http.configuration.chunked-max-content-length* | Value in bytes the max content length per chunked frame received on the Netty HTTP server. | 1048576 | Integer -| *camel.component.netty4-http.configuration.compression* | Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers. | false | Boolean -| *camel.component.netty4-http.configuration.disable-stream-cache* | Determines whether or not the raw input stream from Netty HttpRequest#getContent() or HttpResponset#getContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example [...] -| *camel.component.netty4-http.configuration.host* | The local hostname such as localhost, or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. | | String -| *camel.component.netty4-http.configuration.map-headers* | 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 insta [...] -| *camel.component.netty4-http.configuration.match-on-uri-prefix* | Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. | false | Boolean -| *camel.component.netty4-http.configuration.max-header-size* | The maximum length of all headers. If the sum of the length of each header exceeds this value, a {@link io.netty.handler.codec.TooLongFrameException} will be raised. | 8192 | Integer -| *camel.component.netty4-http.configuration.ok-status-code-range* | The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. <tt>200-204,209,301-304</tt>. Each range must be a single number or from-to with the dash included. <p/> The default range is <tt>200-299</tt> | 200-299 | String -| *camel.component.netty4-http.configuration.path* | Resource path | | String -| *camel.component.netty4-http.configuration.port* | The port number. Is default 80 for http and 443 for https. | | Integer -| *camel.component.netty4-http.configuration.protocol* | The protocol to use which is either http, https or proxy - a consumer only option. | | String -| *camel.component.netty4-http.configuration.send503when-suspended* | 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. | true | Boolean -| *camel.component.netty4-http.configuration.throw-exception-on-failure* | 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. | true | Boolean -| *camel.component.netty4-http.configuration.transfer-exception* | 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. <p/> This is by default turned off. If you enable this then be [...] -| *camel.component.netty4-http.configuration.url-decode-headers* | 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. | false | [...] -| *camel.component.netty4-http.configuration.use-relative-path* | Sets whether to use a relative path in HTTP requests. | true | Boolean -| *camel.component.netty4-http.enabled* | Enable netty4-http component | true | Boolean -| *camel.component.netty4-http.executor-service* | To use the given EventExecutorGroup. The option is a io.netty.util.concurrent.EventExecutorGroup type. | | String -| *camel.component.netty4-http.header-filter-strategy* | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. The option is a org.apache.camel.spi.HeaderFilterStrategy type. | | String -| *camel.component.netty4-http.maximum-pool-size* | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. | 16 | Integer -| *camel.component.netty4-http.netty-http-binding* | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API. The option is a org.apache.camel.component.netty4.http.NettyHttpBinding type. | | String -| *camel.component.netty4-http.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean -| *camel.component.netty4-http.security-configuration.authenticate* | Whether to enable authentication <p/> This is by default enabled. | | Boolean -| *camel.component.netty4-http.security-configuration.constraint* | The supported restricted. <p/> Currently only Basic is supported. | | String -| *camel.component.netty4-http.security-configuration.login-denied-logging-level* | Sets a logging level to use for logging denied login attempts (incl stacktraces) <p/> This level is by default DEBUG. | | LoggingLevel -| *camel.component.netty4-http.security-configuration.realm* | Sets the name of the realm to use. | | String -| *camel.component.netty4-http.security-configuration.role-class-name* | Sets a logging level to use for logging denied login attempts (incl stacktraces) <p/> This level is by default DEBUG. | | String -| *camel.component.netty4-http.security-configuration.security-authenticator* | Sets the {@link SecurityAuthenticator} to use for authenticating the {@link HttpPrincipal}. | | SecurityAuthenticator -| *camel.component.netty4-http.security-configuration.security-constraint* | Sets a {@link SecurityConstraint} to use for checking if a web resource is restricted or not <p/> By default this is <tt>null</tt>, which means all resources is restricted. | | SecurityConstraint -| *camel.component.netty4-http.ssl-context-parameters* | To configure security using SSLContextParameters. The option is a org.apache.camel.support.jsse.SSLContextParameters type. | | String -| *camel.component.netty4-http.use-global-ssl-context-parameters* | Enable usage of global SSL context parameters. | false | Boolean +| *camel.component.netty-http.basic-property-binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | Boolean +| *camel.component.netty-http.configuration.bridge-endpoint* | 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 consume [...] +| *camel.component.netty-http.configuration.chunked-max-content-length* | Value in bytes the max content length per chunked frame received on the Netty HTTP server. | 1048576 | Integer +| *camel.component.netty-http.configuration.compression* | Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers. | false | Boolean +| *camel.component.netty-http.configuration.disable-stream-cache* | Determines whether or not the raw input stream from Netty HttpRequest#getContent() or HttpResponset#getContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example [...] +| *camel.component.netty-http.configuration.host* | The local hostname such as localhost, or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. | | String +| *camel.component.netty-http.configuration.map-headers* | 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 instan [...] +| *camel.component.netty-http.configuration.match-on-uri-prefix* | Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. | false | Boolean +| *camel.component.netty-http.configuration.max-header-size* | The maximum length of all headers. If the sum of the length of each header exceeds this value, a {@link io.netty.handler.codec.TooLongFrameException} will be raised. | 8192 | Integer +| *camel.component.netty-http.configuration.ok-status-code-range* | The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. <tt>200-204,209,301-304</tt>. Each range must be a single number or from-to with the dash included. <p/> The default range is <tt>200-299</tt> | 200-299 | String +| *camel.component.netty-http.configuration.path* | Resource path | | String +| *camel.component.netty-http.configuration.port* | The port number. Is default 80 for http and 443 for https. | | Integer +| *camel.component.netty-http.configuration.protocol* | The protocol to use which is either http, https or proxy - a consumer only option. | | String +| *camel.component.netty-http.configuration.send503when-suspended* | 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. | true | Boolean +| *camel.component.netty-http.configuration.throw-exception-on-failure* | 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. | true | Boolean +| *camel.component.netty-http.configuration.transfer-exception* | 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. <p/> This is by default turned off. If you enable this then be a [...] +| *camel.component.netty-http.configuration.url-decode-headers* | 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. | false | Boolean +| *camel.component.netty-http.configuration.use-relative-path* | Sets whether to use a relative path in HTTP requests. | true | Boolean +| *camel.component.netty-http.enabled* | Whether to enable auto configuration of the netty-http component. This is enabled by default. | | Boolean +| *camel.component.netty-http.executor-service* | To use the given EventExecutorGroup. The option is a io.netty.util.concurrent.EventExecutorGroup type. | | String +| *camel.component.netty-http.header-filter-strategy* | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. The option is a org.apache.camel.spi.HeaderFilterStrategy type. | | String +| *camel.component.netty-http.maximum-pool-size* | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. | 16 | Integer +| *camel.component.netty-http.netty-http-binding* | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API. The option is a org.apache.camel.component.netty4.http.NettyHttpBinding type. | | String +| *camel.component.netty-http.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +| *camel.component.netty-http.security-configuration.authenticate* | Whether to enable authentication <p/> This is by default enabled. | | Boolean +| *camel.component.netty-http.security-configuration.constraint* | The supported restricted. <p/> Currently only Basic is supported. | | String +| *camel.component.netty-http.security-configuration.login-denied-logging-level* | Sets a logging level to use for logging denied login attempts (incl stacktraces) <p/> This level is by default DEBUG. | | LoggingLevel +| *camel.component.netty-http.security-configuration.realm* | Sets the name of the realm to use. | | String +| *camel.component.netty-http.security-configuration.role-class-name* | Sets a logging level to use for logging denied login attempts (incl stacktraces) <p/> This level is by default DEBUG. | | String +| *camel.component.netty-http.security-configuration.security-authenticator* | Sets the {@link SecurityAuthenticator} to use for authenticating the {@link HttpPrincipal}. | | SecurityAuthenticator +| *camel.component.netty-http.security-configuration.security-constraint* | Sets a {@link SecurityConstraint} to use for checking if a web resource is restricted or not <p/> By default this is <tt>null</tt>, which means all resources is restricted. | | SecurityConstraint +| *camel.component.netty-http.ssl-context-parameters* | To configure security using SSLContextParameters. The option is a org.apache.camel.support.jsse.SSLContextParameters type. | | String +| *camel.component.netty-http.use-global-ssl-context-parameters* | Enable usage of global SSL context parameters. | false | Boolean |=== // spring-boot-auto-configure options: END diff --git a/components/camel-netty/src/main/docs/netty-component.adoc b/components/camel-netty/src/main/docs/netty-component.adoc index 1acff4e..2e6b9fa 100644 --- a/components/camel-netty/src/main/docs/netty-component.adoc +++ b/components/camel-netty/src/main/docs/netty-component.adoc @@ -798,5 +798,5 @@ under the `camel-example-netty-custom-correlation` directory. == See Also -* xref:netty4-http-component.adoc[Netty HTTP] +* xref:netty-http-component.adoc[Netty HTTP] * xref:mina-component.adoc[MINA] diff --git a/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc b/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc index fd19beb..016cbe9 100644 --- a/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc +++ b/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc @@ -9,7 +9,7 @@ delegates to a component implementing the _RestProducerFactory_ interface. Currently known working components are: * xref:http-component.adoc[http] -* xref:netty4-http-component.adoc[netty4-http] +* xref:netty-http-component.adoc[netty-http] * xref:restlet-component.adoc[restlet] * xref:jetty-component.adoc[jetty] * xref:undertow-component.adoc[undertow] diff --git a/components/readme.adoc b/components/readme.adoc index e0a77ec..0b29a5b 100644 --- a/components/readme.adoc +++ b/components/readme.adoc @@ -607,8 +607,8 @@ Number of Components: 297 in 234 JAR artifacts (0 deprecated) | link:camel-netty/src/main/docs/netty-component.adoc[Netty] (camel-netty) + `netty:protocol:host:port` | 2.14 | Socket level networking using TCP or UDP with the Netty 4.x library. -| link:camel-netty4-http/src/main/docs/netty4-http-component.adoc[Netty4 HTTP] (camel-netty4-http) + -`netty4-http:protocol:host:port/path` | 2.14 | Netty HTTP server and client using the Netty 4.x library. +| link:camel-netty-http/src/main/docs/netty-http-component.adoc[Netty HTTP] (camel-netty-http) + +`netty-http:protocol:host:port/path` | 2.14 | Netty HTTP server and client using the Netty 4.x library. | link:camel-nsq/src/main/docs/nsq-component.adoc[NSQ] (camel-nsq) + `nsq:servers` | 2.23 | Represents a nsq endpoint. diff --git a/docs/components/modules/ROOT/nav.adoc b/docs/components/modules/ROOT/nav.adoc index c293f3d..2babd1d 100644 --- a/docs/components/modules/ROOT/nav.adoc +++ b/docs/components/modules/ROOT/nav.adoc @@ -247,8 +247,8 @@ * xref:mybatis-component.adoc[MyBatis Component] * xref:nagios-component.adoc[Nagios Component] * xref:nats-component.adoc[Nats Component] +* xref:netty-http-component.adoc[Netty HTTP Component] * xref:netty-component.adoc[Netty Component] -* xref:netty4-http-component.adoc[Netty4 HTTP Component] * xref:nsq-component.adoc[NSQ Component] * xref:ognl-language.adoc[OGNL Language] * xref:olingo2-component.adoc[Olingo2 Component] diff --git a/docs/components/modules/ROOT/pages/netty-component.adoc b/docs/components/modules/ROOT/pages/netty-component.adoc index 1acff4e..2e6b9fa 100644 --- a/docs/components/modules/ROOT/pages/netty-component.adoc +++ b/docs/components/modules/ROOT/pages/netty-component.adoc @@ -798,5 +798,5 @@ under the `camel-example-netty-custom-correlation` directory. == See Also -* xref:netty4-http-component.adoc[Netty HTTP] +* xref:netty-http-component.adoc[Netty HTTP] * xref:mina-component.adoc[MINA] diff --git a/docs/components/modules/ROOT/pages/netty4-http-component.adoc b/docs/components/modules/ROOT/pages/netty-http-component.adoc similarity index 78% rename from docs/components/modules/ROOT/pages/netty4-http-component.adoc rename to docs/components/modules/ROOT/pages/netty-http-component.adoc index 0c4d0b5..8f77242 100644 --- a/docs/components/modules/ROOT/pages/netty4-http-component.adoc +++ b/docs/components/modules/ROOT/pages/netty-http-component.adoc @@ -1,9 +1,9 @@ -[[netty4-http-component]] -= Netty4 HTTP Component +[[netty-http-component]] += Netty HTTP Component *Available as of Camel version 2.14* -The Netty4 HTTP component is an extension to xref:netty-component.adoc[Netty] +The Netty HTTP component is an extension to xref:netty-component.adoc[Netty] component to facilitiate HTTP transport with xref:netty-component.adoc[Netty]. This camel component supports both producer and consumer endpoints. @@ -32,7 +32,7 @@ for this component: ------------------------------------------------------------ <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-netty4-http</artifactId> + <artifactId>camel-netty-http</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency> @@ -44,7 +44,7 @@ The URI scheme for a netty component is as follows [source,java] ------------------------------------------- -netty4-http:http://0.0.0.0:8080[?options] +netty-http:http://0.0.0.0:8080[?options] ------------------------------------------- You can append query options to the URI in the following format, @@ -57,7 +57,7 @@ You can append query options to the URI in the following format, 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 +`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 @@ -88,7 +88,7 @@ related to UDP transport. // component options: START -The Netty4 HTTP component supports 10 options, which are listed below. +The Netty HTTP component supports 10 options, which are listed below. @@ -118,10 +118,10 @@ The Netty4 HTTP component supports 10 options, which are listed below. // endpoint options: START -The Netty4 HTTP endpoint is configured using URI syntax: +The Netty HTTP endpoint is configured using URI syntax: ---- -netty4-http:protocol:host:port/path +netty-http:protocol:host:port/path ---- with the following path and query parameters: @@ -237,7 +237,7 @@ When using Spring Boot make sure to use the following Maven dependency to have s ---- <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-netty4-http-starter</artifactId> + <artifactId>camel-netty-http-starter</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency> @@ -251,39 +251,39 @@ The component supports 33 options, which are listed below. [width="100%",cols="2,5,^1,2",options="header"] |=== | Name | Description | Default | Type -| *camel.component.netty4-http.basic-property-binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | Boolean -| *camel.component.netty4-http.configuration.bridge-endpoint* | 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 consum [...] -| *camel.component.netty4-http.configuration.chunked-max-content-length* | Value in bytes the max content length per chunked frame received on the Netty HTTP server. | 1048576 | Integer -| *camel.component.netty4-http.configuration.compression* | Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers. | false | Boolean -| *camel.component.netty4-http.configuration.disable-stream-cache* | Determines whether or not the raw input stream from Netty HttpRequest#getContent() or HttpResponset#getContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example [...] -| *camel.component.netty4-http.configuration.host* | The local hostname such as localhost, or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. | | String -| *camel.component.netty4-http.configuration.map-headers* | 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 insta [...] -| *camel.component.netty4-http.configuration.match-on-uri-prefix* | Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. | false | Boolean -| *camel.component.netty4-http.configuration.max-header-size* | The maximum length of all headers. If the sum of the length of each header exceeds this value, a {@link io.netty.handler.codec.TooLongFrameException} will be raised. | 8192 | Integer -| *camel.component.netty4-http.configuration.ok-status-code-range* | The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. <tt>200-204,209,301-304</tt>. Each range must be a single number or from-to with the dash included. <p/> The default range is <tt>200-299</tt> | 200-299 | String -| *camel.component.netty4-http.configuration.path* | Resource path | | String -| *camel.component.netty4-http.configuration.port* | The port number. Is default 80 for http and 443 for https. | | Integer -| *camel.component.netty4-http.configuration.protocol* | The protocol to use which is either http, https or proxy - a consumer only option. | | String -| *camel.component.netty4-http.configuration.send503when-suspended* | 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. | true | Boolean -| *camel.component.netty4-http.configuration.throw-exception-on-failure* | 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. | true | Boolean -| *camel.component.netty4-http.configuration.transfer-exception* | 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. <p/> This is by default turned off. If you enable this then be [...] -| *camel.component.netty4-http.configuration.url-decode-headers* | 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. | false | [...] -| *camel.component.netty4-http.configuration.use-relative-path* | Sets whether to use a relative path in HTTP requests. | true | Boolean -| *camel.component.netty4-http.enabled* | Enable netty4-http component | true | Boolean -| *camel.component.netty4-http.executor-service* | To use the given EventExecutorGroup. The option is a io.netty.util.concurrent.EventExecutorGroup type. | | String -| *camel.component.netty4-http.header-filter-strategy* | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. The option is a org.apache.camel.spi.HeaderFilterStrategy type. | | String -| *camel.component.netty4-http.maximum-pool-size* | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. | 16 | Integer -| *camel.component.netty4-http.netty-http-binding* | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API. The option is a org.apache.camel.component.netty4.http.NettyHttpBinding type. | | String -| *camel.component.netty4-http.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean -| *camel.component.netty4-http.security-configuration.authenticate* | Whether to enable authentication <p/> This is by default enabled. | | Boolean -| *camel.component.netty4-http.security-configuration.constraint* | The supported restricted. <p/> Currently only Basic is supported. | | String -| *camel.component.netty4-http.security-configuration.login-denied-logging-level* | Sets a logging level to use for logging denied login attempts (incl stacktraces) <p/> This level is by default DEBUG. | | LoggingLevel -| *camel.component.netty4-http.security-configuration.realm* | Sets the name of the realm to use. | | String -| *camel.component.netty4-http.security-configuration.role-class-name* | Sets a logging level to use for logging denied login attempts (incl stacktraces) <p/> This level is by default DEBUG. | | String -| *camel.component.netty4-http.security-configuration.security-authenticator* | Sets the {@link SecurityAuthenticator} to use for authenticating the {@link HttpPrincipal}. | | SecurityAuthenticator -| *camel.component.netty4-http.security-configuration.security-constraint* | Sets a {@link SecurityConstraint} to use for checking if a web resource is restricted or not <p/> By default this is <tt>null</tt>, which means all resources is restricted. | | SecurityConstraint -| *camel.component.netty4-http.ssl-context-parameters* | To configure security using SSLContextParameters. The option is a org.apache.camel.support.jsse.SSLContextParameters type. | | String -| *camel.component.netty4-http.use-global-ssl-context-parameters* | Enable usage of global SSL context parameters. | false | Boolean +| *camel.component.netty-http.basic-property-binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | Boolean +| *camel.component.netty-http.configuration.bridge-endpoint* | 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 consume [...] +| *camel.component.netty-http.configuration.chunked-max-content-length* | Value in bytes the max content length per chunked frame received on the Netty HTTP server. | 1048576 | Integer +| *camel.component.netty-http.configuration.compression* | Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers. | false | Boolean +| *camel.component.netty-http.configuration.disable-stream-cache* | Determines whether or not the raw input stream from Netty HttpRequest#getContent() or HttpResponset#getContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example [...] +| *camel.component.netty-http.configuration.host* | The local hostname such as localhost, or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. | | String +| *camel.component.netty-http.configuration.map-headers* | 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 instan [...] +| *camel.component.netty-http.configuration.match-on-uri-prefix* | Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. | false | Boolean +| *camel.component.netty-http.configuration.max-header-size* | The maximum length of all headers. If the sum of the length of each header exceeds this value, a {@link io.netty.handler.codec.TooLongFrameException} will be raised. | 8192 | Integer +| *camel.component.netty-http.configuration.ok-status-code-range* | The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. <tt>200-204,209,301-304</tt>. Each range must be a single number or from-to with the dash included. <p/> The default range is <tt>200-299</tt> | 200-299 | String +| *camel.component.netty-http.configuration.path* | Resource path | | String +| *camel.component.netty-http.configuration.port* | The port number. Is default 80 for http and 443 for https. | | Integer +| *camel.component.netty-http.configuration.protocol* | The protocol to use which is either http, https or proxy - a consumer only option. | | String +| *camel.component.netty-http.configuration.send503when-suspended* | 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. | true | Boolean +| *camel.component.netty-http.configuration.throw-exception-on-failure* | 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. | true | Boolean +| *camel.component.netty-http.configuration.transfer-exception* | 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. <p/> This is by default turned off. If you enable this then be a [...] +| *camel.component.netty-http.configuration.url-decode-headers* | 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. | false | Boolean +| *camel.component.netty-http.configuration.use-relative-path* | Sets whether to use a relative path in HTTP requests. | true | Boolean +| *camel.component.netty-http.enabled* | Whether to enable auto configuration of the netty-http component. This is enabled by default. | | Boolean +| *camel.component.netty-http.executor-service* | To use the given EventExecutorGroup. The option is a io.netty.util.concurrent.EventExecutorGroup type. | | String +| *camel.component.netty-http.header-filter-strategy* | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. The option is a org.apache.camel.spi.HeaderFilterStrategy type. | | String +| *camel.component.netty-http.maximum-pool-size* | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. | 16 | Integer +| *camel.component.netty-http.netty-http-binding* | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API. The option is a org.apache.camel.component.netty4.http.NettyHttpBinding type. | | String +| *camel.component.netty-http.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean +| *camel.component.netty-http.security-configuration.authenticate* | Whether to enable authentication <p/> This is by default enabled. | | Boolean +| *camel.component.netty-http.security-configuration.constraint* | The supported restricted. <p/> Currently only Basic is supported. | | String +| *camel.component.netty-http.security-configuration.login-denied-logging-level* | Sets a logging level to use for logging denied login attempts (incl stacktraces) <p/> This level is by default DEBUG. | | LoggingLevel +| *camel.component.netty-http.security-configuration.realm* | Sets the name of the realm to use. | | String +| *camel.component.netty-http.security-configuration.role-class-name* | Sets a logging level to use for logging denied login attempts (incl stacktraces) <p/> This level is by default DEBUG. | | String +| *camel.component.netty-http.security-configuration.security-authenticator* | Sets the {@link SecurityAuthenticator} to use for authenticating the {@link HttpPrincipal}. | | SecurityAuthenticator +| *camel.component.netty-http.security-configuration.security-constraint* | Sets a {@link SecurityConstraint} to use for checking if a web resource is restricted or not <p/> By default this is <tt>null</tt>, which means all resources is restricted. | | SecurityConstraint +| *camel.component.netty-http.ssl-context-parameters* | To configure security using SSLContextParameters. The option is a org.apache.camel.support.jsse.SSLContextParameters type. | | String +| *camel.component.netty-http.use-global-ssl-context-parameters* | Enable usage of global SSL context parameters. | false | Boolean |=== // spring-boot-auto-configure options: END @@ -326,7 +326,7 @@ 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")...` +`from("netty-http:http:0.0.0.0:8080/myapp")...` [width="100%",cols="10%,10%,80%",options="header",] |======================================================================= @@ -380,7 +380,7 @@ back a hardcoded "Bye World" message. [source,java] ----------------------------------------------- - from("netty4-http:http://0.0.0.0:8080/foo";) + from("netty-http:http://0.0.0.0:8080/foo";) .transform().constant("Bye World"); ----------------------------------------------- @@ -389,7 +389,7 @@ ProducerTemplate as shown below: [source,java] ------------------------------------------------------------------------------------------------------------ - String out = template.requestBody("netty4-http:http://0.0.0.0:8080/foo";, "Hello World", String.class); + String out = template.requestBody("netty-http:http://0.0.0.0:8080/foo";, "Hello World", String.class); System.out.println(out); ------------------------------------------------------------------------------------------------------------ @@ -402,7 +402,7 @@ instruct Netty to match prefixes. For example [source,java] ----------------------------------------------------------- -from("netty4-http:http://0.0.0.0:8123/foo";).to("mock:foo"); +from("netty-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 @@ -414,7 +414,7 @@ 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"); +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`. @@ -423,7 +423,7 @@ To match *any* endpoint you can do: [source,java] ----------------------------------------------------------------------------- -from("netty4-http:http://0.0.0.0:8123?matchOnUriPrefix=true";).to("mock:foo"); +from("netty-http:http://0.0.0.0:8123?matchOnUriPrefix=true";).to("mock:foo"); ----------------------------------------------------------------------------- === Using multiple routes with same port @@ -450,11 +450,11 @@ Here is an example with two routes that share the same port. [source,java] ----------------------------------------------- -from("netty4-http:http://0.0.0.0:{{port}}/foo";) +from("netty-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";) +from("netty-http:http://0.0.0.0:{{port}}/bar";) .to("mock:bar") .transform().constant("Bye Camel"); ----------------------------------------------- @@ -469,12 +469,12 @@ and will fail on starting* [source,java] -------------------------------------------------------------------------------------- -from("netty4-http:http://0.0.0.0:{{port}}/foo";) +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("netty4-http:http://0.0.0.0:{{port}}/bar?ssl=true";) +from("netty-http:http://0.0.0.0:{{port}}/bar?ssl=true";) .to("mock:bar") .transform().constant("Bye Camel"); -------------------------------------------------------------------------------------- @@ -501,17 +501,17 @@ 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"/> + <from uri="netty-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"/> + <from uri="netty-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"/> + <from uri="netty-http:http://0.0.0.0:{{port}}/beer?bootstrapConfiguration=#nettyHttpBootstrapOptions"/> ... </route> ---------------------------------------------------------------------------------------------------------- @@ -560,7 +560,7 @@ 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"/> + <from uri="netty-http:http://0.0.0.0:{{port}}/foo?securityConfiguration.realm=karaf"/> ... </route> ------------------------------------------------------------------------------------------ @@ -621,7 +621,7 @@ below: [source,xml] ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- <route> - <from uri="netty4-http:http://0.0.0.0:{{port}}/foo?matchOnUriPrefix=true&securityConfiguration.realm=karaf&securityConfiguration.securityConstraint=#constraint"/> + <from uri="netty-http:http://0.0.0.0:{{port}}/foo?matchOnUriPrefix=true&securityConfiguration.realm=karaf&securityConfiguration.securityConstraint=#constraint"/> ... </route> ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- diff --git a/docs/components/modules/ROOT/pages/rest-swagger-component.adoc b/docs/components/modules/ROOT/pages/rest-swagger-component.adoc index fd19beb..016cbe9 100644 --- a/docs/components/modules/ROOT/pages/rest-swagger-component.adoc +++ b/docs/components/modules/ROOT/pages/rest-swagger-component.adoc @@ -9,7 +9,7 @@ delegates to a component implementing the _RestProducerFactory_ interface. Currently known working components are: * xref:http-component.adoc[http] -* xref:netty4-http-component.adoc[netty4-http] +* xref:netty-http-component.adoc[netty-http] * xref:restlet-component.adoc[restlet] * xref:jetty-component.adoc[jetty] * xref:undertow-component.adoc[undertow] diff --git a/docs/user-manual/modules/ROOT/pages/index.adoc b/docs/user-manual/modules/ROOT/pages/index.adoc index d224c0f..cc0043d 100644 --- a/docs/user-manual/modules/ROOT/pages/index.adoc +++ b/docs/user-manual/modules/ROOT/pages/index.adoc @@ -344,7 +344,7 @@ camel routes without them knowing ** xref:components::nagios-component.adoc[Nagios] ** xref:components::nats-component.adoc[Nats] ** xref:components::netty-component.adoc[Netty] -** xref:components::netty4-http-component.adoc[Netty4 HTTP] +** xref:components::netty-http-component.adoc[Netty HTTP] ** xref:components::nsq-component.adoc[NSQ] ** xref:components::olingo2-component.adoc[Olingo2] ** xref:components::olingo4-component.adoc[Olingo4] diff --git a/docs/user-manual/modules/ROOT/pages/rest-dsl.adoc b/docs/user-manual/modules/ROOT/pages/rest-dsl.adoc index db7ae40..fa1c4c5 100644 --- a/docs/user-manual/modules/ROOT/pages/rest-dsl.adoc +++ b/docs/user-manual/modules/ROOT/pages/rest-dsl.adoc @@ -20,7 +20,7 @@ The following Camel components supports the Rest DSL. See the bottom of this page for how to integrate a component with the Rest DSL. * xref:components::rest-component.adoc[came-rest] *required* contains the base rest component needed by Rest DSL -* xref:components::netty4-http-component.adoc[camel-netty4-http] (also +* xref:components::netty-http-component.adoc[camel-netty-http] (also supports Swagger Java) * xref:components::jetty-component.adoc[camel-jetty] (also supports Swagger Java) @@ -499,7 +499,7 @@ bindings. |contextPath |-|Leading context-path the REST services will be using. This can be used when using components such as SERVLET where the deployed web application is deployed using a - context-path. Or for components such as `camel-jetty` or `camel-netty4-http` that includes a HTTP server. + context-path. Or for components such as `camel-jetty` or `camel-netty-http` that includes a HTTP server. |apiContextPath | - |A leading API context-path the REST API services will be using. This can be used when using components such as `camel-servlet` where the deployed web application diff --git a/parent/pom.xml b/parent/pom.xml index 413528c..2f66182 100644 --- a/parent/pom.xml +++ b/parent/pom.xml @@ -3298,12 +3298,12 @@ </dependency> <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-netty-starter</artifactId> + <artifactId>camel-netty-http-starter</artifactId> <version>${project.version}</version> </dependency> <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-netty-http-starter</artifactId> + <artifactId>camel-netty-starter</artifactId> <version>${project.version}</version> </dependency> <dependency> diff --git a/platforms/spring-boot/spring-boot-dm/camel-spring-boot-dependencies/pom.xml b/platforms/spring-boot/spring-boot-dm/camel-spring-boot-dependencies/pom.xml index 19b578b..58e757a 100644 --- a/platforms/spring-boot/spring-boot-dm/camel-spring-boot-dependencies/pom.xml +++ b/platforms/spring-boot/spring-boot-dm/camel-spring-boot-dependencies/pom.xml @@ -2240,17 +2240,17 @@ </dependency> <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-netty-starter</artifactId> + <artifactId>camel-netty-http</artifactId> <version>${project.version}</version> </dependency> <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-netty-http</artifactId> + <artifactId>camel-netty-http-starter</artifactId> <version>${project.version}</version> </dependency> <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-netty-http-starter</artifactId> + <artifactId>camel-netty-starter</artifactId> <version>${project.version}</version> </dependency> <dependency>
