org.apache.geronimo.system.plugin
Class PluginMetadata

java.lang.Object
  extended by org.apache.geronimo.system.plugin.PluginMetadata
All Implemented Interfaces:
Serializable, Comparable

public class PluginMetadata
extends Object
implements Serializable, Comparable

Various metadata on a configuration that's used when listing, importing, and exporting configurations.

See Also:
Serialized Form

Nested Class Summary
static class PluginMetadata.CopyFile
           
static class PluginMetadata.geronimoVersions
           
static class PluginMetadata.Hash
           
static class PluginMetadata.License
           
static class PluginMetadata.Prerequisite
           
 
Constructor Summary
PluginMetadata(String name, Artifact moduleId, String category, String description, String pluginURL, String author, PluginMetadata.Hash hash, boolean installed, boolean eligible)
           
 
Method Summary
 int compareTo(Object o)
           
 String getAuthor()
           
 String getCategory()
          Gets a category name for this configuration.
 GBeanOverride[] getConfigXmls()
          Gets a list of settings to populate in config.xml
 String[] getDependencies()
          Gets the JAR or configuration dependencies for this configuration, Each String in the result is an Artifact (or Config ID) in String form.
 String getDescription()
          Gets a description of this configuration and why it is interesting
 PluginMetadata.CopyFile[] getFilesToCopy()
          Gets a list of files to copy from the plugin CAR into the server installation.
 String[] getForceStart()
          Gets the configurations that should definitely be started when the install process completes.
 PluginMetadata.geronimoVersions[] getGeronimoVersions()
           
 PluginMetadata.Hash getHash()
           
 String getHTMLDescription()
          Gets a description of this module in HTML format (with paragraph markers).
 String[] getJvmVersions()
           
 PluginMetadata.License[] getLicenses()
           
 Artifact getModuleId()
          Gets the Config ID for this configuration, which is a globally unique identifier.
 String getName()
          Gets a human-readable name for this configuration.
 String[] getObsoletes()
          Gets the configurations obsoleted by this configuration.
 String getPluginURL()
           
 PluginMetadata.Prerequisite[] getPrerequisites()
           
 URL[] getRepositories()
           
 String getVersion()
           
 boolean isEligible()
           
 boolean isInstalled()
           
 void setConfigXmls(GBeanOverride[] configXmls)
           
 void setDependencies(String[] dependencies)
           
 void setFilesToCopy(PluginMetadata.CopyFile[] filesToCopy)
           
 void setForceStart(String[] forceStart)
           
 void setGeronimoVersions(PluginMetadata.geronimoVersions[] geronimoVersions)
           
 void setJvmVersions(String[] jdkVersions)
           
 void setLicenses(PluginMetadata.License[] licenses)
           
 void setObsoletes(String[] obsoletes)
           
 void setPrerequisites(PluginMetadata.Prerequisite[] prerequisites)
           
 void setRepositories(URL[] repositories)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PluginMetadata

public PluginMetadata(String name,
                      Artifact moduleId,
                      String category,
                      String description,
                      String pluginURL,
                      String author,
                      PluginMetadata.Hash hash,
                      boolean installed,
                      boolean eligible)
Method Detail

setDependencies

public void setDependencies(String[] dependencies)

setObsoletes

public void setObsoletes(String[] obsoletes)

setForceStart

public void setForceStart(String[] forceStart)

getModuleId

public Artifact getModuleId()
Gets the Config ID for this configuration, which is a globally unique identifier.


getName

public String getName()
Gets a human-readable name for this configuration.


getDescription

public String getDescription()
Gets a description of this configuration and why it is interesting


getHTMLDescription

public String getHTMLDescription()
Gets a description of this module in HTML format (with paragraph markers).


getCategory

public String getCategory()
Gets a category name for this configuration. In a list, configurations in the same category will be listed together. There are no specific allowed values, though each repository may have standards for that.


isInstalled

public boolean isInstalled()

getVersion

public String getVersion()

getDependencies

public String[] getDependencies()
Gets the JAR or configuration dependencies for this configuration, Each String in the result is an Artifact (or Config ID) in String form. Generally speaking, the dependency names may be partial artifact names (but not, for example, if this whole thing is a plugin list).


getObsoletes

public String[] getObsoletes()
Gets the configurations obsoleted by this configuration. Each String in the result is an Artifact (or Config ID) in String form.


getForceStart

public String[] getForceStart()
Gets the configurations that should definitely be started when the install process completes.


getGeronimoVersions

public PluginMetadata.geronimoVersions[] getGeronimoVersions()

getAuthor

public String getAuthor()

getHash

public PluginMetadata.Hash getHash()

getPluginURL

public String getPluginURL()

getRepositories

public URL[] getRepositories()

setGeronimoVersions

public void setGeronimoVersions(PluginMetadata.geronimoVersions[] geronimoVersions)

getLicenses

public PluginMetadata.License[] getLicenses()

setLicenses

public void setLicenses(PluginMetadata.License[] licenses)

getJvmVersions

public String[] getJvmVersions()

setJvmVersions

public void setJvmVersions(String[] jdkVersions)

getPrerequisites

public PluginMetadata.Prerequisite[] getPrerequisites()

setRepositories

public void setRepositories(URL[] repositories)

setPrerequisites

public void setPrerequisites(PluginMetadata.Prerequisite[] prerequisites)

isEligible

public boolean isEligible()

getFilesToCopy

public PluginMetadata.CopyFile[] getFilesToCopy()
Gets a list of files to copy from the plugin CAR into the server installation.


setFilesToCopy

public void setFilesToCopy(PluginMetadata.CopyFile[] filesToCopy)

getConfigXmls

public GBeanOverride[] getConfigXmls()
Gets a list of settings to populate in config.xml


setConfigXmls

public void setConfigXmls(GBeanOverride[] configXmls)

compareTo

public int compareTo(Object o)
Specified by:
compareTo in interface Comparable


Copyright © 2003-2007 Apache Software Foundation. All Rights Reserved.