com.github.alexdlaird.ngrok.installer

Class NgrokInstaller

java.lang.Object

com.github.alexdlaird.ngrok.installer.NgrokInstaller

public class NgrokInstaller
extends java.lang.Object

A helper for downloading and installing ngrok for the current system.

Config File

By default, ngrok will look for its config file in the default location. We can override this behavior with JavaNgrokConfig.Builder.withConfigPath(Path).

Binary Path

The java-ngrok package manages its own ngrok binary. We can use our ngrok binary if we want by setting it with JavaNgrokConfig.Builder.withNgrokPath(Path) and passing that config to NgrokClient.

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.file.Path	DEFAULT_CONFIG_PATH
static java.nio.file.Path	DEFAULT_NGROK_PATH
static java.lang.String	FREEBSD
static java.lang.String	LINUX
static java.lang.String	MAC
static java.util.List<java.lang.String>	UNIX_BINARIES
static java.lang.String	WINDOWS

Constructor Summary

Constructors

Constructor and Description
NgrokInstaller() Construct with the DefaultHttpClient.
NgrokInstaller(HttpClient httpClient) Construct with a custom HttpClient.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getDefaultConfig(NgrokVersion ngrokVersion, ConfigVersion configVersion) Get the default config params for the given major version of ngrok.
static java.lang.String	getNgrokBin() Get the ngrok executable for the current system.
NgrokCDNUrl	getNgrokCDNUrl() See getNgrokCDNUrl(NgrokVersion).
NgrokCDNUrl	getNgrokCDNUrl(NgrokVersion ngrokVersion) Determine the ngrok CDN URL for the current OS and architecture.
java.util.Map<java.lang.String,java.lang.Object>	getNgrokConfig(java.nio.file.Path configPath) See getNgrokConfig(Path, boolean, NgrokVersion, ConfigVersion).
java.util.Map<java.lang.String,java.lang.Object>	getNgrokConfig(java.nio.file.Path configPath, boolean useCache) See getNgrokConfig(Path, boolean, NgrokVersion, ConfigVersion).
java.util.Map<java.lang.String,java.lang.Object>	getNgrokConfig(java.nio.file.Path configPath, boolean useCache, NgrokVersion ngrokVersion, ConfigVersion configVersion) Get the ngrok config from the given path.
static java.lang.String	getSystem() Parse the name of the OS from system properties and return a friendly name.
void	installDefaultConfig(java.nio.file.Path configPath, java.util.Map<java.lang.String,java.lang.Object> data) See installDefaultConfig(Path, Map, NgrokVersion, ConfigVersion).
void	installDefaultConfig(java.nio.file.Path configPath, java.util.Map<java.lang.String,java.lang.Object> data, NgrokVersion ngrokVersion) See installDefaultConfig(Path, Map, NgrokVersion, ConfigVersion).
void	installDefaultConfig(java.nio.file.Path configPath, java.util.Map<java.lang.String,java.lang.Object> data, NgrokVersion ngrokVersion, ConfigVersion configVersion) Install the default ngrok config.
void	installNgrok(java.nio.file.Path ngrokPath) See installNgrok(Path, NgrokVersion).
void	installNgrok(java.nio.file.Path ngrokPath, NgrokVersion ngrokVersion) Download and install the latest ngrok for the current system, overwriting any existing contents at the given path.
void	validateConfig(java.util.Map<java.lang.String,java.lang.Object> data) Validate that the given map of config items are valid for ngrok and java-ngrok.
void	validateConfig(java.nio.file.Path configPath) Validate that the config file at the given path is valid for ngrok and java-ngrok.

Methods inherited from class java.lang.Object

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

Field Detail

MAC

public static final java.lang.String MAC

See Also:

Constant Field Values

WINDOWS

public static final java.lang.String WINDOWS

See Also:

Constant Field Values

LINUX

public static final java.lang.String LINUX

See Also:

Constant Field Values

FREEBSD

public static final java.lang.String FREEBSD

See Also:

Constant Field Values

UNIX_BINARIES

public static final java.util.List<java.lang.String> UNIX_BINARIES

DEFAULT_NGROK_PATH

public static final java.nio.file.Path DEFAULT_NGROK_PATH

DEFAULT_CONFIG_PATH

public static final java.nio.file.Path DEFAULT_CONFIG_PATH

Constructor Detail

NgrokInstaller

public NgrokInstaller()

Construct with the DefaultHttpClient.

NgrokInstaller

public NgrokInstaller(HttpClient httpClient)

