You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ja...@apache.org on 2021/11/23 13:09:16 UTC
[camel-quarkus] branch main updated (2e47c10 -> 7dc8268)
This is an automated email from the ASF dual-hosted git repository.
jamesnetherton pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git.
from 2e47c10 Updated CHANGELOG.md
new 886b58a Document that vertx-websocket consumers run on the Quarkus Vert.x web server
new 7dc8268 Repalce reference to quarkus-vertx-web with quarkus-vertx-http
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../pages/reference/extensions/platform-http.adoc | 2 +-
.../reference/extensions/vertx-websocket.adoc | 38 +++++++++++++++++++++-
.../platform-http/runtime/src/main/doc/intro.adoc | 2 +-
.../runtime/src/main/doc/configuration.adoc | 12 +++++++
.../runtime/src/main/doc/intro.adoc | 3 ++
.../runtime/src/main/doc/usage.adoc | 13 ++++++++
.../vertx/websocket/VertxWebsocketRecorder.java | 2 +-
7 files changed, 68 insertions(+), 4 deletions(-)
create mode 100644 extensions/vertx-websocket/runtime/src/main/doc/configuration.adoc
create mode 100644 extensions/vertx-websocket/runtime/src/main/doc/intro.adoc
create mode 100644 extensions/vertx-websocket/runtime/src/main/doc/usage.adoc
[camel-quarkus] 01/02: Document that vertx-websocket consumers run on the Quarkus Vert.x web server
Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
jamesnetherton pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
commit 886b58a0764379642f27bcaca488f667683dba36
Author: James Netherton <ja...@gmail.com>
AuthorDate: Tue Nov 23 10:29:14 2021 +0000
Document that vertx-websocket consumers run on the Quarkus Vert.x web server
Fixes #3318
---
.../reference/extensions/vertx-websocket.adoc | 38 +++++++++++++++++++++-
.../runtime/src/main/doc/configuration.adoc | 12 +++++++
.../runtime/src/main/doc/intro.adoc | 3 ++
.../runtime/src/main/doc/usage.adoc | 13 ++++++++
.../vertx/websocket/VertxWebsocketRecorder.java | 2 +-
5 files changed, 66 insertions(+), 2 deletions(-)
diff --git a/docs/modules/ROOT/pages/reference/extensions/vertx-websocket.adoc b/docs/modules/ROOT/pages/reference/extensions/vertx-websocket.adoc
index 46d8b72..c3d23f0 100644
--- a/docs/modules/ROOT/pages/reference/extensions/vertx-websocket.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/vertx-websocket.adoc
@@ -14,7 +14,10 @@
[.badges]
[.badge-key]##JVM since##[.badge-supported]##1.1.0## [.badge-key]##Native since##[.badge-supported]##1.1.0##
-Camel WebSocket support with Vert.x
+This extension enables you to create WebSocket endpoints to that act as either a WebSocket server, or as a client to connect an existing WebSocket .
+
+It is built on top of the Eclipse Vert.x HTTP server provided by the `quarkus-vertx-http` extension.
+
== What's inside
@@ -37,3 +40,36 @@ Or add the coordinates to your existing project:
----
Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.
+
+== Usage
+
+=== Vert.x WebSocket consumers
+
+When you create a Vert.x WebSocket consumer (E.g with `from("vertx-websocket")`), the host and port configuration in the URI are redundant since the WebSocket will always be hosted on
+the Quarkus HTTP server.
+
+The configuration of the consumer can be simplified to only include the resource path of the WebSocket. For example.
+
+[source,java]
+----
+from("vertx-websocket://my-websocket-path")
+ .setBody().constant("Hello World");
+----
+
+
+
+== Additional Camel Quarkus configuration
+
+=== Vert.x WebSocket server configuration
+
+Configuration of the Vert.x WebSocket server is managed by Quarkus. Refer to the https://quarkus.io/guides/all-config#quarkus-vertx-http_quarkus-vertx-http-eclipse-vert.x-http[Quarkus HTTP configuration guide]
+for the full list of configuration options.
+
+To configure SSL for the Vert.x WebSocket server, follow the https://quarkus.io/guides/http-reference#ssl[secure connections with SSL guide].
+Note that configuring the server for SSL with `SSLContextParameters` is not currently supported.
+
+=== Character encodings
+
+Check the xref:user-guide/native-mode.adoc#charsets[Character encodings section] of the Native mode guide if you expect
+your application to send or receive requests using non-default encodings.
+
diff --git a/extensions/vertx-websocket/runtime/src/main/doc/configuration.adoc b/extensions/vertx-websocket/runtime/src/main/doc/configuration.adoc
new file mode 100644
index 0000000..cadf02c
--- /dev/null
+++ b/extensions/vertx-websocket/runtime/src/main/doc/configuration.adoc
@@ -0,0 +1,12 @@
+=== Vert.x WebSocket server configuration
+
+Configuration of the Vert.x WebSocket server is managed by Quarkus. Refer to the https://quarkus.io/guides/all-config#quarkus-vertx-http_quarkus-vertx-http-eclipse-vert.x-http[Quarkus HTTP configuration guide]
+for the full list of configuration options.
+
+To configure SSL for the Vert.x WebSocket server, follow the https://quarkus.io/guides/http-reference#ssl[secure connections with SSL guide].
+Note that configuring the server for SSL with `SSLContextParameters` is not currently supported.
+
+=== Character encodings
+
+Check the xref:user-guide/native-mode.adoc#charsets[Character encodings section] of the Native mode guide if you expect
+your application to send or receive requests using non-default encodings.
diff --git a/extensions/vertx-websocket/runtime/src/main/doc/intro.adoc b/extensions/vertx-websocket/runtime/src/main/doc/intro.adoc
new file mode 100644
index 0000000..4eefc4a
--- /dev/null
+++ b/extensions/vertx-websocket/runtime/src/main/doc/intro.adoc
@@ -0,0 +1,3 @@
+This extension enables you to create WebSocket endpoints to that act as either a WebSocket server, or as a client to connect an existing WebSocket .
+
+It is built on top of the Eclipse Vert.x HTTP server provided by the `quarkus-vertx-http` extension.
\ No newline at end of file
diff --git a/extensions/vertx-websocket/runtime/src/main/doc/usage.adoc b/extensions/vertx-websocket/runtime/src/main/doc/usage.adoc
new file mode 100644
index 0000000..e1e0644
--- /dev/null
+++ b/extensions/vertx-websocket/runtime/src/main/doc/usage.adoc
@@ -0,0 +1,13 @@
+=== Vert.x WebSocket consumers
+
+When you create a Vert.x WebSocket consumer (E.g with `from("vertx-websocket")`), the host and port configuration in the URI are redundant since the WebSocket will always be hosted on
+the Quarkus HTTP server.
+
+The configuration of the consumer can be simplified to only include the resource path of the WebSocket. For example.
+
+[source,java]
+----
+from("vertx-websocket://my-websocket-path")
+ .setBody().constant("Hello World");
+----
+
diff --git a/extensions/vertx-websocket/runtime/src/main/java/org/apache/camel/quarkus/component/vertx/websocket/VertxWebsocketRecorder.java b/extensions/vertx-websocket/runtime/src/main/java/org/apache/camel/quarkus/component/vertx/websocket/VertxWebsocketRecorder.java
index 8f37b81..0d35db7 100644
--- a/extensions/vertx-websocket/runtime/src/main/java/org/apache/camel/quarkus/component/vertx/websocket/VertxWebsocketRecorder.java
+++ b/extensions/vertx-websocket/runtime/src/main/java/org/apache/camel/quarkus/component/vertx/websocket/VertxWebsocketRecorder.java
@@ -55,7 +55,7 @@ public class VertxWebsocketRecorder {
@Override
public void start() throws InterruptedException, ExecutionException {
- // Noop as quarkus-vertx-web handles the server lifecycle
+ // Noop as quarkus-vertx-http handles the server lifecycle
}
}
}
[camel-quarkus] 02/02: Repalce reference to quarkus-vertx-web with quarkus-vertx-http
Posted by ja...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
jamesnetherton pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-quarkus.git
commit 7dc82684910a20ea10159950390773ed6e3896c7
Author: James Netherton <ja...@gmail.com>
AuthorDate: Tue Nov 23 10:32:45 2021 +0000
Repalce reference to quarkus-vertx-web with quarkus-vertx-http
---
docs/modules/ROOT/pages/reference/extensions/platform-http.adoc | 2 +-
extensions/platform-http/runtime/src/main/doc/intro.adoc | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/modules/ROOT/pages/reference/extensions/platform-http.adoc b/docs/modules/ROOT/pages/reference/extensions/platform-http.adoc
index f5242f9..8940363 100644
--- a/docs/modules/ROOT/pages/reference/extensions/platform-http.adoc
+++ b/docs/modules/ROOT/pages/reference/extensions/platform-http.adoc
@@ -17,7 +17,7 @@
This extension allows for creating HTTP endpoints for consuming HTTP requests.
-It is built on top of Eclipse Vert.x Web service provided by the `quarkus-vertx-web` extension.
+It is built on top of the Eclipse Vert.x HTTP server provided by the `quarkus-vertx-http` extension.
== What's inside
diff --git a/extensions/platform-http/runtime/src/main/doc/intro.adoc b/extensions/platform-http/runtime/src/main/doc/intro.adoc
index 6ac5b40..0747e1c 100644
--- a/extensions/platform-http/runtime/src/main/doc/intro.adoc
+++ b/extensions/platform-http/runtime/src/main/doc/intro.adoc
@@ -1,3 +1,3 @@
This extension allows for creating HTTP endpoints for consuming HTTP requests.
-It is built on top of Eclipse Vert.x Web service provided by the `quarkus-vertx-web` extension.
\ No newline at end of file
+It is built on top of the Eclipse Vert.x HTTP server provided by the `quarkus-vertx-http` extension.
\ No newline at end of file