com.ngrok.EdgeBuilder Maven / Gradle / Ivy

Go to download
package com.ngrok;

import java.io.IOException;
import java.net.URL;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;

/**
 * A builder for creating an edge listener
 */
public class EdgeBuilder extends MetadataBuilder
        implements Listener.Builder, Forwarder.Builder {
    private final Session session;

    private final Map labels = new HashMap<>();

    /**
     * Creates a new {@link EdgeBuilder} with a given session.
     *
     * @param session the session over which this listener will connect.
     *                If {@code null}, {@link #listen()} and {@link #forward(URL)}
     *                will throw {@link NullPointerException}, use the corresponding
     *                methods on the {@link Session} object directly.
     */
    public EdgeBuilder(Session session) {
        this.session = session;
    }

    /**
     * Adds a label with the specified key and value to this builder.
     *
     * @param key the key of the label
     * @param value the value of the label
     * @return the builder instance
     */
    public EdgeBuilder label(String key, String value) {
        labels.put(Objects.requireNonNull(key), Objects.requireNonNull(value));
        return this;
    }

    /**
     * Returns the label map for this builder.
     *
     * @return a label map, string keys and values
     */
    public Map getLabels() {
        return Collections.unmodifiableMap(labels);
    }

    @Override
    public Listener.Edge listen() throws IOException {
        return session.listenEdge(this);
    }

    @Override
    public Forwarder.Edge forward(URL url) throws IOException {
        return session.forwardEdge(this, url);
    }
}