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. Can be configured with JavaNgrokConfig.

Basic Usage

Opening a tunnel will start the ngrok process. This process will remain alive, and the tunnels open, until stop() is invoked, or until the Java process terminates.

Event Logs

When ngrok emits logs, java-ngrok can surface them to a callback function. To register this callback, use JavaNgrokConfig.Builder.withLogEventCallback(java.util.function.Function<com.github.alexdlaird.ngrok.process.NgrokLog, java.lang.Void>).

If these events aren't necessary for our use case, some resources can be freed up by turning them off. JavaNgrokConfig.Builder.withoutMonitoring() will disable logging, or we can call NgrokProcess.ProcessMonitor.stop() to stop monitoring on a running process.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NgrokProcess.ProcessMonitor A Runnable that monitors the ngrok thread.

Constructor Summary

Constructors

Constructor and 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 and Description
java.lang.String	getApiUrl() Get the API URL for the ngrok web interface.
NgrokInstaller	getNgrokInstaller() Get the class used to download and install ngrok.
NgrokProcess.ProcessMonitor	getProcessMonitor() Get the Runnable that is monitoring the ngrok thread.
java.lang.String	getVersion() Get the ngrok version.
boolean	isRunning() Check if this object is currently managing a running ngrok process.
void	setApiKey(java.lang.String apiKey) Set the ngrok API key in the config file, enabling more features (for instance, labeled tunnels).
void	setAuthToken(java.lang.String authToken) Set the ngrok auth token in the config file, enabling authenticated features (for instance, opening multiple concurrent tunnels, custom domains, 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 config to use when interacting with the ngrok binary.

ngrokInstaller - The class used to download and install ngrok.

Method Detail

getNgrokInstaller

public NgrokInstaller getNgrokInstaller()

Get the class used to download and install ngrok.

getProcessMonitor

public NgrokProcess.ProcessMonitor getProcessMonitor()

Get the Runnable that is monitoring the ngrok thread.

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.

Throws:

NgrokException - ngrok could not start.

JavaNgrokSecurityException - The URL was not supported.

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, opening multiple concurrent tunnels, custom domains, etc.).

 // Setting an auth token allows us to do things like open multiple tunnels at the same time
 final NgrokClient ngrokClient = new NgrokClient.Builder().build();
 ngrokClient.setAuthToken("<NGROK_AUTHTOKEN>")

 // <NgrokTunnel: "http://<public_sub1>.ngrok.io" -> "http://localhost:80">
 final Tunnel ngrokTunnel1 = ngrokClient.connect();
 // <NgrokTunnel: "http://<public_sub2>.ngrok.io" -> "http://localhost:8000">
 final CreateTunnel sshCreateTunnel = new CreateTunnel.Builder()
         .withAddr(8000)
         .build();
 final Tunnel ngrokTunnel2 = ngrokClient.connect(createTunnel);
 

The auth token can also be set in the JavaNgrokConfig that is passed to the NgrokClient.Builder.

Parameters:

authToken - The auth token.

Throws:

NgrokException - ngrok could not start.

setApiKey

public void setApiKey(java.lang.String apiKey)

Set the ngrok API key in the config file, enabling more features (for instance, labeled tunnels).

The API key can also be set in the JavaNgrokConfig that is passed to the NgrokClient.Builder.

Parameters:

apiKey - The API key.

Throws:

NgrokException - ngrok could not start.

update

public void update()

Update ngrok, if an update is available.

Throws:

NgrokException - ngrok could not start.

getVersion

public java.lang.String getVersion()

Get the ngrok version.

Returns:

The version.

Throws:

NgrokException - ngrok could not start.

getApiUrl

public java.lang.String getApiUrl()

Get the API URL for the ngrok web interface.

Throws:

JavaNgrokSecurityException - The URL was not supported.