Method Details

• getOsName

  public static String getOsName()

  Get the Operating System name from the os.name system property.

  Returns:

  operating system name

• isWindows

  public static boolean isWindows()

  Check if the current os is Windows.

  Returns:

  true if windows

• streamToString

  public static String streamToString(InputStream inputStream)

  Read a stream and copy the content into a String using system line separators for all 'carriage return' characters.

  Parameters:

  inputStream - the input stream

  Returns:

  the string

• createProcessBuilder

  public static ProcessBuilder createProcessBuilder(List<String> command)

  Creates a process builder for the given list of program and arguments. If the program is defined as an absolute path, then the directory that contains the program is also appended to PATH so that the it can locate related tools.

  Parameters:

  command - a list with the program and arguments

  Returns:

  a configured process builder

• getIndexHtmlContent

  public static String getIndexHtmlContent(VaadinService service) throws IOException

  Gets the content of the frontend/index.html file which is served by vite in dev-mode and read from classpath in production mode.

  NOTE: In dev mode, the file content is fetched using an http request so that we don't need to have a separate index.html's content watcher. Auto-reloading will work automatically, like other files in the `frontend/` folder.

  Parameters:

  service - the vaadin service

  Returns:

  the content of the index html file as a string, null if not found.

  Throws:

  IOException - on error when reading file

• getWebComponentHtmlContent

  public static String getWebComponentHtmlContent(VaadinService service) throws IOException

  Gets the content of the frontend/web-component.html file which is served by vite in dev-mode and read from classpath in production mode.

  NOTE: In dev mode, the file content is fetched using an http request so that we don't need to have a separate web-component.html's content watcher. Auto-reloading will work automatically, like other files in the `frontend/` folder.

  Parameters:

  service - the vaadin service

  Returns:

  the content of the web-component.html file as a string, null if not found.

  Throws:

  IOException - on error when reading file

• getFrontendFileFromDevModeHandler

  public static InputStream getFrontendFileFromDevModeHandler(VaadinService service, String path)

  Get the contents of a frontend file from the running dev server.

  Parameters:

  service - the Vaadin service.

  path - the file path.

  Returns:

  an input stream for reading the file contents; null if there is no such file or the dev server is not running.

• resolveFrontendPath

  public static File resolveFrontendPath(File projectRoot, String path)

  Looks up the frontend resource at the given path. If the path starts with ./, first look in frontend, then in "jar-resources". If the path does not start with ./, look in node_modules instead.

  Parameters:

  projectRoot - the project root folder.

  path - the file path.

  Returns:

  an existing File , or null if the file doesn't exist.

• resolveFrontendPath

  public static File resolveFrontendPath(File projectRoot, String path, File frontendDirectory)

  Looks up the fronted resource at the given path. If the path starts with ./, first look in frontend, then in "jar-resources". If the path does not start with ./, look in node_modules instead.

  Parameters:

  projectRoot - the project root folder.

  path - the file path.

  frontendDirectory - the frontend directory.

  Returns:

  an existing File , or null if the file doesn't exist.

• getJarResourceString

  public static String getJarResourceString(String jarImport)

  Get resource from JAR package.

  Parameters:

  jarImport - jar file to get (no resource folder should be added)

  Returns:

  resource as String or null if not found

• getJarResourcesFolder

  public static File getJarResourcesFolder(File frontendDirectory)

  Get the front-end resources folder. This is where the contents of JAR dependencies are copied to.

  Parameters:

  frontendDirectory - project's frontend directory

  Returns:

  a File representing a folder with copied resources

• getProjectFrontendDir

  public static String getProjectFrontendDir(DeploymentConfiguration configuration)

  Get directory where project's frontend files are located.

  Parameters:

  configuration - the current deployment configuration

  Returns:

  DEFAULT_FRONTEND_DIR or value of PARAM_FRONTEND_DIR if it is set.

• getUnixRelativePath

  public static String getUnixRelativePath(Path source, Path target)

  Get relative path from a source path to a target path in Unix form. All the Windows' path separator will be replaced.

  Parameters:

  source - the source path

  target - the target path

  Returns:

  unix relative path from source to target

• getUnixPath

  public static String getUnixPath(Path source)

  Get path as a String in Unix form.

  Parameters:

  source - path to get

  Returns:

  path as a String in Unix form.

• readFallbackChunk

  public static FallbackChunk readFallbackChunk(elemental.json.JsonObject object)

  Read fallback chunk data from a json object.

  Parameters:

  object - json object to read fallback chunk data

  Returns:

  a fallback chunk data

• getVersion

  protected static FrontendVersion getVersion(String tool, List<String> versionCommand) throws FrontendUtils.UnknownVersionException

  Throws:

  FrontendUtils.UnknownVersionException

• executeCommand

  public static String executeCommand(List<String> command) throws FrontendUtils.CommandExecutionException

  Executes a given command as a native process.

  Parameters:

  command - the command to be executed and it's arguments.

  Returns:

  process output string.

  Throws:

  FrontendUtils.CommandExecutionException - if the process completes exceptionally.

