Zudem findet man im oberen Bereich jeder Seite verschiedene Links:

Transkript

1 Verantwortlicher: Jakob Mühmel,, Christian Hänig, Martin Krüger Designbeschreibung des Fremdprojekts UebManager 1.Allgemeines Bei dem UebManager handelt es sich um ein rechner- und webgestütztes Informationssystem, welches permanent zur Verfügung stehen soll. Ziel des Programms ist es den Übungsbetrieb an universitären Einrichtungen effektiv und unkompliziert zu unterstützen und zu begleiten. Es sollen das Verwalten von Übungsgruppen, die Bereitstellung von Aufgabenblättern und sonstigen Dokumenten (Übungshinweise, Werkzeuge, Musterlösungen etc.) sowie die Einsendung der Lösungen ermöglichen. Das Produkt wird auf einem Server ausgeführt, der mit der Java -Servlet-Technologie arbeitet, die den Erwartungen im Bereich der Geschwindigkeit und Flexibilität gerecht wird. Genutzt wird ein HTML-Client, um durch die Applikation zu navigieren, welcher die resultierenden Daten von resourcen-intensiven Verarbeitungsprozessen des Servers nutzt. Die klare und eindeutige Gliederung der Oberfläche des UebManagers dominiert das Erscheinungsbild. Das erleichtert das Arbeiten und das Zurechtfinden ungemein. Auf aufwendige Grafiken oder Bilder wurde verzichtet, was wiederum dem schnellen Seitenaufbau und der Schonung der Internetverbindung, durch kurze Ladezeiten, zu Gute kommt. 2.Produktübersicht Bei dem Öffnen der Startseite findet man einen Login-Bereich, die Nutzer-Registrierung, sowie einen Bereich der ohne Authentifizierung zugänglich ist. Zu diesem öffentlichen Bereich gehören: Eine Übersicht der letzten News Informationen zur Veranstaltung Übersicht über die Übungsgruppen. Zudem findet man im oberen Bereich jeder Seite verschiedene Links: Index: Download: Forum: Impressum: Öffnet die Startseite In diesem Dateibereich werden verschiedene Dokumente (Werkzeuge, Skripte, Übungsaufgaben ) zum Download angeboten Hier können Beiträge eingesehen und geschrieben (nur von registrierten Benutzern) werden Hier findet man Informationen über die Entwickler und allen Beteiligten des UebManagers 1/11

2 Verantwortlicher: Jakob Mühmel,, Christian Hänig, Martin Krüger Login-Bereich: In diesem Bereich kann sich der Benutzer mit Benutzernamen und dazugehörigen Passwort einloggen. Bei fehlerhafter Anmeldung kommt eine Seite mit entsprechender Fehlermeldung und ein Link zurück zur Startseite. Im Erfolgsfall wird dem Benutzer entsprechend seiner Zugehörigkeit als Dozent, Korrektor oder Übungsteilnehmer eine entsprechende Seite mit den für diese Gruppen zulässigen Funktionen. Über diesen Button bzw. über die Funktion Als neuer Student registrieren im Feld Zugang gelangt der Benutzer der Anmeldeseite, wo er sich registrieren lassen kann. Hier hat er die Möglichkeit sich mit seiner Matrikelnummer und seiner Adresse auf dem Universitätsaccount einzutragen und ein vorläufiges Passwort auf diesem generieren zu lassen ( bzw. ein eigenes zu wählen ) um damit Zugang zu der Applikation zu erhalten. Über diesen Button bzw. über die Funktion Passwort vergessen im Feld Zugang gelangt der Benutzer auf eine Seite, auf der er sich für den angegebenen Login-Namen das entsprechende Passwort an die zugehörige Adresse schicken lassen kann. In der News-Übersicht befinden sich Nachrichten, die nach dem Erstellungsdatum geordnet sind. News können nur von Dozenten und Korrektoren erstellt werden. Bei den Informationen zur Veranstaltung findet man wesentliche organisatorische Hinweise zur Vorlesung und den Übungen. Im Bereich Übungsgruppen im unteren Teil der Startseite findet man Informationen über die einzelnen Übungsgruppen. Es gibt 3 verschiedene Benutzergruppen für die Applikation: 1.Übungsteilnehmer: Diese Benutzergruppe hat nach dem Login drei weitere Links im oberen Bereich. Unter Account kann der User seine -Adresse und sein Passwort ändern. Über Logout meldet sich der User von der Applikation ab und die Session ist beendet. Unter dem Menupunkt Infos findet man die News, Übungsserien, Informationen zur Veranstaltung sowie die Übersicht über die Übungsgruppen. Auf der Index-Seite eines eingeloggten Übungsteilnehmers wird die gewählte Übungsgruppe angezeigt. In diesem Feld gibt es auch einen Button Wechseln, über welchen man zu einer Seite gelangt, auf der man seine Übungsgruppe wechselt bzw. sich in eine Gruppe einzuschreiben kann. Im Feld Punkteübersicht kann der Übungsteilnehmer seine erreichte Punktzahl in den einzelnen Serien sowie insgesamt einsehen, und er kann sich die korrigierten Übungsserien herunterladen. Die aktuell zu bearbeitende Übungsserie kann im Feld Lösung hochladen zur Korrektur abgegeben werden. 2/11

