Quickstart. Quickstart. Anleitung zum schnellen Einstieg in JEAF Version 1.1 Letzte Änderung 15. März Projekt JEAF Framework

Transkript

1 Quickstart Thema Anleitung zum schnellen Einstieg in JEAF Version 1.1 Letzte Änderung 15. März 2011 Status Freigegeben 2011

2 Inhaltsverzeichnis 1 Motivation Abgrenzungen Aufbau JEAF Plattform JEAF Development Plattform Beispielprojekt JEAF Accounting Sample Voraussetzungen Aufbau des Beispielprojekts... 8 Seite 2 von Einrichten des Beispielprojekts Neuen Workspace erstellen Import in Eclipse Workspace Anpassen des Eclipse Classpath an die lokale Installation Einrichten der Datenbank Verbindung Ausführen der Beispielanwendung Ablauf der Software-Entwicklung mit JEAF Modellierung mit MagicDraw UML XMI Export aus MagicDraw und Alternative mit vorliegenden XMI Dateien Ausführung des JEAF Generator Erzeugen des Datenbank Schema Implementierung von Komponenten, Services und Business Objekten Ausführen des Message Generators Ausführen der Beispielanwendung unter JBoss Konfiguration von JBoss 5.1.x und 6.0.x Neue JBoss Server Konfiguration einrichten JDBC Treiber installieren Datasource konfigurieren EJB Timer Service konfigurieren

3 5.1.5 System Properties konfigurieren JEAF Login Modul konfigurieren Ausführen der Beispielapplikation mit JBoss Build & Deployment Ausführen der JEE Beispielapplikation JEAF Management Web Application Weiteres Vorgehen Seite 3 von

4 Referenzierte Dokumente Dokument [JEAF Architektur] [JEAF Modellierungsrichtlinien] [JEAF Developer Guide] [JEAF Installation Guide] [JEAF Properties] [JEAF Wiki] Beschreibung Beschreibung des Architekturmodells von JEAF und dessen konkrete Umsetzung durch das Richtlinien zur UML Modellierung mit der JEAF Plattform Der JEAF Developer Guide liegt nicht als einzelnes Dokument vor, sondern wird über das Wiki zur anaptecs JEAF Plattform in Form von How-To s zur Verfügung gestellt. Dies ermöglicht das schnelle Auffinden der gesuchten Information und sichert die Aktualität. Installationsanleitung zu JEAF Dokumentation der Properties von JEAF Wiki zur anaptecs JEAF Plattform Seite 4 von

5 1 Motivation Dieses Dokument dient als Anleitung für den schnellen Einstieg in die Verwendung von JEAF und nutzt hierfür das im Auslieferungspaket enthaltene Beispielprojekt JEAF Accounting Sample. Das vorliegende Dokument bezieht sich auf die Version 1.1 von JEAF. 1.1 Abgrenzungen Das vorliegende Dokument hat nicht zum Ziel, eine allumfassende Dokumentation zu JEAF zu sein. Vielmehr handelt es sich um eine erste Einleitung. Für weitere Details wird daher insbesondere auf die Dokumente [JEAF Architektur] und [JEAF Modellierungsrichtlinien] verwiesen. Seite 5 von

6 2 Aufbau JEAF Plattform Im Folgenden soll die Installation von JEAF beschrieben werden. 2.1 JEAF Development Plattform 2.2 Die nachfolgende Tabelle beschreibt die Verzeichnisstruktur der JEAF Installation. Verzeichnis (Basis %DEVELOPMENT_HOME%) %./anaptecs/jeaf/1.1.0.x bin data docs jar api model MagicDrawUML xmi sample tests Beschreibung Basisverzeichnis der JEAF Installation. Dieses wird im Folgenden als JEAF_HOME bezeichnet. Verzeichnis enthält alle Skripte zum Starten der ausführbaren Programme von JEAF Verzeichnis enthält alle Datenfiles, die für die Verwendung von JEAF benötigt werden. Dies sind z. B. die XML- Datei mit allen Authorization-Types oder den Propertydefinitionen von Komponenten Verzeichnis enthält die Dokumentation zu JEAF. Weitere Dokumente befinden sich im [JEAF Wiki]. Javadoc API zu JEAF Auslieferungsartefakte des s MagicDraw UML e, die für die Modellierung auf Basis von JEAF benötigt werden MagicDraw UML XMI Export der für den JEAF Generator benötigten Modellbestandteile Beispiel Entwicklungsprojekt bestehend aus einem UML Modell und dem entsprechenden Source-Code JUnit Tests zum JEAF Seite 6 von 28 Abbildung 1: : Verzeichnisse der JEAF Installation JEAF eigene Archive Die JEAF eigenen Auslieferungsartefakte befinden sich im Verzeichnis JEAF_HOME/jar. Das Verzeichnis beinhaltet neben dem übersetzen Code in JAR Archiven auch die zugehörigen Sourcen von JEAF. Artefakt jeaf-core.jar Beschreibung JEAF Core enthält all diejenigen Basisdienste des Frameworks, die auch in reinen JSE Umgebungen eingesetzt werden können. Darüber hinaus werden 2011

