Thema dieser Dokumentation / Das FirstSpirit 5 Modul- / Komponenten-Modell / Der Komponenten-<components>-Deskriptor-Teil / Komponenten-Deskriptoren und spezielle Eigenschaften / Public
Public
Eine Public-Komponente (Schnittstelle/HotSpot) ist eine spezialisierte Klasse, die eine Schnittstelle der FirstSpirit-Access-API implementiert, für die kein spezialisierter Komponenten-Typ definiert wurde. Über die Public-Anweisungen des Moduls werden dem FirstSpirit-Server Klassen bekannt gemacht, die solche Schnittstellen implementieren. Diese Klassen müssen über Modul-Bibliotheken (siehe Bibliothek und Ressourcen) gefunden werden. Die Definition der Bibliothek kann auch innerhalb des gleichen Moduls erfolgen, welches die Public-Komponente definiert.
Listing: Public Komponenten-Deskriptor und Eigenschaften
<public>
<name>Beanshell</name>
<displayname>My Scripts</displayname>
<description>Beanshell Scripting engine.</description>
<class>de.espirit.firstspirit.server.script.BeanshellScriptEngine</class>
</public>
Eigenschaft | Beschreibung |
---|---|
<name> | Definiert den Namen, über den die Komponente in FirstSpirit als Public-Komponente erreichbar ist. |
<displayname> | Optionaler Anzeigename für die Komponente. Ist kein Anzeigename definiert, wird in allen FirstSpirit-Oberflächen der technische Name (<name>) der Komponente angezeigt. |
<class> | Klasse, die ein Interface der FirstSpirit-Access-API implementiert. |
<configurable> | Optional. Definition der Konfigurationsoberflächen-Klasse. Ist dieses Element nicht definiert, stellt die Komponente im FirstSpirit ServerManager keine Konfigurations-GUI zur Verfügung – der „Konfigurieren“-Button im ServerManager ist deaktiviert. |
Wobei hier die Klasse BeanshellScriptEngine das Interface ScriptEngine implementiert. Eine mögliche Kombination einer Service- und einer Public-Komponente definiert sich im Modul-Deskriptor wie in Vollständiger Modul-Deskriptor mit Drei Komponenten-Typen zu sehen.
Public-Komponenten benötigen zwingend einen parameterlosen Konstruktor. |