FHZ > FACHHOCHSCHULE ZENTRALSCHWEIZ HTA > HOCHSCHULE FÜR TECHNIK+ARCHITEKTUR LUZERN Softwae Engineeing Pojekt Softwae Requiements Specification SRS Vesion 1.0 Patick Bündle, Pascal Mengelt, Andy Wyss, Fabian Heusse Dozent: Jög Hofstette HTA LUZERN Technikumstasse 21 CH 6048 How T: 041 349 33 11 F: 041 349 39 60 W: www.hta.fhz.ch
Histoy N Datum Name Bescheibung 1 27.3.02 men Este Entwuf 2 22.4.02 men Vesion 1.0 3 22.4.02 bu Review Inhalt Histoy...2 Inhalt...2 1 Einfühung...3 1.1 Absicht...3 1.2 Umfang...3 1.3 Definitionen, Begiffe und Abküzungen...3 1.4 Veweise...3 1.5 Übeblick...4 2 Allgemeine Bescheibung (C-Requiements)...4 2.1 Podukt Pespektive...4 2.1.1 System Schnittstellen...4 2.1.2 Benutze Schnittstellen...4 2.1.3 Softwae Schnittstellen...5 2.1.4 Voaussetzungen Speiche...5 2.2 Podukte Funktionalität...6 2.2.1 Use Case: Nachicht loggen...7 2.2.2 Use Case: LogViewe öffnen...8 2.2.3 Use Case: LogViewe schliessen...8 2.2.4 Use Case: Logge konfiguieen...8 2.2.5 Use Case: alte Nachichten löschen / öffnen...8 2.2.6 Use Case: configue LogViewe...9 2.3 Benutze Chaakteistiken...9 2.4 Voaussetzungen...9 2.5 Veteilung von Anfodeungen...9 3 Konkete Anfodeungen (D-Requiements)...10 Seite 2
4 Untestützende Infomationen...10 1 Einfühung 1.1 Absicht Dieses Dokument beinhaltet alle Anfodeungen fü den antlogge Message Logge. Die Kapitel 1 und 2 sind besondes fü den Kunden inteessant (C-Requiements). Kapitel 3 ist hauptsächlich fü den Softwae Ingenieu (D-Requiements). 1.2 Umfang Dieses Dokument behandelt die Anfodeungen fü den Release 1.0 des antlogge, ein Message Logge fü und in Java. Das SRS soll ein Hilfe fü den Kunden, wie auch fü den Softwae Entwickle sein wähend de Entwicklung des Systemes. 1.3 Definitionen, Begiffe und Abküzungen Begiff ode Tem C-Requiement D-Requiement Message Logge antlogge Client Log-Viewe Bescheibung Kunden- Anfodeung (Custome): Ekläung eine Anfodeung fü die Anwendung, ausgedückt in eine Fom, welche dem Kunden kla ist. Entwickle-Anfodeung (Develope): Ekläung eine Anfodeung fü die Anwendung, ausgedückt in eine Fom, welche genügend detailliet ist, um von den Entwicklen fü das Design und die Implementation benutzt zu weden. Softwae um Nachichten entgegenzunehmen und diese zu speichen, sowie dem Benutze zugänglich zu machen. Name des Message Logge. Ein Pogamm welches Nachichten an den antlogge absetzen kann. Ein Wekzeug, um die gesammelten Nachichten anzeigen zu können. 1.4 Veweise Softwae Configuation Management Plan (SCMP) Softwae Poject Management Plan (SPMP) Softwae Design Document (SDD) Seite 3
1.5 Übeblick Das SRS ist gemäss dem IEEE Standat oganisiet. (Siehe Inhaltsvezeichnis) 2 Allgemeine Bescheibung (C-Requiements) Ein Message Logge sammelt und speichet veschiedenste Meldungen (Eos, Wanungen etc.) von veschiedensten Pogammen (Clients). Diese Clients müssen den Logge einesp. ausschalten können sowie ihn konfiguieen können (welche Nachichten loggen etc.). Mit einem einfachen Wekzeug (View-Logge) können die Nachichten eingesehen weden (Filten, Suchen soll möglich sein). Die Clients können dieses Window aktivieen esp. deaktivieen. 2.1 Podukt Pespektive De antlogge ist eine Komponente, welche einfach von Java-Pogammen implementiet weden kann. Diese Pogamme können übe eine Schnittstelle (siehe System Schnittstellen) dem Message Logge Nachichten übemitteln. Weite sind sie in de Lage ein Fenste (View-Logge) zu öffnen (esp. zu schliessen), mit welchem die Nachichten eingesehen, sotiet ode duchsucht weden können. 2.1.1 System Schnittstellen MessageLogge: Klasse um eine Nachicht an den antlogge abzusetzen. um den Message Logge zu konfiguieen. Zum Beispiel: Filten de Nachichten; zeigen, esp. vestecken des Log-Viewe, setzen des Pogammnamen. 2.1.2 Benutze Schnittstellen Da ein Benutze nicht diekt auf den antlogge zugeift (imme übe ein Pogamm), weden fü die Bedienung keine Schnittstellen benötigt. Ein GUI baucht de Log-Viewe um einen einfachen Zugiff auf die gesammelten Nachichten zu gewähleisten. Pe Inteface kann ein Client ein Log-Viewe (SWING / AWT) aktivieen, welches paallel und völlig unabhängig von de Client-Applikation abeitet. De Client hat dazu via Inteface das Log-Viewe zu aktivieen. Nach diese Aktivieung kann e nomal weiteabeiten, und das Log-Viewe bleibt bei Bedaf ebenfalls aktiv. Ist dieses Log-Viewe aktiv, weden dain die aktuell auftetenden Messages des zugehöigen Clients in Listenfom angezeigt und gleichzeitig dauehaft gespeichet (Siehe MessageWindow von Togethe). Jede Client hat sein eigenes Message-Window. Seite 4
Die angezeigten Messages können unteschiedlich sotiet und gefiltet weden: Zeitbeeich Nach Applikation Nach Modul Nach Pioität Wotsuche in Nachichten Es kann bei Wunsch auch auf ältee Meldungen zugegiffen weden (duch Laden alte Sicheungsdateien). Alte Meldungen können auch gelöscht weden (indem alte Sicheungsdateien gelöscht weden). -> Damit kann auf einfachste At- und Weise eine Watungs-Applikation fü alte auf Disk aufgezeichnete Messages ealisiet weden. Optional: Dem Betachte kann angezeigt weden, welche Klasse einen Message-Eintag ezeugt hat. De LogViewe wid etwa so aussehen: 2.1.3 Softwae Schnittstellen Siehe 2.1.1 2.1.4 Voaussetzungen Speiche Dauehafte Speicheung de Messages auf Disk. Seite 5
2.2 Podukte Funktionalität N Bezeichnung 1 Aufgezeichnete Messages müssen einem menschlichen Betachte in Klatext päsentiet weden können (keine kyptischen Zahlen-Codes). Es muss fü den Betachte zumindest esichtlich sein, wann diese Message eingetagen wude. Weitee wünschenswete Infomationen: Wo im Pogammablauf wude die Message abgesetzt? Waum wude diese abgesetzt? 2 Die Speicheung seh viele Messages daf nicht zu einem Disk-Übelauf fühen, d.h. die maximale Speichegösse ist zu beschänken (MByte), alte Messages weden bei Eeichen de maximalen Speichegenze in eine Datei abgegelegt. Diese Speichegenze ist konfiguieba, wie auch die Anzahl de Sicheungsdateien. 3 Es gibt eine zentale Datenhaltung, d.h. eine unabhängige Applikation hat Zugiff auf alte, abgespeichete Messages andee Applikationen. Es muss möglich sein, dass mehee Applikationen gleichzeitig Message-Logge nutzen können (d.h. jede Applikation beinhaltet eine eigene Instanz de Komponente, zentale Datenspeicheung). 4 Komponenten-Achitektu -> Message-Logge ist als Komponente zu ealisieen, die einfach in eine Applikation integiet weden kann (d.h. einfaches Inteface) und auch einfach austauschba ist (neue Vesion). Bemekung: Ein Austausch de Message-Logge Komponente (neue Vesion) muss möglichst einfach auszufühen sein, d.h. die entspechende Applikation daf nu minimal davon betoffen sein. Vo einem Austausch aufgezeichnete Meldungen müssen mit de neuen Komponente nicht meh sichtba gemacht weden können, d.h. es ist kein nomietes Aufzeichnungs-Fomat nötig. Die Austauschbakeit de Komponenten wid im Pojekt gepüft. 5 Bei jedem Message-Eintag hat die aufufende Applikation einen Message-Level mitzugeben (Bsp: Fehle, wichtige Meldung, nomale Meldung, unwichtige Meldung). Pe Pogamm-Inteface kann ein Level-Filte gesetzt weden. Damit kann definiet weden, welche Meldungen (mit welchem Level) tatsächlich aufgezeichnet weden. Diese Level kann zu Laufzeit duch die Applikation jedezeit geändet weden, hat abe nu auf die danach einteffenden Meldungen Einfluss. Idee: Man kann in eine Applikation zu Debug Zwecken seh viele Meldungen einfügen, duch den Level-Filte abe eeichen, dass die Meldungen im Nomalfall nicht aufgezeichnet weden (wegen Pefomance). 6 De Pefomance ist besondees Augenmek zu widmen. Insbesondee ist zu beachten, dass Message-Eintäge, welche vom Level-Filte nicht duchgelassen weden, die Applikation in ihem Zeitvehalten nicht negativ beeinflussen. Übesicht übe die wichtigsten Anwendungsfälle (use cases), welche die Softwae efüllt. Im Abschnitt 3 weden diese detailliete beschieben. Seite 6
2.2.1 Use Case: Nachicht loggen Benutze Vo-Bedingung Schitte Vaiationen Anwendung Logge läuft 1) Anwendung meldet Logge eine Nachicht zu loggen 2) Logge loggt die Nachicht 2) Log Datei ist zu goss und einige Nachichten müssen gelöscht weden Seite 7
2.2.2 Use Case: LogViewe öffnen Benutze Vo-Bedingung Schitte Vaiationen Anwendung Logge läuft 1) Anwendung meldet Logge den LogViewe zu öffnen 2) Logge öffnet den LogViewe 2) De LogViewe ist beeits geöffnet 2.2.3 Use Case: LogViewe schliessen Benutze Vo-Bedingung Schitte Vaiationen Anwendung Logge läuft 1) Anwendung meldet Logge den LogViewe zu schliessen 2) Logge schliesst den LogViewe 2) De LogViewe ist beeits geschlossen 2.2.4 Use Case: Logge konfiguieen Benutze Vo-Bedingung Schitte Vaiationen Anwendung Logge läuft 1) Anwendung konfiguiet den Logge 1) De Logge antwotet nicht 2.2.5 Use Case: alte Nachichten löschen / öffnen Benutze Vo-Bedingung Schitte Vaiationen Anwende Logge läuft 1) Benutze löscht / öffnet alte Nachichten (ganze Dateien) Seite 8
2.2.6 Use Case: configue LogViewe Benutze Vo-Bedingung Schitte Vaiationen Anwende Logge läuft 1) Benutze konfiguiet den LogViewe 2.3 Benutze Chaakteistiken De antlogge sollte einfach zu bedienen sein. Einzige Voaussetzung ist die Bedienung eines Clients. 2.4 Voaussetzungen Keine. 2.5 Veteilung von Anfodeungen Sämtliche Anfodeungen weden beeits in de Vesion 1.0 gefodet. Weitee Vesionen sind nicht vogesehen. Seite 9
3 Konkete Anfodeungen (D-Requiements) Auf die D-Requiements wid vezichtet. Das Pojekt ist zu klein, um diesen Aufwand zu echtfetigen. Die Anfodeungen sind in den C-Requiements aufgelistet. Die Fagen de Achitektu und des Designs weden im SDD geklät. 4 Untestützende Infomationen Softwae Design Document (SDD) (in Abeit) Java Doc (noch nicht estellt) Betiebsanleitung (noch nicht estellt) Seite 10