Tutorial: Session Bean mit Datenbank-Zugriff, EJB3-Standard (Java_EJB_07) – Packen der Dateien in Java-Archive (JAR) und 'deploy'

Dieses Dokument enthält die Anleitungen um die Dateien, die für den Einsatz auf einem Java-Application-Server (JAS) und für die Schnittstellen-Definition für Client-Programme erforderlich sind, zu erstellen.

Das Packen in Java-ARchive (JAR-) Dateien ist gleich wie schon im Dokument Tutorial: Einfache Session Bean, EJB3-Standard (Java_EJB_05) – Packen der Dateien in Java-Archive (JAR) und 'deploy' beschrieben und dort ausführlich mit Abbildungen versehen.
Deswegen enthält dieses Dokument nur mehr eine Beschreibung in Stichworten.

Inhaltsverzeichnis:

Vorigerer Schritt: Codieren 

Installationanleitung für die frühere Version (vor EJB3-Standard) 

Vorbedingungen 
'Project archives' anlegen 
Dateien mit Java-Klassen hinzufügen 
JAR-Datei neu erstellen 

JAR-Datei an den JAS übergeben ('deploy') 
*  'Deploy' bei JBoss 
*  'Deploy' bei Glassfish 

JAR-Datei für Client-Programme erstellen 

Weitere Schritte und verwandte Dokumentation 

Nächster Schritt: Benutzen der Hypersonic Datenbank von 'JBoss' 
bzw. Maßnahmen für den Zugriff auf eine MySQL-Datenbank 

Installationsanleitung für die frühere Version (vor EJB3-Standard)

Wenn Sie vor der Aufgabe stehen, Code für ältere EJBs adaptieren zu müssen und die passende Anleitung dafür suchen dann beginnen Sie bitte mit
Tutorial: Session Bean mit Datenbank-Zugriff (Java_EJB_03) – Einrichten des Projects.
Das äquivalente Dokument für das Erstellen von Archiven und 'deploy' am JAS ist Tutorial: Session Bean mit Datenbank-Zugriff (Java_EJB_03) – Packen der Dateien in Java-Archive (JAR) und 'deploy'.

▲ zum Inhaltsverzeichnis

Vorbedingungen

• Schritt 2 Codieren ausgeführt – und dessen Vorbedingungen auch.

• JBoss-IDE Plugin in Eclipse installiert.

▲ zum Inhaltsverzeichnis

'Project archives' anlegen

Vermutlich werden bereits andere Projects im Eclipse-Workspace vorhanden sein und für diese auch Package-Configurations angelegt worden sein.
Wenn Sie die Tutorials in empfohlener Reihenfolge ausgeführt haben, dann haben Sie auch den Abschnitt Tutorial: Einfache Session Bean, EJB3-Standard (Java_EJB_05) – Packen der Dateien in Java-Archive (JAR) und 'deploy' > 'Project archives' anlegen durchgearbeitet; dort finden Sie eine ausführliche Beschreibung mit Abbildungen wie die 'View' für 'Project archives' geöffnet wird.

Wenn das bearbeitete Project vielleicht doch das Erste im Eclipse-Workspace sein sollte, für das JAR-Dateien erstellt werden sollen, muss zuerst die View für die 'Project archives' eröffnet werden.

• Das geschieht über die Auswahl Window > Show View > Other... .

• Im darauf hin erscheinenden Fenster (Show View) wird Project archives ausgewählt.
  Project archives ist innerhalb der Gruppe 'JBoss Tools' zu finden und wenn die Auswahl nicht sichtbar ist, kann sie durch anklicken des kleinen Dreiecks links neben 'JBoss Tools' sichtbar gemacht werden.
  Anschließend wird die Schaltfläche [ OK ] angeklickt um einen neuen 'Reiter' im unteren Bereich zu öffnen.

Anschließend wird das 'Project' ausgewählt für das die Anweisungen festgelegt werden sollen.

• Nach dem Auswählen wird im Bereich für die 'Project archives' eine Auswahlmöglichkeit der zu erstellenden Archive angezeigt.
  Aus diesen wird 'EJB JAR' ausgewählt.

• Die vorgegebenen Einstellungen werden beibehalten.
  Nach dem Anklicken der Schaltfläche [ Next > ] wird eine Vorschau mit dem Namen und der Struktur der Datei mit der Erweiterung 'jar' angezeigt.

• Die Datei ist derzeit noch leer; für sie werden später die Regeln, was in diese Datei gepackt werden soll, festgelegt.
  Durch das Anklicken der Schaltfläche [ Finish ] wird die Datei erstellt.

▲ zum Inhaltsverzeichnis

Dateien mit Java-Klassen hinzufügen