3 Verantwortlicher: Jakob Mühmel,, Christian Hänig, Martin Krüger Im Feld Einschreibung kann der Übungsteilnehmer sich zu Klausuren, Praktika o.ä. anmelden. Die Ergebnisse werden darunter angezeigt. 2.Korrektor: Die besonderen Unterpunkte für die Tutoren sind der Download gelöster Übungsaufgaben, der Upload korrigierter Übungsaufgaben inkl. Bewertung und der Zugriff auf das Forum. Bei dem Download gelöster Übungsaufgaben kann der Korrektor sich die gelösten und hochgeladenen Lösungen der Übungsteilnehmer herunterladen um sie dann zu korrigieren. Die korrigierten Übungsaufgaben kann der Korrektor dann über den Upload korrigierter Übungsaufgaben inkl. Berwertung dem Übungsteilnehmer zur Verfügung stellen. 3.Dozent: Der Dozent hat nach seinem Login weitere wichtige Funktionen zur Verfügung stehen. Er kann Übungsgruppen erstellen, wobei die Anzahl, der Raum und der Übungsgruppenleiter festgelegt werden müssen. Die Veröffentlichung von Materialen zur Vorlesung ist möglich. Beim Feld Übungsaufgaben veröffentlichen kann der Dozent die Übungsserien uploaden und diese somit den Übungsteilnehmern zur Verfügung stellen. Des Weiteren kann der Dozent das Forum moderieren und verwalten. Außerdem hat der Dozent natürlich einen Zugriff auf die Punkteübersichten und Klausureinschreibungen. 3. Grundsätzliche Designentscheidung Die Anwendung Uebman ist als Servlet für den Tomcat-Server konzipiert. Aufgrund der Natur von Java alles in Klassen zu kapseln wird in Uebman jede für den Endanwender sichtbare Funktionalität in Komponenten unterteilt, die sich wiederum nochmals unterteilt, je nachdem welche internen Arbeitsschritte gruppiert und verallgemeinert werden können. Dadurch können einzelnen Anwendungsschichten voneinander unabhängig gemacht werden und es ist ein klares Schichtenmodell im Uebman erkennbar. Daraus ergibt sich, dass die einzelnen Schichten unabhängiger voneinander agieren können und sich somit die Programmierung/Änderung von Teilen des Uebman erleichtert. Der Uebman ist als ein einziges Servlet konzipiert. D.h. die gesamte Funktionalität wird über diese eine Schnittstelle zur Verfügung gestellt. Der Vorteil ist, dass die Anwendung nach aussen hin geschlossen erscheint und auch unter Sicherheitsaspekten weniger Probleme gibt. (Das Session-tracking wird erheblich erleichtert.) Grundsätzlich wird die gesamte Funktionalität über sog. Services bereitgestellt. Diese werden über eine ServiceFactory organisiert und verwaltet. Hier ist auch der Ansatzpunkt Erweiterungen vorzunehmen, indem man weitere Services hinzufügt, oder bestehende Services modifiziert. Um nicht nur der Funktionalität durch Modularisierung alle Möglichkeiten offen zu lassen, wurde auch das Design der zu erstellenden Web-Seite gekapselt. Im Konkreten heisst das, dass auch die Designvorlagen von den funktionalen Schichten getrennt ist. Dadurch ist es sehr einfach das Design den eigenen Bedürfnissen anzupassen. Realisiert wird dies durch die Verwendung von Platzhaltern in HTML- Seiten. Diese werden dann nur durch den eigentlichen Inhalt aus der funktionalen Schicht (aus den Services kommend) ersetzt. 3/11

