Package com.ngrok

Interface Session

All Superinterfaces:

AutoCloseable

public interface Session
extends AutoCloseable

A session with the ngrok service.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Session.Builder	A builder for creating a session
static class	Session.ClientInfo	Represents additional information about the client.
static interface	Session.CommandHandler	Provides a way to listen for specific server side events.
static interface	Session.HeartbeatHandler	Provides a way to monitor current session's heartbeats and disconnects.

Method Summary

Modifier and Type	Method	Description
void	close()
void	closeForwarder(String forwarderId)	Closes a forwarder by its ID
void	closeListener(String listenerId)	Closes a listener by its ID
static Session	connect(Session.Builder builder)	Connects a session with specified Session.Builder
default EdgeBuilder	edge()	Creates a new EdgeBuilder associated with this session.
Forwarder.Edge	forwardEdge(EdgeBuilder builder, URL url)	Configures and starts a Forwarder.Edge
Forwarder.Endpoint	forwardHttp(HttpBuilder builder, URL url)	Configures and starts a HTTP Forwarder.Endpoint
Forwarder.Endpoint	forwardTcp(TcpBuilder builder, URL url)	Configures and starts a TCP Forwarder.Endpoint
Forwarder.Endpoint	forwardTls(TlsBuilder builder, URL url)	Configures and starts a TLS Forwarder.Endpoint
String	getId()	Returns the ID of this session
String	getMetadata()	Returns the metadata of this session
default HttpBuilder	httpEndpoint()	Creates a new HttpBuilder associated with this session.
Listener.Edge	listenEdge(EdgeBuilder builder)	Configures and starts a Listener.Edge
Listener.Endpoint	listenHttp(HttpBuilder builder)	Configures and starts a HTTP Listener.Endpoint
Listener.Endpoint	listenTcp(TcpBuilder builder)	Configures and starts a TCP Listener.Endpoint
Listener.Endpoint	listenTls(TlsBuilder builder)	Configures and starts a TLS Listener.Endpoint
default TcpBuilder	tcpEndpoint()	Creates a new TcpBuilder associated with this session.
default TlsBuilder	tlsEndpoint()	Creates a new TlsBuilder associated with this session.
static Session.Builder	withAuthtoken(String authtoken)	Creates a new session Session.Builder with specified ngrok authtoken
static Session.Builder	withAuthtokenFromEnv()	Creates a new session Session.Builder resolving the ngrok authtoken from NGROK_AUTHTOKEN env variable

Method Detail

withAuthtoken

static Session.Builder withAuthtoken(String authtoken)

Creates a new session Session.Builder with specified ngrok authtoken

Parameters:

authtoken - the authtoken

Returns:

the builder

withAuthtokenFromEnv

static Session.Builder withAuthtokenFromEnv()

Creates a new session Session.Builder resolving the ngrok authtoken from NGROK_AUTHTOKEN env variable

Returns:

the builder

connect

static Session connect(Session.Builder builder)
                throws IOException

Connects a session with specified Session.Builder

Parameters:

builder - the builder

Returns:

newly created session

Throws:

IOException - if an I/O error occurs

getId

String getId()

Returns the ID of this session

Returns:

session ID

getMetadata

String getMetadata()

Returns the metadata of this session

Returns:

session metadata

tcpEndpoint

default TcpBuilder tcpEndpoint()

Creates a new TcpBuilder associated with this session.

Returns:

the builder

listenTcp

Listener.Endpoint listenTcp(TcpBuilder builder)
                     throws IOException

Configures and starts a TCP Listener.Endpoint

Parameters:

builder - the builder

Returns:

the running listener

Throws:

IOException - if an I/O error occurs

forwardTcp

Forwarder.Endpoint forwardTcp(TcpBuilder builder,
                              URL url)
                       throws IOException

Configures and starts a TCP Forwarder.Endpoint

Parameters:

builder - the builder

url - the url to forward to

Returns:

the running forwarder

Throws:

IOException - if an I/O error occurs

tlsEndpoint

default TlsBuilder tlsEndpoint()

Creates a new TlsBuilder associated with this session.

Returns:

the builder

listenTls

Listener.Endpoint listenTls(TlsBuilder builder)
                     throws IOException

Configures and starts a TLS Listener.Endpoint

Parameters:

builder - the builder

Returns:

the running listener

Throws:

IOException - if an I/O error occurs

forwardTls

Forwarder.Endpoint forwardTls(TlsBuilder builder,
                              URL url)
                       throws IOException

Configures and starts a TLS Forwarder.Endpoint

Parameters:

builder - the builder

url - the url to forward to

Returns:

the running forwarder

Throws:

IOException - if an I/O error occurs

httpEndpoint

default HttpBuilder httpEndpoint()

Creates a new HttpBuilder associated with this session.

Returns:

the builder

listenHttp

Listener.Endpoint listenHttp(HttpBuilder builder)
                      throws IOException

Configures and starts a HTTP Listener.Endpoint

Parameters:

builder - the builder

Returns:

the running listener

Throws:

IOException - if an I/O error occurs

forwardHttp

Forwarder.Endpoint forwardHttp(HttpBuilder builder,
                               URL url)
                        throws IOException

Configures and starts a HTTP Forwarder.Endpoint

Parameters:

builder - the builder

url - the url to forward to

Returns:

the running forwarder

Throws:

IOException - if an I/O error occurs

edge

default EdgeBuilder edge()

Creates a new EdgeBuilder associated with this session.

Returns:

the builder

listenEdge

Listener.Edge listenEdge(EdgeBuilder builder)
                  throws IOException

Configures and starts a Listener.Edge

Parameters:

builder - the builder

Returns:

the running listener

Throws:

IOException - if an I/O error occurs

forwardEdge

Forwarder.Edge forwardEdge(EdgeBuilder builder,
                           URL url)
                    throws IOException

Configures and starts a Forwarder.Edge

Parameters:

builder - the builder

url - the url to forward to

Returns:

the running forwarder

Throws:

IOException - if an I/O error occurs

closeListener

void closeListener(String listenerId)
            throws IOException

Closes a listener by its ID

Parameters:

listenerId - the listener ID

Throws:

IOException - if an I/O error occurs

closeForwarder

void closeForwarder(String forwarderId)
             throws IOException

Closes a forwarder by its ID

Parameters:

forwarderId - the forwarder ID

Throws:

IOException - if an I/O error occurs

close

void close()
    throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException