Jive API (4.5.7.0) Core Javadocs

com.jivesoftware.base.plugin
Class PluginMetaDataImpl

java.lang.Object
  extended by com.jivesoftware.base.plugin.PluginMetaDataImpl
All Implemented Interfaces:
com.jivesoftware.base.plugin.PluginMetaData

public class PluginMetaDataImpl
extends java.lang.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  java.lang.String author
           
protected  boolean changelogExists
           
protected  org.dom4j.Document config
           
protected  java.util.Collection<java.lang.String> cssUrls
           
protected  java.lang.String databaseKey
           
protected  int databaseVersion
           
protected  java.lang.String dependency
           
protected  java.lang.String description
           
protected  boolean installed
           
protected  java.util.Collection<java.lang.String> javaScriptUrls
           
protected  boolean largeLogoExists
           
protected  com.jivesoftware.base.plugin.PluginMetaData.LicenseType licenseType
           
protected  com.jivesoftware.base.plugin.PluginClassLoader loader
           
protected  java.lang.String minServerVersion
           
protected  java.lang.String name
           
protected  Plugin<?> plugin
           
protected  com.jivesoftware.base.plugin.dao.PluginDbBean pluginDbBean
           
protected  java.io.File pluginDirectory
           
protected  PluginManagerImpl pluginManager
           
protected  boolean readmeExists
           
protected  boolean smallLogoExists
           
protected  boolean uninstalled
           
protected  java.lang.String version
           
protected  java.util.Collection<java.lang.Class<?>> webServiceClasses
           
protected  java.util.Collection<java.lang.Class<?>> widgetClasses
           
 
Constructor Summary
PluginMetaDataImpl(Plugin<?> plugin, com.jivesoftware.base.plugin.PluginClassLoader loader, PluginManagerImpl pluginManager, org.dom4j.Document config, java.io.File pluginDirectory)
           
PluginMetaDataImpl(PluginManagerImpl pluginManager, org.dom4j.Document config, java.io.File pluginDirectory)
           
 
Method Summary
 java.lang.String getAuthor()
           
 com.jivesoftware.base.plugin.PluginClassLoader getClassLoader()
           
 org.dom4j.Document getConfig()
           
 java.lang.String getDatabaseKey()
           
 int getDatabaseVersion()
           
 java.lang.String getDependency()
           
 java.lang.String getDescription()
           
protected  java.lang.String getElementValue(java.lang.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()
           
 java.lang.String getMinServerVersion()
           
 java.lang.String getName()
           
 Plugin<?> getPlugin()
           
 com.jivesoftware.base.plugin.dao.PluginDbBean getPluginDbBean()
           
 java.io.File getPluginDirectory()
           
 JiveProperties<java.lang.String,java.lang.String> getPluginProperties()
           
 java.util.ResourceBundle getPluginResourceBundle(java.util.Locale locale)
           
 java.lang.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 java.lang.String name

author

protected java.lang.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 java.util.Collection<java.lang.Class<?>> webServiceClasses

widgetClasses

protected java.util.Collection<java.lang.Class<?>> widgetClasses

cssUrls

protected java.util.Collection<java.lang.String> cssUrls

javaScriptUrls

protected java.util.Collection<java.lang.String> javaScriptUrls

pluginDirectory

protected final java.io.File pluginDirectory

version

protected java.lang.String version

minServerVersion

protected java.lang.String minServerVersion

databaseKey

protected java.lang.String databaseKey

description

protected java.lang.String description

databaseVersion

protected int databaseVersion

dependency

protected java.lang.String dependency

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,
                          java.io.File pluginDirectory)

PluginMetaDataImpl

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

getPluginDirectory

public java.io.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 java.util.ResourceBundle getPluginResourceBundle(java.util.Locale locale)
Specified by:
getPluginResourceBundle in interface com.jivesoftware.base.plugin.PluginMetaData

getPluginProperties

public JiveProperties<java.lang.String,java.lang.String> getPluginProperties()
Specified by:
getPluginProperties in interface com.jivesoftware.base.plugin.PluginMetaData

getName

public java.lang.String getName()
Specified by:
getName in interface com.jivesoftware.base.plugin.PluginMetaData

getDescription

public java.lang.String getDescription()
Specified by:
getDescription in interface com.jivesoftware.base.plugin.PluginMetaData

getAuthor

public java.lang.String getAuthor()
Specified by:
getAuthor in interface com.jivesoftware.base.plugin.PluginMetaData

getVersion

public java.lang.String getVersion()
Specified by:
getVersion in interface com.jivesoftware.base.plugin.PluginMetaData

getMinServerVersion

public java.lang.String getMinServerVersion()
Specified by:
getMinServerVersion in interface com.jivesoftware.base.plugin.PluginMetaData

getDatabaseKey

public java.lang.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

getDependency

public java.lang.String getDependency()
Specified by:
getDependency 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 java.lang.String getElementValue(java.lang.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)

Jive Product Page

Copyright © 1999-2007 Jive Software.