4 Verantwortlicher: Jakob Mühmel,, Christian Hänig, Martin Krüger 4. Paket- und Klassenstruktur: Es sind 8 Packages vorhanden, wobei drei Packages herauszuheben sind, manager mit den Hauptfunktionen, services mit den Aktionen der bestimmten Rollen bzw. allgemeinen Aktionen und xml mit der Anbindung an die XML-Datenbanken. Diverse Klassen für Servlets, Responses & Requests und Chiffrierung. In diesem Package werden die Ergebnisse der Übungsserien, Korrekturstatus, Statistiken zu den Korrekturen und Zulassungskontrollen zu Klausuren realisiert. Enthält die Hauptfunktionen wie z.b. Ein-/Ausloggen, URL-Parsen zum herausfinden, was zu tun ist, Speicherung der Daten der eingeloggten User und das Servlet UebManager. Repräsentiert Datenklassen für Klausuren, Gruppen, News, Passwortänderungen, Übungsserien, etc Package der möglichen Services, wie z.b. Dateien down-/uploaden, Fehlermeldungen und zugehörige Funktionen (Variablen expandieren ). Dazu kommen noch spezielle Services der einzelnen Rollen, mehr dazu folgt später. Allgemeine Klassen zum Datumshandeln, Passworterzeugen, Mailversenden, Integritätstesten und natürlich zum Sprücheklopfen ;-) Enthält Kernoperation für den Umgang mit XML-Dateien (lesen, schreiben ), außerdem verschiedene Klassen zum Handeln der Daten für Serien, User, Einschreibungen, Studenten, Klausuren Enthält Klassen zum XML-Formatieren, zum File -/Directoryfiltern und zum XML- Exception behandeln. Im folgenden werden die wichtigsten Klassen der Packages etwas genauer beschrieben, d.h. schwerpunktmäßig werden die Packages manager, services und xml vorgestellt. 4/11

5 Verantwortlicher: Jakob Mühmel,, Christian Hänig, Martin Krüger Package data: Enthält zwei Packages: Beinhaltet Klassen, die das Abgeben und Korrigieren von Übungsserien realisieren. Managt die Zulassung zu zugangsbeschränkten Klausuren. Enthält 6 Klassen, wobei CorrectionData die Daten einer Serie eines Studenten verwaltet. Der CorrectionManager verwaltet die Korrekturen der Übungsserien und Klausuren, der StatisticsManager liefert statistische Auswertungen der Korrekturen. 5/11

6 Verantwortlicher: Jakob Mühmel,, Christian Hänig, Martin Krüger Die Klasse Student repräsentiert einen Studenten, mit den Daten zu den Übungsserien, Korrekturen und Klausuren. Die Daten der Klausuren werden in ExamData gespeichert. Der FileManager regelt den Dateizugriff auf dem Dateisystem zum Zugriff auf die abgegebenen Lösungen. Package model: Diese Klassen repräsentieren die Daten/Eigenschaften von Übungsserien, Benutzern, Klausuren, News, Gruppen, Statistiken von Übungsserien, Forumsdaten, Passwortsänderungen und Einschreibungen. Diese Klassen werden zur gekapselten Datenhaltung verwendet, damit man einfacher und gut strukturiert mit ihnen umgehen kann. 6/11

