org.pentaho.platform.api.engine
Interface IPluginProvider

All Known Implementing Classes:

FileSystemXmlPluginProvider, SystemPathXmlPluginProvider

public interface IPluginProvider

A plugin provider is responsible for serving up IPlatformPlugins to whoever is asking, typically IPluginManager. The plugin provider is not responsible for integrating the plugins into the platform. It's only role is to render plugin definitions, IPlatformPlugins. A plugin provider might load plugin definitions from an xml file, or a properties file. You might also create a plugin provider that creates plugins programmatically. It won't matter what mechanism you use to define your plugins so long as you implement IPluginProvider.

Author:

aphillips

Method Summary

java.util.List<IPlatformPlugin>

getPlugins(IPentahoSession session) Returns a list of IPlatformPlugins defined by this plugin provider.

Method Detail

getPlugins

java.util.List<IPlatformPlugin> getPlugins(IPentahoSession session)
                                           throws PlatformPluginRegistrationException

Returns a list of IPlatformPlugins defined by this plugin provider. These plugins have not been initialized or registered within the platform at this point.

Parameters:

session - the current session

Returns:

a list of platform plugins

Throws:

PlatformPluginRegistrationException - if there is a problem looking for plugins