com.github.alexdlaird.ngrok.agent

Class NgrokAgent

java.lang.Object

com.github.alexdlaird.ngrok.agent.NgrokAgent

public class NgrokAgent
extends java.lang.Object

A client for interaction with the ngrok agent.

Constructor Summary

Constructors

Constructor and Description
NgrokAgent(NgrokProcess ngrokProcess) See NgrokAgent(NgrokProcess, HttpClient).
NgrokAgent(NgrokProcess ngrokProcess, HttpClient httpClient) Construct to interact with the ngrok agent.

Method Summary

Modifier and Type	Method and Description
void	deleteRequests() Delete request history.
Response<AgentStatus>	getAgentStatus() Get the ngrok agent status.
Response<CapturedRequest>	getRequest(java.lang.String requestId) Get the given request.
Response<CapturedRequests>	getRequests() See getRequests(String).
Response<CapturedRequests>	getRequests(java.lang.String tunnelName) Get the list of requests made to either all tunnels, or the given tunnel name.
void	replayRequest(java.lang.String requestId) See replayRequest(String, String).
void	replayRequest(java.lang.String requestId, java.lang.String tunnelName) Replay a given request through its original tunnel, or through a different given tunnel.

Methods inherited from class java.lang.Object

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

Constructor Detail

NgrokAgent

public NgrokAgent(NgrokProcess ngrokProcess)

See NgrokAgent(NgrokProcess, HttpClient).

Parameters:

ngrokProcess - The ngrok process.

NgrokAgent

public NgrokAgent(NgrokProcess ngrokProcess,
                  HttpClient httpClient)

Construct to interact with the ngrok agent.

Parameters:

ngrokProcess - The ngrok process.

httpClient - The HTTP client.

Method Detail

getAgentStatus

public Response<AgentStatus> getAgentStatus()

Get the ngrok agent status.

Returns:

The agent status.

getRequests

public Response<CapturedRequests> getRequests()

See getRequests(String).

getRequests

public Response<CapturedRequests> getRequests(java.lang.String tunnelName)

Get the list of requests made to either all tunnels, or the given tunnel name.

Parameters:

tunnelName - The optional tunnel name to filter by.

getRequest

public Response<CapturedRequest> getRequest(java.lang.String requestId)

Get the given request.

Parameters:

requestId - The ID of the request to fetch.

replayRequest

public void replayRequest(java.lang.String requestId)

See replayRequest(String, String).

replayRequest

public void replayRequest(java.lang.String requestId,
                          java.lang.String tunnelName)

Replay a given request through its original tunnel, or through a different given tunnel.

Parameters:

requestId - The request ID.

tunnelName - The optional name of tunnel to replay the request through.

deleteRequests

public void deleteRequests()

Delete request history.