7 Verantwortlicher: Jakob Mühmel,, Christian Hänig, Martin Krüger Package util: Die Klasse PasswortGenerator erzeugt Passwörter, welche mit PasswortGeneratorTest (JUnit TestCase) getestet werden. IntegrityCheck überprüft Daten wie z.b. - Adressen, Studserv-Adressen, Passwörter auf Korrektheit. Die Funktionsfähigkeit dieser Klasse wird mit dem TestCase IntegrityTests überprüft. Die Klasse Mail ermöglicht das Senden von s. DateUtil liefert Methoden zum DateHandling, HtmlFilterReader ist ein HtmlReader. Package xml_util: Die Klasse Xml_Constants liefert statische Konstanten für die Verwendung in Verbindung mit XML. Dieses Package beinhaltet außerdem Filter, zum einen den DirectoryOnlyFilter, welche nur Directories akzeptiert, außerdem den DirectoryFilter, mit einer ähnlichen Funktion. Es gibt auch noch den FileOnlyFilter, welcher nur Dateien (evtl. auch nur einen bestimmten FileType) durchlässt. LinkAnd Check sucht in einem String nach Links bzw. -adressen. Außerdem gibt es noch 2 Klassen für XML-Exceptions. 7/11

8 Verantwortlicher: Jakob Mühmel,, Christian Hänig, Martin Krüger Package manager: Die Klasse UebManagerServer ist die zentrale Server-Instanz, welche die Daten des Servers speichert und weitergibt. Diese Klasse wurde als Singleton implementiert, d.h. es existiert immer nur eine Instanz des UebManagerServers. Diese Klasse verwaltet alle Pfade zu den Daten, Datenbanken etc., außerdem verwaltet sie den Modus, da der Admin auch exklusiven Zugriff hat, und zu diesem Zweck alle anderen User ausgeloggt werden. Die Klasse UebManager ist die zentrale Anwendung, in diesem Fall das Servlet, welches die anderen Services wie z.b. Logger, UebManagerServer und LoginManager instanziiert. Die übergebene URL wird geparst und an die Services übergeben, die dann die gewünschten Aktionen durchführen. Die Klasse LoginManager führt das einloggen der User durch und die Daten des eingeloggten Users wird in Kontext gespeichert, damit während der Session auf die Daten des eingeloggten Users zugegriffen werden kann. Die Klasse ServiceFactory entscheidet, welche speziellen Services durchgeführt werden sollen. 8/11

9 Verantwortlicher: Jakob Mühmel,, Christian Hänig, Martin Krüger Package services: Zwei Klassen halte ich für besonders wichtig: den VarHandler, dieser expandiert die Variablen in den HTML-Templates und die Klasse Service, von der alle Services abgeleitet werden. Sie ist dazu da, die benötigten Referenzen auf z.b. HTTPServletRequest/Response zu verwalten. Des weiteren gibt es noch 6 Sub-Packages, welche die speziellen Services für den Admin(z.B. Dateien und User managen), für allgemeine Verwendung (z.b. Ein- und Ausloggen, Einschreibung und Userprofile editieren, Zugriff auf öffentliche Downloads und Dateien, sowie das Forum und das Senden von Mails), für den Dozenten (z.b. Übungsserien und Übungsgruppen managen, News verfassen und Klausuren erstellen/bearbeiten), für Studenten (z.b. spezielle Dateien downloaden, Übungsgruppe einschreiben/wechseln, Klausur einschreiben) und für Tutoren(z.B. Daten zum Korrigieren runter- /hochladen, Ergebnisse mitteilen). Des weiteren gibt es noch ein Package mit Hilfsklassen für Links und Darstellung von Daten in Baumstruktur. Package XML: 9/11

10 Verantwortlicher: Jakob Mühmel,, Christian Hänig, Martin Krüger Die Klasse XML_core_ops_ regelt den Zugriff auf XML-Dateien, sie ermöglicht das Lesen bzw. Schreiben der XML-Datenbankstrukturen. Dazu wird DOM verwendet. Von dieser Klasse werden diverse Klassen abgeleitet, welche bestimmt Daten einlesen (z.b. Daten von Gruppen, Studenten, Klausuren etc.) Die Klasse XML_UegrVerwaltung verwaltet alle Übungsgruppen (Mitglieder, Wechsel, Einschreibungen etc.). 10/11

11 Verantwortlicher: Jakob Mühmel,, Christian Hänig, Martin Krüger 11/11