Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   * This program is free software; you can redistribute it and/or modify it under the 
   * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software 
   * Foundation.
   * You should have received a copy of the GNU Lesser General Public License along with this 
   * program; if not, you can obtain a copy at 
   * or from the Free Software Foundation, Inc., 
   * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  * See the GNU Lesser General Public License for more details.
  * Copyright 2006 - 2008 Pentaho Corporation.  All rights reserved.
  * Created Dec 19, 2008 
  * @author aphillips
 package org.pentaho.platform.api.engine;
 import java.util.List;
 import java.util.Map;
 import  org.pentaho.ui.xul.XulOverlay;
This interface represents the contract for the specification of a plugin. A IPluginProvider is responsible for serving these to requesting clients, such as the IPluginManager. The presence of an instance of an IPlatformPlugin does not necessarily mean that the plugin is loaded. An implementations of this interface represents merely a plugin configuration.

 public interface IPlatformPlugin extends IPluginLifecycleListener {
   public enum ClassLoaderType {

Returns the unique ID of this plugin

the plugin id
   public String getId();
A short description of where this plugin came from, e.g. "biserver/solutions/pluginA"

   public String getSourceDescription();
Returns the list of content generators for this plug-in

Returns a list of overlays for this plug-in

   public List<XulOverlay> getOverlays();
Returns a list of content info objects for this plug-in

   public List<IContentInfogetContentInfos();
Returns a list of perspective objects for this plug-in

plugin perspectives
Returns a list of bean configurations for this plugin-in
   public Collection<PluginBeanDefinitiongetBeans();
Returns the Spring application context for this plugin
   public ListableBeanFactory getBeanFactory();
Returns a list of static resource paths for this plugin-in
   public Map<String,StringgetStaticResourceMap();
Returns the fully qualified name of the lifecycle listener class defined by this plugin. The class must be a IPluginLifecycleListener.

lifecycle listener class name
Registers a lifecycle listener with this plugin. This listener will be notified when lifecycle events occur on this plugin.

listener a lifecycle listener
   * (non-Javadoc)
   * @see org.pentaho.platform.api.engine.IPluginLifecycleListener#init()
  public void init() throws PluginLifecycleException;
   * (non-Javadoc)
   * @see org.pentaho.platform.api.engine.IPluginLifecycleListener#loaded()
  public void loaded() throws PluginLifecycleException;
   * (non-Javadoc)
   * @see org.pentaho.platform.api.engine.IPluginLifecycleListener#unLoaded()
  public void unLoaded() throws PluginLifecycleException;
The storage mechanism for a plugin to know what ISolutionFileMetaProvider class should be used for a particular content type.

a map of content types (extensions) keys and ISolutionFileMetaProvider (or deprecated IFileInfoGenerator) classnames for values
  public Map<StringStringgetMetaProviderMap();
Returns the list of the webservices defined by this plugin.

the definitions of the webservices for this plugin
Indicates what kind of classloader should be used to load classes and resources from this plugin. The default classloader type is no more than an extension of URLClassLoader.

the type of classloader to use for this plugin
See also:
  public ClassLoaderType getLoaderType();
Return a List of scripts registered for a given context.

context named area in the platform
list of registered scripts
New to GrepCode? Check out our FAQ X