Package io.jmix.flowui.devserver

Class ViteHandler

java.lang.Object

io.jmix.flowui.devserver.AbstractDevServerRunner

io.jmix.flowui.devserver.ViteHandler

All Implemented Interfaces:

com.vaadin.flow.internal.DevModeHandler, com.vaadin.flow.server.RequestHandler, Serializable

public final class ViteHandler
extends AbstractDevServerRunner

Handles communication with a Vite server.

This class is meant to be used during developing time.

For internal use only. May be renamed or removed in a future release.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	VITE_SERVER	The local installation path of the server node script.

Fields inherited from class io.jmix.flowui.devserver.AbstractDevServerRunner

DEV_SERVER_HOST

Constructor Summary

Constructors

Constructor	Description
ViteHandler(com.vaadin.flow.di.Lookup lookup, int runningPort, File npmFolder, File studioFolder, CompletableFuture<Void> waitFor)	Creates and starts the dev mode handler if none has been started yet.

Method Summary

Modifier and Type	Method	Description
String	getPathToVaadin()	Gets the url path to the /VAADIN folder.
String	getPathToVaadinInContext()	Gets the url path to the /VAADIN folder inside the context root.
protected File	getServerBinary()	Gets the binary that starts the dev server.
protected File	getServerConfig()	Gets the main configuration file for the dev server.
protected Pattern	getServerFailurePattern()	Gets a pattern to match with the output to determine that the server has failed to start.
protected String	getServerName()	Gets the name of the dev server for outputting to the user and statistics.
protected Pattern	getServerRestartedPattern()	Gets a pattern to match with the output to determine that the server has been restarted.
protected Pattern	getServerRestartingPattern()	Gets a pattern to match with the output to determine that the server is restarting.
protected List<String>	getServerStartupCommand(FrontendTools frontendTools)	Gets the commands to run to start the dev server.
protected Pattern	getServerSuccessPattern()	Gets a pattern to match with the output to determine that the server has started successfully.
HttpURLConnection	prepareConnection(String path, String method)

Methods inherited from class io.jmix.flowui.devserver.AbstractDevServerRunner

checkConnection, doStartDevServer, getApplicationConfiguration, getFailedOutput, getPort, getProjectRoot, getStudioRoot, getWatchDog, handleRequest, onDevServerCompilation, serveDevModeRequest, stop, triggerLiveReload, updateServerStartupEnvironment, validateFiles, waitForDevServer, writeStream

Methods inherited from class java.lang.Object

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

Field Details

VITE_SERVER

public static final String VITE_SERVER

The local installation path of the server node script.

See Also:

• Constant Field Values

Constructor Details

ViteHandler

public ViteHandler(com.vaadin.flow.di.Lookup lookup,
 int runningPort,
 File npmFolder,
 File studioFolder,
 CompletableFuture<Void> waitFor)

Creates and starts the dev mode handler if none has been started yet.

Parameters:

lookup - the provided lookup to get required data

runningPort - a port on which Vite is already running or 0 to start a new process

npmFolder - folder with npm configuration files

waitFor - a completable future whose execution result needs to be available to start the dev server

Method Details

getServerStartupCommand

protected List<String> getServerStartupCommand(FrontendTools frontendTools)

Description copied from class: AbstractDevServerRunner

Gets the commands to run to start the dev server.

Specified by:

getServerStartupCommand in class AbstractDevServerRunner

Parameters:

frontendTools - the frontend tools object

getServerName

protected String getServerName()

Description copied from class: AbstractDevServerRunner

Gets the name of the dev server for outputting to the user and statistics.

Specified by:

getServerName in class AbstractDevServerRunner

getServerBinary

protected File getServerBinary()

Description copied from class: AbstractDevServerRunner

Gets the binary that starts the dev server.

Specified by:

getServerBinary in class AbstractDevServerRunner

getServerConfig

protected File getServerConfig()

Description copied from class: AbstractDevServerRunner

Gets the main configuration file for the dev server.

Specified by:

getServerConfig in class AbstractDevServerRunner

getServerFailurePattern

protected Pattern getServerFailurePattern()

Description copied from class: AbstractDevServerRunner

Gets a pattern to match with the output to determine that the server has failed to start.

Specified by:

getServerFailurePattern in class AbstractDevServerRunner

getServerSuccessPattern

protected Pattern getServerSuccessPattern()

Description copied from class: AbstractDevServerRunner

Gets a pattern to match with the output to determine that the server has started successfully.

Specified by:

getServerSuccessPattern in class AbstractDevServerRunner

getServerRestartingPattern

protected Pattern getServerRestartingPattern()

Description copied from class: AbstractDevServerRunner

Gets a pattern to match with the output to determine that the server is restarting. Defaults to null, meaning that server restart is not monitored. Server restart is monitored only if both this method and AbstractDevServerRunner.getServerRestartedPattern() provides a pattern.

Overrides:

getServerRestartingPattern in class AbstractDevServerRunner

getServerRestartedPattern

protected Pattern getServerRestartedPattern()

Description copied from class: AbstractDevServerRunner

Gets a pattern to match with the output to determine that the server has been restarted. Defaults to null, meaning that server restart is not monitored. Server restart is monitored only if both this method and AbstractDevServerRunner.getServerRestartingPattern() provides a pattern.

Overrides:

getServerRestartedPattern in class AbstractDevServerRunner

prepareConnection

public HttpURLConnection prepareConnection(String path,
 String method)
                                    throws IOException

Specified by:

prepareConnection in interface com.vaadin.flow.internal.DevModeHandler

Overrides:

prepareConnection in class AbstractDevServerRunner

Throws:

IOException

getPathToVaadin

public String getPathToVaadin()

Gets the url path to the /VAADIN folder.

Returns:

the url path to the /VAADIN folder, relative to the host root

getPathToVaadinInContext

public String getPathToVaadinInContext()

Gets the url path to the /VAADIN folder inside the context root.

Returns:

the url path to the /VAADIN folder, relative to the context root