Package io.quarkus.devconsole.spi

Class DevConsoleRouteBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.MultiBuildItem

io.quarkus.devconsole.spi.DevConsoleRouteBuildItem

public final class DevConsoleRouteBuildItem
extends io.quarkus.builder.item.MultiBuildItem

A route for handling requests in the dev console.

Routes are registered under /q/dev/{groupId}.{artifactId}/

The route is registered:

• in the "regular" app router (runtime class loader), if the handler is produced by a recorder (i.e. implements BytecodeRecorderImpl.ReturnedProxy),
• in the Dev UI router (deployment class loader).

Constructor Summary

Constructors

Constructor	Description
DevConsoleRouteBuildItem(String path, String method, io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> handler)
DevConsoleRouteBuildItem(String path, String method, io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> handler, boolean isBodyHandlerRequired)
DevConsoleRouteBuildItem(String groupId, String artifactId, String path, String method, io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> handler)

Method Summary

Modifier and Type	Method	Description
io.vertx.core.Handler<io.vertx.ext.web.RoutingContext>	getHandler()
String	getMethod()
String	getPath()
Map.Entry<String,String>	groupIdAndArtifactId(CurateOutcomeBuildItem curateOutcomeBuildItem)	Gets the group id and artifact ID.
boolean	isBodyHandlerRequired()
boolean	isDeploymentSide()

Methods inherited from class java.lang.Object

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

Constructor Detail

DevConsoleRouteBuildItem

public DevConsoleRouteBuildItem(String groupId,
                                String artifactId,
                                String path,
                                String method,
                                io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> handler)

DevConsoleRouteBuildItem

public DevConsoleRouteBuildItem(String path,
                                String method,
                                io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> handler)

DevConsoleRouteBuildItem

public DevConsoleRouteBuildItem(String path,
                                String method,
                                io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> handler,
                                boolean isBodyHandlerRequired)

Method Detail

groupIdAndArtifactId

public Map.Entry<String,String> groupIdAndArtifactId(CurateOutcomeBuildItem curateOutcomeBuildItem)

Gets the group id and artifact ID. This needs the curate result to map the calling class to the artifact that contains it in some situations (namely in dev mode tests).

getPath

public String getPath()

getMethod

public String getMethod()

getHandler

public io.vertx.core.Handler<io.vertx.ext.web.RoutingContext> getHandler()

isDeploymentSide

public boolean isDeploymentSide()

isBodyHandlerRequired

public boolean isBodyHandlerRequired()