A B C D E F G H I J K L M N P R S T U V W 
All Classes All Packages

A

AP - com.github.alexdlaird.ngrok.protocol.Region
 
AU - com.github.alexdlaird.ngrok.protocol.Region
 

B

build() - Method in class com.github.alexdlaird.http.DefaultHttpClient.Builder
 
build() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
 
build() - Method in class com.github.alexdlaird.ngrok.NgrokClient.Builder
 
build() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
 
Builder() - Constructor for class com.github.alexdlaird.http.DefaultHttpClient.Builder
 
Builder() - Constructor for class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
 
Builder() - Constructor for class com.github.alexdlaird.ngrok.NgrokClient.Builder
 
Builder() - Constructor for class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
 

C

CapturedRequest - Class in com.github.alexdlaird.ngrok.protocol
An object representing a CapturedRequest response from ngrok's API.
CapturedRequest() - Constructor for class com.github.alexdlaird.ngrok.protocol.CapturedRequest
 
CapturedRequest.Request - Class in com.github.alexdlaird.ngrok.protocol
 
CapturedRequest.Response - Class in com.github.alexdlaird.ngrok.protocol
 
CapturedRequests - Class in com.github.alexdlaird.ngrok.protocol
An object representing CapturedRequests response from ngrok's API.
CapturedRequests() - Constructor for class com.github.alexdlaird.ngrok.protocol.CapturedRequests
 
com.github.alexdlaird - package com.github.alexdlaird
 
com.github.alexdlaird.exception - package com.github.alexdlaird.exception
 
com.github.alexdlaird.http - package com.github.alexdlaird.http
 
com.github.alexdlaird.ngrok - package com.github.alexdlaird.ngrok
 
com.github.alexdlaird.ngrok.conf - package com.github.alexdlaird.ngrok.conf
 
com.github.alexdlaird.ngrok.installer - package com.github.alexdlaird.ngrok.installer
 
com.github.alexdlaird.ngrok.process - package com.github.alexdlaird.ngrok.process
 
com.github.alexdlaird.ngrok.protocol - package com.github.alexdlaird.ngrok.protocol
 
connect() - Method in class com.github.alexdlaird.ngrok.NgrokClient
connect(CreateTunnel) - Method in class com.github.alexdlaird.ngrok.NgrokClient
Establish a new ngrok tunnel for the tunnel definition, returning an object representing the connected tunnel.
createHttpUrlConnection(String) - Method in class com.github.alexdlaird.http.DefaultHttpClient
Override this method if you could like to implement a custom URL connection.
CreateTunnel - Class in com.github.alexdlaird.ngrok.protocol
An object that represents a ngrok Tunnel creation request.
CreateTunnel.Builder - Class in com.github.alexdlaird.ngrok.protocol
Builder for a CreateTunnel, which can be used to construct a request that conforms to ngrok's tunnel definition.

D

DARWIN_i386 - com.github.alexdlaird.ngrok.installer.NgrokCDNUrl
 
DARWIN_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokCDNUrl
 
DefaultHttpClient - Class in com.github.alexdlaird.http
Implementation of a default client for executing JSON-based HTTP requests.
DefaultHttpClient.Builder - Class in com.github.alexdlaird.http
Builder for a DefaultHttpClient.
delete(String, List<Parameter>, Map<String, String>) - Method in interface com.github.alexdlaird.http.HttpClient
delete(String, List<Parameter>, Map<String, String>, Class<B>) - Method in class com.github.alexdlaird.http.DefaultHttpClient
 
delete(String, List<Parameter>, Map<String, String>, Class<B>) - Method in interface com.github.alexdlaird.http.HttpClient
Perform DELETE operation against an endpoint.
disconnect(String) - Method in class com.github.alexdlaird.ngrok.NgrokClient
Disconnect the ngrok tunnel for the given URL, if open.

E

EU - com.github.alexdlaird.ngrok.protocol.Region
 

F

FREEBSD_i386 - com.github.alexdlaird.ngrok.installer.NgrokCDNUrl
 
FREEBSD_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokCDNUrl
 

G

get(String, List<Parameter>, Map<String, String>, Class<B>) - Method in class com.github.alexdlaird.http.DefaultHttpClient
 
get(String, List<Parameter>, Map<String, String>, Class<B>) - Method in interface com.github.alexdlaird.http.HttpClient
Perform GET operation against an endpoint.
getAddr() - Method in class com.github.alexdlaird.ngrok.process.NgrokLog
 
getAddr() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.TunnelConfig
 