• Die Java-Klassen inklusive der durch die Java-'package's definierten Verzeichnis-Struktur werden in das EJB aufgenommen.
  Für das Hinzufügen von Dateien (inklusive der Verzeichnis-Struktur) wird die Datei 'Java_EJB_07.jar' mit der rechten Maustaste angeklickt und aus dem Kontext-Menu New Fileset ausgewählt.

• Im folgenden Fenster wird durch Anklicken der Schaltfläche [ Workspace... ] (über dem Eingabefeld 'Includes') ein eigenes Fenster geöffnet, in dem als Nächstes jenes Verzeichnis, in dem die Dateien mit den Java-Klassen – inlusive der Verzeichnis-Struktur für die Java-'package's – ausgewählt werden kann.

• Im erscheinenden Auswahl-Fenster ('Folder Selection') wird wird zu jenem Verzeichnis manövriert, in dem die Dateien mit den Java-Klassen liegen.
  Dieses Verzeichnis wurde in Schritt 1: Einrichten des Projects > Verzeichnisse für Quell-Code und kompilierte Java-Klassen festlegen definiert.
  Die Verzeichnis-Struktur wird angezeigt bzw. verborgen, wenn das kleine Dreieck links neben einem Verzeichnis-Namen angeklickt wird.
  Die Auswahl wird durch Anklicken der Schaltfläche [  OK  ] bestätigt und damit wird auch das Fenster geschlossen.

• Im Fenster für das 'New Fileset' werden dann die Filter-Kriterien für die Dateien, die in die JAR-Datei aufgenommen werden sollen, im Feld 'Includes' festgelegt: **/*.class.
  **/ bedeutet, daß alle Verzeichnisse in der Struktur auf Dateien mit einem passenden Namen durchsucht werden.
  *.class bedeutet, daß alle Dateien, deren Namen mit .class endet, in die JAR-Datei gepackt werden sollen.
  Nach Eingabe der Filter-Kriterien ist im Feld 'Preview' zu sehen, welche Dateien ausgewählt sind.
  Die Definition wird durch Anklicken der Schaltfläche [  Finish  ] abgeschlossen und damit wird auch das Fenster geschlossen.

▲ zum Inhaltsverzeichnis

JAR-Datei neu erstellen

Bis jetzt wurde nur festgelegt, welche Dateien in die JAR-Datei gepackt werden.
In diesem kurzen Abschnitt wird beschrieben, wie die JAR-Datei erstellt wird.

• Dazu wird die Datei 'Java_EJB_07.jar' mit der rechten Maustaste angeklickt und aus dem Kontext-Menu Build Archive (Full) ausgewählt.
  Der Vorgang des 'Packens' dauert nur Bruchteile einer Sekunde und es wird keine Rückmeldung gegeben wenn der Vorgang beendet ist.

▲ zum Inhaltsverzeichnis

JAR-Datei an den JAS übergeben ('deploy')

Eclipse bietet zwar die Möglichkeit die fertige JAR-Datei per 'Mausklicks' an verschiedene Java Application Server (JAS) zu übergeben ('deploy').
Die Konfiguration und die Benutzeroberfläche dieser Funktionalität ist aber häufigen Änderungen unterzogen – deswegen verzichte ich auf eine Beschreibung dieser Möglichkeit.

Neuere Versionen verschiedener JAS bieten andere komfortable Möglichkeiten eine Archiv-Datei zu übergeben:

• JBoss durch Kopieren der fertigen Archiv-Datei in das entsprechende Verzeichnis des JAS.
Wenn JBoss manuell in einem 'Terminal'-Fenster gestartet ist, werden in diesem Fenster auch eine Bestätigungsmeldung bzw. eventuelle Fehlermeldungen angezeigt.

• Glassfish ermöglicht das 'Hochladen' der Archiv-Datei über einen Webbrowser.
Damit kann auch ein 'deploy' ausgeführt werden wenn Glassfish auf einem anderen Computer gestartet ist.

▲ zum Inhaltsverzeichnis

'Deploy' bei JBoss

Im folgenden Beispiel sind /workspace_and_project_directory und /jboss_home Platzhalter für das Verzeichnis mit der im vorigen Abschnitt erstellten JAR-Datei und das Verzeichnis in dem JBoss installiert ist.

Zum eingeben des Kommandos ist ein 'Terminal'-Window notwendig. Das kann bei Fedora-Linux über die Auswahl Anwendungen > Systemwerkzeuge > Terminal aufgerufen werden.

Im Terminal-Window wird folgendes Kommando eingegeben:
cp /workspace_directory/Java_EJB_07.jar /jboss_home/server/default/deploy

