Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document HttpServerOptionsCustomizer #34997

Merged
merged 1 commit into from
Jul 26, 2023
Merged

Document HttpServerOptionsCustomizer #34997

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/src/main/asciidoc/http-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,6 +442,27 @@
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 servers started by Quarkus via the use of `io.quarkus.vertx.http.HttpServerOptionsCustomizer`.

Check warning on line 447 in docs/src/main/asciidoc/http-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'through' rather than 'via' unless updating existing content that uses it.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'through' rather than 'via' unless updating existing content that uses it.", "location": {"path": "docs/src/main/asciidoc/http-reference.adoc", "range": {"start": {"line": 447, "column": 72}}}, "severity": "WARNING"}
For example, if the HTTP port needs to be set programmatically, then the following code could be used:

Check warning on line 448 in docs/src/main/asciidoc/http-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'needs to'.

Raw Output:
{"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'needs to'.", "location": {"path": "docs/src/main/asciidoc/http-reference.adoc", "range": {"start": {"line": 448, "column": 9}}}, "severity": "INFO"}
rsvoboda marked this conversation as resolved.
Show resolved Hide resolved

[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 managed bean, Quarkus will take the customizer into account when it starts the Vert.x servers
<2> In this case, we only care about customizing the HTTP server, so we just override the `customizeHttpServer` method, but users should be aware that `HttpServerOptionsCustomizer` allows configuring the HTTPS and Domain Socket servers as well

[[reverse-proxy]]
== Running behind a reverse proxy
Expand Down
Loading