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
All Classes All Packages
All Classes All Packages
A
- allowCidrs - Variable in class com.github.alexdlaird.ngrok.protocol.TunnelIPRestrictions.Builder
- AP - com.github.alexdlaird.ngrok.protocol.Region
- AU - com.github.alexdlaird.ngrok.protocol.Region
B
- BindTls - Enum in com.github.alexdlaird.ngrok.protocol
- BOTH - com.github.alexdlaird.ngrok.protocol.BindTls
- 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
- build() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelHeader.Builder
- build() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelIPRestrictions.Builder
- build() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelOAuth.Builder
- build() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelVerifyWebhook.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
-
Use this constructor if default values should not be populated in required attributes when
CreateTunnel.Builder.build()
is called. - Builder() - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelHeader.Builder
- Builder() - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelIPRestrictions.Builder
- Builder() - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelOAuth.Builder
- Builder() - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelVerifyWebhook.Builder
- Builder(boolean) - Constructor for class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
Use this constructor if default values should be populated in required attributes when
CreateTunnel.Builder.build()
is called. - Builder(JavaNgrokConfig) - Constructor for class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
-
Copy a
JavaNgrokConfig
in to a new Builder. - Builder(CreateTunnel) - Constructor for class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
Copy a
CreateTunnel
in to a new Builder. - Builder(Map<String, Object>) - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelHeader.Builder
- Builder(Map<String, Object>) - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelIPRestrictions.Builder
- Builder(Map<String, Object>) - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelOAuth.Builder
- Builder(Map<String, Object>) - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelVerifyWebhook.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.exception - package com.github.alexdlaird.exception
-
This package contains exceptions that can be thrown by
java-ngrok
. - com.github.alexdlaird.http - package com.github.alexdlaird.http
-
This package contains a simple, generic HTTP client, which can be used to interact with
ngrok
's APIs. - com.github.alexdlaird.ngrok - module com.github.alexdlaird.ngrok
- com.github.alexdlaird.ngrok - package com.github.alexdlaird.ngrok
-
This package contains functionality related to
ngrok
. - com.github.alexdlaird.ngrok.conf - package com.github.alexdlaird.ngrok.conf
-
This package contains functionality related to
java-ngrok
configuration. - com.github.alexdlaird.ngrok.installer - package com.github.alexdlaird.ngrok.installer
-
This package contains functionality related to downloading and installing
ngrok
. - com.github.alexdlaird.ngrok.process - package com.github.alexdlaird.ngrok.process
-
This package contains functionality related to managing the
ngrok
process. - com.github.alexdlaird.ngrok.protocol - package com.github.alexdlaird.ngrok.protocol
-
This package contains POJOs for interacting with
ngrok
. - com.github.alexdlaird.util - package com.github.alexdlaird.util
-
This package contains utility functions.
- 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 creation request, 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 tongrok
's tunnel definition.
D
- DARWIN_i386_arm - com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
- DARWIN_i386_arm - com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
- DARWIN_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
- DARWIN_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
- DEFAULT_CONFIG_PATH - Static variable in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
- DEFAULT_NGROK_PATH - Static variable in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
- DefaultHttpClient - Class in com.github.alexdlaird.http
-
A default client for executing JSON-based HTTP requests.
- DefaultHttpClient.Builder - Class in com.github.alexdlaird.http
-
Builder for a
DefaultHttpClient
, see docs for that class for example usage. - delete(String) - Method in interface com.github.alexdlaird.http.HttpClient
- 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.
- denyCidrs - Variable in class com.github.alexdlaird.ngrok.protocol.TunnelIPRestrictions.Builder
- disconnect(String) - Method in class com.github.alexdlaird.ngrok.NgrokClient
-
Disconnect the
ngrok
tunnel for the given URL, if open.
E
F
- FALSE - com.github.alexdlaird.ngrok.protocol.BindTls
- FREEBSD - Static variable in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
- FREEBSD_i386 - com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
- FREEBSD_i386 - com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
- FREEBSD_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
- FREEBSD_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
G
- get(String, Class<B>) - Method in interface com.github.alexdlaird.http.HttpClient
- 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.
- get(String, List<Parameter>, Map<String, String>, Path) - Method in class com.github.alexdlaird.http.DefaultHttpClient
- get(String, List<Parameter>, Map<String, String>, Path) - Method in interface com.github.alexdlaird.http.HttpClient
-
Perform GET operation that downloads a file to the given path.
- getAdd() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelHeader
-
Get the list of headers to add.
- getAddr() - Method in class com.github.alexdlaird.ngrok.process.NgrokLog
- getAddr() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the local port to which the tunnel will forward traffic.
- getAddr() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.TunnelConfig
-
Get the local addr to which the tunnel forwards traffic.
- getAllowCidrs() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelIPRestrictions
-
Get the list of allowed CIDRs.
- getAllowDomains() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelOAuth
-
Get the list of OAuth allowed domains.
- getAllowEmails() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelOAuth
-
Get the list of OAuth allowed emails.
- getApiKey() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig
-
A
ngrok
API key. - getApiUrl() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess
-
Get the API URL for the
ngrok
web interface. - getAuth() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get HTTP basic authentication credentials enforced on tunnel requests.
- getAuthToken() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig
-
Get the
ngrok
authtoken that will be passed to commands. - getBasicAuth() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the list of HTTP basic authentication credentials to enforce on tunneled requests.
- getBindTls() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get
ngrok
'sbind_tls
value. - 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).
- getCircuitBreaker() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the circuit breaker trigger.
- getClientCas() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the PEM TLS certificate authority path that will be used to verify incoming TLS client connection certificates.
- getConfig() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
-
Get the tunnel config.
- 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
- getCrt() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the PEM TLS certificate path that will be used to terminate TLS traffic before forwarding locally.
- getDefaultConfig(NgrokVersion) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
-
Get the default config params for the given major version of
ngrok
. - getDenyCidrs() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelIPRestrictions
-
Get the list of denied CIDRs.
- 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
- getHostHeader() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the HTTP Host header.
- getHostname() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the hostname.
- 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
- getId() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
-
Get the ID of the tunnel.
- getInputStream(HttpURLConnection, String, String, Map<String, String>, int) - Method in class com.github.alexdlaird.http.DefaultHttpClient
- getIpRestrictions() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the IP restrictions for the tunnel.
- getJavaNgrokConfig() - Method in class com.github.alexdlaird.ngrok.NgrokClient
-
Get the
java-ngrok
to use when interacting with thengrok
binary. - getJavaNgrokVersion() - Method in class com.github.alexdlaird.ngrok.protocol.Version
-
Get the
java-ngrok
version. - getKey() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the PEM TLS private key path that will be used to terminate TLS traffic before forwarding locally.
- getLabels() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the labels.
- 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. - getLogs() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess.ProcessMonitor
-
Get the
ngrok
logs. - 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. - getMetadata() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the arbitrary user-defined metadata that will appear in the ngrok service API when listing tunnels.
- getMethod() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Request
- getMetrics() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
-
Get the tunnel metrics.
- getMsg() - Method in class com.github.alexdlaird.ngrok.process.NgrokLog
- getMutualTlsCas() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the path to the TLS certificate authority to verify client certs.
- 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
-
Get the name of the tunnel.
- getName() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
-
Get the name of the tunnel.
- getNgrokBin() - Static method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
-
Get the
ngrok
executable for the current system. - getNgrokCDNUrl() - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
- getNgrokCDNUrl(NgrokVersion) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
-
Determine the
ngrok
CDN URL for the current OS and architecture. - getNgrokConfig(Path) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
- getNgrokConfig(Path, boolean) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
- getNgrokConfig(Path, boolean, NgrokVersion) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
-
Get the
ngrok
config from the given path. - 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.process.NgrokProcess
-
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.conf.JavaNgrokConfig
-
Get the major
ngrok
version to be used. - getNgrokVersion() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the version of
ngrok
for which the tunnel was created. - getNgrokVersion() - Method in class com.github.alexdlaird.ngrok.protocol.Version
-
Get the
ngrok
version. - getOauth() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the OAuth settings to be setup on the tunnel.
- 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
- getProcessMonitor() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess
-
Get the Runnable that is monitoring the
ngrok
thread. - 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
-
Get the tunnel protocol.
- getProto() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
-
Get the proto of the tunnel.
- getProvider() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelOAuth
-
Get the OAuth provider.
- getProvider() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelVerifyWebhook
-
Get the provider.
- getProxyProto() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the proxy proto.
- getPublicUrl() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
-
Get the public URL of the 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
- 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
- getRemoteAddr() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the bound remote TCP port on the given address.
- getRemove() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelHeader
-
Get the list of headers to remove.
- getRequest() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest
- getRequestHeader() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the Headers to be added or removed from requests.
- getRequests() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequests
- getResponse() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest
- getResponseHeader() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the Headers to be added or removed from responses.
- getSchemes() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the schemes to be bound.
- getScopes() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelOAuth
-
Get the list of OAuth scopes.
- getSecret() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelVerifyWebhook
-
Get the secret.
- 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
- getSubdomain() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the subdomain.
- getSystem() - Static method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
-
Parse the name fo the OS from system properties and return a friendly name.
- getT() - Method in class com.github.alexdlaird.ngrok.process.NgrokLog
- getTerminateAt() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the termination point.
- 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
-
Get the relative URI of the 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 interface com.github.alexdlaird.ngrok.installer.NgrokCDNUrl
- getUrl() - Method in enum com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
- getUrl() - Method in enum com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
- getValue() - Method in class com.github.alexdlaird.http.Parameter
-
Get the value of the field.
- getVerifyWebhook() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Get the signature for webhooks.
- getVersion() - Method in class com.github.alexdlaird.ngrok.NgrokClient
-
Get the
ngrok
andjava-ngrok
version. - getVersion() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess
-
Get the
ngrok
version.
H
- HTTP - com.github.alexdlaird.ngrok.protocol.Proto
- 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, Object>) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
- installDefaultConfig(Path, Map<String, Object>, NgrokVersion) - 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
- installNgrok(Path, NgrokVersion) - 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.util.StringUtils
-
Check that a String does not contain text.
- isCompression() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Whether compression is enabled on this tunnel.
- isInspect() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Whether HTTP request inspection on tunnels is enabled.
- isInspect() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.TunnelConfig
-
Whether tunnel traffic is being inspected.
- 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. - isMonitoring() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess.ProcessMonitor
-
Get whether the thread is continuing to monitor
ngrok
logs. - isNotBlank(CharSequence) - Static method in class com.github.alexdlaird.util.StringUtils
-
Check that a String contains text.
- isRunning() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess
-
Check if this object is currently managing a running
ngrok
process. - isWebsocketTcpConverter() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel
-
Whether ingress connections are converted to TCP upstream.
J
- JavaNgrokConfig - Class in com.github.alexdlaird.ngrok.conf
-
An object for managing
java-ngrok
's configuration to interact thengrok
binary. - JavaNgrokConfig.Builder - Class in com.github.alexdlaird.ngrok.conf
-
Builder for a
JavaNgrokConfig
, see docs for that class for example usage. - JavaNgrokException - Exception in com.github.alexdlaird.exception
-
Root exception for the
NgrokClient
and thejava-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 thengrok
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 thengrok
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 - Static variable in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
- LINUX_i386 - com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
- LINUX_i386 - com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
- LINUX_i386_arm - com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
- LINUX_i386_arm - com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
- LINUX_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
- LINUX_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
- LINUX_x86_64_arm - com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
- LINUX_x86_64_arm - com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
M
- MAC - Static variable in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
- 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 beforeURLConnection.connect()
is called on the instance of the passed in connection.
N
- NgrokCDNUrl - Interface in com.github.alexdlaird.ngrok.installer
- 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
, see docs for that class for example usage. - NgrokException - Exception in com.github.alexdlaird.exception
-
Thrown from
NgrokProcess
when an error occurs interacting directly with thengrok
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 causedngrok
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
- NgrokInstaller(HttpClient) - 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 atJavaNgrokConfig.getNgrokPath()
, the givenNgrokInstaller
will install it. - NgrokProcess.ProcessMonitor - Class in com.github.alexdlaird.ngrok.process
- NgrokV2CDNUrl - Enum in com.github.alexdlaird.ngrok.installer
-
An enum that maps systems and architectures to their corresponding legacy
ngrok
V2 download URLs. - NgrokV3CDNUrl - Enum in com.github.alexdlaird.ngrok.installer
-
An enum that maps systems and architectures to their corresponding
ngrok
download URLs. - NgrokVersion - Enum in com.github.alexdlaird.ngrok.installer
-
An enum for the list of supported major
ngrok
versions.
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, Class<B>) - Method in interface com.github.alexdlaird.http.HttpClient
- 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.
- ProcessMonitor(Process, JavaNgrokConfig) - Constructor for class com.github.alexdlaird.ngrok.process.NgrokProcess.ProcessMonitor
- ProcessMonitor(Process, JavaNgrokConfig, HttpClient) - Constructor for class com.github.alexdlaird.ngrok.process.NgrokProcess.ProcessMonitor
- Proto - Enum in com.github.alexdlaird.ngrok.protocol
-
An enum representing
ngrok
's valid protos, as defined inngrok
's docs. - provider - Variable in class com.github.alexdlaird.ngrok.protocol.TunnelVerifyWebhook.Builder
- put(String, R, Class<B>) - Method in interface com.github.alexdlaird.http.HttpClient
- 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
- refreshMetrics(Tunnel) - Method in class com.github.alexdlaird.ngrok.NgrokClient
-
Get the latest metrics for the given
Tunnel
and update itsmetrics
attribute. - Region - Enum in com.github.alexdlaird.ngrok.protocol
-
An enum representing
ngrok
's valid regions, as defined inngrok
's docs. - 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.
- retryCount - Variable in class com.github.alexdlaird.http.DefaultHttpClient.Builder
- run() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess.ProcessMonitor
S
- SA - com.github.alexdlaird.ngrok.protocol.Region
- secret - Variable in class com.github.alexdlaird.ngrok.protocol.TunnelVerifyWebhook.Builder
- 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.). - setMetrics(Map<String, Tunnel.Metrics>) - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
-
Set tunnel metrics.
- setProto(String) - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
-
Set tunnel proto.
- setPublicUrl(String) - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel
-
Set the tunnel's public URL.
- 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.util.StringUtils
-
Convert an
InputStream
to a String. - StringUtils - Class in com.github.alexdlaird.util
-
Convenience methods for String manipulation.
- StringUtils() - Constructor for class com.github.alexdlaird.util.StringUtils
T
- TCP - com.github.alexdlaird.ngrok.protocol.Proto
- timeout - Variable in class com.github.alexdlaird.http.DefaultHttpClient.Builder
- TLS - com.github.alexdlaird.ngrok.protocol.Proto
- toString() - Method in enum com.github.alexdlaird.ngrok.protocol.BindTls
- toString() - Method in enum com.github.alexdlaird.ngrok.protocol.Proto
- toString() - Method in enum com.github.alexdlaird.ngrok.protocol.Region
- TRUE - com.github.alexdlaird.ngrok.protocol.BindTls
- 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
- TunnelHeader - Class in com.github.alexdlaird.ngrok.protocol
-
An object that represents header configuration for a
CreateTunnel
. - TunnelHeader.Builder - Class in com.github.alexdlaird.ngrok.protocol
- TunnelIPRestrictions - Class in com.github.alexdlaird.ngrok.protocol
-
An object that represents IP restrictions for a
CreateTunnel
. - TunnelIPRestrictions(TunnelIPRestrictions.Builder) - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelIPRestrictions
- TunnelIPRestrictions.Builder - Class in com.github.alexdlaird.ngrok.protocol
- TunnelOAuth - Class in com.github.alexdlaird.ngrok.protocol
-
An object that represents the OAuth configuration for a
CreateTunnel
. - TunnelOAuth.Builder - Class in com.github.alexdlaird.ngrok.protocol
-
Builder for OAuth configuration that conforms to
ngrok
's tunnel definition. - 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
- TunnelVerifyWebhook - Class in com.github.alexdlaird.ngrok.protocol
-
An object that represents webhook signature verification for a
CreateTunnel
. - TunnelVerifyWebhook(TunnelVerifyWebhook.Builder) - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelVerifyWebhook
- TunnelVerifyWebhook.Builder - Class in com.github.alexdlaird.ngrok.protocol
U
- UNIX_BINARIES - Static variable in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
- 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
- V2 - com.github.alexdlaird.ngrok.installer.NgrokVersion
- V3 - com.github.alexdlaird.ngrok.installer.NgrokVersion
- validateConfig(Path) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
-
Validate that the config file at the given path is valid for
ngrok
andjava-ngrok
. - validateConfig(Map<String, Object>) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
-
Validate that the given map of config items are valid for
ngrok
andjava-ngrok
. - valueOf(String) - Static method in enum com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.alexdlaird.ngrok.installer.NgrokVersion
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.alexdlaird.ngrok.protocol.BindTls
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.alexdlaird.ngrok.protocol.Proto
-
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.NgrokV2CDNUrl
-
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.installer.NgrokV3CDNUrl
-
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.installer.NgrokVersion
-
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.BindTls
-
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.Proto
-
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 andjava-ngrok
's version. - Version(String, String) - Constructor for class com.github.alexdlaird.ngrok.protocol.Version
W
- WINDOWS - Static variable in class com.github.alexdlaird.ngrok.installer.NgrokInstaller
- WINDOWS_i386 - com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
- WINDOWS_i386 - com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
- WINDOWS_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
- WINDOWS_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
- withAdd(List<String>) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelHeader.Builder
-
The list of headers to add.
- 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".
- withAllowCidrs(List<String>) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelIPRestrictions.Builder
-
The list of allowed CIDRs.
- withAllowDomains(List<String>) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelOAuth.Builder
-
The list of allowed OAuth domains.
- withAllowEmails(List<String>) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelOAuth.Builder
-
The list of allowed OAuth emails.
- withApiKey(String) - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
-
A
ngrok
API key. - 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
-
A
ngrok
authtoken to pass to commands (overrides what is in the config). - withBasicAuth(List<String>) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
List of HTTP basic authentication credentials to enforce on tunneled requests.
- withBindTls(boolean) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
- withBindTls(BindTls) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
- withCircuitBreaker(Float) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
The circuit breaker trigger.
- 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.
- withCompression(Boolean) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
Whether compression is enabled on this tunnel.
- withConfigPath(Path) - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
-
The path to the
ngrok
config file, defaults to~/.ngrok2/ngrok.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.
- withDenyCidrs(List<String>) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelIPRestrictions.Builder
-
The list of denied CIDRs.
- 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. - withIpRestrictions(TunnelIPRestrictions) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
The IP restrictions for the tunnel.
- withJavaNgrokConfig(JavaNgrokConfig) - Method in class com.github.alexdlaird.ngrok.NgrokClient.Builder
-
The
java-ngrok
to use when interacting with thengrok
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.
- withMutualTlsCas(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
The path to the TLS certificate authority to verify client certs.
- withName(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
A friendly name for the tunnel, or the name of a ngrok tunnel definition to be used.
- 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. - withNgrokVersion(NgrokVersion) - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder
-
The major version of
ngrok
to be used. - withNgrokVersion(NgrokVersion) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
The major version of
ngrok
for which the tunnel will be created. - withOAuth(TunnelOAuth) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
Set of OAuth settings to enable OAuth authentication on the tunnel endpoint.
- 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(Proto) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
The tunnel protocol, defaults to
Proto.HTTP
. - withProvider(String) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelOAuth.Builder
-
The OAuth provider.
- withProvider(String) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelVerifyWebhook.Builder
-
The signature provider.
- withProxyProto(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
The proxy proto.
- 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.
- withRemove(List<String>) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelHeader.Builder
-
The list of headers to remove.
- withRequestHeader(TunnelHeader) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
The Headers to be added or removed from requests.
- withResponseHeader(TunnelHeader) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
The Headers to be added or removed from responses.
- withRetryCount(int) - Method in class com.github.alexdlaird.http.DefaultHttpClient.Builder
-
Default retry count for GET requests.
- withSchemes(List<String>) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
The schemes to be bound.
- withScopes(List<String>) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelOAuth.Builder
-
The list of OAuth scopes.
- withSecret(String) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelVerifyWebhook.Builder
-
The signature secret.
- 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.
- withTerminateAt(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
The termination point.
- withTimeout(int) - Method in class com.github.alexdlaird.http.DefaultHttpClient.Builder
-
Default timeout for requests.
- withTunnelDefinition(Map<String, Object>) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
Populate any
null
attributes (with the exception ofname
) in this Builder with values from the giventunnelDefinition
. - withVerifyWebhook(TunnelVerifyWebhook) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
The signature for webhooks.
- withWebsocketTcpConverter(Boolean) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder
-
Whether ingress connections are converted to TCP upstream.
All Classes All Packages