getApiUrl() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess
Get the API URL for the ngrok web interface.
getAuthToken() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig
Get the authtoken that will be passed to commands.
getBindTls() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
 
getBody() - Method in exception com.github.alexdlaird.exception.JavaNgrokHTTPException
Get the response body.
getBody() - Method in exception com.github.alexdlaird.http.HttpClientException
Get the response body.
getBody() - Method in class com.github.alexdlaird.http.Response
Get the body of the response.
getBodyRaw() - Method in class com.github.alexdlaird.http.Response
Get the raw body of the response (can be useful if parsing fails).
getConfig() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
 
getConfigPath() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig
Get the path to the ngrok config file.
getCount() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics
 
getDuration() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest
 
getErr() - Method in class com.github.alexdlaird.ngrok.process.NgrokLog
 
getGauge() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics
 
getHeaderFields() - Method in class com.github.alexdlaird.http.Response
Get the response headers.
getHeaders() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Request
 
getHeaders() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Response
 
getHttpClient() - Method in class com.github.alexdlaird.ngrok.NgrokClient
Get the class used to make HTTP requests to ngrok's APIs.
getId() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest
 
getJavaNgrokConfig() - Method in class com.github.alexdlaird.ngrok.NgrokClient
Get the java-ngrok to use when interacting with the ngrok binary.
getJavaNgrokVersion() - Method in class com.github.alexdlaird.ngrok.protocol.Version
Get the java-ngrok version.
getLine() - Method in class com.github.alexdlaird.ngrok.process.NgrokLog
 
getLogEventCallback() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig
Get the log event callback that will be invoked each time ngrok emits a log.
getLvl() - Method in class com.github.alexdlaird.ngrok.process.NgrokLog
 
getMaxLogs() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig
Get the maximum number of ngrok logs to retain in the monitoring thread.
getMethod() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Request
 
getMetrics() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
 
getMsg() - Method in class com.github.alexdlaird.ngrok.process.NgrokLog
 
getName() - Method in class com.github.alexdlaird.http.Parameter
Get the name of the field.
getName() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
 
getName() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
 
getNgrokBin() - Static method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
Get the ngrok executable for the current system.
getNgrokError() - Method in exception com.github.alexdlaird.exception.NgrokException
Get The error that caused the ngrok process to fail.
getNgrokInstaller() - Method in class com.github.alexdlaird.ngrok.NgrokClient
Get the class used to download and install ngrok.
getNgrokLogs() - Method in exception com.github.alexdlaird.exception.NgrokException
Get the ngrok logs, which may be useful for debugging.
getNgrokPath() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig
Get the path to the ngrok binary.
getNgrokProcess() - Method in class com.github.alexdlaird.ngrok.NgrokClient
Get the class used to manage the ngrok binary.
getNgrokVersion() - Method in class com.github.alexdlaird.ngrok.protocol.Version
Get the ngrok version.
getP50() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics
 
getP90() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics
 
getP95() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics
 
getP99() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics
 
getProto() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Request
 
getProto() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Response
 
getProto() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
 
getProto() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
 
getPublicUrl() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
 
getRate1() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics
 
getRate15() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics
 
getRate5() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics
 
getRaw() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Request
 
getRaw() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Response
 
getReconnectSessionRetries() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig
Get the max number of times to retry establishing a new session with ngrok if the connection fails on startup.
getRegion() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig
Get the region in which ngrok will start.
getRemoteAddr() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest
 
getRequest() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest
 
getRequests() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequests
 
getResponse() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest
 
getStart() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest
 
getStartupTime() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig
Get the startup time before ngrok times out on boot.
getStatus() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Response
 
getStatusCode() - Method in exception com.github.alexdlaird.exception.JavaNgrokHTTPException
Get the HTTP status code.
getStatusCode() - Method in exception com.github.alexdlaird.http.HttpClientException
Get the HTTP status code.
getStatusCode() - Method in class com.github.alexdlaird.http.Response
Get the response code.
getStatusCode() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Response
 
getT() - Method in class com.github.alexdlaird.ngrok.process.NgrokLog
 
getTunnelName() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest
 
getTunnels() - Method in class com.github.alexdlaird.ngrok.NgrokClient
Get a list of active ngrok tunnels.
getTunnels() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnels
 
getUri() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest
 
getUri() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Request
 
getUri() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequests
 
getUri() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
 
getUri() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnels
 