Dabei ist /workspace_directory durch jenes Verzeichnis zu ersetzen, in dem die Dateien des Projects innerhalb von Eclipse enthalten sind, z.B. /home/kurti-o/java_ejb/Java_EJB_07.
/jboss_home ist das Stamm-Verzeichnis, in dem JBoss installiert ist. Wenn die Installation so wie in JBoss Java-Application-Server installieren > Installation von JBoss beschrieben erfolgt ist, ist dieses Verzeichnis /opt/jboss.

▲ zum Inhaltsverzeichnis

'Deploy' bei Glassfish

Das Übergeben an einen Glassfish JAS unterscheidet sich nur durch den Namen der JAR-Datei von dem unter Tutorial: Einfache Session Bean, EJB3-Standard (Java_EJB_07) – Packen der Dateien in Java-Archive (JAR) und 'deploy' > 'Deploy' bei Glassfish beschriebenen Vorgehen.
Aus diesem Grund wird auf eine nochmalige Anleitung in diesem Dokument verzichtet.

▲ zum Inhaltsverzeichnis

JAR-Datei für Client-Programme erstellen

Für das Client-Programm, das im Tutorial: Client-Programm für Session Bean mit Datenbank-Zugriff, EJB3-Standard (Java_EJB_08)) erstellt wird, ist eine JAR-Datei notwendig, die die Schnittstellen des auf dem JAS laufenden EJB beschreibt.

Eine detaillierte Beschreibung mit Abbildungen finden Sie unter Tutorial: Einfache Session Bean, EJB-Standard (Java_EJB_05) – Packen der Dateien in Java-Archive (JAR) und 'deploy' > JAR-Datei für Client-Programme erstellen.
In diesem Abschnitt ist das Verfahren nur mehr in Stichworten beschrieben.

Das Definieren der Dateien, die in diese JAR-Datei gepackt werden sollen, erfolgt nach dem gleichen Schema wie in den vorigen Abschnitten (ab 'Project archives' anlegen) beschrieben.

• Durch Anklicken des Bereiches 'project archives' mit der rechten Maustaste wird das bekannte Kontext-Menu angezeigt.
  Mit der Auswahl von New Archive > JAR wird ein Fenster (New JAR) geöffnet mit dem Parameterisierungen für die zu erstellende Datei vorgenommen werden können.

• Der Name der Datei ('Archive name') wird auf Java_EJB_07-client.jar geändert.
  Das ist notwendig, weil eine Datei mit dem vorgegebenen Namen bereits existiert (Java_EJB_05.jar als EJB-Container).
  Anschließend wird die Schaltfläche [ Workspace... ] angeklickt.

• m folgenden Fenster ('Select a destination') wird das Verzeichnis 'Java_EJB_07' ausgewählt. Damit wird eine eigene Datei erstellt.
(Bei Auswahl von 'Java_EJB_07.jar' würde innerhalb dieser Datei ein Unterverzeichnis eröffnet.).
Durch Anklicken der Schaltfläche [ OK ] wird die Auswahl des Verzeichnisses bestätigt.

• Durch das Anklicken der Schaltfläche [ Finish ] im Fenster 'New JAR' wird die Datei erstellt.

In die Datei werden nur Dateien mit Java-Klassen, die von Client-Programmen importiert werden müssen, aufgenommen.

• Für das Hinzufügen dieser Dateien wird die gerade angelegte Datei mit der rechten Maustaste angeklickt und aus dem Kontext-Menu New Fileset ausgewählt.

• Im folgenden Fenster (Fileset Wizard) wird durch Anklicken der Schaltfläche [ Workspace... ] ein weiteres Fenster geöffnet.

• Im folgenden Fenster (Folder Selection) wird das Verzeichnis mit den Dateien, die in die JAR-Datei aufgenommen werden sollen, ausgewählt.
Darin wird zum Verzeichnis gen/classes manövriert.
Die Auswahl wird durch Anklicken der Schaltfläche [  OK  ] bestätigt.

• Im Fenster für das 'New Fileset' werden dann noch im Feld 'Includes' die Filterkriterien **/bo/*.class für die Auswahl der Dateien festgelegt.
Die ausgewählte Klasse ('Chat_BO.class') ist dann im Bereich 'Preview' gelistet.
Die Auswahl wird durch Anklicken der Schaltfläche [ Finish ] bestätigt und damit wird auch das Fenster geschlossen.

• Das Hinzufügen von 'Fileset's mit Dateien wird für das Verzeichnis gen/classes mit den Filterkriterien **/remote/*.class wiederholt.
Die ausgewählte Klasse ('ChatManagementBeanRemote.class') ist dann im Bereich 'Preview' gelistet.
Die Auswahl wird durch Anklicken der Schaltfläche [ Finish ] bestätigt und damit wird auch das Fenster geschlossen.

▲ zum Inhaltsverzeichnis

Weitere Schritte und verwandte Dokumentation

▲ zum Inhaltsverzeichnis