Package com.github.alexdlaird.ngrok.process

Class NgrokProcess

java.lang.Object

com.github.alexdlaird.ngrok.process.NgrokProcess

public class NgrokProcess
extends java.lang.Object

An object containing information about the ngrok process.

Constructor Summary

Constructors

Constructor	Description
NgrokProcess(JavaNgrokConfig javaNgrokConfig, NgrokInstaller ngrokInstaller)	If ngrok is not already installed at JavaNgrokConfig.getNgrokPath(), the given NgrokInstaller will install it.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getApiUrl()	Get the API URL for the ngrok web interface.
java.lang.String	getVersion()	Get the ngrok version.
boolean	isRunning()	Check if this object is currently managing a running ngrok process.
void	setAuthToken(java.lang.String authToken)	Set the ngrok auth token in the config file, enabling authenticated features (for instance, more concurrent tunnels, custom subdomains, etc.).
void	start()	If not already running, start a ngrok process with no tunnels.
void	stop()	Terminate the ngrok processes, if running.
void	update()	Update ngrok, if an update is available.

Methods inherited from class java.lang.Object

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

Constructor Detail

NgrokProcess

public NgrokProcess(JavaNgrokConfig javaNgrokConfig,
                    NgrokInstaller ngrokInstaller)

If ngrok is not already installed at JavaNgrokConfig.getNgrokPath(), the given NgrokInstaller will install it. This will also provision a default ngrok config at JavaNgrokConfig.getConfigPath() ()}, if none exists.

Parameters:

javaNgrokConfig - The java-ngrok to use when interacting with the ngrok binary.

ngrokInstaller - The class used to download and install ngrok.

Method Detail

start

public void start()

If not already running, start a ngrok process with no tunnels. This will start the ngrok web interface, against which HTTP requests can be made to create, interact with, and destroy tunnels.

isRunning

public boolean isRunning()

Check if this object is currently managing a running ngrok process.

stop

public void stop()

Terminate the ngrok processes, if running. This method will not block, it will just issue a kill request.

setAuthToken

public void setAuthToken(java.lang.String authToken)

Set the ngrok auth token in the config file, enabling authenticated features (for instance, more concurrent tunnels, custom subdomains, etc.).

Parameters:

authToken - The auth token.

update

public void update()

Update ngrok, if an update is available.

getVersion

public java.lang.String getVersion()

Get the ngrok version.

Returns:

The version.

getApiUrl

public java.lang.String getApiUrl()

Get the API URL for the ngrok web interface.