Package org.pentaho.platform.plugin.services.pluginmgr

Class SystemPathXmlPluginProvider

java.lang.Object

org.pentaho.platform.plugin.services.pluginmgr.SystemPathXmlPluginProvider

All Implemented Interfaces:

org.pentaho.platform.api.engine.IPluginProvider

Direct Known Subclasses:

FileSystemXmlPluginProvider

public class SystemPathXmlPluginProvider
extends Object
implements org.pentaho.platform.api.engine.IPluginProvider

An implementation of IPluginProvider that searches for plugin.xml files in the Pentaho system path and instantiates IPlatformPlugins from the information in those files.

Author:

aphillips

Constructor Summary

Constructors

Constructor	Description
SystemPathXmlPluginProvider()

Method Summary

Modifier and Type	Method	Description
protected PlatformPlugin	createPlugin(org.dom4j.Document doc, org.pentaho.platform.api.engine.IPentahoSession session, String folder, boolean hasLib)
List<org.pentaho.platform.api.engine.IPlatformPlugin>	getPlugins(org.pentaho.platform.api.engine.IPentahoSession session)	Gets the list of plugins that this provider class has discovered.
protected void	processBeans(PlatformPlugin plugin, org.dom4j.Document doc)
protected void	processContentGenerators(PlatformPlugin plugin, org.dom4j.Document doc, org.pentaho.platform.api.engine.IPentahoSession session, String folder, boolean hasLib)
protected void	processContentTypes(PlatformPlugin plugin, org.dom4j.Document doc, org.pentaho.platform.api.engine.IPentahoSession session)
protected void	processDirectory(List<org.pentaho.platform.api.engine.IPlatformPlugin> plugins, File folder, org.pentaho.platform.api.engine.IPentahoSession session)
protected void	processExternalResources(PlatformPlugin plugin, org.dom4j.Document doc)
protected void	processLifecycleListeners(PlatformPlugin plugin, org.dom4j.Document doc)
static org.pentaho.ui.xul.impl.DefaultXulOverlay	processOverlay(org.dom4j.Element node)
protected void	processOverlays(PlatformPlugin plugin, org.dom4j.Document doc, org.pentaho.platform.api.engine.IPentahoSession session)
protected void	processPerspectives(PlatformPlugin plugin, org.dom4j.Document doc)
protected void	processPluginInfo(PlatformPlugin plugin, org.dom4j.Document doc, String folder, org.pentaho.platform.api.engine.IPentahoSession session)
protected void	processStaticResourcePaths(PlatformPlugin plugin, org.dom4j.Document doc, org.pentaho.platform.api.engine.IPentahoSession session)
protected void	processWebservices(PlatformPlugin plugin, org.dom4j.Document doc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SystemPathXmlPluginProvider

public SystemPathXmlPluginProvider()

Method Detail

getPlugins

public List<org.pentaho.platform.api.engine.IPlatformPlugin> getPlugins(org.pentaho.platform.api.engine.IPentahoSession session)
                                                                 throws org.pentaho.platform.api.engine.PlatformPluginRegistrationException

Gets the list of plugins that this provider class has discovered.

Specified by:

getPlugins in interface org.pentaho.platform.api.engine.IPluginProvider

Returns:

an read-only list of plugins

Throws:

org.pentaho.platform.api.engine.PlatformPluginRegistrationException - if there is a problem preventing the impl from looking for plugins

See Also:

IPluginProvider#getPlugins()

processDirectory

protected void processDirectory(List<org.pentaho.platform.api.engine.IPlatformPlugin> plugins,
                                File folder,
                                org.pentaho.platform.api.engine.IPentahoSession session)
                         throws org.pentaho.platform.api.engine.PlatformPluginRegistrationException

Throws:

org.pentaho.platform.api.engine.PlatformPluginRegistrationException

createPlugin

protected PlatformPlugin createPlugin(org.dom4j.Document doc,
                                      org.pentaho.platform.api.engine.IPentahoSession session,
                                      String folder,
                                      boolean hasLib)

processPerspectives

protected void processPerspectives(PlatformPlugin plugin,
                                   org.dom4j.Document doc)

Parameters:

plugin -

doc -

processStaticResourcePaths

protected void processStaticResourcePaths(PlatformPlugin plugin,
                                          org.dom4j.Document doc,
                                          org.pentaho.platform.api.engine.IPentahoSession session)

processExternalResources

protected void processExternalResources(PlatformPlugin plugin,
                                        org.dom4j.Document doc)

processLifecycleListeners

protected void processLifecycleListeners(PlatformPlugin plugin,
                                         org.dom4j.Document doc)

processBeans

protected void processBeans(PlatformPlugin plugin,
                            org.dom4j.Document doc)

processWebservices

protected void processWebservices(PlatformPlugin plugin,
                                  org.dom4j.Document doc)

processPluginInfo

protected void processPluginInfo(PlatformPlugin plugin,
                                 org.dom4j.Document doc,
                                 String folder,
                                 org.pentaho.platform.api.engine.IPentahoSession session)

processOverlays

protected void processOverlays(PlatformPlugin plugin,
                               org.dom4j.Document doc,
                               org.pentaho.platform.api.engine.IPentahoSession session)

processOverlay

public static org.pentaho.ui.xul.impl.DefaultXulOverlay processOverlay(org.dom4j.Element node)

processContentTypes

protected void processContentTypes(PlatformPlugin plugin,
                                   org.dom4j.Document doc,
                                   org.pentaho.platform.api.engine.IPentahoSession session)

processContentGenerators

protected void processContentGenerators(PlatformPlugin plugin,
                                        org.dom4j.Document doc,
                                        org.pentaho.platform.api.engine.IPentahoSession session,
                                        String folder,
                                        boolean hasLib)