Index (java-ngrok 2.3.15 API)

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

AgentStatus - Class in com.github.alexdlaird.ngrok.protocol: An object representing an AgentStatus response from ngrok's API.
AgentStatus() - Constructor for class com.github.alexdlaird.ngrok.protocol.AgentStatus
AgentStatus.Session - Class in com.github.alexdlaird.ngrok.protocol: An object representing a nested Session from ngrok's Agent.
AgentStatus.Session.Leg - Class in com.github.alexdlaird.ngrok.protocol: An object representing a nested Leg from ngrok's Agent Session.
AP - com.github.alexdlaird.ngrok.protocol.Region
api(List<String>) - Method in class com.github.alexdlaird.ngrok.NgrokClient: Run a ngrok command against the api with the given args.
ApiResponse - Class in com.github.alexdlaird.ngrok.protocol: A response from the ngrok API.
AU - com.github.alexdlaird.ngrok.protocol.Region

B

BindTls - Enum in com.github.alexdlaird.ngrok.protocol: An enum representing ngrok's valid bind_tls values, as defined in ngrok's docs.
BOTH - com.github.alexdlaird.ngrok.protocol.BindTls
build() - Method in class com.github.alexdlaird.http.DefaultHttpClient.Builder: Build the DefaultHttpClient.
build() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder: Build the JavaNgrokConfig.
build() - Method in class com.github.alexdlaird.ngrok.NgrokClient.Builder: Build the NgrokClient.
build() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder: Build the CreateTunnel.
build() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelHeader.Builder: Build the TunnelHeader.
build() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelIPRestriction.Builder: Build the TunnelIPRestriction.
build() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelOAuth.Builder: Build the TunnelOAuth.
build() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelPolicy.Builder: Build the TunnelPolicy.
build() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelPolicyActions.Builder: Build the TunnelPolicyActions.
build() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelUserAgentFilter.Builder: Build the TunnelUserAgentFilter.
build() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelVerifyWebhook.Builder: Build the TunnelVerifyWebhook.
Builder() - Constructor for class com.github.alexdlaird.http.DefaultHttpClient.Builder
Builder() - Constructor for class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder: Construct a 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: Construct a TunnelHeader Builder.
Builder() - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelIPRestriction.Builder: Construct a TunnelIPRestriction Builder.
Builder() - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelOAuth.Builder: Construct TunnelOAuth Builder.
Builder() - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelPolicy.Builder: Construct a TunnelPolicy Builder.
Builder() - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelPolicyActions.Builder: Construct a TunnelPolicy Builder.
Builder() - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelUserAgentFilter.Builder: Construct a UserAgentFilter Builder.
Builder() - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelVerifyWebhook.Builder: Construct a 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: Construct a TunnelHeader Builder from tunnel definition of request_header or response_header.
Builder(Map<String, Object>) - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelIPRestriction.Builder: Construct a TunnelIPRestriction Builder from tunnel definition of ip_restriction.
Builder(Map<String, Object>) - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelOAuth.Builder: Construct a TunnelOAuth Builder from tunnel definition of oauth.
Builder(Map<String, Object>) - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelPolicy.Builder: Construct a TunnelPolicy Builder from tunnel definition of policy.
Builder(Map<String, Object>) - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelPolicyActions.Builder: Construct a TunnelPolicyActions Builder from tunnel definition of policy.inbound.actions or policy.outbound.actions.
Builder(Map<String, Object>) - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelUserAgentFilter.Builder: Construct a UserAgentFilter Builder from tunnel definition of user_agent_filters.
Builder(Map<String, Object>) - Constructor for class com.github.alexdlaird.ngrok.protocol.TunnelVerifyWebhook.Builder: Construct a TunnelVerifyWebhook Builder from tunnel definition of verify_webhook.

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: An object representing a nested Request from ngrok's API.
CapturedRequest.Response - Class in com.github.alexdlaird.ngrok.protocol: An object representing a nested Response from ngrok's API.
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
captureRunProcess(Path, List<String>) - Static method in class com.github.alexdlaird.util.ProcessUtils: Start a blocking ngrok process with the binary at the given path and the passed args.
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: This module contains a Java wrapped for ngrok that manages its own binary.
com.github.alexdlaird.ngrok - package com.github.alexdlaird.ngrok: This package contains functionality related to ngrok.
com.github.alexdlaird.ngrok.agent - package com.github.alexdlaird.ngrok.agent: This package contains functionality related to interacting with the running ngrok agent.
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.
ConfigVersion - Enum in com.github.alexdlaird.ngrok.installer: An enum for the list of supported ngrok config versions.
connect() - Method in class com.github.alexdlaird.ngrok.NgrokClient: See NgrokClient.connect(CreateTunnel).
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 would 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_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
DARWIN_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
DARWIN_x86_64_arm - com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
DARWIN_x86_64_arm - 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: See HttpClient.delete(String, List, Map).
delete(String, List<Parameter>, Map<String, String>) - Method in interface com.github.alexdlaird.http.HttpClient: See HttpClient.delete(String, List, Map, Class).
delete(String, List<Parameter>, Map<String, String>, Class) - Method in class com.github.alexdlaird.http.DefaultHttpClient
delete(String, List<Parameter>, Map<String, String>, Class) - Method in interface com.github.alexdlaird.http.HttpClient: Perform DELETE operation against an endpoint.
deleteRequests() - Method in class com.github.alexdlaird.ngrok.agent.NgrokAgent: Delete request history.
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

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_i386_arm - com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
FREEBSD_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
FREEBSD_x86_64 - com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
fromBody(String) - Static method in class com.github.alexdlaird.ngrok.protocol.ApiResponse: Construct an object from a response body.

