FrontendTools (Vaadin Platform (vaadin-platform-javadoc) 14.9.6 API)

java.lang.Object
- com.vaadin.flow.server.frontend.FrontendTools

```
public class FrontendTools
extends Object
```
Provides access to frontend tools (node.js and npm, pnpm) and optionally installs the tools if needed.
WARNING: This class is intended for internal usage only. May be renamed or removed in a future release.

Author:

Vaadin Ltd

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_NODE_VERSION` This is the version that is installed if there is no node installed or the installed version is older than `SUPPORTED_NODE_VERSION`, i.e.
`static String`	`DEFAULT_PNPM_VERSION`
`static String`	`INSTALL_NODE_LOCALLY`
`static int`	`SUPPORTED_PNPM_MAJOR_VERSION`
`static int`	`SUPPORTED_PNPM_MINOR_VERSION`

Constructor Summary

Constructors
Constructor and Description
`FrontendTools(String baseDir, Supplier<String> alternativeDirGetter)` Creates an instance of the class using the `baseDir` as a base directory to locate the tools and the directory returned by the `alternativeDirGetter` as a directory to install tools if they are not found and use it as an alternative tools location.
`FrontendTools(String baseDir, Supplier<String> alternativeDirGetter, boolean forceAlternativeNode)` Creates an instance of the class using the `baseDir` as a base directory to locate the tools and the directory returned by the `alternativeDirGetter` as a directory to install tools if they are not found and use it as an alternative tools location.
`FrontendTools(String baseDir, Supplier<String> alternativeDirGetter, String nodeVersion, URI nodeDownloadRoot)` Creates an instance of the class using the `baseDir` as a base directory to locate the tools and the directory returned by the `alternativeDirGetter` as a directory to install tools if they are not found and use it as an alternative tools location.
`FrontendTools(String baseDir, Supplier<String> alternativeDirGetter, String nodeVersion, URI nodeDownloadRoot, boolean forceAlternativeNode)` Creates an instance of the class using the `baseDir` as a base directory to locate the tools and the directory returned by the `alternativeDirGetter` as a directory to install tools if they are not found and use it as an alternative tools location.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`forceAlternativeNodeExecutable()` Locate `node` executable from the alternative directory given.
`List<String>`	`getBowerExecutable()` Locate `bower` executable.
`String`	`getNodeExecutable()` Locate `node` executable.
`FrontendVersion`	`getNodeVersion()` Gets the version of the node executable.
`List<String>`	`getNpmExecutable()` Locate `npm` executable.
`List<String>`	`getPnpmExecutable()` Locate `pnpm` executable.
`protected List<ProxyConfig.Proxy>`	`getProxies()` Read list of configured proxies in order from system properties, .npmrc file in the project root folder, .npmrc file in user root folder and system environment variables.
`Map<String,String>`	`getWebpackNodeEnvironment()` Returns flags required to pass to Node for Webpack to function.
`protected String`	`installNode(String nodeVersion, URI downloadRoot)` Install node and npm.
`void`	`validateNodeAndNpmVersion()` Validate that the found node and npm versions are new enough.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_NODE_VERSION
```
public static final String DEFAULT_NODE_VERSION
```
    This is the version that is installed if there is no node installed or the installed version is older than SUPPORTED_NODE_VERSION, i.e. ..
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PNPM_VERSION
```
public static final String DEFAULT_PNPM_VERSION
```
    See Also:
    
    Constant Field Values
  - INSTALL_NODE_LOCALLY
```
public static final String INSTALL_NODE_LOCALLY
```
    See Also:
    
    Constant Field Values
  - SUPPORTED_PNPM_MAJOR_VERSION
```
public static final int SUPPORTED_PNPM_MAJOR_VERSION
```
    See Also:
    
    Constant Field Values
  - SUPPORTED_PNPM_MINOR_VERSION
```
public static final int SUPPORTED_PNPM_MINOR_VERSION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FrontendTools
```
public FrontendTools(String baseDir,
                     Supplier<String> alternativeDirGetter,
                     boolean forceAlternativeNode)
```
    Creates an instance of the class using the baseDir as a base directory to locate the tools and the directory returned by the alternativeDirGetter as a directory to install tools if they are not found and use it as an alternative tools location.
    If alternativeDir is null tools won't be installed.
    
    Parameters:
    
    baseDir - the base directory to locate the tools, not null
    
    alternativeDirGetter - the getter for a directory where tools will be installed if they are not found globally or in the baseDir, may be null
    
    forceAlternativeNode - force usage of node executable from alternative directory
  - FrontendTools
```
public FrontendTools(String baseDir,
                     Supplier<String> alternativeDirGetter)
```
    Creates an instance of the class using the baseDir as a base directory to locate the tools and the directory returned by the alternativeDirGetter as a directory to install tools if they are not found and use it as an alternative tools location.
    If alternativeDir is null tools won't be installed.
    
    Parameters:
    
    baseDir - the base directory to locate the tools, not null
    
    alternativeDirGetter - the getter for a directory where tools will be installed if they are not found globally or in the baseDir, may be null
  - FrontendTools