Construct with a custom HttpClient.

Parameters:

httpClient - The HTTP client.

Method Detail

getNgrokBin

public static java.lang.String getNgrokBin()

Get the ngrok executable for the current system.

Returns:

The name of the ngrok executable.

getSystem

public static java.lang.String getSystem()

Parse the name of the OS from system properties and return a friendly name.

Returns:

The friendly name of the OS.

Throws:

JavaNgrokInstallerException - The OS is not supported.

installDefaultConfig

public void installDefaultConfig(java.nio.file.Path configPath,
                                 java.util.Map<java.lang.String,java.lang.Object> data)

See installDefaultConfig(Path, Map, NgrokVersion, ConfigVersion).

installDefaultConfig

public void installDefaultConfig(java.nio.file.Path configPath,
                                 java.util.Map<java.lang.String,java.lang.Object> data,
                                 NgrokVersion ngrokVersion)

See installDefaultConfig(Path, Map, NgrokVersion, ConfigVersion).

installDefaultConfig

public void installDefaultConfig(java.nio.file.Path configPath,
                                 java.util.Map<java.lang.String,java.lang.Object> data,
                                 NgrokVersion ngrokVersion,
                                 ConfigVersion configVersion)

Install the default ngrok config. If a config is not already present for the given path, create one.

Parameters:

configPath - The path to where the ngrok config should be installed.

data - A map of things to add to the default config.

ngrokVersion - The major version of ngrok installed.

configVersion - The ngrok config version.

Throws:

JavaNgrokInstallerException - An error occurred downloading ngrok.

installNgrok

public void installNgrok(java.nio.file.Path ngrokPath)

See installNgrok(Path, NgrokVersion).

installNgrok

public void installNgrok(java.nio.file.Path ngrokPath,
                         NgrokVersion ngrokVersion)

Download and install the latest ngrok for the current system, overwriting any existing contents at the given path.

Parameters:

ngrokPath - The path to where the ngrok binary will be downloaded.

ngrokVersion - The major ngrok version to install.

Throws:

JavaNgrokInstallerException - An error occurred installing ngrok.

JavaNgrokSecurityException - An error occurred unzipping the download.

getNgrokCDNUrl

public NgrokCDNUrl getNgrokCDNUrl()

See getNgrokCDNUrl(NgrokVersion).

getNgrokCDNUrl

public NgrokCDNUrl getNgrokCDNUrl(NgrokVersion ngrokVersion)

Determine the ngrok CDN URL for the current OS and architecture.

Parameters:

ngrokVersion - The major version of ngrok to install.

Returns:

The ngrok CDN URL.

validateConfig

public void validateConfig(java.nio.file.Path configPath)

Validate that the config file at the given path is valid for ngrok and java-ngrok.

Parameters:

configPath - The config path to validate.

validateConfig

public void validateConfig(java.util.Map<java.lang.String,java.lang.Object> data)

Validate that the given map of config items are valid for ngrok and java-ngrok.

Parameters:

data - A map of things to be validated as config items.

Throws:

JavaNgrokException - A key or value failed validation.

getNgrokConfig

public java.util.Map<java.lang.String,java.lang.Object> getNgrokConfig(java.nio.file.Path configPath,
                                                                       boolean useCache,
                                                                       NgrokVersion ngrokVersion,
                                                                       ConfigVersion configVersion)

Get the ngrok config from the given path.

Parameters:

configPath - The ngrok config path to read.

useCache - Use the cached version of the config (if populated).

ngrokVersion - The major version of ngrok installed.

configVersion - The ngrok config version.

Returns:

A map of the ngrok config.

Throws:

JavaNgrokInstallerException - The config could not be parsed.

getNgrokConfig

public java.util.Map<java.lang.String,java.lang.Object> getNgrokConfig(java.nio.file.Path configPath,
                                                                       boolean useCache)

See getNgrokConfig(Path, boolean, NgrokVersion, ConfigVersion).

getNgrokConfig

public java.util.Map<java.lang.String,java.lang.Object> getNgrokConfig(java.nio.file.Path configPath)

See getNgrokConfig(Path, boolean, NgrokVersion, ConfigVersion).

getDefaultConfig

public java.util.Map<java.lang.String,java.lang.Object> getDefaultConfig(NgrokVersion ngrokVersion,
                                                                         ConfigVersion configVersion)

Get the default config params for the given major version of ngrok.

Parameters:

ngrokVersion - The major version of ngrok installed.

configVersion - The ngrok config version.

Returns:

The default config.