G

get(String, Class) - Method in interface com.github.alexdlaird.http.HttpClient: See HttpClient.get(String, List, Map, Class).
get(String, List<Parameter>, Map<String, String>, Class) - Method in class com.github.alexdlaird.http.DefaultHttpClient
get(String, List<Parameter>, Map<String, String>, Class) - Method in interface com.github.alexdlaird.http.HttpClient: Perform GET operation against an endpoint.
get(String, List<Parameter>, Map<String, String>, Path) - Method in interface com.github.alexdlaird.http.HttpClient: See HttpClient.get(String, List, Map, Path, int).
get(String, List<Parameter>, Map<String, String>, Path, int) - Method in class com.github.alexdlaird.http.DefaultHttpClient
get(String, List<Parameter>, Map<String, String>, Path, int) - Method in interface com.github.alexdlaird.http.HttpClient: Perform GET operation that downloads a file to the given path.
getActions() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelPolicy: Get the policy actions.
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: Get The addr, which will be a URL if obj is "web".
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.
getAgentStatus() - Method in class com.github.alexdlaird.ngrok.agent.NgrokAgent: Get the ngrok agent status.
getAgentVersion() - Method in class com.github.alexdlaird.ngrok.protocol.AgentStatus: Get the version of the Agent.
getAllow() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelUserAgentFilter: Get the list of allowed UserAgent filters.
getAllowCidrs() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelIPRestriction: 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's bind_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.
getConfig() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel: Get the tunnel config.
getConfig() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelPolicyActions: Get the action config.
getConfigPath() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig: Get the path to the ngrok config file.
getConfigVersion() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig: The ngrok config version.
getCount() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics: Get the count metric.
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.
getData() - Method in class com.github.alexdlaird.ngrok.protocol.ApiResponse: The parsed API response.
getDefaultConfig(NgrokVersion, ConfigVersion) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller: Get the default config params for the given major version of ngrok.
getDeny() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelUserAgentFilter: Get the list of denied UserAgent filters.
getDenyCidrs() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelIPRestriction: Get the list of denied CIDRs.
getDomain() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel: Get the tunnel domain.
getDuration() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest: Get the duration of the request.
getErr() - Method in class com.github.alexdlaird.ngrok.process.NgrokLog: Get the log's error, if applicable.
getExpressions() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelPolicy: Get the policy expressions.
getGauge() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics: Get the gauge metric.
getHeaderFields() - Method in class com.github.alexdlaird.http.Response: Get the response headers.
getHeaders() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Request: Get the map of request headers.
getHeaders() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Response: Get the map of response headers.
getHostHeader() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel: Get the HTTP Host header.
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: Get the ID of the captured request.
getId() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel: Get the ID of the tunnel.
getInputStream(HttpURLConnection, String, String, Map<String, String>) - Method in class com.github.alexdlaird.http.DefaultHttpClient: Initialize the connection with the given parameters, then return the provisioned input stream.
getInstance() - Static method in class com.github.alexdlaird.ngrok.conf.JavaNgrokVersion: Get or initialize the singleton instance.
getIpRestriction() - 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 the ngrok 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.
getLatency() - Method in class com.github.alexdlaird.ngrok.protocol.AgentStatus.Session.Leg: Get the latency of the leg.
getLegs() - Method in class com.github.alexdlaird.ngrok.protocol.AgentStatus.Session: Get the list of AgentStatus.Session.Legs.
getLine() - Method in class com.github.alexdlaird.ngrok.process.NgrokLog: Get the raw, unparsed log line.
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: Get the ngrok logs.
getLogs() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess.ProcessMonitor: Deprecated.
Use NgrokProcess.getLogs() instead.
getLvl() - Method in class com.github.alexdlaird.ngrok.process.NgrokLog: Get the log's level.
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: Get the method of the 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: Get the log's msg.
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.
getName() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelPolicy: Get the policy name.
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: See NgrokInstaller.getNgrokCDNUrl(NgrokVersion).
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: See NgrokInstaller.getNgrokConfig(Path, boolean, NgrokVersion, ConfigVersion).
getNgrokConfig(Path, boolean) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller: See NgrokInstaller.getNgrokConfig(Path, boolean, NgrokVersion, ConfigVersion).
getNgrokConfig(Path, boolean, NgrokVersion, ConfigVersion) - 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.
getObj() - Method in class com.github.alexdlaird.ngrok.process.NgrokLog: Get the log's type.
getP50() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics: Get the p50 metric.
getP90() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics: Get the p90 metric.
getP95() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics: Get the p95 metric.
getP99() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics: Get the p99 metric.
getPolicyInbound() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel: Get the inbound policy.
getPolicyOutbound() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel: Get the outbound policy.
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: Get the proto of the request.
getProto() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Response: Get the proto of the 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: Get the rate1 metric.
getRate15() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics: Get the rate15 metric.
getRate5() - Method in class com.github.alexdlaird.ngrok.protocol.Tunnel.Metrics: Get the rate5 metric.
getRaw() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Request: Get the raw request.
getRaw() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Response: Get the raw response.
getRegion() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig: Get the region in which ngrok will start.
getRegion() - Method in class com.github.alexdlaird.ngrok.protocol.AgentStatus.Session.Leg: Get the region of the leg.
getRemoteAddr() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest: Get the remote addr of the captured request.
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: Get the captured CapturedRequest.Request.
getRequest(String) - Method in class com.github.alexdlaird.ngrok.agent.NgrokAgent: Get the given request.
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.agent.NgrokAgent: See NgrokAgent.getRequests(String).
getRequests() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequests: Get the list of CapturedRequests.
getRequests(String) - Method in class com.github.alexdlaird.ngrok.agent.NgrokAgent: Get the list of requests made to either all tunnels, or the given tunnel name.
getResponse() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest: Get the captured CapturedRequest.Response.
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.
getSession() - Method in class com.github.alexdlaird.ngrok.protocol.AgentStatus: Get the AgentStatus.Session details.
getStart() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest: Get the start of the captured request.
getStartupTimeout() - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig: Get the max timeout, in seconds, to wait for ngrok to start.
getStatus() - Method in class com.github.alexdlaird.ngrok.protocol.AgentStatus: Get the description of the response.
getStatus() - Method in class com.github.alexdlaird.ngrok.protocol.ApiResponse: The description of the response.
getStatus() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Response: Get the description of the 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: Get the status code of the 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 of the OS from system properties and return a friendly name.
getT() - Method in class com.github.alexdlaird.ngrok.process.NgrokLog: Get the log's ISO 8601 timestamp.
getTerminateAt() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel: Get the termination point.
getTunnelName() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest: Get the tunnel name of the captured request.
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: Get the list tunnels.
getType() - Method in class com.github.alexdlaird.ngrok.protocol.TunnelPolicyActions: Get the action type.
getUri() - Method in class com.github.alexdlaird.ngrok.protocol.AgentStatus: Get the Agent URI.
getUri() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest: Get the URI of the captured request.
getUri() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequest.Request: Get the URI of the request.
getUri() - Method in class com.github.alexdlaird.ngrok.protocol.CapturedRequests: Get the URI of the captured requests.
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: Get the URI.
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: Get the download URL.
getUrl() - Method in enum com.github.alexdlaird.ngrok.installer.NgrokV2CDNUrl
getUrl() - Method in enum com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
getUserAgentFilter() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel: Get the UserAgent filters.
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.conf.JavaNgrokVersion: Get the version.
getVersion() - Method in enum com.github.alexdlaird.ngrok.installer.ConfigVersion
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.
gson - Static variable in class com.github.alexdlaird.ngrok.protocol.ApiResponse

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: See NgrokInstaller.installDefaultConfig(Path, Map, NgrokVersion, ConfigVersion).
installDefaultConfig(Path, Map<String, Object>, NgrokVersion) - Method in class com.github.alexdlaird.ngrok.installer.NgrokInstaller: See NgrokInstaller.installDefaultConfig(Path, Map, NgrokVersion, ConfigVersion).
installDefaultConfig(Path, Map<String, Object>, NgrokVersion, ConfigVersion) - 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: See NgrokInstaller.installNgrok(Path, NgrokVersion).
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: 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: 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.
isPoolingEnabled() - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel: Whether pooling is enabled on this tunnel.
isRunning() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess: Whether 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 the ngrok 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 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.
JavaNgrokVersion - Class in com.github.alexdlaird.ngrok.conf: A singleton object that represents the java-ngrok library version.
JP - com.github.alexdlaird.ngrok.protocol.Region

