io.quarkus.vertx.http.deployment

Class HttpRootPathBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.SimpleBuildItem

io.quarkus.vertx.http.deployment.HttpRootPathBuildItem

public final class HttpRootPathBuildItem
extends io.quarkus.builder.item.SimpleBuildItem

Constructor Summary

Constructors

Constructor and Description
HttpRootPathBuildItem(String rootPath)

Method Summary

Modifier and Type	Method and Description
String	adjustPath(String path) Deprecated. Use resolvePath instead. Do not use this method. Will be removed in Quarkus 2.0
String	getRootPath() Return normalized Http root path configured from quarkus.http.root-path.
String	resolvePath(String path) Resolve path into an absolute path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpRootPathBuildItem

public HttpRootPathBuildItem(String rootPath)

Method Detail

getRootPath

public String getRootPath()

Return normalized Http root path configured from quarkus.http.root-path. This path will always end in a slash.

Use resolvePath(String) if you need to construct a Uri from the Http root path.

Returns:

Normalized Http root path ending with a slash

See Also:

resolvePath(String)

adjustPath

public String adjustPath(String path)

Deprecated. Use resolvePath instead. Do not use this method. Will be removed in Quarkus 2.0

Adjusts the path in relation to `quarkus.http.root-path`. Any leading slash will be removed to resolve relatively.

resolvePath

public String resolvePath(String path)

Resolve path into an absolute path. If path is relative, it will be resolved against `quarkus.http.root-path`. An absolute path will be normalized and returned.

Given quarkus.http.root-path=/

• resolvePath("foo") will return /foo
• resolvePath("/foo") will return /foo

Given quarkus.http.root-path=/app

• resolvePath("foo") will return /app/foo
• resolvePath("/foo") will return /foo

The returned path will not end with a slash.

Parameters:

path - Path to be resolved to an absolute path.

Returns:

An absolute path not ending with a slash

See Also:

UriNormalizationUtil.normalizeWithBase(URI, String, boolean)