Package de.elo.ix.client.plugin

Interface PluginServiceAsync

All Superinterfaces:
byps.BRemote, PluginService, byps.Remote, de.elo.utils.net.Remote, Remote
All Known Implementing Classes:
BSkeleton_PluginService
public interface PluginServiceAsync extends byps.BRemote, PluginService

  • Method Details

    • getPlugins

      List<PluginInfo> getPlugins(ClientInfo ci) throws byps.RemoteException
      Description copied from interface: PluginService
      Return a list of installed plugins.
      Specified by:
      getPlugins in interface PluginService
      Parameters:
      ci - ClientInfo
      Returns:
      List Return a list of installed plugins.
      Throws:
      byps.RemoteException

    • getPlugins

      void getPlugins(ClientInfo ci, byps.BAsyncResult<List<PluginInfo>> asyncResult)

    • getPlugin

      PluginInfo getPlugin(ClientInfo ci, String symbolicName) throws byps.RemoteException
      Description copied from interface: PluginService
      Return the plugin with the given symbolic name. If no plugin with the given name is running, an exception with code IXExceptionC#NOT_FOUND is thrown.
      Specified by:
      getPlugin in interface PluginService
      Parameters:
      ci - ClientInfo
      symbolicName - Symbolic name. If no plugin with the given name is running, an exception with code IXExceptionC#NOT_FOUND is thrown.
      Returns:
      List
      Throws:
      byps.RemoteException
      Since:
      11.00.000.018 Return the plugin with the given symbolic name.

    • getPlugin

      void getPlugin(ClientInfo ci, String symbolicName, byps.BAsyncResult<PluginInfo> asyncResult)

    • start

      void start(ClientInfo ci, long id) throws byps.RemoteException
      Description copied from interface: PluginService
      Start plugin with given ID.
      Specified by:
      start in interface PluginService
      Parameters:
      ci - ClientInfo
      id - Plugin ID, call getPlugins(ClientInfo) to receive a plugin ID. Start plugin with given ID.
      Throws:
      byps.RemoteException

    • start

      void start(ClientInfo ci, long id, byps.BAsyncResult<Object> asyncResult)

    • stop

      void stop(ClientInfo ci, long id) throws byps.RemoteException
      Description copied from interface: PluginService
      Stop plugin with given ID.
      Specified by:
      stop in interface PluginService
      Parameters:
      ci - ClientInfo
      id - Plugin ID, call getPlugins(ClientInfo) to receive a plugin ID. Stop plugin with given ID.
      Throws:
      byps.RemoteException

    • stop

      void stop(ClientInfo ci, long id, byps.BAsyncResult<Object> asyncResult)

    • uninstall

      void uninstall(ClientInfo ci, long id) throws byps.RemoteException
      Description copied from interface: PluginService
      Uninstall plugin with given ID.
      Specified by:
      uninstall in interface PluginService
      Parameters:
      ci - ClientInfo
      id - Plugin ID, call getPlugins(ClientInfo) to receive a plugin ID.
      Throws:
      byps.RemoteException
      Since:
      10.99.999.026 Uninstall plugin with given ID.

    • uninstall

      void uninstall(ClientInfo ci, long id, byps.BAsyncResult<Object> asyncResult)

    • install

      long install(ClientInfo ci, String location) throws byps.RemoteException
      Description copied from interface: PluginService
      Install a plugin from the location of a JAR file.
      Specified by:
      install in interface PluginService
      Parameters:
      ci - ClientInfo
      location - Path to the bundle from the view point of Indexserver. If a bundle with the
      same - Bundle-SymbolicName is already installed, this function returns its ID and skips
      installation - .
      Returns:
      ID of the installed bundle.
      Throws:
      byps.RemoteException
      Since:
      10.99.999.026 Install a plugin from the location of a JAR file.

    • install

      void install(ClientInfo ci, String location, byps.BAsyncResult<Long> asyncResult)

    • upload

      long upload(ClientInfo ci, InputStream istream) throws byps.RemoteException
      Description copied from interface: PluginService
      Install a plugin which JAR is uploaded from a stream.
      Specified by:
      upload in interface PluginService
      Parameters:
      ci - ClientInfo
      istream - JAR file content as InputStream. If a bundle with the same Bundle-SymbolicName
      is - already installed, this function returns its ID and skips installation.
      Returns:
      ID of the installed bundle.
      Throws:
      byps.RemoteException
      Since:
      10.99.999.026 Install a plugin which JAR is uploaded from a stream.

    • upload

      void upload(ClientInfo ci, InputStream istream, byps.BAsyncResult<Long> asyncResult)

    • getHistory

      PluginHistory getHistory(ClientInfo ci, long id) throws byps.RemoteException
      Description copied from interface: PluginService
      Get the history of a plugin.
      Specified by:
      getHistory in interface PluginService
      Parameters:
      ci - ClientInfo
      id - Plugin ID, call getPlugins(ClientInfo) to receive a plugin ID.
      Returns:
      PluginHistory containing at least the plain text
      Throws:
      byps.RemoteException
      Since:
      12.00.000.048 Get the history of a plugin.

    • getHistory

      void getHistory(ClientInfo ci, long id, byps.BAsyncResult<PluginHistory> asyncResult)

    • configure

      String configure(ClientInfo ci, long id, String config) throws byps.RemoteException
      Description copied from interface: PluginService
      Read and/or modify plugin configuration. If the plugin does not support configuration, an exception with code IXExceptionC.UNSUPPORTED_FUNCTION is thrown. This function internally calls the interface de.elo.ix.plugin.ConfigurePlugin.configure().
      Specified by:
      configure in interface PluginService
      Parameters:
      ci - ClientInfo
      id - Plugin ID, call getPlugins(ClientInfo) or
      config - Configuration encoded as string. Format depends on object's internals. If the plugin does not support configuration, an exception with code
      invalid reference 
      IXExceptionC#UNSUPPORTED_FUNCTION
      is thrown. This function internally calls the interface de.elo.ix.plugin.ConfigurePlugin.configure().
      Returns:
      Previous configuration.
      Throws:
      byps.RemoteException
      Since:
      11.00.000.006 Read and/or modify plugin configuration.

    • configure

      void configure(ClientInfo ci, long id, String config, byps.BAsyncResult<String> asyncResult)

    • send

      PluginMessage send(ClientInfo ci, long id, PluginMessage message) throws byps.RemoteException
      Description copied from interface: PluginService
      Send a message to a plugin. This function directs the message to the ConfigurePlugin interface of the plugin.
      Specified by:
      send in interface PluginService
      Parameters:
      ci - ClientInfo
      id - Plugin ID, call getPlugins(ClientInfo) or
      message - Message to be sent This function directs the message to the ConfigurePlugin interface of the plugin.
      Returns:
      Response message
      Throws:
      byps.RemoteException
      Since:
      11.00.000.018 Send a message to a plugin.

    • send

      void send(ClientInfo ci, long id, PluginMessage message, byps.BAsyncResult<PluginMessage> asyncResult)