K

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

L

Leg() - Constructor for class com.github.alexdlaird.ngrok.protocol.AgentStatus.Session.Leg
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 before URLConnection.connect() is called on the instance of the passed in connection.

N

NgrokAgent - Class in com.github.alexdlaird.ngrok.agent: A client for interaction with the ngrok agent.
NgrokAgent(NgrokProcess) - Constructor for class com.github.alexdlaird.ngrok.agent.NgrokAgent: See NgrokAgent(NgrokProcess, HttpClient).
NgrokAgent(NgrokProcess, HttpClient) - Constructor for class com.github.alexdlaird.ngrok.agent.NgrokAgent: Construct to interact with the ngrok agent.
NgrokCDNUrl - Interface in com.github.alexdlaird.ngrok.installer: An interface for getting 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, 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 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 ngrok for the current system.
NgrokInstaller() - Constructor for class com.github.alexdlaird.ngrok.installer.NgrokInstaller: Construct with the DefaultHttpClient.
NgrokInstaller(HttpClient) - Constructor for class com.github.alexdlaird.ngrok.installer.NgrokInstaller: Construct with a custom HttpClient.
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: See NgrokProcess(JavaNgrokConfig, NgrokInstaller, HttpClient).
NgrokProcess(JavaNgrokConfig, NgrokInstaller, HttpClient) - Constructor for class com.github.alexdlaird.ngrok.process.NgrokProcess: If ngrok is not already installed at JavaNgrokConfig.getNgrokPath(), the given NgrokInstaller will install it.
NgrokProcess.ProcessMonitor - Class in com.github.alexdlaird.ngrok.process: A Runnable that monitors the 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 V3 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) - Method in interface com.github.alexdlaird.http.HttpClient: See HttpClient.post(String, Object, List, Map, Class).
post(String, R, List<Parameter>, Map<String, String>, Class) - Method in class com.github.alexdlaird.http.DefaultHttpClient
post(String, R, List<Parameter>, Map<String, String>, Class) - Method in interface com.github.alexdlaird.http.HttpClient: Perform POST operation against an endpoint.
ProcessMonitor(NgrokProcess, JavaNgrokConfig) - Constructor for class com.github.alexdlaird.ngrok.process.NgrokProcess.ProcessMonitor: Construct to monitor a {link @Process} monitor.
ProcessUtils - Class in com.github.alexdlaird.util: Convenience methods for executing processes and capturing their output.
ProcessUtils() - Constructor for class com.github.alexdlaird.util.ProcessUtils
Proto - Enum in com.github.alexdlaird.ngrok.protocol: An enum representing ngrok's valid protos, as defined in ngrok's docs.
put(String, R, Class) - Method in interface com.github.alexdlaird.http.HttpClient: See HttpClient.put(String, Object, List, Map, Class).
put(String, R, List<Parameter>, Map<String, String>, Class) - Method in class com.github.alexdlaird.http.DefaultHttpClient
put(String, R, List<Parameter>, Map<String, String>, Class) - 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 its metrics attribute.
Region - Enum in com.github.alexdlaird.ngrok.protocol: An enum representing ngrok's valid regions, as defined in ngrok's docs.
replayRequest(String) - Method in class com.github.alexdlaird.ngrok.agent.NgrokAgent: See NgrokAgent.replayRequest(String, String).
replayRequest(String, String) - Method in class com.github.alexdlaird.ngrok.agent.NgrokAgent: Replay a given request through its original tunnel, or through a different given tunnel.
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.
run() - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess.ProcessMonitor

