Package 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpRootPathBuildItem.Builder

Constructor Summary

Constructors

Constructor	Description
HttpRootPathBuildItem(String rootPath)

Method Summary

Modifier and Type	Method	Description
String	getRootPath()	Return normalized Http root path configured from quarkus.http.root-path.
String	relativePath(String path)	Resolve path that is always relative into an absolute path.
String	resolvePath(String path)	Resolve path into an absolute path.
HttpRootPathBuildItem.Builder	routeBuilder()

Methods inherited from class java.lang.Object

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

Constructor Details

HttpRootPathBuildItem

public HttpRootPathBuildItem(String rootPath)

Method Details

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)

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
• resolvePath("/") will return /

Given quarkus.http.root-path=/app

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

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)

relativePath

public String relativePath(String path)

Resolve path that is always relative into an absolute path. Whether the path is relative or absolute, it will be resolved against `quarkus.http.root-path`, by removing the '/' in the latter case.

Given quarkus.http.root-path=/

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

Given quarkus.http.root-path=/app

• relativePath("foo") will return /app/foo
• relativePath("/foo") will return /app/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)

routeBuilder

public HttpRootPathBuildItem.Builder routeBuilder()