Package io.quarkiverse.quinoa.deployment

Class DevServerConfig

java.lang.Object

io.quarkiverse.quinoa.deployment.DevServerConfig

public class DevServerConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Optional<String>	checkPath	After start, Quinoa wait for the external dev server.
int	checkTimeout	Timeout in ms for the dev server to be up and running.
boolean	enabled	Enable external dev server (live coding).
String	host	Host of the server to forward requests to.
boolean	logs	Enable external dev server live coding logs.
boolean	managed	When set to true, Quinoa will manage the Web UI dev server When set to false, the Web UI dev server have to be started before running Quarkus dev
OptionalInt	port	Port of the server to forward requests to.
boolean	websocket	By default, Quinoa will handle request upgrade to websocket and act as proxy with the dev server.

Constructor Summary

Constructors

Constructor	Description
DevServerConfig()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

enabled

@ConfigItem(name="<<parent>>",
            defaultValue="true")
public boolean enabled

Enable external dev server (live coding). The "dev-server.port" config is required to communicate with the dev server. If not set the default is true.

managed

@ConfigItem(defaultValue="true")
public boolean managed

When set to true, Quinoa will manage the Web UI dev server When set to false, the Web UI dev server have to be started before running Quarkus dev

port

@ConfigItem
public OptionalInt port

Port of the server to forward requests to. The dev server process (i.e npm start) is managed like a dev service by Quarkus. If the external server responds with a 404, it is ignored by Quinoa and processed like any other backend request.

host

@ConfigItem(defaultValue="localhost")
public String host

Host of the server to forward requests to. "localhost" is the default

checkPath

@ConfigItem(defaultValue="/")
public Optional<String> checkPath

After start, Quinoa wait for the external dev server. by sending GET requests to this path waiting for a 200 status. If not set the default is "/". If empty string "", Quinoa will not check if the dev server is up.

websocket

@ConfigItem(defaultValue="true")
public boolean websocket

By default, Quinoa will handle request upgrade to websocket and act as proxy with the dev server. If set to false, Quinoa will pass websocket upgrade request to the next Vert.x route handler.

checkTimeout

@ConfigItem(defaultValue="30000")
public int checkTimeout

Timeout in ms for the dev server to be up and running. If not set the default is ~30000ms.

logs

@ConfigItem
public boolean logs

Enable external dev server live coding logs. This is not enabled by default because most dev servers display compilation errors directly in the browser. False if not set.

Constructor Detail

DevServerConfig

public DevServerConfig()

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object