Package com.ngrok

Class EdgeBuilder

java.lang.Object

com.ngrok.MetadataBuilder<EdgeBuilder>

com.ngrok.EdgeBuilder

All Implemented Interfaces:

Forwarder.Builder<Forwarder.Edge>, Listener.Builder<Listener.Edge>

public class EdgeBuilder
extends MetadataBuilder<EdgeBuilder>
implements Listener.Builder<Listener.Edge>, Forwarder.Builder<Forwarder.Edge>

A builder for creating an edge listener

Constructor Summary

Constructors

Constructor	Description
EdgeBuilder(Session session)	Creates a new EdgeBuilder with a given session.

Method Summary

Modifier and Type	Method	Description
Forwarder.Edge	forward(URL url)	Start listening and forwarding connections to given url.
Map<String,String>	getLabels()	Returns the label map for this builder.
EdgeBuilder	label(String key, String value)	Adds a label with the specified key and value to this builder.
Listener.Edge	listen()	Starts listening and accepting new connections.

Methods inherited from class com.ngrok.MetadataBuilder

forwardsTo, getForwardsTo, getMetadata, metadata

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgeBuilder

public EdgeBuilder(Session session)

Creates a new EdgeBuilder with a given session.

Parameters:

session - the session over which this listener will connect. If null, listen() and forward(URL) will throw NullPointerException, use the corresponding methods on the Session object directly.

Method Detail

label

public EdgeBuilder label(String key,
                         String value)

Adds a label with the specified key and value to this builder.

Parameters:

key - the key of the label

value - the value of the label

Returns:

the builder instance

getLabels

public Map<String,String> getLabels()

Returns the label map for this builder.

Returns:

a label map, string keys and values

listen

public Listener.Edge listen()
                     throws IOException

Description copied from interface: Listener.Builder

Starts listening and accepting new connections.

Specified by:

listen in interface Listener.Builder<Listener.Edge>

Returns:

the concrete Listener instance

Throws:

IOException - if an I/O error occurs

forward

public Forwarder.Edge forward(URL url)
                       throws IOException

Description copied from interface: Forwarder.Builder

Start listening and forwarding connections to given url.

Specified by:

forward in interface Forwarder.Builder<Forwarder.Edge>

Parameters:

url - to forward connections to

Returns:

the concrete Forwarder instance

Throws:

IOException - if an I/O error occurs