Module com.zeroc.ice
Package com.zeroc.Ice

Interface PluginManager

public interface PluginManager
Manages the plug-ins of a communicator.

  • Method Details

    • initializePlugins

      void initializePlugins()
      Initializes the configured plug-ins. The communicator automatically initializes the plug-ins by default, but an application may need to interact directly with a plug-in prior to initialization. In this case, the application must set `Ice.InitPlugins=0` and then invoke `initializePlugins` manually. The plug-ins are initialized in the order in which they are loaded. If a plug-in throws an exception during initialization, the communicator calls Plugin.destroy() on the plug-ins that have already been initialized.
      Throws:
      InitializationException - if the plug-ins have already been initialized

    • getPlugins

      String[] getPlugins()
      Gets the installed plug-ins.
      Returns:
      the names of the installed plug-ins
      See Also:

    • getPlugin

      Plugin getPlugin(String name)
      Gets a plug-in by name.
      Parameters:
      name - the plug-in's name
      Returns:
      the plug-in
      Throws:
      NotRegisteredException - if no plug-in is found with the given name

    • addPlugin

      void addPlugin(String name, Plugin pi)
      Installs a new plug-in.
      Parameters:
      name - the plug-in's name
      pi - the plug-in
      Throws:
      AlreadyRegisteredException - if a plug-in already exists with the given name

    • destroy

      void destroy()
      Destroys this plug-in manager. Called when the communicator is being destroyed.