Jive API (3.0.13) Core Javadocs

com.jivesoftware.base.plugin
Class PluginMetaDataImpl

java.lang.Object
  extended by com.jivesoftware.base.plugin.PluginMetaDataImpl

public class PluginMetaDataImpl
extends Object

Provides all information about a plugin


Field Summary
protected  String author
           
protected  boolean changelogExists
           
protected  org.dom4j.Document config
           
protected  Collection<String> cssUrls
           
protected  String databaseKey
           
protected  int databaseVersion
           
protected  String description
           
protected  boolean installed
           
protected  Collection<String> javaScriptUrls
           
protected  boolean largeLogoExists
           
protected  LicenseType licenseType
           
protected  PluginClassLoader loader
           
protected  String minServerVersion
           
protected  String name
           
protected  Plugin<?> plugin
           
protected  PluginDbBean pluginDbBean
           
protected  File pluginDirectory
           
protected  PluginManagerImpl pluginManager
           
protected  boolean readmeExists
           
protected  boolean smallLogoExists
           
protected  boolean uninstalled
           
protected  String version
           
protected  Collection<Class<?>> webServiceClasses
           
protected  Collection<Class<?>> widgetClasses
           
 
Constructor Summary
PluginMetaDataImpl(Plugin<?> plugin, PluginClassLoader loader, PluginManagerImpl pluginManager, org.dom4j.Document config, File pluginDirectory)
           
PluginMetaDataImpl(PluginManagerImpl pluginManager, org.dom4j.Document config, File pluginDirectory)
           
 
Method Summary
 String getAuthor()
           
 PluginClassLoader getClassLoader()
           
 org.dom4j.Document getConfig()
           
 String getDatabaseKey()
           
 int getDatabaseVersion()
           
 String getDescription()
           
protected  String getElementValue(String xpath)
          Returns the value of an element selected via an xpath expression from a Plugin's plugin.xml file.
 LicenseType getLicense()
           
 String getMinServerVersion()
           
 String getName()
           
 Plugin<?> getPlugin()
           
 PluginDbBean getPluginDbBean()
           
 File getPluginDirectory()
           
 JiveProperties<String,String> getPluginProperties()
           
 ResourceBundle getPluginResourceBundle(Locale locale)
           
 String getVersion()
           
 boolean isChangelogExists()
           
 boolean isInstalled()
           
 boolean isLargeLogoExists()
           
 boolean isReadmeExists()
           
 boolean isSmallLogoExists()
           
 boolean isUninstalled()
           
 void setInstalled(boolean installed)
           
 void setPluginDbBean(PluginDbBean pluginDbBean)
           
 void setUninstalled(boolean uninstalled)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

protected String name

author

protected String author

plugin

protected Plugin<?> plugin

loader

protected PluginClassLoader loader

pluginManager

protected PluginManagerImpl pluginManager

config

protected org.dom4j.Document config

webServiceClasses

protected Collection<Class<?>> webServiceClasses

widgetClasses

protected Collection<Class<?>> widgetClasses

cssUrls

protected Collection<String> cssUrls

javaScriptUrls

protected Collection<String> javaScriptUrls

pluginDirectory

protected final File pluginDirectory

version

protected String version

minServerVersion

protected String minServerVersion

databaseKey

protected String databaseKey

description

protected String description

databaseVersion

protected int databaseVersion

licenseType

protected LicenseType licenseType

readmeExists

protected boolean readmeExists

changelogExists

protected boolean changelogExists

largeLogoExists

protected boolean largeLogoExists

smallLogoExists

protected boolean smallLogoExists

pluginDbBean

protected PluginDbBean pluginDbBean

installed

protected boolean installed

uninstalled

protected boolean uninstalled
Constructor Detail

PluginMetaDataImpl

public PluginMetaDataImpl(PluginManagerImpl pluginManager,
                          org.dom4j.Document config,
                          File pluginDirectory)

PluginMetaDataImpl

public PluginMetaDataImpl(Plugin<?> plugin,
                          PluginClassLoader loader,
                          PluginManagerImpl pluginManager,
                          org.dom4j.Document config,
                          File pluginDirectory)
Method Detail

getPluginDirectory

public File getPluginDirectory()

getPlugin

public Plugin<?> getPlugin()

getClassLoader

public PluginClassLoader getClassLoader()

getConfig

public org.dom4j.Document getConfig()

getPluginResourceBundle

public ResourceBundle getPluginResourceBundle(Locale locale)

getPluginProperties

public JiveProperties<String,String> getPluginProperties()

getName

public String getName()

getDescription

public String getDescription()

getAuthor

public String getAuthor()

getVersion

public String getVersion()

getMinServerVersion

public String getMinServerVersion()

getDatabaseKey

public String getDatabaseKey()

getDatabaseVersion

public int getDatabaseVersion()

getLicense

public LicenseType getLicense()

isReadmeExists

public boolean isReadmeExists()

isSmallLogoExists

public boolean isSmallLogoExists()

isLargeLogoExists

public boolean isLargeLogoExists()

isChangelogExists

public boolean isChangelogExists()

getElementValue

protected String getElementValue(String xpath)
Returns the value of an element selected via an xpath expression from a Plugin's plugin.xml file.

Parameters:
xpath - the xpath expression.
Returns:
the value of the element selected by the xpath expression.

getPluginDbBean

public PluginDbBean getPluginDbBean()

setPluginDbBean

public void setPluginDbBean(PluginDbBean pluginDbBean)

isInstalled

public boolean isInstalled()

setInstalled

public void setInstalled(boolean installed)

isUninstalled

public boolean isUninstalled()

setUninstalled

public void setUninstalled(boolean uninstalled)

Jive Product Page

Copyright © 1999-2007 Jive Software.