7 jeaf-ejb.jar jeaf-ejb-client.jar jeaf-junitextensions.jar jeaf-generator.jar jeaf-init-web.war jeaf-services.jar jeaf-components.jar jeaf-spi.jar jeaf-serviceproviders.jar jeaf-managementweb.war jeaf-tools.jar die Schnittstellen für allgemeine Dienste definiert, die für unterschiedliche Laufzeitumgebungen unterschiedliche Implementierungen bedingen können. EJB spezifische Erweiterungen und Implementierungen von JEAF, die speziell für die Ausführung in einem EJB Container entwickelt wurden. Alle Interfaces und Klassen, die benötigt werden, um auf JEAF-basierte Services zuzugreifen, die in einem EJB Container ausgeführt werden. JEAF JUnit Extensions umfasst alle Klassen, die bei der Erstellung von JUnit Tests im JEAF Umfeld die Arbeit erleichtern. JEAF Generator unterstützt die Umsetzung eines MDA-basierten Entwicklungsprozesses, indem die Generierung von Komponenten, Services und Business Objekten aus UML Modellen ermöglicht wird. Hierbei handelt es sich um ein spezielles Archiv, das für die Initialisierung von JEAF in JEE Kontext zwingend benötigt wird und daher in jede JEAF JEE Applikation eingebunden wird. Das JAR umfasst die Schnittstellen (Interfaces und Service Objekte) aller Services die standardmäßig durch JEAF angeboten werden. Hierbei handelt es sich um die Services, die im Lieferumfang der JEAF Components enthalten sind. Die zugehörigen Implementierungen der Services sind im JAR jeafcomponents.jar. Das JAR beinhaltet die Implementierung der Services aus JEAF Services. Das JAR umfasst die Schnittstellen aller durch JEAF standardmäßig angebotenen Service Provider. Die zugehörigen Implementierungen befinden sich im JAR jeaf-service-providers.jar. Das JAR beinhaltet die Implementierung der Service Provider aus JEAF Service Provider Interfaces (jeaf-spi.jar). JEAF Management Web ist eine spezielle Web Applikation von JEAF, die zur Laufzeit die Überwachung von Komponenten und Services, sowie Anpassungen an deren Konfiguration ermöglicht. JEAF Tools enthält weitere Entwicklungswerkzeuge, welche die Entwicklung beim Einsatz von JEAF weiter vereinfachen. Seite 7 von 28 Abbildung 2: : Libraries von JEAF 2011

