com.jivesoftware.base.plugin
Class PluginMetaDataImpl

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

All Implemented Interfaces:

com.jivesoftware.base.plugin.PluginMetaData

public class PluginMetaDataImpl
extends Object
implements com.jivesoftware.base.plugin.PluginMetaData

Provides all information about a plugin

Nested Class Summary

Nested classes/interfaces inherited from interface com.jivesoftware.base.plugin.PluginMetaData

com.jivesoftware.base.plugin.PluginMetaData.LicenseType

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 com.jivesoftware.base.plugin.PluginMetaData.LicenseType	licenseType
protected com.jivesoftware.base.plugin.PluginClassLoader	loader
protected String	minServerVersion
protected String	name
protected Plugin<?>	plugin
protected com.jivesoftware.base.plugin.dao.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, com.jivesoftware.base.plugin.PluginClassLoader loader, PluginManagerImpl pluginManager, org.dom4j.Document config, File pluginDirectory)

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

Method Summary

String	getAuthor()
com.jivesoftware.base.plugin.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.
com.jivesoftware.base.plugin.PluginMetaData.LicenseType	getLicense()
String	getMinServerVersion()
String	getName()
Plugin<?>	getPlugin()
com.jivesoftware.base.plugin.dao.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(com.jivesoftware.base.plugin.dao.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 com.jivesoftware.base.plugin.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 com.jivesoftware.base.plugin.PluginMetaData.LicenseType licenseType

readmeExists

protected boolean readmeExists

changelogExists

protected boolean changelogExists

largeLogoExists

protected boolean largeLogoExists

smallLogoExists

protected boolean smallLogoExists

pluginDbBean

protected com.jivesoftware.base.plugin.dao.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,
                          com.jivesoftware.base.plugin.PluginClassLoader loader,
                          PluginManagerImpl pluginManager,
                          org.dom4j.Document config,
                          File pluginDirectory)

Method Detail

getPluginDirectory

public File getPluginDirectory()

Specified by:

getPluginDirectory in interface com.jivesoftware.base.plugin.PluginMetaData

getPlugin

public Plugin<?> getPlugin()

Specified by:

getPlugin in interface com.jivesoftware.base.plugin.PluginMetaData

getClassLoader

public com.jivesoftware.base.plugin.PluginClassLoader getClassLoader()

Specified by:

getClassLoader in interface com.jivesoftware.base.plugin.PluginMetaData

getConfig

public org.dom4j.Document getConfig()

Specified by:

getConfig in interface com.jivesoftware.base.plugin.PluginMetaData

getPluginResourceBundle

public ResourceBundle getPluginResourceBundle(Locale locale)

Specified by:

getPluginResourceBundle in interface com.jivesoftware.base.plugin.PluginMetaData

getPluginProperties

public JiveProperties<String,String> getPluginProperties()

Specified by:

getPluginProperties in interface com.jivesoftware.base.plugin.PluginMetaData

getName

public String getName()

Specified by:

getName in interface com.jivesoftware.base.plugin.PluginMetaData

getDescription

public String getDescription()

Specified by:

getDescription in interface com.jivesoftware.base.plugin.PluginMetaData

getAuthor

public String getAuthor()

Specified by:

getAuthor in interface com.jivesoftware.base.plugin.PluginMetaData

getVersion

public String getVersion()

Specified by:

getVersion in interface com.jivesoftware.base.plugin.PluginMetaData

getMinServerVersion

public String getMinServerVersion()

Specified by:

getMinServerVersion in interface com.jivesoftware.base.plugin.PluginMetaData

getDatabaseKey

public String getDatabaseKey()

Specified by:

getDatabaseKey in interface com.jivesoftware.base.plugin.PluginMetaData

getDatabaseVersion

public int getDatabaseVersion()

Specified by:

getDatabaseVersion in interface com.jivesoftware.base.plugin.PluginMetaData

getLicense

public com.jivesoftware.base.plugin.PluginMetaData.LicenseType getLicense()

Specified by:

getLicense in interface com.jivesoftware.base.plugin.PluginMetaData

isReadmeExists

public boolean isReadmeExists()

Specified by:

isReadmeExists in interface com.jivesoftware.base.plugin.PluginMetaData

isSmallLogoExists

public boolean isSmallLogoExists()

Specified by:

isSmallLogoExists in interface com.jivesoftware.base.plugin.PluginMetaData

isLargeLogoExists

public boolean isLargeLogoExists()

Specified by:

isLargeLogoExists in interface com.jivesoftware.base.plugin.PluginMetaData

isChangelogExists

public boolean isChangelogExists()

Specified by:

isChangelogExists in interface com.jivesoftware.base.plugin.PluginMetaData

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 com.jivesoftware.base.plugin.dao.PluginDbBean getPluginDbBean()

Specified by:

getPluginDbBean in interface com.jivesoftware.base.plugin.PluginMetaData

setPluginDbBean

public void setPluginDbBean(com.jivesoftware.base.plugin.dao.PluginDbBean pluginDbBean)

isInstalled

public boolean isInstalled()

Specified by:

isInstalled in interface com.jivesoftware.base.plugin.PluginMetaData

setInstalled

public void setInstalled(boolean installed)

isUninstalled

public boolean isUninstalled()

Specified by:

isUninstalled in interface com.jivesoftware.base.plugin.PluginMetaData

setUninstalled

public void setUninstalled(boolean uninstalled)