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

Class PlatformPlugin

java.lang.Object
org.pentaho.platform.plugin.services.pluginmgr.PlatformPlugin
All Implemented Interfaces:
org.pentaho.platform.api.engine.IPentahoInitializer, org.pentaho.platform.api.engine.IPlatformPlugin, org.pentaho.platform.api.engine.IPluginLifecycleListener
public class PlatformPlugin extends Object implements org.pentaho.platform.api.engine.IPlatformPlugin, org.pentaho.platform.api.engine.IPentahoInitializer
Default bean implementation of IPlatformPlugin

  • Constructor Details

    • PlatformPlugin

      public PlatformPlugin()

    • PlatformPlugin

      public PlatformPlugin(org.springframework.beans.factory.support.DefaultListableBeanFactory defaultListableBeanFactory)

  • Method Details

    • init

      public void init(org.pentaho.platform.api.engine.IPentahoSession session)
      Specified by:
      init in interface org.pentaho.platform.api.engine.IPentahoInitializer

    • addLifecycleListenerClassname

      public void addLifecycleListenerClassname(String lifecycleListenerClassname)

    • setLifecycleListenerClassname

      public void setLifecycleListenerClassname(String lifecycleListenerClassnames)

    • getLifecycleListenerClassnames

      public List<String> getLifecycleListenerClassnames()
      Specified by:
      getLifecycleListenerClassnames in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • getContentGenerators

      public List<org.pentaho.platform.api.engine.IContentGeneratorInfo> getContentGenerators()
      Specified by:
      getContentGenerators in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • getContentInfos

      public List<org.pentaho.platform.api.engine.IContentInfo> getContentInfos()
      Specified by:
      getContentInfos in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • getId

      public String getId()
      Specified by:
      getId in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • getTitle

      @Nullable public String getTitle(@Nullable Locale locale)
      Specified by:
      getTitle in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • setTitle

      public void setTitle(@Nullable String title)
      Sets the title of this plugin. It can be a default localized value or contain keys in the format "${resource-id}" for localization.
      Parameters:
      title - the title

    • getDescription

      @Nullable public String getDescription(@Nullable Locale locale)
      Specified by:
      getDescription in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • setDescription

      public void setDescription(@Nullable String description)
      Sets the description of this plugin. It can be a default localized value or contain keys in the format "${key}" for localization.
      Parameters:
      description - the description

    • localizeInterpolatedString

      @Nullable protected String localizeInterpolatedString(@Nullable String value, @Nullable Locale locale)
      Returns a localized string for the given key and locale. If the key is not found or no resource bundle is found for the specified locale, then `value` is returned.
      Parameters:
      value - the value string to be localized
      locale - the locale to use for localization
      Returns:
      the localized string or `value` if not found

    • getResourceBundleClassName

      @Nullable public String getResourceBundleClassName()
      Specified by:
      getResourceBundleClassName in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • setResourceBundleClassName

      public void setResourceBundleClassName(@Nullable String className)
      Sets the fully qualified class name used as the resource bundle base name.
      Parameters:
      className - the fully qualified class name

    • setResourceBundleProvider

      public void setResourceBundleProvider(@Nullable org.pentaho.platform.api.locale.IResourceBundleProvider provider)
      Specified by:
      setResourceBundleProvider in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • getOverlays

      public List<org.pentaho.ui.xul.XulOverlay> getOverlays()
      Specified by:
      getOverlays in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • getPluginPerspectives

      public List<org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective> getPluginPerspectives()
      Specified by:
      getPluginPerspectives in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • setId

      public void setId(String id)
      Sets the unique id for this plug-in
      Parameters:
      id -

    • addInitializer

      public void addInitializer(org.pentaho.platform.api.engine.IPentahoInitializer initializer)
      Adds an initializer to this plug-in
      Parameters:
      initializer -

    • addContentGenerator

      public void addContentGenerator(org.pentaho.platform.api.engine.IContentGeneratorInfo contentGenerator)
      Adds a content generator to this plug-in
      Parameters:
      contentGenerator -

    • addContentInfo

      public void addContentInfo(org.pentaho.platform.api.engine.IContentInfo contentInfo)
      Adds a content info type to this plug-in
      Parameters:
      contentInfo -

    • addOverlay

      public void addOverlay(org.pentaho.ui.xul.XulOverlay overlay)
      Adds an overlay to this plug-in
      Parameters:
      overlay -

    • getSourceDescription

      public String getSourceDescription()
      Specified by:
      getSourceDescription in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • setSourceDescription

      public void setSourceDescription(String sourceDescription)

    • addStaticResourcePath

      public void addStaticResourcePath(String url, String localFolder)

    • getStaticResourceMap

      public Map<String,String> getStaticResourceMap()
      Specified by:
      getStaticResourceMap in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • getBeans

      public Collection<org.pentaho.platform.api.engine.PluginBeanDefinition> getBeans()
      Specified by:
      getBeans in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • getBeanFactory

      public org.springframework.beans.factory.support.DefaultListableBeanFactory getBeanFactory()
      Specified by:
      getBeanFactory in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • getServices

      public Collection<org.pentaho.platform.api.engine.PluginServiceDefinition> getServices()
      Specified by:
      getServices in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • addBean

      public void addBean(org.pentaho.platform.api.engine.PluginBeanDefinition beanDefinition)

    • addWebservice

      public void addWebservice(org.pentaho.platform.api.engine.PluginServiceDefinition serviceDefinition)

    • init

      public void init() throws org.pentaho.platform.api.engine.PluginLifecycleException
      Specified by:
      init in interface org.pentaho.platform.api.engine.IPlatformPlugin
      Specified by:
      init in interface org.pentaho.platform.api.engine.IPluginLifecycleListener
      Throws:
      org.pentaho.platform.api.engine.PluginLifecycleException

    • loaded

      public void loaded() throws org.pentaho.platform.api.engine.PluginLifecycleException
      Specified by:
      loaded in interface org.pentaho.platform.api.engine.IPlatformPlugin
      Specified by:
      loaded in interface org.pentaho.platform.api.engine.IPluginLifecycleListener
      Throws:
      org.pentaho.platform.api.engine.PluginLifecycleException

    • unLoaded

      public void unLoaded() throws org.pentaho.platform.api.engine.PluginLifecycleException
      Specified by:
      unLoaded in interface org.pentaho.platform.api.engine.IPlatformPlugin
      Specified by:
      unLoaded in interface org.pentaho.platform.api.engine.IPluginLifecycleListener
      Throws:
      org.pentaho.platform.api.engine.PluginLifecycleException

    • addLifecycleListener

      public void addLifecycleListener(org.pentaho.platform.api.engine.IPluginLifecycleListener listener)
      Specified by:
      addLifecycleListener in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • getMetaProviderMap

      public Map<String,String> getMetaProviderMap()
      Specified by:
      getMetaProviderMap in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • getLoaderType

      public org.pentaho.platform.api.engine.IPlatformPlugin.ClassLoaderType getLoaderType()
      Specified by:
      getLoaderType in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • setLoadertype

      public void setLoadertype(org.pentaho.platform.api.engine.IPlatformPlugin.ClassLoaderType loaderType)

    • addExternalResource

      public void addExternalResource(String context, String resource)

    • getExternalResourcesForContext

      public List<String> getExternalResourcesForContext(String context)
      Specified by:
      getExternalResourcesForContext in interface org.pentaho.platform.api.engine.IPlatformPlugin

    • addPluginPerspective

      public void addPluginPerspective(org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective perspective)