org.openremote.manager.gateway.GatewayTunnelFactory Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024, OpenRemote Inc.
 *
 * See the CONTRIBUTORS.txt file in the distribution for a
 * full listing of individual contributors.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see .
 */

package org.openremote.manager.gateway;

import org.openremote.model.gateway.GatewayTunnelInfo;
import org.openremote.model.gateway.GatewayTunnelStartRequestEvent;

/**
 * This interface is an abstraction for starting/stopping gateway tunnels and is used by edge gateway instances.
 */
public interface GatewayTunnelFactory {

    /**
     * Start a tunnel for the requested {@link GatewayTunnelInfo}
     *
     * @return Tunnel instance counter (should be tracked by implementations as this will be used to stop the tunnel)
     * @throws jakarta.ws.rs.BadRequestException If {@link GatewayTunnelInfo} is invalid
     * @throws jakarta.ws.rs.ServerErrorException If the {@link GatewayTunnelInfo} is valid but the tunnel could not be created
     */
    void startTunnel(GatewayTunnelStartRequestEvent startRequestEvent) throws Exception;

    void stopTunnel(GatewayTunnelInfo tunnelInfo) throws Exception;
}