de.willuhn.jameica.plugin
Class Manifest

java.lang.Object
  de.willuhn.jameica.plugin.Manifest

All Implemented Interfaces:

java.lang.Comparable

public class Manifest
extends java.lang.Object
implements java.lang.Comparable

Enthaelt die Manifest-Informationen des Plugins aus plugin.xml.

Constructor Summary

Manifest(java.io.File manifest)
ct.

Manifest(java.io.InputStream manifest)
ct.

Method Summary

int	compareTo(java.lang.Object o) Wir implementieren die Funktion, damit wir eine Liste von Manifesten nach Abhaengigkeit sortieren koennen.
java.lang.String	getBuildDate() Liefert das Build-Datum, insofern es ermittelbar ist.
java.lang.String	getBuildnumber() Liefert die Build-Nummer, insofern sie ermittelbar ist.
java.lang.String[]	getClassFinderIncludes() Liefert eine Liste von Pfaden, die in den Classfinder aufgenommen werden sollen.
Dependency[]	getDependencies() Liste der Plugins, von denen dieses hier abhaengig ist.
java.lang.String	getDescription() Liefert die Beschreibung der Komponente.
ExtensionDescriptor[]	getExtensions() Liefert eine Liste von Extension-Desktriptoren zu diesem Plugin.
java.lang.String	getHomepage() Liefert die Homepage-URL der Komponente.
Dependency	getJameicaDependency() Liefert die Versionsabhaengigkeit zu Jameica.
java.lang.String	getLicense() Liefert die Lizenz der Komponente.
MenuItem	getMenu() Liefert das Menu der Komponente.
java.lang.String	getName() Liefert den Namen der Komponente.
NavigationItem	getNavigation() Liefert die Navigation der Komponente.
java.lang.String	getPluginClass() Liefert den Klassen-Name des Plugins.
java.lang.String	getPluginDir() Liefert das Verzeichnis, in dem sich das Plugin befindet.
ServiceDescriptor[]	getServices() Liefert eine Liste von Service-Desktriptoren zu diesem Plugin.
java.lang.String	getURL() Liefert die Download-URL der Komponente.
Version	getVersion() Liefert die Versionsnummer.
boolean	isInstalled() Prueft, ob das Plugin initialisiert werden konnte.
boolean	isShared() Liefert true, wenn das Plugin ueber den globalen Classloader von Jameica geladen werden soll.
void	setInstalled(boolean b) Legt fest, ob das Plugin als erfolgreich installiert gelten soll.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Manifest

public Manifest(java.io.File manifest)
         throws java.lang.Exception

ct.

Parameters:

manifest - die Datei mit dem Manifest.

Throws:

java.lang.Exception

Manifest

public Manifest(java.io.InputStream manifest)
         throws java.lang.Exception

ct.

Parameters:

manifest - InputStream mit dem Manifest.

Throws:

java.lang.Exception

Method Detail

getPluginDir

public java.lang.String getPluginDir()

Liefert das Verzeichnis, in dem sich das Plugin befindet.

Returns:

das Installations-Verzeichnis.

getVersion

public Version getVersion()

Liefert die Versionsnummer.

Returns:

Versionsnummer.

getBuildnumber

public final java.lang.String getBuildnumber()

Liefert die Build-Nummer, insofern sie ermittelbar ist. Da die Nummer nur im Manifest des Jars steht, kann sie nur dann ermittelt werden, wenn die Anwendung in ein solches deployed wurde und der entsprechende Parameter im Manifest des JARs existiert.

Returns:

Build-Number.

getBuildDate

public final java.lang.String getBuildDate()

Liefert das Build-Datum, insofern es ermittelbar ist. Da das Datum nur im Manifest des Jars steht, kann es nur dann ermittelt werden, wenn die Anwendung in ein solches deployed wurde und der entsprechende Parameter im Manifest des JARs existiert.

Returns:

Build-Datum.

getName

public java.lang.String getName()

Liefert den Namen der Komponente.

Returns:

Name.

getPluginClass

public java.lang.String getPluginClass()

Liefert den Klassen-Name des Plugins.

Returns:

Klassen-Name des Plugins.

isShared

public boolean isShared()

Liefert true, wenn das Plugin ueber den globalen Classloader von Jameica geladen werden soll.

Returns:

true, wenn es ueber den globalen Classloader geladen werden soll. Andernfalls erhaelt es einen exlusiven Classloader. Default: True

getDescription

public java.lang.String getDescription()

Liefert die Beschreibung der Komponente.

Returns:

Beschreibung.

getURL

public java.lang.String getURL()

Liefert die Download-URL der Komponente.

Returns:

Download-URL der Komponente.

getHomepage

public java.lang.String getHomepage()

Liefert die Homepage-URL der Komponente.

Returns:

Homepage-URL der Komponente.

getLicense

public java.lang.String getLicense()

Liefert die Lizenz der Komponente.

Returns:

Lizent.

getMenu

public MenuItem getMenu()

Liefert das Menu der Komponente.

Returns:

Menu.

getNavigation

public NavigationItem getNavigation()

Liefert die Navigation der Komponente.

Returns:

Menu.

getServices

public ServiceDescriptor[] getServices()

Liefert eine Liste von Service-Desktriptoren zu diesem Plugin.

Returns:

Liste aller Service-Deskriptoren aus der plugin.xml oder null wenn keine definiert sind.

getClassFinderIncludes

public java.lang.String[] getClassFinderIncludes()

Liefert eine Liste von Pfaden, die in den Classfinder aufgenommen werden sollen.

Returns:

Liste von Pfaden fuer den ClassFinder.

getExtensions

public ExtensionDescriptor[] getExtensions()

Liefert eine Liste von Extension-Desktriptoren zu diesem Plugin.

Returns:

Liste aller Extension-Deskriptoren aus der plugin.xml oder null wenn keine definiert sind.

getJameicaDependency

public Dependency getJameicaDependency()

Liefert die Versionsabhaengigkeit zu Jameica.

Returns:

Die Abhaengigkeit zu einer bestimmten Jameica-Version.

getDependencies

public Dependency[] getDependencies()

Liste der Plugins, von denen dieses hier abhaengig ist.

Returns:

Liefert eine Liste von Plugin-Namen, die installiert und initialisiert sein muessen, damit dieses Plugin geladen werden kann. Die Namen sind genau die Bezeichnungen, die in den anderen Plugins in

isInstalled

public boolean isInstalled()

Prueft, ob das Plugin initialisiert werden konnte.

Returns:

true, wenn es initialisiert werden konnte.

setInstalled

public void setInstalled(boolean b)

Legt fest, ob das Plugin als erfolgreich installiert gelten soll.

Parameters:

b -

compareTo

public int compareTo(java.lang.Object o)

Wir implementieren die Funktion, damit wir eine Liste von Manifesten nach Abhaengigkeit sortieren koennen.

Specified by:

compareTo in interface java.lang.Comparable

See Also:

Comparable.compareTo(java.lang.Object)