Package com.vaadin.flow.server.frontend.installer

Class NodeInstaller

java.lang.Object

com.vaadin.flow.server.frontend.installer.NodeInstaller

public class NodeInstaller
extends Object

Node installation class.

Derived from eirslett/frontend-maven-plugin

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCEPT_MISSING_SHA
static final String	DEFAULT_NODEJS_DOWNLOAD_ROOT
static final String	INSTALL_PATH_PREFIX
static final String	PROVIDED_VERSION
static final String	SHA_SUMS_FILE
static final String	UNOFFICIAL_NODEJS_DOWNLOAD_ROOT

Constructor Summary

Constructors

Constructor	Description
NodeInstaller(File installDirectory, Platform platform, com.vaadin.frontendtools.installer.ArchiveExtractor archiveExtractor, FileDownloader fileDownloader)	Initialize a new NodeInstaller.
NodeInstaller(File installDirectory, Platform platform, List<ProxyConfig.Proxy> proxies)	Create NoodeInstaller with default extractor and downloader.
NodeInstaller(File installDirectory, List<ProxyConfig.Proxy> proxies)	Create NodeInstaller with default extractor and downloader and guess platform.

Method Summary

Modifier and Type	Method	Description
String	getInstallDirectory()
void	install()	Install node and npm.
NodeInstaller	setNodeDownloadRoot(URI nodeDownloadRoot)	Set a custom download root.
NodeInstaller	setNodeVersion(String nodeVersion)	Set the node version to install.
NodeInstaller	setPassword(String password)	Set password to use.
NodeInstaller	setUserName(String userName)	Set user name to use.

Methods inherited from class java.lang.Object

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

Field Details

INSTALL_PATH_PREFIX

public static final String INSTALL_PATH_PREFIX

See Also:

• Constant Field Values

SHA_SUMS_FILE

public static final String SHA_SUMS_FILE

See Also:

• Constant Field Values

PROVIDED_VERSION

public static final String PROVIDED_VERSION

See Also:

• Constant Field Values

ACCEPT_MISSING_SHA

public static final String ACCEPT_MISSING_SHA

See Also:

• Constant Field Values

DEFAULT_NODEJS_DOWNLOAD_ROOT

public static final String DEFAULT_NODEJS_DOWNLOAD_ROOT

See Also:

• Constant Field Values

UNOFFICIAL_NODEJS_DOWNLOAD_ROOT

public static final String UNOFFICIAL_NODEJS_DOWNLOAD_ROOT

See Also:

• Constant Field Values

Constructor Details

NodeInstaller

public NodeInstaller(File installDirectory,
 List<ProxyConfig.Proxy> proxies)

Create NodeInstaller with default extractor and downloader and guess platform.

Parameters:

installDirectory - installation directory

proxies - list of proxies

NodeInstaller

public NodeInstaller(File installDirectory,
 Platform platform,
 List<ProxyConfig.Proxy> proxies)

Create NoodeInstaller with default extractor and downloader.

Parameters:

installDirectory - installation directory

platform - platform information

proxies - list of proxies

NodeInstaller

public NodeInstaller(File installDirectory,
 Platform platform,
 com.vaadin.frontendtools.installer.ArchiveExtractor archiveExtractor,
 FileDownloader fileDownloader)

Initialize a new NodeInstaller.

Parameters:

installDirectory - installation directory

platform - platform information

archiveExtractor - archive extractor

fileDownloader - file downloader

Method Details

setNodeVersion

public NodeInstaller setNodeVersion(String nodeVersion)

Set the node version to install. (given as "v16.0.0")

Parameters:

nodeVersion - version string

Returns:

this

setNodeDownloadRoot

public NodeInstaller setNodeDownloadRoot(URI nodeDownloadRoot)

Set a custom download root.

This should be a url or directory under which we can find a directory nodeVersion and there should then exist the archived node packages. For instance for v16.0.0 we should have under nodeDownloadRoot: ./v16.0.0/node-v16.0.0-linux-x64.tar.xz ./v16.0.0/node-v16.0.0-darwin-x64.tar.gz ./v16.0.0/node-v16.0.0-win-x64.zip ./v16.0.0/node-v16.0.0-win-x86.zip

Parameters:

nodeDownloadRoot - custom download root

Returns:

this

setUserName

public NodeInstaller setUserName(String userName)

Set user name to use.

Parameters:

userName - user name

Returns:

this

setPassword

public NodeInstaller setPassword(String password)

Set password to use.

Parameters:

password - password

Returns:

this

install

public void install()
             throws InstallationException

Install node and npm. This method unconditionally downloads and installs the specified node version without checking if it already exists. Use NodeResolver to check for existing installations before calling this.

Throws:

InstallationException - exception thrown when installation fails

getInstallDirectory

public String getInstallDirectory()