```
public FrontendTools(String baseDir,
                     Supplier<String> alternativeDirGetter,
                     String nodeVersion,
                     URI nodeDownloadRoot,
                     boolean forceAlternativeNode)
```
    Creates an instance of the class using the baseDir as a base directory to locate the tools and the directory returned by the alternativeDirGetter as a directory to install tools if they are not found and use it as an alternative tools location.
    If alternativeDir is null tools won't be installed.
    
    Parameters:
    
    baseDir - the base directory to locate the tools, not null
    
    alternativeDirGetter - the getter for a directory where tools will be installed if they are not found globally or in the baseDir, may be null
    
    nodeVersion - The node.js version to be used when node.js is installed automatically by Vaadin, for example "v14.15.4". Use "v14.21.1" by default.
    
    nodeDownloadRoot - Download node.js from this URL. Handy in heavily firewalled corporate environments where the node.js download can be provided from an intranet mirror. Use NodeInstaller.DEFAULT_NODEJS_DOWNLOAD_ROOT by default.
    
    forceAlternativeNode - force usage of node executable from alternative directory
  - FrontendTools
```
public FrontendTools(String baseDir,
                     Supplier<String> alternativeDirGetter,
                     String nodeVersion,
                     URI nodeDownloadRoot)
```
    Creates an instance of the class using the baseDir as a base directory to locate the tools and the directory returned by the alternativeDirGetter as a directory to install tools if they are not found and use it as an alternative tools location.
    If alternativeDir is null tools won't be installed.
    
    Parameters:
    
    baseDir - the base directory to locate the tools, not null
    
    alternativeDirGetter - the getter for a directory where tools will be installed if they are not found globally or in the baseDir, may be null
    
    nodeVersion - The node.js version to be used when node.js is installed automatically by Vaadin, for example "v14.15.4". Use "v14.21.1" by default.
    
    nodeDownloadRoot - Download node.js from this URL. Handy in heavily firewalled corporate environments where the node.js download can be provided from an intranet mirror. Use NodeInstaller.DEFAULT_NODEJS_DOWNLOAD_ROOT by default.
- Method Detail
  - getNodeExecutable
```
public String getNodeExecutable()
```
    Locate node executable.
    
    Returns:
    
    the full path to the executable
  - forceAlternativeNodeExecutable
```
public String forceAlternativeNodeExecutable()
```
    Locate node executable from the alternative directory given.
    The difference between getNodeExecutable() and this method in a search algorithm: getNodeExecutable() first searches executable in the base/alternative directory and fallbacks to the globally installed if it's not found there. The forceAlternativeNodeExecutable() doesn't search for globally installed executable. It tries to find it in the installation directory and if it's not found it downloads and installs it there.
    
    Returns:
    
    the full path to the executable
    
    See Also:
    
    getNodeExecutable()
  - getNpmExecutable
```
public List<String> getNpmExecutable()
```
    Locate npm executable.
    
    Returns:
    
    the list of all commands in sequence that need to be executed to have npm running
  - getPnpmExecutable
```
public List<String> getPnpmExecutable()
```
    Locate pnpm executable.
    In case pnpm is not available it will be installed.
    
    Returns:
    
    the list of all commands in sequence that need to be executed to have pnpm running
  - validateNodeAndNpmVersion
```
public void validateNodeAndNpmVersion()
```
    Validate that the found node and npm versions are new enough. Throws an exception with a descriptive message if a version is too old.
  - getBowerExecutable
```
public List<String> getBowerExecutable()
```
    Locate bower executable.
    An empty list is returned if bower is not found
    
    Returns:
    
    the list of all commands in sequence that need to be executed to have bower running, an empty list if bower is not found
  - getNodeVersion
```
public FrontendVersion getNodeVersion()
                               throws FrontendUtils.UnknownVersionException
```
    Gets the version of the node executable.
    
    Throws:
    
    FrontendUtils.UnknownVersionException
  - installNode
```
protected String installNode(String nodeVersion,
                             URI downloadRoot)
```
    Install node and npm.
    
    Parameters:
    
    nodeVersion - node version to install
    
    downloadRoot - optional download root for downloading node. May be a filesystem file or a URL see NodeInstaller.setNodeDownloadRoot(URI).
    
    Returns:
    
    node installation path
  - getProxies
```
protected List<ProxyConfig.Proxy> getProxies()
```
    Read list of configured proxies in order from system properties, .npmrc file in the project root folder, .npmrc file in user root folder and system environment variables.
    
    Returns:
    
    list of configured proxies
  - getWebpackNodeEnvironment
```
public Map<String,String> getWebpackNodeEnvironment()
```
    Returns flags required to pass to Node for Webpack to function. Determine whether webpack requires Node.js to be started with the --openssl-legacy-provider parameter. This is a webpack 4 workaround of the issue https://github.com/webpack/webpack/issues/14532 See: https://github.com/vaadin/flow/issues/12649
    
    Returns:
    
    the flags

Class FrontendTools

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_NODE_VERSION

DEFAULT_PNPM_VERSION

INSTALL_NODE_LOCALLY

SUPPORTED_PNPM_MAJOR_VERSION

SUPPORTED_PNPM_MINOR_VERSION

Constructor Detail

FrontendTools

FrontendTools

FrontendTools

FrontendTools

Method Detail

getNodeExecutable

forceAlternativeNodeExecutable

getNpmExecutable

getPnpmExecutable

validateNodeAndNpmVersion

getBowerExecutable

getNodeVersion

installNode

getProxies

getWebpackNodeEnvironment