8 3 Beispielprojekt JEAF Accounting Sample Im Lieferumfang von JEAF ist das Beispielprojekt JEAF Accounting Sample enthalten. Das bereits lauffähige befindet sich unterhalb des Installationsverzeichnisses im Verzeichnis sample. Das Beispielprojekt implementiert eine Kontoverwaltung einer Bank und verdeutlicht die verschiedenen Schritte bei der Entwicklung mit JEAF. 3.1 Voraussetzungen Grundsätzlich sind die Anforderungen von JEAF an seine Umgebung sehr gering. So benötigt JEAF z.b. nicht zwingend einen JEE Application Server. Für einfache Applikationen bzw. zum einfachen Testen reicht eine JSE Umgebung (JDK 1.5 oder höher) vollkommen aus. Alle benötigten externen Bibliotheken sind bereits im Lieferumfang enthalten und befinden sich in den Unterverzeichnissen von DEVELOPMENT_HOME. Da die Beispielanwendung auch den Umgang mit persistenten Klassen demonstriert, wird zusätzlich noch Zugriff auf eine relationale Datenbank benötigt. Die Umgebungsvariable DEVELOPMENT_HOME muss gesetzt sein (siehe [JEAF Installation Guide]). Seite 8 von Aufbau des Beispielprojekts Die folgende Tabelle beschreibt die Bestandteile des JEAF Accounting Sample s. Verzeichnis classes jee-conf model res res-gen sql src src-gen xmi Beschreibung Output Verzeichnis für Eclipse. In dieses Verzeichnis werden beim Build von Eclipse alle Dateien geschrieben. Verzeichnis enthält JEAF-spezifische Konfigurationsdateien, die speziell für den Einsatz von JEAF im JEE Umfeld benötigt werden. Verzeichnis enthält das MagicDraw UML für das Beispiel. Das UML Modell kann mit dem Modellierungswerkzeug MagicDraw geöffnet und editiert werden. Darüber hinaus befindet sich im Archiv JEAF_Accounting_Sample_UML_Export.zip ein HTML Export des UML Modells, so dass das UML Modell auch ohne Modellierungswerkzeug betrachtet werden kann. Verzeichnis enthält alle Ressourcen, die während der Entwicklung manuell editiert werden. Verzeichnis enthält alle Ressourcen, die durch Generatoren erzeugt werden. Verzeichnis enthält alle SQL Skripte (Schema und Daten) des Beispiel s. Verzeichnis enthält den Source Code des Beispiel s, der im Rahmen der Entwicklung manuell erstellt wird. Verzeichnis enthält den Source Code, der durch den JEAF Generator erzeugt wird. Verzeichnis enthält die Beschreibung des UML s als XMI Dateien. Diese Dateien dienen als Input für den JEAF Generator und können durch einen Export aus MagicDraw UML erzeugt werden. Abbildung 3: : Verzeichnisse des Beispielprojekts 2011

9 3.3 Einrichten des Beispielprojekts Das im Auslieferungsumfang enthaltene Eclipse ist bereits vorkonfiguriert. Damit das mit der lokalen JEAF Installation auch tatsächlich verwendet werden kann, sind folgende Schritte notwendig: Neuen Workspace erstellen Import in Eclipse Workspace Anpassen des Eclipse Classpath an die lokale Installation Einrichten der Datenbank Verbindung Neuen Workspace erstellen Achtung: Die im Folgenden beschriebenen Schritte zur Einrichtung eines Workspace gelten nur bei einer Komplettinstallation der JEAF Plattform. Für Benutzer der JEAF Test- und Evaluierungsversion sind die nachfolgenden Schritte nicht notwendig. Hier kann direkt beim Punkt fortgefahren werden, indem entweder ein bestehender oder ein neuer Eclipse Workspace verwendet wird. Seite 9 von 28 Im Lieferumfang von JEAF ist bereits ein Default-Workspace enthalten. Dieser beinhaltet sämtliche Einstellungen, wie sie durch die JEAF Plattform vorgegebenen werden und enthält bereits so genannte User Libraries für alle mitgelieferten Bibliotheken. Zum Aufsetzen eines neuen s kann dieser einfach an die entsprechende Stelle kopiert werden. Alternativ dazu kann natürlich auch ein neuer leerer Workspace angelegt werden. In diesem Fall empfiehlt es sich die User Libraries zu importieren. Das entsprechende Inputfile mit den Definitionen befindet sich unter DEVELOPMENT_HOME\anaptecs\JEAF Development Platform\config\eclipse_libs.userlibraries Import in Eclipse Workspace Die Screenshots aus Abbildung 4 zeigen die notwendigen Schritte zum Import eines bestehenden s in einen Eclipse Workspace. Das umfasst neben den Standard einstellungen u. a. auch Start-Konfigurationen zum Starten der Beispielanwendung, des JEAF Generators und Message Generators sowie zum Erzeugen des Datenbank-Schemas. 2011

10 Seite 10 von 28 Abbildung 4: : Importieren des Beispielprojekts in Eclipse Achtung: Die mitgelieferte Beispielanwendung kann zu diesem Zeitpunkt noch nicht ausgeführt werden, da das noch nicht an die lokale JEAF Installation angepasst wurde. Dazu müssen zuerst noch die Schritte, die in den Abschnitten und beschrieben sind, ausgeführt werden Anpassen des Eclipse Classpath an die lokale Installation Wie bereits beschrieben ist das Eclipse zum aktuellen Zeitpunkt noch nicht lauffähig und weist Buildpath Probleme auf. Diese hängen damit zusammen, dass die Pfade in Eclipse, welche 2011