S

SA - com.github.alexdlaird.ngrok.protocol.Region
Session() - Constructor for class com.github.alexdlaird.ngrok.protocol.AgentStatus.Session
setApiKey(String) - Method in class com.github.alexdlaird.ngrok.NgrokClient: Set the ngrok API key in the config file to enable access to more features (for instance, Internal Endpoints).
setApiKey(String) - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess: See NgrokClient.setApiKey(String).
setAuthToken(String) - Method in class com.github.alexdlaird.ngrok.NgrokClient: Set the ngrok auth token in the config file to streamline access to more features (for instance, multiple concurrent tunnels, custom domains, etc.).
setAuthToken(String) - Method in class com.github.alexdlaird.ngrok.process.NgrokProcess: See NgrokClient.setAuthToken(String).
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.ProcessMonitor: Set the monitor thread to stop monitoring the ngrok process after the next log event.
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
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: An object representing a nested Metrics from ngrok's API.
Tunnel.TunnelConfig - Class in com.github.alexdlaird.ngrok.protocol: An object representing a nested TunnelConfig from ngrok's API.
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: Builder for a TunnelHeader.
TunnelIPRestriction - Class in com.github.alexdlaird.ngrok.protocol: An object that represents IP restriction for a CreateTunnel.
TunnelIPRestriction.Builder - Class in com.github.alexdlaird.ngrok.protocol: Builder for a TunnelIPRestriction.
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.
TunnelPolicy - Class in com.github.alexdlaird.ngrok.protocol: An object that represents policy configuration for a CreateTunnel.
TunnelPolicy.Builder - Class in com.github.alexdlaird.ngrok.protocol: Builder for a TunnelPolicy.
TunnelPolicyActions - Class in com.github.alexdlaird.ngrok.protocol: An object that represents policy actions configuration for a CreateTunnel.
TunnelPolicyActions.Builder - Class in com.github.alexdlaird.ngrok.protocol: Builder for a TunnelPolicyActions.
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
TunnelUserAgentFilter - Class in com.github.alexdlaird.ngrok.protocol: An object that represents UserAgent filter for a CreateTunnel.
TunnelUserAgentFilter.Builder - Class in com.github.alexdlaird.ngrok.protocol: Builder for a TunnelUserAgentFilter.
TunnelVerifyWebhook - Class in com.github.alexdlaird.ngrok.protocol: An object that represents webhook signature verification for a CreateTunnel.
TunnelVerifyWebhook.Builder - Class in com.github.alexdlaird.ngrok.protocol: Builder for a TunnelVerifyWebhook.

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.
urlWithParameters(String, List<Parameter>) - Method in class com.github.alexdlaird.http.DefaultHttpClient: Rebuild the URL with parameters appended.
US - com.github.alexdlaird.ngrok.protocol.Region
US_CAL_1 - com.github.alexdlaird.ngrok.protocol.Region

