Package org.openremote.manager.gateway

Interface GatewayTunnelFactory

All Known Implementing Classes:
JSchGatewayTunnelFactory
public interface GatewayTunnelFactory
This interface is an abstraction for starting/stopping gateway tunnels and is used by edge gateway instances.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    startTunnel(org.openremote.model.gateway.GatewayTunnelStartRequestEvent startRequestEvent)
    Start a tunnel for the requested GatewayTunnelInfo
    void
    stopAll()
    Terminate all known tunnel sessions; should perform try/catch to prevent any exceptions bubbling and to ensure termination of each session is attempted.
    void
    stopTunnel(org.openremote.model.gateway.GatewayTunnelInfo tunnelInfo)
     

  • Method Details

    • startTunnel

      void startTunnel(org.openremote.model.gateway.GatewayTunnelStartRequestEvent startRequestEvent) throws Exception
      Start a tunnel for the requested GatewayTunnelInfo
      Throws:
      jakarta.ws.rs.BadRequestException - If GatewayTunnelInfo is invalid
      jakarta.ws.rs.ServerErrorException - If the GatewayTunnelInfo is valid but the tunnel could not be created
      Exception

    • stopTunnel

      void stopTunnel(org.openremote.model.gateway.GatewayTunnelInfo tunnelInfo) throws Exception
      Throws:
      Exception

    • stopAll

      void stopAll()
      Terminate all known tunnel sessions; should perform try/catch to prevent any exceptions bubbling and to ensure termination of each session is attempted.