Dabei sollen die Nutzern nach einer Authentifizierung entsprechend ihren Rechten Begriffe ändern, anlegen und kommentieren können.

Transkript

1 Seite: 1 / 10 Designentwurf 1 Allgemeines 1.1 Kurzcharakterisierung Die Glossarverwaltung soll eine einheitliche Terminologie zwischen allen Beteiligten sicherstellen, hier zwischen den Mitarbeitern der Firma ERPSoft und des jeweiligen Kunden. Dabei sollen die Nutzern nach einer Authentifizierung entsprechend ihren Rechten Begriffe ändern, anlegen und kommentieren können. 1.2 Produktumgebung Die GV ist als webbasierte Anwendung konzipiert. Damit ist zur Bedienung (Client-Seite) nur eine Internetverbindung und ein gewöhnlicher Web-Browser notwendig, der über HTTP mit dem GV-Server kommuniziert. Damit kann eine ortsunabhängige Erreichbarkeit der Glossarverwaltung ermöglicht werden. Die Benutzungsoberfäche besteht aus Webseiten, die Interaktion wird mit den Möglichkeiten von HTML realisiert. Auf der Server-Seite wird die Java-Servlet-Technologie verwendet. Damit ist der Einsatz eines servlet-fähigen Containers zwingend. Zudem wird dadurch die Belastung der Internetverbindung und der Client-Rechner minimiert, da nur die benötigten Daten übertragen werden müssen. 2 Produktübersicht 2.1 Produktbeschreibung Wird die Glossarverwaltung aufgerufen, erscheint die Startseite, auf der sich das Login befindet. Auf einen nicht erfolgreichen Login-Vorgang wird der Benutzer hingewiesen. Nach dem erfolgreichen Einloggen erhält der jeweilige Benutzer Zugriff auf die seiner Rolle entsprechenden Funktionen.

2 Seite: 2 / 10 Abbildung 2.1.1: Use Case 2.2 Produktanforderungen Die Anwendung muss, bedingt durch die Möglichkeit des gleichzeitigen Zugriffs mehrerer Benutzer auf die Glossardaten, mehrbenutzerfähig sein. 3 Grundsätzliche Design-Entscheidungen 3.1 Architektur Die Glossarverwaltung ist als Web-Architektur modelliert, d. h. auf dem Client befindet sich nur ein Web-Browser. Sämtliche restliche Prozesse finden auf dem Server statt. Die Kommunikation basiert auf dem HTTP-Protokoll, die Verbindung zwischen Client und Server ist damit nur temporär. Die Web-Architektur erlaubt eine sehr hohe Benutzeranzahl. Die Wartung der Software ist durch die Konzentration auf dem Server einfach. Auf den Clients muss keine anwendungsspezifische Software installiert werden, wodurch auf das Problem der Verteilung der Software entfällt.

3 Seite: 3 / Benutzungsoberfläche Die Benutzungsoberfläche ist als graphical user interface (GUI) realisiert und basiert auf HTML. Die Steuerung durch den Benutzer erfolgt mittels Maus und Tastatur. Die Eingaben des Benutzers werden an den Server über in HTML integrierte Aufrufe weitergeleitet. Die Gestaltung der HTML-Nutzungoberfläche ist fast vollständig unabhängig von der Umsetzung des Fachkonzepts und kann mittels eines einfachen Editors realisiert werden. 3.3 MVC und Struts Als Design-Pattern bietet sich der Model-Viewer-Controller Ansatz an. Dies wird durch das Struts Framework unterstüzt, welches Klassen für den Controller-Teil zur Verfügung stellt. Als Viewer Komponente bieten sich aufgrund der Web-Architektur Java- Server-Pages an, welche durch Beans ihre dynamischen Daten überliefert bekommen. Die eigentliche Business-Logik steckt schließlich im Modell, welches durch eigenständige Klassen realisiert werden soll. Es soll Wert auf die Unabhängigkeit diesen Teils gelegt werden. 4 Paket- und Klassenstruktur Die Paketstruktur besteht aus folgenden Packeten: Abbildung 4.0.1: Die Paketstruktur Wie die Namen schon andeuten findet sich der Modell-Teil im Paket Model und der Controller- Teil im Paket Controller. Da der View lediglich aus JSP Dateien besteht ist für diesen kein extra Paket vorgesehen. 4.1 Statische Sicht Das folgende Diagramm enthält die statische Sicht auf die vorläufige Klassenstruktur.