V

V2 - com.github.alexdlaird.ngrok.installer.ConfigVersion
V2 - com.github.alexdlaird.ngrok.installer.NgrokVersion
V3 - com.github.alexdlaird.ngrok.installer.ConfigVersion
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 and java-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 and java-ngrok.
valueOf(String) - Static method in enum com.github.alexdlaird.ngrok.installer.ConfigVersion: Returns the enum constant of this type with the specified name.
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.ConfigVersion: 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.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 and java-ngrok's version.
Version(String, String) - Constructor for class com.github.alexdlaird.ngrok.protocol.Version: Construct a 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
WINDOWS_x86_64_arm - com.github.alexdlaird.ngrok.installer.NgrokV3CDNUrl
withActions(TunnelPolicyActions) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelPolicy.Builder: The policy actions.
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: See CreateTunnel.Builder.withAddr(String).
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".
withAllow(List<String>) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelUserAgentFilter.Builder: The list of allowed UserAgent filters.
withAllowCidrs(List<String>) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelIPRestriction.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: See CreateTunnel.Builder.withBindTls(BindTls).
withBindTls(BindTls) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder: Bind an HTTPS (BindTls.TRUE or HTTP (BindTls.FALSE) endpoint, defaults to BindTls.BOTH.
withCircuitBreaker(Float) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder: The circuit breaker trigger.
withCompression(Boolean) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder: Whether compression is enabled on this tunnel.
withConfig(String) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelPolicyActions.Builder: The action config.
withConfigPath(Path) - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder: The path to the ngrok config file, defaults to ngrok's default config location.
withConfigVersion(ConfigVersion) - Method in class com.github.alexdlaird.ngrok.conf.JavaNgrokConfig.Builder: The ngrok config version.
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.
withDeny(List<String>) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelUserAgentFilter.Builder: The list of denied UserAgent filters.
withDenyCidrs(List<String>) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelIPRestriction.Builder: The list of denied CIDRs.
withDomain(String) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder: The tunnel domain.
withEncoding(String) - Method in class com.github.alexdlaird.http.DefaultHttpClient.Builder: Default encoding for requests.
withExpressions(List<String>) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelPolicy.Builder: The list of policy expressions.
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.
withHttpClient(HttpClient) - Method in class com.github.alexdlaird.ngrok.NgrokClient.Builder: The class used to make HTTP requests to ngrok's APIs.
withIpRestriction(TunnelIPRestriction) - 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 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.
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 defined in ngrok's config file.
withName(String) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelPolicy.Builder: The policy name.
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 being placed in the same directory as ngrok's configs.
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.
withPolicyInbound(TunnelPolicy) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder: The inbound policy for the tunnel.
withPolicyOutbound(TunnelPolicy) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder: The outbound policy for the tunnel.
withPoolingEnabled(Boolean) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder: Whether pooling is enabled on this tunnel.
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 timeout, in seconds, to wait for ngrok to start.
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, in ms, for requests.
withTunnelDefinition(Map<String, Object>) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder: Populate any null attributes (except for name) in this Builder with values from the given tunnelDefinition.
withType(String) - Method in class com.github.alexdlaird.ngrok.protocol.TunnelPolicyActions.Builder: The action type.
withUserAgentFilter(TunnelUserAgentFilter) - Method in class com.github.alexdlaird.ngrok.protocol.CreateTunnel.Builder: The UserAgent filter for the tunnel.
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.

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