Package de.elo.ix.client.plugin

Interface PluginService

All Superinterfaces:
byps.BRemote, byps.Remote, de.elo.utils.net.Remote, Remote
public interface PluginService extends byps.BRemote
This service allows to start and stop OSGi plugins.
Since:
10.99.999.008

  • Method Details

    • getPlugins

      List<PluginInfo> getPlugins(ClientInfo ci) throws byps.RemoteException
      Return a list of installed plugins.
      Parameters:
      ci - ClientInfo
      Returns:
      List
      Throws:
      byps.RemoteException

    • getPlugin

      PluginInfo getPlugin(ClientInfo ci, String symbolicName) throws byps.RemoteException
      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.
      Parameters:
      ci - ClientInfo
      symbolicName - Symbolic name.
      Returns:
      List
      Throws:
      byps.RemoteException
      Since:
      11.00.000.018

    • start

      void start(ClientInfo ci, long id) throws byps.RemoteException
      Start plugin with given ID.
      Parameters:
      ci - ClientInfo
      id - Plugin ID, call getPlugins(ClientInfo) to receive a plugin ID.
      Throws:
      byps.RemoteException

    • stop

      void stop(ClientInfo ci, long id) throws byps.RemoteException
      Stop plugin with given ID.
      Parameters:
      ci - ClientInfo
      id - Plugin ID, call getPlugins(ClientInfo) to receive a plugin ID.
      Throws:
      byps.RemoteException

    • uninstall

      void uninstall(ClientInfo ci, long id) throws byps.RemoteException
      Uninstall plugin with given ID.
      Parameters:
      ci - ClientInfo
      id - Plugin ID, call getPlugins(ClientInfo) to receive a plugin ID.
      Throws:
      byps.RemoteException
      Since:
      10.99.999.026

    • install

      long install(ClientInfo ci, String location) throws byps.RemoteException
      Install a plugin from the location of a JAR file.
      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

    • upload

      long upload(ClientInfo ci, InputStream istream) throws byps.RemoteException
      Install a plugin which JAR is uploaded from a stream.
      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

    • getHistory

      PluginHistory getHistory(ClientInfo ci, long id) throws byps.RemoteException
      Get the history of a plugin.
      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

    • configure

      String configure(ClientInfo ci, long id, String config) throws byps.RemoteException
      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().
      Parameters:
      ci - ClientInfo
      id - Plugin ID, call getPlugins(ClientInfo) or getPlugin(ClientInfo, String) to receive a plugin's ID.
      config - Configuration encoded as string. Format depends on object's internals.
      Returns:
      Previous configuration.
      Throws:
      byps.RemoteException
      Since:
      11.00.000.006

    • send

      PluginMessage send(ClientInfo ci, long id, PluginMessage message) throws byps.RemoteException
      Send a message to a plugin. This function directs the message to the ConfigurePlugin interface of the plugin.
      Parameters:
      ci - ClientInfo
      id - Plugin ID, call getPlugins(ClientInfo) or getPlugin(ClientInfo, String) to receive a plugin's ID.
      message - Message to be sent
      Returns:
      Response message
      Throws:
      byps.RemoteException
      Since:
      11.00.000.018