Package org.eclipse.keyple.core.distributed.remote.spi

Interface AbstractRemotePluginSpi

All Known Subinterfaces:
ObservableRemotePluginSpi, RemotePluginSpi, RemotePoolPluginSpi
public interface AbstractRemotePluginSpi
Abstract API extended by all types of distributed remote plugin extensions able to communicate with a distributed local service extension.
Since:
2.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    exchangeApiLevel(int coreApiLevel)
    Exchanges the JSON API levels between the Keyple Core and Distributed layers.
    String
    executeRemotely(String jsonData)
    Forwards the provided JSON data to the associated distributed local service.
    String
    getName()
    Gets the name of the distributed remote plugin extension.
    void
    onUnregister()
    Invoked when unregistering the plugin.

  • Method Details

    • getName

      String getName()
      Gets the name of the distributed remote plugin extension.
      Returns:
      A not empty string.
      Since:
      2.0.0

    • exchangeApiLevel

      int exchangeApiLevel(int coreApiLevel)
      Exchanges the JSON API levels between the Keyple Core and Distributed layers.
      Parameters:
      coreApiLevel - The JSON API level of the Core layer.
      Returns:
      The JSON API level of the Distributed layer.
      Since:
      3.0.0

    • executeRemotely

      String executeRemotely(String jsonData)
      Forwards the provided JSON data to the associated distributed local service.
      Parameters:
      jsonData - A JSON string containing the data to transmit.
      Returns:
      A JSON string containing the response received from the distributed local service. It can be empty if the command returns nothing.
      Since:
      2.0.0

    • onUnregister

      void onUnregister()
      Invoked when unregistering the plugin.
      Since:
      2.0.0