You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2019/08/08 11:16:28 UTC
[camel] 03/21: CAMEL-13792 - Rename components to default names,
Camel-netty4-http to camel-netty-http - update docs
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 43b331f41fb828c0058dec2938b84c82e0fef09e
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Thu Aug 8 10:31:15 2019 +0200
CAMEL-13792 - Rename components to default names, Camel-netty4-http to camel-netty-http - update docs
---
...tp-component.adoc => netty-http-component.adoc} | 48 +++++++++++-----------
platforms/spring-boot/components-starter/pom.xml | 1 -
2 files changed, 24 insertions(+), 25 deletions(-)
diff --git a/components/camel-netty-http/src/main/docs/netty4-http-component.adoc b/components/camel-netty-http/src/main/docs/netty-http-component.adoc
similarity index 96%
rename from components/camel-netty-http/src/main/docs/netty4-http-component.adoc
rename to components/camel-netty-http/src/main/docs/netty-http-component.adoc
index 0c4d0b5..0269d24 100644
--- a/components/camel-netty-http/src/main/docs/netty4-http-component.adoc
+++ b/components/camel-netty-http/src/main/docs/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:
@@ -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/platforms/spring-boot/components-starter/pom.xml b/platforms/spring-boot/components-starter/pom.xml
index c72e536..71a2e7c 100644
--- a/platforms/spring-boot/components-starter/pom.xml
+++ b/platforms/spring-boot/components-starter/pom.xml
@@ -283,7 +283,6 @@
<module>camel-nats-starter</module>
<module>camel-netty-http-starter</module>
<module>camel-netty-starter</module>
- <module>camel-netty4-http-starter</module>
<module>camel-nsq-starter</module>
<module>camel-ognl-starter</module>
<module>camel-olingo2-starter</module>