getUrl() - Method in exception com.github.alexdlaird.exception.JavaNgrokHTTPException
Get the URL.
getUrl() - Method in exception com.github.alexdlaird.http.HttpClientException
Get the URL.
getUrl() - Method in enum com.github.alexdlaird.ngrok.installer.NgrokCDNUrl
 
getValue() - Method in class com.github.alexdlaird.http.Parameter
Get the value of the field.
getVersion() - Method in class com.github.alexdlaird.ngrok.NgrokClient
Get the ngrok and java-ngrok version.
getVersion() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess
Get the ngrok version.

H

HttpClient - Interface in com.github.alexdlaird.http
A simple interface for executing HTTP requests.
HttpClientException - Exception in com.github.alexdlaird.http
Root exception for DefaultHttpClient interactions.
HttpClientException(String, Exception) - Constructor for exception com.github.alexdlaird.http.HttpClientException
An exception with a message and a root cause.
HttpClientException(String, Exception, String, int, String) - Constructor for exception com.github.alexdlaird.http.HttpClientException
An exception with a message, root cause, and HTTP response data.

I

IN - com.github.alexdlaird.ngrok.protocol.Region
 
installDefaultConfig(Path, Map<String, String>) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
Install the default ngrok config.
installNgrok(Path) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
Download and install the latest ngrok for the current system, overwriting any existing contents at the given path.
isBlank(CharSequence) - Static method in class com.github.alexdlaird.StringUtils
Check that a String contains text.
isInspect() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.TunnelConfig
 
isKeepMonitoring() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig
Get whether the ngrok process will continue to be monitored after it finishes starting up.
isNotBlank(CharSequence) - Static method in class com.github.alexdlaird.StringUtils
Check that a String does not contain text.
isRunning() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess
Check if this object is currently managing a running ngrok process.

J

JavaNgrokConfig - Class in com.github.alexdlaird.ngrok.conf
An object for managing java-ngrok's configuration to interact the ngrok binary.
JavaNgrokConfig.Builder - Class in com.github.alexdlaird.ngrok.conf
Builder for a JavaNgrokConfig.
JavaNgrokException - Exception in com.github.alexdlaird.exception
Root exception for the NgrokClient and the java-ngrok library.
JavaNgrokException(String) - Constructor for exception com.github.alexdlaird.exception.JavaNgrokException
An exception with a message.
JavaNgrokException(String, Throwable) - Constructor for exception com.github.alexdlaird.exception.JavaNgrokException
An exception with a message and a root cause.
JavaNgrokHTTPException - Exception in com.github.alexdlaird.exception
Thrown from NgrokClient when an error occurs making a request to the ngrok web interface.
JavaNgrokHTTPException(String, Throwable, String, int, String) - Constructor for exception com.github.alexdlaird.exception.JavaNgrokHTTPException
An exception with a message and a root cause.
JavaNgrokInstallerException - Exception in com.github.alexdlaird.exception
Thrown from NgrokInstaller when an error occurs while downloading and installing the ngrok binary.
JavaNgrokInstallerException(String) - Constructor for exception com.github.alexdlaird.exception.JavaNgrokInstallerException
An exception with a message.
JavaNgrokInstallerException(String, Throwable) - Constructor for exception com.github.alexdlaird.exception.JavaNgrokInstallerException
An exception with a message and a root cause.
JavaNgrokSecurityException - Exception in com.github.alexdlaird.exception
Thrown from NgrokProcess when a security error occurs.
JavaNgrokSecurityException(String) - Constructor for exception com.github.alexdlaird.exception.JavaNgrokSecurityException
An exception with a message.
JP - com.github.alexdlaird.ngrok.protocol.Region
 

K

kill() - Method in class com.github.alexdlaird.ngrok.NgrokClient
Terminate the ngrok processes, if running.

L

LINUX_i386 - com.github.alexdlaird.ngrok.installer.NgrokCDNUrl
 
LINUX_i386_arm - com.github.alexdlaird.ngrok.installer.NgrokCDNUrl
 
LINUX_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokCDNUrl
 
LINUX_x86_64_arm - com.github.alexdlaird.ngrok.installer.NgrokCDNUrl
 

M

Metrics() - Constructor for class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics
 
modifyConnection(HttpURLConnection) - Method in interface com.github.alexdlaird.http.HttpClient
Override this method if you could like to extend DefaultHttpClient and perform customer HTTP operations before URLConnection.connect() is called on the instance of the passed in connection.

N

