Package org.somda.sdc.glue.consumer

Interface SdcRemoteDevicesConnector

All Superinterfaces:
com.google.common.util.concurrent.Service
All Known Implementing Classes:
SdcRemoteDevicesConnectorImpl
public interface SdcRemoteDevicesConnector extends com.google.common.util.concurrent.Service
Central starting point to gain access to remote SDC devices.

  • Method Details

    • connect

      com.google.common.util.concurrent.ListenableFuture<SdcRemoteDevice> connect(HostingServiceProxy hostingServiceProxy, ConnectConfiguration connectConfiguration) throws PrerequisitesException
      Tries to establish an SDC client connection to the given hosting service proxy (i.e., remote SDC device).

      The client connection will pass only if the host is reachable and provides the mandatory BICEPS Get service. After this function is triggered, the following process is conducted:

      1. If there is at least one action in the set of available actions, then the connector subscribes to those actions.
      2. The connector starts a watchdog and either uses WS-Eventing Renew requests in case of an existing subscription or DirectedProbe requests in case of no existing subscriptions in order to keep track of the connection to the remote node.
      3. The connector collects and buffers all incoming reports.
      4. The MDIB is requested from the remote node.
      5. Reports are applied on the MDIB.
      6. An SdcRemoteDevice is supplied.

      Connections can be triggered only once per device per time. As reports are applied on the received MDIB there are no gaps as long as every subscription has been subscribed during connection.

      Parameters:
      hostingServiceProxy - the hosted service to connect to
      connectConfiguration - options for the connection process.
      Returns:
      a future that contains the SdcRemoteDevice if connection succeeds. It will immediately return if there is an existing connection already.
      Throws:
      PrerequisitesException - if verification of premises for connection establishment fails.

    • connect

      com.google.common.util.concurrent.ListenableFuture<SdcRemoteDevice> connect(HostingServiceProxy hostingServiceProxy, ConnectConfiguration connectConfiguration, MdibAccessObserver mdibAccessObserver) throws PrerequisitesException
      Tries to establish an SDC client connection to the given hosting service proxy (i.e., remote SDC device).

      The client connection will pass only if the host is reachable and provides the mandatory BICEPS Get service. After this function is triggered, the following process is conducted:

      1. If there is at least one action in the set of available actions, then the connector subscribes to those actions.
      2. The connector starts a watchdog and either uses WS-Eventing Renew requests in case of an existing subscription or DirectedProbe requests in case of no existing subscriptions in order to keep track of the connection to the remote node.
      3. The connector collects and buffers all incoming reports.
      4. The MDIB is requested from the remote node.
      5. Reports are applied on the MDIB.
      6. An SdcRemoteDevice is supplied.

      Connections can be triggered only once per device per time. As reports are applied on the received MDIB there are no gaps as long as every subscription has been subscribed during connection.

      Parameters:
      hostingServiceProxy - the hosted service to connect to
      connectConfiguration - options for the connection process.
      mdibAccessObserver - observer that is registered before the initial MDIB is fetched from the device
      Returns:
      a future that contains the SdcRemoteDevice if connection succeeds. It will immediately return if there is an existing connection already.
      Throws:
      PrerequisitesException - if verification of premises for connection establishment fails.

    • disconnect

      com.google.common.util.concurrent.ListenableFuture<?> disconnect(String eprAddress)
      Disconnects a device.

      This function is non-blocking. Right after it returns the disconnected device can be re-connected (while the former device is still disconnecting).

      Parameters:
      eprAddress - the endpoint reference address of the remote device to disconnect.
      Returns:
      a listenable future that finishes once the remote device is disconnected (i.e., subscriptions are unsubscribed). If there is no device to disconnect, an immediate cancelled future is returned.

    • getConnectedDevices

      Collection<SdcRemoteDevice> getConnectedDevices()
      Gets a copy of all connected devices at a certain point in time.
      Returns:
      a collection of all connected devices. Please note that this creates a copy on every call.

    • getConnectedDevice

      Optional<SdcRemoteDevice> getConnectedDevice(String eprAddress)
      Gets a connected device.
      Parameters:
      eprAddress - the endpoint reference address of the remote device to get.
      Returns:
      an SdcRemoteDevice instance if connected, otherwise Optional.empty().

    • registerObserver

      void registerObserver(SdcRemoteDevicesObserver observer)

    • unregisterObserver

      void unregisterObserver(SdcRemoteDevicesObserver observer)