Thema dieser Dokumentation / Das FirstSpirit 5 Modul- / Komponenten-Modell / Der Komponenten-<components>-Deskriptor-Teil / Komponenten-Deskriptoren und spezielle Eigenschaften / Webanwendung

Webanwendung

Eine Webanwendung definiert JSP-Tags und Servlets, die innerhalb eines Projekts verwendet und aufgerufen werden können (siehe Webanwendung). Eine Webanwendung leitet sich von AbstractWebApp ab. Eine Konfigurationsmaske für die Webanwendung kann über die Implementierung von Configuration<WebEnvironment> erfolgen.

<web-app xml-schema-version="6.0">
<name>My WebApp</name>
<displayname>My Web Application</displayname>
<description>Longer description of the webapp</description>
<class>de.espirit.firstspirit.opt.examples.WebApp</class>
<configurable>
de.espirit.firstspirit.opt.examples.WebAppConfiguration
</configurable>
<web-xml>web.xml</web-xml>
<resources>
<resource>lib/webapp-example.jar</resource>
</resources>
<web-resources>
<resource>HelloWorld.tld</resource>
<resource>configuration.properties</resource>
<resource>lib/webapp-example-webapp.jar</resource>
</web-resources>
</web-app>

Eigenschaft

Beschreibung

<web-app>
Mandatory

Der Container der obersten Ebene.
Attribute

<name>
Mandatory

Definiert den Namen, über den die Komponente in FirstSpirit als Projekt-Komponente erreichbar ist und in der Liste der zugehörigen Komponenten des Moduls erscheint.

<displayname>

Optionaler Anzeigename für die Komponente. Ist kein Anzeigename definiert, wird in allen FirstSpirit-Oberflächen der technische Name (<name>) der Komponente angezeigt.

<description>

Aussagekräftige Beschreibung des Moduls und dessen Funktionalität

<class>
Mandatory

Klasse, die die abstrakte Klasse de.espirit.firstspirit.module.AbstractWebApp implementiert.
Konkret: WebApp extends AbstractWebApp

<web-xml>
Mandatory

Pfad zur web.xml innerhalb der Modulstruktur.

<configurable>

Definition der Konfigurationsoberflächen-Klasse. Ist dieses Element nicht definiert, stellt die Webanwendung im FirstSpirit ServerManager kein Konfiguration-GUI zur Verfügung – der „Konfigurieren“-Button im ServerManager ist deaktiviert. Die Konfigurationsklasse muss das typisierte Interface de.espirit.firstspirit.module.Configuration<WebEnvironment> implementieren.
Konkret: WebAppConfiguration implements Configuration<WebEnvironment>

<resource>
Mandatory

Definition der eigenen Ressourcen. Jede Webanwendung muss zwingend seine “eigenen” Klassen als Ressourcen in Form eines JARs enthalten.

  • lib/webapp-example.jar


Attribute

  • version Aktuelle Version der Ressource (optional)
  • minVersion Minimal kompatible Version der Ressource (optional)
  • maxVersion Maximal kompatible Version der Ressource (optional)
  • Innerhalb des <web-resources>-Blocks:
    target Zielverzeichnis, an der die Ressourcendatei in der automatisch erzeugten WAR-Datei abgelegt werden soll (optional, standardmässig wird /WEB-INF angenommen)

<web-resources>

Enthält alle Ressourcen, die auf dem Webserver zur Verfügung stehen müssen. Diese werden in die vom FirstSpirit-Server erzeugte WAR-Datei übernommen.

  • lib/webapp-example-webapp.jar
  • HelloWorld.tld
  • configuration.properties

  

© 2005 - 2024 Crownpeak Technology GmbH | Alle Rechte vorbehalten. | FirstSpirit 2024.12 | Datenschutz