• parseFrontendVersion

  public static FrontendVersion parseFrontendVersion(String versionString) throws IOException

  Parse the version number of node/npm from version output string.

  Parameters:

  versionString - string containing version output, typically produced by tool --version

  Returns:

  FrontendVersion of versionString

  Throws:

  IOException - if parsing fails

• getVaadinHomeDirectory

  public static File getVaadinHomeDirectory()

  Gets vaadin home directory (".vaadin" folder in the user home dir).

  The directory is created if it's doesn't exist.

  Returns:

  a vaadin home directory

• commandToString

  public static String commandToString(String baseDir, List<String> command)

  Pretty prints a command line order. It split in lines adapting to 80 columns, and allowing copy and paste in console. It also removes the current directory to avoid security issues in log files.

  Parameters:

  baseDir - the current directory

  command - the command and it's arguments

  Returns:

  the string for printing in logs

• getPackageVersionFromJson

  public static FrontendVersion getPackageVersionFromJson(elemental.json.JsonObject sourceJson, String pkg, String versionOrigin)

  Tries to parse the given package's frontend version or if it doesn't exist, returns null. In case the value cannot be parsed, logs an error and returns null.

  Parameters:

  sourceJson - json object that has the package

  pkg - the package name

  versionOrigin - origin of the version (like a file), used in error message

  Returns:

  the frontend version the package or null

• console

  public static void console(String format, Object message)

  Intentionally send to console instead to log, useful when executing external processes.

  Parameters:

  format - Format of the line to send to console, it must contain a `%s` outlet for the message

  message - the string to show

• deleteNodeModules

  public static void deleteNodeModules(File nodeModules) throws IOException

  Try to remove the node_modules directory, if it exists inside the given base directory. Note that pnpm uses symlinks internally, so delete utilities that follow symlinks when deleting and/or modifying permissions may not work as intended.

  Parameters:

  nodeModules - the node_modules directory

  Throws:

  IOException - on failure to delete any one file, or if the directory name is not node_modules

• deleteDirectory

  public static void deleteDirectory(File directory) throws IOException

  Recursively delete given directory and contents.

  Will not delete contents of symlink or junction directories, only the link file.

  Parameters:

  directory - directory to delete

  Throws:

  IOException - on failure to delete or read any one file

• getFrontendServletPath

  public static String getFrontendServletPath(jakarta.servlet.ServletContext servletContext)

  Gets the servlet path (excluding the context path) for the servlet used for serving the VAADIN frontend bundle.

  Returns:

  the path to the servlet used for the frontend bundle. Empty for a /* mapping, otherwise always starts with a slash but never ends with a slash

• findBundleFile

  public static URL findBundleFile(File projectDir, String filename) throws IOException

  Finds the given file inside the express mode development bundle that is used.

  Parameters:

  projectDir - the project root folder

  filename - the file name inside the bundle

  Returns:

  a URL referring to the file inside the bundle or null if the file was not found

  Throws:

  IOException

• getDevBundleFolder

  public static File getDevBundleFolder(File projectDir)

  Get the folder where an application specific bundle is stored.

  Parameters:

  projectDir - the project base directory

  Returns:

  the bundle directory

• findBundleStatsJson

  public static String findBundleStatsJson(File projectDir) throws IOException

  Get the stats.json for the application specific development bundle.

  Parameters:

  projectDir - the project base directory

  Returns:

  stats.json content or null if not found

  Throws:

  IOException - if an I/O exception occurs.

• getThemeName

  public static Optional<String> getThemeName(File projectFolder) throws IOException

  Gets the custom theme name if the custom theme is used in the project.

  Should be only used in the development mode.

  Parameters:

  projectFolder - the project root folder

  Returns:

  custom theme name or empty optional if no theme is used

  Throws:

  IOException - if I/O exceptions occur while trying to extract the theme name.

• getThemeAnnotation

  public static Optional<Theme> getThemeAnnotation(VaadinContext context)

  Gets the theme annotation for the project.

  Parameters:

  context - the Vaadin context

  Returns:

  the theme annotation or an empty optional

• getThemeJsonInFrontend

  public static Optional<elemental.json.JsonObject> getThemeJsonInFrontend(File frontendFolder, String themeName) throws IOException

  Throws:

  IOException

• getThemeJsonInFrontend

  public static Optional<elemental.json.JsonObject> getThemeJsonInFrontend(Options options, ThemeDefinition themeDefinition) throws IOException

  Throws:

  IOException

• getParentThemeNameInFrontend

  public static Optional<String> getParentThemeNameInFrontend(File frontendFolder, elemental.json.JsonObject themeJson)

• getParentThemeNameInFrontend

  public static Optional<String> getParentThemeNameInFrontend(File frontendFolder, String projectCustomThemeName) throws IOException

  Throws:

  IOException