4 Seite: 4 / 10 Abbildung 4.1.1: Das Paket User

5 Seite: 5 / 10 Abbildung 4.1.2: Das Paket Data

6 Seite: 6 / 10 Abbildung 4.1.3: Das Paket Glossary Der Controller-Teil wird aus einer Reihe von Klassen bestehen, die von Action (aus dem Struts Framework) abgeleitet sind. Diese realisieren eine bestimmte Aktion des Benutzers, z.b. den Logon/Logoff, indem sie den Request vom Browser entgegennehmen, die entsprechenden Methoden der Modell-Klassen aufrufen und schließlich das Ergebnis an eine JSP weiterleiten.

7 Seite: 7 / 10 Abbildung 4.1.4: Das Paket Controller Abbildung 4.1.5: Das Paket View 4.2 Dynamische Sicht

8 Seite: 8 / Administrator erstellt eine Gruppe und fügt einen Benutzer hinzu Nach erfolgreichem Login füllt der Administrator auf der Glossarverwaltungs-Seite ein Formular aus, welches die relevanten Daten (z.b. Gruppenname) enthält. Dieses wird durch eine ActionForm Klasse validiert und an die Klasse AdminAction übergeben. Diese leitet die Änderungen am Modell ein: Zunächst holt es sich die UserIO Instanz aus dem Servlet Context und übergibt die neu Instanzierte Gruppe an UserIO.setGroup(), damit sie persistent wird. Schließlich können bestehnde (oder neue) User in die Gruppe eingetragen werden, indem User.setGroup() aufgerufen wird. Die User Instanzen können dazu wieder über UserIO.getUser() geholt werden. Nach jeder Änderung wird der Administrator über ein Forward auf eine entsprechende JSP weitergeleitet Glossar erstellen und Begriffe hinzufügen Nach erfolgreichen Login kann der Benutzer über ein Formular ein neues Glossar anlegen. Die benötigten Daten werden wieder analog über eine ActionForm übergeben. Die Action Klasse, in diesem Fall GlossarAction holt sich die DataIO Instanz aus dem Servlet Context und benutzt DataIO.setGlossary() um ein neu Instanziertes Glossary Objekt zu speichern. Nachdem dem Benutzer eine Erfolgsseite angezeigt wird hat dieser die Möglichkeit auf dieser einen neuen Begriff hinzuzufügen (genauer: einen neuen Kontexteintrag). Dazu wird ein neues Term Objekt instanziert, via addcontext() beliebig viele Kontexte hinzugefügt und schließlich der Begriff mit DataIO.setTerm() gespeichert.

9 Seite: 9 / Begriff hinzufügen, finalisieren und veröffentlichen Wie eben beschrieben kann ein Benutzer einen Begriff hinzufügen. Über einen Button auf der Begriffs Webseite soll der Begriff nun finalisiert und danach veröffentlicht werden. Dies wird wieder über eine Action Klasse geleitet, welche (wie üblich) mit DataIO.getTerm() den Begriff bekommt und dann setfinalized(true) bzw. setpublished(true) aufruft. Schließlich muss der Begriff wieder mit setterm() persistent gemacht werden Begriff editieren Nachdem auf der Übersichtsseite des Glossars der Begriff ausgewählt wurde und auf der Begriffsseite der Editierbutton für einen Kontext gedrückt wird, wird der Benutzer auf eine Editierseite mit Formular geleitet. Auf dieser wird der alte Kontext dargestellt, dazu wird dieser durch eine Action Klasse über DataIO.getTerm().getContext() an die JSP übergeben. Schließlich wird der Text über DataIO.getTerm().getContext().getText() geändert. Wieder

10 Seite: 10 / 10 muss die Aktion mit DataIO.setTerm() abgeschlossen werden Begriff suchen und kommentieren Um im Glossar zu Suchen holt sich die Action eine SearchEngine Instanz aus dem ServletContext und ruft eine der Methoden searchbyname(), searchbyowner() etc. auf. Die gefundenen Term Objekte werden dann auf einer JSP dargestellt. Ein Kommentar kann dann zu einem Term mittels Term.getContext().addComment() hinzugefügt werden. DataIO.setTerm() sollte dabei nicht vergessen werden!