Class Manifest
- All Implemented Interfaces:
Comparable
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Prueft, ob das Plugin installiert werden kann.void
canDeploy
(boolean checkDeps) Prueft, ob das Plugin installiert werden kann.int
Wir implementieren die Funktion, damit wir eine Liste von Manifesten nach Abhaengigkeit sortieren koennen.final String
Liefert das Build-Datum, insofern es ermittelbar ist.final String
Liefert die Build-Nummer, insofern sie ermittelbar ist.String[]
Liefert eine Liste von Pfaden, die in den Classfinder aufgenommen werden sollen.de.willuhn.util.MultipleClassLoader
Liefert den Classloader, mit dem das Plugin geladen wurde.Liste der Plugins, von denen dieses hier direkt oder indirekt abhaengig ist.Liefert die Beschreibung der Komponente.Liste der Plugins, von denen dieses hier direkt abhaengig ist.Liefert eine Liste von Extension-Desktriptoren zu diesem Plugin.Liefert die Homepage-URL der Komponente.getIcon()
Liefert das Icon des Plugins.Liefert die Versionsabhaengigkeit zu Jameica.Liefert die Lizenz der Komponente.getMenu()
Liefert das Menu der Komponente.Liefert eine Liste von Consumer-Desktriptoren zu diesem Plugin.Liefert eine Liste von Messages, die automatisch beim Start versendet werden sollen.getName()
Liefert den Namen der Komponente.Liefert die Navigation der Komponente.Liefert den Klassen-Name des Plugins.Liefert das Verzeichnis, in dem sich das Plugin befindet.Liefert den Identifier des Plugins, idealerweise ist dieser eindeutig.Liefert die Art der Plugin-Quelle, aus der das Plugin stammt.Liefert eine Liste von Service-Desktriptoren zu diesem Plugin.getURL()
Liefert die Download-URL der Komponente.Liefert die Versionsnummer.boolean
Prueft, ob das Plugin initialisiert werden konnte.boolean
isLoaded()
Prueft, ob das Plugin geladen werden konnte.boolean
isShared()
Liefert zurueck, ob das Plugin ueber den globalen Classloader von Jameica geladen werden soll.boolean
Pruefe, ob es sich um das Manifest von Jameica selbst handelt (und somit kein Plugin-Manifest).void
setInstalled
(boolean b) Legt fest, ob das Plugin als erfolgreich installiert gelten soll.void
Legt die Art der Plugin-Quelle fest, aus der das Plugin stammt.boolean
Liefert true, wenn die Homepage bei Updates geprüft werden soll.
-
Constructor Details
-
Method Details
-
getPluginDir
Liefert das Verzeichnis, in dem sich das Plugin befindet.- Returns:
- das Installations-Verzeichnis.
-
getVersion
Liefert die Versionsnummer.- Returns:
- Versionsnummer.
-
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
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
Liefert den Namen der Komponente.- Returns:
- Name.
-
getPluginClass
Liefert den Klassen-Name des Plugins.- Returns:
- Klassen-Name des Plugins oder vom
PlaceholderPlugin
, wenn keines angegeben ist.
-
getPluginId
Liefert den Identifier des Plugins, idealerweise ist dieser eindeutig. Im Allgemeinen entspricht das dem Klassen-Namen. Im Falle einerProxy
Instanz, wird der Namen der Komponente zurueck gegeben.- Returns:
- Klassen-Name des Plugins oder Namen der Komponente.
-
isSystemManifest
public boolean isSystemManifest()Pruefe, ob es sich um das Manifest von Jameica selbst handelt (und somit kein Plugin-Manifest).- Returns:
true
, wenn es kein gewoehnliches Plugin-Manifest ist sondern das Manifest von Jameica selbst.
-
getDescription
Liefert die Beschreibung der Komponente.- Returns:
- Beschreibung.
-
getURL
Liefert die Download-URL der Komponente.- Returns:
- Download-URL der Komponente.
-
getHomepage
Liefert die Homepage-URL der Komponente.- Returns:
- Homepage-URL der Komponente.
-
validateHomepage
public boolean validateHomepage()Liefert true, wenn die Homepage bei Updates geprüft werden soll. Updates des Plugins werden in dem Fall nur dann durchgeführt, wenn sie vom selben Server kommen, der auch als Homepage angegeben ist.- Returns:
- true, wenn die Homepage bei Updates geprüft werden soll.
-
getLicense
Liefert die Lizenz der Komponente.- Returns:
- Lizenz.
-
getIcon
Liefert das Icon des Plugins. Sollte 64x64 Pixel gross sein.- Returns:
- das Icon oder
null
, wenn keines definiert ist.
-
getMenu
Liefert das Menu der Komponente.- Returns:
- Menu.
-
getServices
Liefert eine Liste von Service-Desktriptoren zu diesem Plugin.- Returns:
- Liste aller Service-Deskriptoren aus der plugins.xml oder
null
wenn keine definiert sind.
-
getClassFinderIncludes
Liefert eine Liste von Pfaden, die in den Classfinder aufgenommen werden sollen.- Returns:
- Liste von Pfaden fuer den ClassFinder.
-
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.
-
getMessageConsumers
Liefert eine Liste von Consumer-Desktriptoren zu diesem Plugin.- Returns:
- Liste aller Consumer-Deskriptoren aus der plugin.xml oder
null
wenn keine definiert sind.
-
getMessages
Liefert eine Liste von Messages, die automatisch beim Start versendet werden sollen.- Returns:
- Liste aller Messages oder
null
wenn keine definiert sind.
-
getJameicaDependency
Liefert die Versionsabhaengigkeit zu Jameica.- Returns:
- Die Abhaengigkeit zu einer bestimmten Jameica-Version.
-
getDirectDependencies
Liste der Plugins, von denen dieses hier direkt abhaengig ist.Es werden also nur die direkt abhaengigen Plugins geliefert, nicht jedoch die indirekten Abhaengigkeiten. Wenn die komplette Liste der Abhaengigkeiten ermittelt werden soll (also incl. indirekter Abhaengigkeiten), dann muss
getDependencies()
verwendet werden.- Returns:
- Liste von Abhaengigkeiten fuer dieses Plugin.
Die Funktion liefert nie
null
sondern hoechstens ein leeres Array.
-
getDependencies
Liste der Plugins, von denen dieses hier direkt oder indirekt abhaengig ist.Es werden also nicht nur die direkt abhaengigen Plugins geliefert, sondern auch alle Plugins, die von diesen wiederum benoetigt werden. Wenn nur die einfache Liste der Abhaengigkeiten ermittelt werden soll (also ohne indirekte Abhaengigkeiten), dann muss
getDirectDependencies()
verwendet werden.- Returns:
- Liste von Abhaengigkeiten fuer dieses Plugin.
Die Funktion liefert nie
null
sondern hoechstens ein leeres Array.
-
canDeploy
public void canDeploy() throws de.willuhn.util.ApplicationExceptionPrueft, ob das Plugin installiert werden kann.Konkret wird hier geprueft:
- Ist die richtige Jameica-Version installiert?
- Sind die Abhaengigkeiten zu anderen Plugins erfuellt?
- Ist das Plugin ggf. schon installiert und wenn ja ...
- ... kann es ueberschrieben werden?
- ... ist die installierte Version nicht neuer als die zu installierende?
- Throws:
de.willuhn.util.ApplicationException
- wenn das Plugin nicht installiert werden kann.- See Also:
-
canDeploy
public void canDeploy(boolean checkDeps) throws de.willuhn.util.ApplicationException Prueft, ob das Plugin installiert werden kann.Konkret wird hier geprueft:
- Ist die richtige Jameica-Version installiert?
- Sind die Abhaengigkeiten zu anderen Plugins erfuellt?
- Ist das Plugin ggf. schon installiert und wenn ja ...
- ... kann es ueberschrieben werden?
- ... ist die installierte Version nicht neuer als die zu installierende?
- Parameters:
checkDeps
-true
, wenn die Abhaengigkeiten zu anderen Plugins geprueft werden sollen.- Throws:
de.willuhn.util.ApplicationException
- wenn das Plugin nicht installiert werden kann.- See Also:
-
setPluginSource
Legt die Art der Plugin-Quelle fest, aus der das Plugin stammt.- Parameters:
type
- die Art der Plugin-Quelle.
-
getPluginSource
Liefert die Art der Plugin-Quelle, aus der das Plugin stammt.- Returns:
- die Art der Plugin-Quelle, aus der das Plugin stammt.
-
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
-
-
isLoaded
public boolean isLoaded()Prueft, ob das Plugin geladen werden konnte.- Returns:
true
, wenn es geladen werden konnte.
-
getClassLoader
public de.willuhn.util.MultipleClassLoader getClassLoader()Liefert den Classloader, mit dem das Plugin geladen wurde.- Returns:
- der Classloader des Plugins.
-
compareTo
Wir implementieren die Funktion, damit wir eine Liste von Manifesten nach Abhaengigkeit sortieren koennen.- Specified by:
compareTo
in interfaceComparable
- See Also:
-