11 externe Bibliotheken referenzieren, stets absolut angegeben werden müssen. Daher ist das mitgelieferte erst noch an die lokale JEAF Installation anzupassen. Dies kann entweder manuell erfolgen, in dem mit Eclipse Bordmitteln der Classpath entsprechend korrigiert wird oder aber durch ein mitgeliefertes Ant-Skript, das einmalig ausgeführt wird. Dieses ist in seiner Anwendung, wie Abbildung 5 entnommen werden kann, denkbar einfach. Das Skript Prepare Local Workspace.xml muss lediglich über sein Kontextmenü Run as Ant Build ausgeführt werden. Nach einem anschließenden Refresh des s sind die Buildpath Probleme behoben. Alternativ dazu kann auch die bereits eingerichtete Run Configuration für das Ant-Skript verwendet werden (siehe Abbildung 5). Seite 11 von 28 Abbildung 5: : Ausführen des Ant Skripts zur Classpath Korrektur Einrichten der Datenbank Verbindung Da die mitgelieferte Beispielanwendung neben der Verwendung von Services auch die Persistenz Anbindung von JEAF demonstriert, ist darüber hinaus noch einen entsprechende Datenbank Verbindung einzurichten. Die JEAF Development Plattform definiert für die lokale Entwicklung MySQL als Datenbank. Daher gehen die mitgelieferten Konfigurationen und SQL-Skripte von einer lokal installierten MySQL Datenbank aus, die unter der URL jdbc:mysql://localhost:3306/jeaf erreichbar ist. 2011

12 Sollte dies nicht der Fall sein, so sind die folgenden Dateien anzupassen: res/meta-inf/persistence.xml Diese enthält die JDBC Treiber Einstellungen für die JSE Variante der Beispielapplikation jee-conf/persistence.xml Diese enthält die JDBC Treiber Einstellungen für die JEE Variante der Beispielapplikation DEVELOPMENT_HOME/anaptecs/JEAF/1.1.0.x/res In diesem Verzeichnis befinden sich die Property Dateien die durch das Authorization Import Tool und den Dynamic Properties Importer verwendet werden. Da auch diese beiden Tools auf die Datenbank zugreifen (siehe unten) muss auch hier die Datenbankverbindung entsprechend angepasst werden. Nachdem, sofern notwendig, die Anpassungen an den Konfigurationsdateien vorgenommen wurden, kann nun die Datenbank entsprechend aufgesetzt werden. Dazu wird das Ant-Skript Setup Sample Database.xml zur Verfügung gestellt. Dieses erzeugt einerseits die notwendigen Tabellen in der Datenbank und importiert zusätzlich die so genannten Competence Types und Dynamic Properties, für die mitgelieferten JEAF Standard Komponenten (die entsprechenden Dateien für den Import befinden sich im Verzeichnis data der JEAF Installation und unter resgen im verzeichnis). Das Ant-Skript kann über das Kontextmenü Run As Ant Build oder über die Run Configuration Setup Sample Database ausgeführt werden. Danach ist das Einrichten der Datenbankverbindung abgeschlossen (siehe auch Abbildung 6). Seite 12 von 28 Abbildung 6: : Ausführen des Ant-Skripts zum Aufsetzen der Datenbank 3.4 Ausführen der Beispielanwendung Die mitgelieferte Beispielapplikation kann in 2 Varianten ausgeführt werden, zum einen als JSE und zum anderen als JEE Variante. Zunächst einmal soll im Folgenden die JSE Variante beschrieben werden. In dieser Variante nutzt die Beispielapplikation lokale Services und Komponenten und greift mit Hilfe des Persis- 2011

13 tence Service Providers von JEAF (und Hibernate) auf die Datenbank zu. Wie Abbildung 7 entnommen werden kann, greif die Beispielapplikation direkt nur auf den AccoutingService und den AccountingBasicDataService zu. Darüber hinaus wird beim Starten der Applikation implizit das JEAF JSE Loginmodul zur Anmeldung verwendet. Seite 13 von 28 Abbildung 7: : Aufbau der Beispielapplikation in der JSE Variante Die Main Klasse für die Ausführung der JEAF Beispielanwendung ist com.anaptecs.jeaf.accounting.jeafsample. Die JSE Variante der Beispielapplikation kann über die mitgelieferte Run Configuration JEAF Sample gestartet werden. Beim Starten der Applikation wird über das Systemproperty jeaf.properties der Name der Property Datei mit den JEAF Konfigurationseinstellungen übergeben. Im konkreten Fall ist dies die Datei jeaf_hibernate, die sich im Verzeichnis res des Beispielprojekts befindet. Darüber hinaus wird über das Systemproperty java.security.auth.login.config definiert, dass die JAAS Konfiguration aus der Datei 2011