NgrokCDNUrl - Enum in com.github.alexdlaird.ngrok.installer
An enum that maps systems and architectures to their corresponding ngrok download URLs.
NgrokClient - Class in com.github.alexdlaird.ngrok
A client for interacting with ngrok, its binary, and its APIs.
NgrokClient.Builder - Class in com.github.alexdlaird.ngrok
Builder for a NgrokClient.
NgrokException - Exception in com.github.alexdlaird.exception
Thrown from NgrokProcess when an error occurs interacting directly with the ngrok binary.
NgrokException(String) - Constructor for exception com.github.alexdlaird.exception.NgrokException
An exception with a message.
NgrokException(String, Throwable) - Constructor for exception com.github.alexdlaird.exception.NgrokException
An exception with a message and a root cause.
NgrokException(String, List<NgrokLog>) - Constructor for exception com.github.alexdlaird.exception.NgrokException
An exception with a message and ngrok logs.
NgrokException(String, List<NgrokLog>, String) - Constructor for exception com.github.alexdlaird.exception.NgrokException
An exception with a message, ngrok logs, and the error that caused ngrok to fail.
NgrokInstaller - Class in com.github.alexdlaird.ngrok.installer
A helper for downloading and installing the ngrok for the current system.
NgrokInstaller() - Constructor for class com.github.alexdlaird.ngrok.installer.NgrokInstaller
 
NgrokLog - Class in com.github.alexdlaird.ngrok.process
An object containing a parsed log from the ngrok process.
NgrokLog(String) - Constructor for class com.github.alexdlaird.ngrok.process.NgrokLog
Parse a String ngrok log to an object representation.
NgrokProcess - Class in com.github.alexdlaird.ngrok.process
An object containing information about the ngrok process.
NgrokProcess(JavaNgrokConfig, NgrokInstaller) - Constructor for class com.github.alexdlaird.ngrok.process.NgrokProcess
If ngrok is not already installed at JavaNgrokConfig.getNgrokPath(), the given NgrokInstaller will install it.

P

Parameter - Class in com.github.alexdlaird.http
A parameter for the HttpClient.
Parameter(String, String) - Constructor for class com.github.alexdlaird.http.Parameter
Construct a parameter.
post(String, R, List<Parameter>, Map<String, String>, Class<B>) - Method in class com.github.alexdlaird.http.DefaultHttpClient
 
post(String, R, List<Parameter>, Map<String, String>, Class<B>) - Method in interface com.github.alexdlaird.http.HttpClient
Perform POST operation against an endpoint.
put(String, R, List<Parameter>, Map<String, String>, Class<B>) - Method in class com.github.alexdlaird.http.DefaultHttpClient
 
put(String, R, List<Parameter>, Map<String, String>, Class<B>) - Method in interface com.github.alexdlaird.http.HttpClient
Perform PUT operation against an endpoint.

R

Region - Enum in com.github.alexdlaird.ngrok.protocol
An enum representing ngrok's valid regions.
Request() - Constructor for class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Request
 
Response<T> - Class in com.github.alexdlaird.http
A response from the HttpClient.
Response() - Constructor for class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Response
 
Response(int, T, String, Map<String, List<String>>) - Constructor for class com.github.alexdlaird.http.Response
Construct a response.

S

SA - com.github.alexdlaird.ngrok.protocol.Region
 
setAuthToken(String) - Method in class com.github.alexdlaird.ngrok.NgrokClient
Set the ngrok auth token in the config file, enabling authenticated features (for instance, more concurrent tunnels, custom subdomains, etc.).
setAuthToken(String) - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess
Set the ngrok auth token in the config file, enabling authenticated features (for instance, more concurrent tunnels, custom subdomains, etc.).
start() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess
If not already running, start a ngrok process with no tunnels.
stop() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess
Terminate the ngrok processes, if running.
streamToString(InputStream, Charset) - Static method in class com.github.alexdlaird.StringUtils
Convert an InputStream to a String.
StringUtils - Class in com.github.alexdlaird
Convenience methods for String manipulation.
StringUtils() - Constructor for class com.github.alexdlaird.StringUtils
 

T

Tunnel - Class in com.github.alexdlaird.ngrok.protocol
An object representing a Tunnel response from ngrok's API.
Tunnel() - Constructor for class com.github.alexdlaird.ngrok.protocol.Tunnel
 
Tunnel.Metrics - Class in com.github.alexdlaird.ngrok.protocol
 
Tunnel.TunnelConfig - Class in com.github.alexdlaird.ngrok.protocol
 
TunnelConfig() - Constructor for class com.github.alexdlaird.ngrok.protocol.Tunnel.TunnelConfig
 
