Package io.quarkiverse.quinoa.deployment.config.delegate

Class DevServerConfigDelegate

java.lang.Object

io.quarkiverse.quinoa.deployment.config.delegate.DevServerConfigDelegate

All Implemented Interfaces:

DevServerConfig

public class DevServerConfigDelegate
extends Object
implements DevServerConfig

Constructor Summary

Constructors

Constructor	Description
DevServerConfigDelegate(DevServerConfig delegate)

Method Summary

Modifier and Type	Method	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.
Optional<String>	indexPage()	Set this value if the index page is different for the dev-server
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
Optional<Integer>	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DevServerConfigDelegate

public DevServerConfigDelegate(DevServerConfig delegate)

Method Detail

enabled

public boolean enabled()

Description copied from interface: DevServerConfig

Enable external dev server (live coding). If the "dev-server.port" config is not detected or defined it will be disabled.

Specified by:

enabled in interface DevServerConfig

managed

public boolean managed()

Description copied from interface: DevServerConfig

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

Specified by:

managed in interface DevServerConfig

port

public Optional<Integer> port()

Description copied from interface: DevServerConfig

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.

Specified by:

port in interface DevServerConfig

host

public String host()

Description copied from interface: DevServerConfig

Host of the server to forward requests to.

Specified by:

host in interface DevServerConfig

checkPath

public Optional<String> checkPath()

Description copied from interface: DevServerConfig

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

Specified by:

checkPath in interface DevServerConfig

websocket

public boolean websocket()

Description copied from interface: DevServerConfig

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.

Specified by:

websocket in interface DevServerConfig

checkTimeout

public int checkTimeout()

Description copied from interface: DevServerConfig

Timeout in ms for the dev server to be up and running.

Specified by:

checkTimeout in interface DevServerConfig

logs

public boolean logs()

Description copied from interface: DevServerConfig

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

Specified by:

logs in interface DevServerConfig

indexPage

public Optional<String> indexPage()

Description copied from interface: DevServerConfig

Set this value if the index page is different for the dev-server

Specified by:

indexPage in interface DevServerConfig