14 jeaf_login_module_local.conf gelesen werden soll. Dies führt dazu, dass das JEAF JAAS Loginmodul für JSE verwendet wird. Seite 14 von 28 Abbildung 8: : Run Configuration für die JEAF Beispielanwendung Die Klasse JEAFSample besteht im Wesentlichen aus der Methode runaccountingsample(). Diese enthält den Beispiel Source Code zur Verwendung des Accounting Service. Die Implementierung eines JEAF Service kann der Klasse AccountingServiceImpl aus dem Package com.anaptecs.jeaf.accounting.impl entnommen werden (siehe auch 4.4 Erzeugen des Datenbank Schemas). Weitere Details befinden sich darüber hinaus als Kommentare im Source Code der genannten Klassen und im [JEAF Developer Guide] und [JEAF Architektur]. 2011

15 4 Ablauf der Software-Entwicklung mit JEAF Generell kommt bei der Entwicklung mit JEAF ein so genannter generativer Entwicklungsprozess zum Einsatz. Dieser besteht aus den folgenden Schritten, die in den direkt darauf folgenden Abschnitten kurz erklärt werden: 1. Modellierung in MagicDraw UML 2. XMI Export des UML Modells 3. Ausführen des JEAF Generator 4. Erzeugen des Datenbank Schemas 5. Implementierung von Komponenten, Services und Business Objekten 4.1 Modellierung mit MagicDraw UML Im Installationspaket von JEAF ist u. a. auch ein UML Beispielprojekt enthalten. Dieses basiert auf dem Modellierungswerkzeug MagicDraw UML 16.8 ( und befindet sich im Verzeichnis JEAF_HOME/sample/model/JEAF_Sample.mdzip. Alternativ dazu kann auch der ebenfalls mitgelieferte HTML Export zu Studienzwecken verwendet werden. Seite 15 von 28 Abbildung 9: : Komponentenmodell ntenmodell des Beispielprojekts Abbildung 9 zeigt das Komponentenmodell des Beispielprojekts. Das Komponentenmodell beschreibt das System auf dem obersten Abstraktionsniveau. Darüber hinaus umfasst das UML Modell eine Definition der Service Schnittstellen und des Domänenmodells der Accounting Komponente. Die zugehörigen Diagramme befinden sich im UML Modell in den in Abbildung 10 rot umrandeten Diagrammen. 2011

16 Seite 16 von 28 Abbildung 10: : UML Modell des JEAF Accounting Sample Eine Beschreibung wie die Modellierung mit MagicDraw für JEAF zu erfolgen hat, befindet ich im Dokument [JEAF Modellierungsrichtlinien]. 4.2 XMI Export aus MagicDraw und Alternative mit vorliegenden XMI Dateien Der Export des UML Modells nach XMI ist denkbar einfach. Dazu ist im Menü von MagicDraw UML nach Auswahl von File Export Eclipse UML2 (v1.x) XMI das Verzeichnis auszuwählen, in welches das UML Modell exportiert werden soll. Zur Vereinfachung der ersten Schritte wurde vom mitgelieferten bereits ein XMI Export durchgeführt. Die dabei erzeugten Dateien befinden sich unter JEAF_HOME/sample/xmi. 2011

17 Seite 17 von 28 Abbildung 11: : XMI Export mit MagicDraw UML 4.3 Ausführung des JEAF Generator Der JEAF Generator erzeugt aus den Daten des UML Modells entsprechenden JEAF spezifischen Code für die Implementierung von Komponenten und Services. Darüber hinaus werden auch aus XML-Dateien mit Meldungstexten die entsprechenden Konstanten erzeugt. Das Starten des JEAF Generators ist gemäß folgendem Aufrufschema möglich: JEAF_Generator.bat "propertyfile" Abbildung 12 zeigt die Konfigurationseinstellungen für den JEAF Generator wie sie für die mitgelieferte Beispielapplikation benötigt werden. 2011

18 Seite 18 von 28 Abbildung 12: : Konfigurationseinstellungen für den JEAF Generator Übertragen auf das mitgelieferte Beispielprojekt muss der JEAF Generator mit folgenden Parametern aufgerufen werden:.\bin\jeaf_generator.bat jeaf-generator-samples.properties Alternativ kann auch die Run Configuration JEAF Generator, die im Eclipse enthalten ist, aufgerufen werden. Diese startet das Ant-Skript run-generator.xml, das im Verzeichnis 2011

19 JEAF_HOME\bin enthalten ist und den JEAF Generator ausführt. Auch hier erfolgt die Konfiguration über das entsprechende Propertyfile. Seite 19 von 28 Abbildung 13: : Run Configuration zum Starten des JEAF Generator 4.4 Erzeugen des Datenbank Schema Das Erzeugen des Datenbank Schemas erfolgt durch ein im Lieferumfang von Hibernate enthaltenes Tool, welches das DB-Schema aufgrund der Mapping Definitionen (*.hbm.xml) erzeugt. Ein entsprechende Start-Konfiguration ist im mitgelieferten Eclipse unter dem Name Generate DB Schema ebenfalls bereits eingerichtet. Die erzeugten SQL Dateien werden in die Datei./sql/accounting-schema.sql geschrieben. Ferner ist wichtig zu wissen, dass Hibernate die Information für welche Klassen das DB-Schema generiert werden soll, aus der Datei hibernate.cfg.xml liest. Nur *.hbm.xml Dateien, die in dieser Datei eingetragen sind, werden bei der Generierung berücksichtigt. Abbildung 14: : Run Configuration zum Erzeugen des Datenbank Schemas 2011

20 4.5 Implementierung von Komponenten, Services und Business Objekten Nachdem mit dem JEAF Generator für die im UML Modell beschriebenen Komponenten und Services der entsprechende Code generiert wurde. Muss nun noch die eigentliche Implementierung erfolgen. Hierzu hat der JEAF Generator bereits ein entsprechendes Gerüst erzeugt, das nun noch mit Leben gefüllt werden muss. Darüber hinaus hat der JEAF Generator Klassen und Interfaces erzeugt, die nicht mehr editiert werden müssen. Zur einfachen Unterscheidung, werden die entsprechenden Dateien, daher in unterschiedlichen Verzeichnissen abgelegt. Das Verzeichnis src-gen enthält all diejenigen Dateien, die vollständig generiert werden. src enthält all diejenigen Source Dateien, die noch mit Intelligenz angereichert werden müssen. Im Falle von Komponenten und Services bedeutet dies, dass durch den JEAF Generator bereits alle Framework-spezifischen Klassen generiert wurden und lediglich noch die Implementierung der Services von Hand erfolgen muss. Ein Beispiel hierfür ist die Klasse AccountingServiceImpl (Package com.anaptecs.jeaf.accounting.impl). Im Falle von Business Objekten wurden neben den Klassen inkl. set- und get- Methoden auch bereits die entsprechenden Hibernate Mapping Dateien für die Abbildung auf die Datenbank erzeugt. Hier müssen noch die fachlichen Methoden der Objekte implementiert werden. Exemplarisch hierfür steht die Methode calculatebalance( ) in der Klasse AccountBO aus dem Package com.anaptecs.jeaf.accounting.impl.domain. Seite 20 von Ausführen des Message Generators Neben dem JEAF Generator gibt es zusätzlich noch den so genannten Message Generator. Wie im Dokument [JEAF Architektur] beschrieben, ermöglicht JEAF die Definition von Error-Codes und Message-IDs in XML-Dateien. Damit auf diese im Code einfach zugegriffen werden kann, erzeugt der Message Generator aus diesen XML-Dateien Java Klassen mit einer Konstante für jede Message-ID und jeden Error-Code (siehe Abbildung 15). Abbildung 15: : XML-Datei mit Message-IDs aus dem Beispielprojekt 2011

21 Wie bereits kurz erwähnt wird bei der Ausführung des JEAF Generators stets implizit auch der Message Generator mit ausgeführt. Zusätzlich kann dieser auch eigenständig ausgeführt werden. Hierzu wird im Verzeichnis JEAF_HOME\bin das Skript Message_Generator.bat mitgeliefert, mit dessen Hilfe die Ausführung gemäß folgendem Aufruf Schema möglich ist: Message_Generator.bat "message resource(s)" "source dir" [excluded files] Die einzelnen Parameter haben dabei folgende Bedeutung: "message resources" Verzeichnis, in dem sich die Ressource Dateien mit den Messages befinden. "source dir" Verzeichnis, in welches der Generator die erzeugten Dateien schreiben soll. [excluded files] Liste mit Ressource Dateien, die bei der Generierung nicht beachtet werden sollen. Seite 21 von 28 Beispiel: Message_Generator.bat C:\Development\anaptecs\JEAF\1.1.0.x\sample res src-gen hibernate.cfg.xml 2011

22 5 Ausführen der Beispielanwendung unter JBoss Im Folgenden soll beschrieben werden, wie die JEAF Beispielapplikation unter JBoss ausgeführt werden kann und welche Konfigurationsschritte hierzu notwendig sind. 5.1 Konfiguration von JBoss 5.1.x und 6.0.x Eine Vorlage mit alle notwendigen Einstellungen befindet sich in der Datei JBoss_Configs.xml im Verzeichnis JEAF_HOME/bin. Die Beschreibungen gelten gleichermaßen für die JBoss Versionen 5.1.x und 6.0.x Neue JBoss Server Konfiguration einrichten Auf Basis der JBoss Standard Konfiguration erfolgen die spezifischen Einstellungen für die JEAF Beispielapplikation. Daher ist als erstes eine Kopie der Default Konfiguration im Verzeichnis JBOSS_HOME/server/default zu erstellen (z.b. nach JBOSS_HOME/server/jeaf). Alle im Folgenden beschriebenen Konfigurationsschritte erfolgen in diesem Verzeichnis. Das Verzeichnis der verwendeten Konfiguration wird im Folgenden als CONFIG_HOME bezeichnet. Seite 22 von JDBC Treiber installieren Damit von der Beispielapplikation aus Zugriffe auf die Datenbank möglich sind, muss der entsprechende JDBC Treiber installiert werden. Dies erfolgt durch das Kopieren der entsprechenden JAR-Dateien in das Verzeichnis CONFIG_HOME/lib. (z.b. mysql-connector-java bin.jar im Falle des MySQL JDBC Treibers) Datasource konfigurieren Damit aus der Beispielapplikation heraus der Datenbank-Zugriff tatsächlich möglich ist, muss neben der Installation des JDBC Treibers zusätzlich auch noch die entsprechende Datasource eingerichtet werden. Hierzu ist eine neue Datei mit dem Namen mysql-ds.xml im Verzeichnis CONFIG_HOME/deploy anzulegen, welche die Konfiguration aus Abbildung 16 enthält. Abbildung 16: : Beispiel für Konfiguration einer MySQL Datasource 2011

23 5.1.4 EJB Timer Service konfigurieren Für den in JEAF implementierten Scheduling Mechanismus muss die Konfiguration des EJB Timer Service angepasst werden. Da JEAF die entsprechenden Tasks in eigenen Datenbank Tabellen speichert, müssen die Tasks des EJB Timer Service nicht persistent sein. Abbildung 17 zeigt die Konfigurationseinstellungen, die in der Datei CONFIG_HOME/deploy/ejb2-timerservice.xml vorzunehmen sind. Seite 23 von 28 Abbildung 17: : Konfiguration des EJB Timer Service für JEAF System Properties konfigurieren JEAF selbst benötigt ein Minimum an Java System Properties. So lange in einer Application Server Instanz nur genau eine JEAF-basierte Applikation ausgeführt wird, können diese global (nicht EAR-spezifisch) über die Datei CONFIG_HOME/deploy/properties-service.xml wie in Abbildung 18 dargestellt, konfiguriert werden. Details zur Bedeutung der einzelnen Properties und ihre möglichen Werte können [JEAF Properties] entnommen werden. Abbildung 18: : Konfiguration der JEAF-spezifischen System Properties JEAF F Login Modul konfigurieren JEAF verfügt über ein eigenes JAAS kompatibles Login Modul, das Teil des JEAF Security- Konzepts ist. Dieses muss in der Datei CONFIG_HOME/conf/login-config.xml gemäß den Einstellungen aus Abbildung 19 konfiguriert werden. 2011

24 Seite 24 von 28 Abbildung 19: : Konfiguration des JEAF Login Moduls 2011

25 5.2 Ausführen der Beispielapplikation mit JBoss Wie bereits kurz beschrieben gibt es neben der JSE Variante der Beispielapplikation auch eine JEE Variante. Diese unterscheidet sich von der JSE Variante darin, dass die Accounting Komponente mit ihren Services nicht lokal sondern unter JBoss im EJB Container ausgeführt wird. Dadurch ergeben sich für die Applikation folgende Änderungen: Die Serviceaufrufe der Beispielapplikation müssen nun an den JEE Application Server gesendet werden. Der JAAS Login der Applikation erfolgt nun gegenüber dem Application Server Die oben genannten Änderungen können allesamt ohne Code-Änderungen an den bestehenden Komponenten und der Beispielapplikation erreicht werden. Hierzu ist lediglich eine andere JEAF Properties Datei und eine Anpassung an der JAAS Konfiguration notwendig. Die entsprechenden Änderungen sind in der Property Datei jeaf_demo_ear.properties im Verzeichnis res sowie in der JAAS Konfigurationsdatei jboss_login_module.conf enthalten. Seite 25 von Build & Deployment Damit die Komponenten der Beispielapplikation unter JBoss ausgeführt werden können müssen diese zu einem EAR paketiert werden. Das EAR umfasst neben den Komponenten der Beispielapplikation auch die notwendigen JEAF JAR-Dateien und die notwendigen Konfigurationsdateien (siehe Verzeichnis jee-config im Sample ). Der Build des jeaf-demo.ear kann über die Ant Run Configuration Build JEAF Demo EAR gestartet werden. Als nächstes muss das erzeugte EAR nun noch deployed werden. Dazu muss das EAR in das Verzeichnis CONFIG_HOME/deploy kopiert werden. Beim nächsten Start von JBoss wird das EAR automatisch deployed und gestartet. Sollte JBoss bereits gestartet sein, so erfolgt das Deployment sofort, wie auf der Konsole unschwer zu erkennen ist. Achtung: Damit das vom Ant-Skript erzeugte EAR erfolgreich von JBoss deployed werden kann, muss JBoss gemäß den Beschreibungen aus Abschnitt 5.1 Konfiguration von JBoss 5.1.x und 6.0.x konfiguriert sein Ausführen der JEE Beispielapplikation Nachdem das jeaf-demo.ear erfolgreich deployed wurde, kann nun die Beispielapplikation als EJB Client gegenüber dem Application Server gestartet werden. Hierzu ist lediglich die Run Configuration JEAF Sample JEE zu starten. 2011

26 Seite 26 von 28 Abbildung 20: : Run Configuration der Beispielapplikation in der JEE Variante Wie Abbildung 20 entnommen werden kann, unterscheidet sich die Run Configuration für die JEE Variante der Beispielapplikation von der JSE Variante lediglich durch Anpassungen in den System Properties. Im konkreten Fall werden, wie bereits beschrieben, andere JEAF Properties und ein anderes JAAS Login Modul verwendet. Darüber hinaus sind Properties für den JNDI Lookup so zu setzen, so dass der Zugriff auf den lokalen JBoss Application Server möglich ist JEAF Management Web Application Im Lieferumfang von JEAF ist u. a. auch die so genannte JEAF Management Web Application enthalten. Dabei handelt es sich um eine Web Applikation mit deren Hilfe der Zustand von Services zur Laufzeit überwacht werden kann. Diese wird in Form eines WAR mit ausgeliefert und wird beim Build der JEE Beispielapplikation mit eingepackt. Die Management Applikation ist unter der URL zu erreichen, sobald das jeaf-demo.ear im JBoss ausgeführt wird. User Name: root Passwort: Anaptecs

27 Seite 27 von 28 Abbildung 21: : Screenshots der JEAF Management Web Application 2011

28 6 Weiteres Vorgehen Nach dem erfolgreichen Durcharbeiten dieses Dokuments empfiehlt es sich als nächstes sich mit JEAF weiter vertraut zu machen, indem die Beispielapplikation als Ausgangspunkt für eigene Erweiterungen genutzt wird, z.b. in dem zusätzliche Services modelliert und implementiert werden. Parallel dazu empfiehlt sich die Lektüre der Dokumente [JEAF Architektur]und [JEAF Modellierungsrichtlinien]. Weitere hilfreiche und nützliche Informationen befinden sich darüber hinaus im [JEAF Wiki]. Seite 28 von