Tunnels - Class in com.github.alexdlaird.ngrok.protocol
An object representing a Tunnels response from ngrok's API.
Tunnels() - Constructor for class com.github.alexdlaird.ngrok.protocol.Tunnels
 

U

update() - Method in class com.github.alexdlaird.ngrok.NgrokClient
Update ngrok, if an update is available.
update() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess
Update ngrok, if an update is available.
US - com.github.alexdlaird.ngrok.protocol.Region
 

V

validateConfig(Path) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
Validate that the config file at the given path is valid for ngrok and java-ngrok.
validateConfig(Map<String, String>) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
Validate that the given map of config items are valid for ngrok and java-ngrok.
valueOf(String) - Static method in enum com.github.alexdlaird.ngrok.installer.NgrokCDNUrl
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.alexdlaird.ngrok.protocol.Region
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.github.alexdlaird.ngrok.installer.NgrokCDNUrl
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.alexdlaird.ngrok.protocol.Region
Returns an array containing the constants of this enum type, in the order they are declared.
Version - Class in com.github.alexdlaird.ngrok.protocol
An object representing ngrok's version and java-ngrok's version.
Version(String, String) - Constructor for class com.github.alexdlaird.ngrok.protocol.Version
 

W

WINDOWS_i386 - com.github.alexdlaird.ngrok.installer.NgrokCDNUrl
 
WINDOWS_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokCDNUrl
 
withAddr(int) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
withAddr(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
The local port to which the tunnel will forward traffic, or a local directory or network address, defaults to "80"
withAuth(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
HTTP basic authentication credentials to enforce on tunneled requests
withAuthToken(String) - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
An authtoken to pass to commands (overrides what is in the config).
withBindTls(boolean) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
withBindTls(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
Bind an HTTPS ("true") or HTTP ("false") endpoint, defaults to "both".
withClientCas(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
PEM TLS certificate authority at this path will verify incoming TLS client connection certificates.
withConfigPath(Path) - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
The path to the ngrok config file, defaults to ~/.ngrok2/config.yml.
withContentType(String) - Method in class com.github.alexdlaird.http.DefaultHttpClient.Builder
Default contentType header for requests.
withCrt(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
PEM TLS certificate at this path to terminate TLS traffic before forwarding locally.
withEncoding(String) - Method in class com.github.alexdlaird.http.DefaultHttpClient.Builder
Default encoding for requests.
withHostHeader(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
Rewrite the HTTP Host header to this value, or preserve to leave it unchanged.
withHostname(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
Hostname to request (requires reserved name and DNS CNAME).
withHttpClient(HttpClient) - Method in class com.github.alexdlaird.ngrok.NgrokClient.Builder
The class used to make HTTP requests to ngrok's APIs.
withJavaNgrokConfig(JavaNgrokConfig) - Method in class com.github.alexdlaird.ngrok.NgrokClient.Builder
The java-ngrok to use when interacting with the ngrok binary.
withKey(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
PEM TLS private key at this path to terminate TLS traffic before forwarding locally.
withLogEventCallback(Function<NgrokLog, Void>) - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
A callback that will be invoked each time ngrok emits a log.
withMaxLogs(int) - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
The maximum number of ngrok logs to retain in the monitoring thread.
withMetadata(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
Arbitrary user-defined metadata that will appear in the ngrok service API when listing tunnels.
withName(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
The name of the tunnel.
withNgrokInstaller(NgrokInstaller) - Method in class com.github.alexdlaird.ngrok.NgrokClient.Builder
The class used to download and install ngrok.
withNgrokPath(Path) - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
The path to the ngrok binary, defaults to ~/.ngrok2/ngrok.
withNgrokProcess(NgrokProcess) - Method in class com.github.alexdlaird.ngrok.NgrokClient.Builder
The class used to manage the ngrok binary.
withoutInspect() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
Disable HTTP request inspection on tunnels.
withoutMonitoring() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
Don't keep monitoring ngrok (for logs, etc.) after startup is complete.
withProto(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
A valid tunnel protocol, defaults to "http".
withReconnectSessionRetries(int) - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
The max number of times to retry establishing a new session with ngrok if the connection fails on startup.
withRegion(Region) - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
The region in which ngrok should start
withRemoteAddr(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
Bind the remote TCP port on the given address.
withStartupTimeout(int) - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
The max number of seconds to wait for ngrok to start before timing out.
withSubdomain(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
Subdomain name to request.
A B C D E F G H I J K L M N P R S T U V W 
All Classes All Packages