Document HttpServerOptionsCustomizer

Fixes: #34992
quarkusio · Jul 25, 2023 · 4ebeba5 · 4ebeba5
1 parent d2ed11f
commit 4ebeba5
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/docs/src/main/asciidoc/http-reference.adoc b/docs/src/main/asciidoc/http-reference.adoc
@@ -442,6 +442,27 @@ include::{generated-dir}/config/quarkus-vertx-http-config-group-access-log-confi
 Use `quarkus.http.access-log.exclude-pattern=/some/path/.*` to exclude all entries concerning the path `/some/path/...` (_including subsequent paths_) from the log.
 ====
 
+== Arbitrary customizations
+
+Quarkus allows users to arbitrarily customize the options of HTTP server(s) that is(are) started by Quarkus via the use of `io.quarkus.vertx.http.HttpServerOptionsCustomizer`.
+For example, the HTTP port needs to be set programmatically, then the following code could be used:
+
+[source,java]
+----
+import jakarta.inject.Singleton;
+import io.quarkus.vertx.http.HttpServerOptionsCustomizer;
+
+@Singleton <1>
+public static class MyCustomizer implements HttpServerOptionsCustomizer {
+
+    @Override
+    public void customizeHttpServer(HttpServerOptions options) { <2>
+        options.setPort(9998);
+    }
+}
+----
+<1> By making the class a bean, Quarkus will take the customizer into account when it starts the Vert.x servers
+<2> We only care about customizing the HTTP server in this case, so we only override the `customizeHttpServer` method.
 
 [[reverse-proxy]]
 == Running behind a reverse proxy