HWR-Chat: Pflichtenheft
Warning: preg_match(): Compilation failed: group name must start with a non-digit at offset 8 in /www/htdocs/w0102873/mediawiki/includes/MagicWord.php on line 739
Aus It2010-g1
Chge (Diskussion | Beiträge) (→Produktübersicht) |
Admin (Diskussion | Beiträge) (→Siehe auch) |
||
Zeile 16: | Zeile 16: | ||
==Glossar== | ==Glossar== | ||
− | |||
− | |||
*'''Abstraktion:''' Abstraktion bezeichnet meist den induktiven Denkprozess des Weglassens von Einzelheiten und des Überführens auf etwas Allgemeineres oder Einfacheres. | *'''Abstraktion:''' Abstraktion bezeichnet meist den induktiven Denkprozess des Weglassens von Einzelheiten und des Überführens auf etwas Allgemeineres oder Einfacheres. | ||
Zeile 30: | Zeile 28: | ||
*'''Eclipse:''' Eclipse ist ein quelloffenes Programmierwerkzeug zur Entwicklung von Software verschiedenster Art. Dabei wird Eclipse als integrierte Entwicklungsumgebung für die Programmiersprache Java genutzt. | *'''Eclipse:''' Eclipse ist ein quelloffenes Programmierwerkzeug zur Entwicklung von Software verschiedenster Art. Dabei wird Eclipse als integrierte Entwicklungsumgebung für die Programmiersprache Java genutzt. | ||
− | |||
− | |||
*'''Firewall''': Eine Firewall ist eine Software, die dazu dient, den Netzwerkzugriff, basierend auf Absender- oder Zieladresse und genutzten Diensten, zu beschränken. | *'''Firewall''': Eine Firewall ist eine Software, die dazu dient, den Netzwerkzugriff, basierend auf Absender- oder Zieladresse und genutzten Diensten, zu beschränken. | ||
Zeile 41: | Zeile 37: | ||
*'''JDK:''' Das Java Development Kit (JDK) ist eines der von Java-Entwicklern meistgenutzten Java-SDKs (Software Development Kits). | *'''JDK:''' Das Java Development Kit (JDK) ist eines der von Java-Entwicklern meistgenutzten Java-SDKs (Software Development Kits). | ||
− | *'''Kapselung:''' Als (Daten-)Kapselung bezeichnet man in der Programmierung das Verbergen von Daten oder Informationen vor dem Zugriff von außen. Der direkte Zugriff auf die interne Datenstruktur wird unterbunden und erfolgt | + | *'''Kapselung:''' Als (Daten-)Kapselung bezeichnet man in der Programmierung das Verbergen von Daten oder Informationen vor dem Zugriff von außen. Der direkte Zugriff auf die interne Datenstruktur wird unterbunden und erfolgt stattdessen über definierte Schnittstellen. |
*'''Klasse:''' Unter einer Klasse versteht man in der objektorientierten Programmierung ein abstraktes Modell bzw. einen Bauplan für eine Reihe von ähnlichen Objekten. | *'''Klasse:''' Unter einer Klasse versteht man in der objektorientierten Programmierung ein abstraktes Modell bzw. einen Bauplan für eine Reihe von ähnlichen Objekten. | ||
Zeile 52: | Zeile 48: | ||
*'''Konsistenz:''' In der Informatik sind Daten konsistent, wenn Widerspruchsfreiheit innerhalb einer Datenbank gewährleistet ist. | *'''Konsistenz:''' In der Informatik sind Daten konsistent, wenn Widerspruchsfreiheit innerhalb einer Datenbank gewährleistet ist. | ||
+ | |||
+ | *'''Konsole:''' Die Konsole eines Betriebssystems dient zur direkten Befehlseingabe durch Text an das System. Übliche Konsolen sind die "CMD" von Windows und die "shell" für alle Unix-Systeme, wie OS, Linux, BSD u.s.w. | ||
*'''Logdatei:''' Als Logdatei wird ein automatisch geführtes Protokoll bestimmter Aktionen bezeichnet. Im Falle des Chat Programmes ist das Protokoll der ausgetauschten Nachrichten gemeint. | *'''Logdatei:''' Als Logdatei wird ein automatisch geführtes Protokoll bestimmter Aktionen bezeichnet. Im Falle des Chat Programmes ist das Protokoll der ausgetauschten Nachrichten gemeint. | ||
Zeile 59: | Zeile 57: | ||
*'''Objekt:''' Ein Objekt bezeichnet in der objektorientierten Programmierung (OOP) ein Exemplar eines bestimmten Datentyps oder einer Klasse. | *'''Objekt:''' Ein Objekt bezeichnet in der objektorientierten Programmierung (OOP) ein Exemplar eines bestimmten Datentyps oder einer Klasse. | ||
− | *''' | + | *'''Orgware:''' Als Orgware bezeichnet man die für die Organisation und Pflege eines Systems benötigten Komponenten, wie z.B. Administratoren. |
*'''Parameter:''' Parameter sind Variablen, über die ein Computerprogramm oder Unterprogramm, für einen Aufruf gültig, auf bestimmte Werte "eingestellt" werden kann. | *'''Parameter:''' Parameter sind Variablen, über die ein Computerprogramm oder Unterprogramm, für einen Aufruf gültig, auf bestimmte Werte "eingestellt" werden kann. | ||
Zeile 65: | Zeile 63: | ||
*'''Peer-to-Peer:''' Unter Peer-to-Peer versteht man eine direkte Rechner zu Rechner Verbindung. Beide Rechner sind gleichberechtigt, ein Server wird nicht benötigt. | *'''Peer-to-Peer:''' Unter Peer-to-Peer versteht man eine direkte Rechner zu Rechner Verbindung. Beide Rechner sind gleichberechtigt, ein Server wird nicht benötigt. | ||
− | *'''Port:''' | + | *'''Port:''' Ein Port ist der Teil einer Netzwerkadresse, der für die Zuteilung der für die Übertragung verwendeten Netzwerkprotokolle zuständig ist. Dargestellt wird ein Port mit einer Nummer von 0 bis 65535. |
− | *''' | + | *'''Primärschlüssel:''' Als Primärschlüssel bezeichnet man in einer Datenbank die Spalten einer Tabelle, die für jede Zeile einen unterschiedlichen / eindeutigen Wert besitzen. Somit kann jede Zeile über eben diesen eindeutig benannt werden. |
*'''Profilseite:''' Als Profilseite bezeichnet man eine Seite, auf der einem angemeldeten Nutzer persönliche Informationen zur Verfügung gestellt werden. | *'''Profilseite:''' Als Profilseite bezeichnet man eine Seite, auf der einem angemeldeten Nutzer persönliche Informationen zur Verfügung gestellt werden. | ||
− | *'''Relation:''' | + | *'''Relation:''' Eine Relation ist die Beziehung zwischen zwei Objekten, und wird in Datenbanken als eigene Tabelle, oder in einem Teil der Tabelle eines der betroffenen Objekte beschrieben. |
− | *'''Schnittstelle:''' Eine Schnittstelle (auch Interface) dient zur Kommunikation zwischen Modulen eines Systems oder zwischen dem Menschen und | + | *'''Schnittstelle:''' Eine Schnittstelle (auch Interface) dient zur Kommunikation zwischen Modulen eines Systems oder zwischen dem Menschen und Modulen eines Systems. Schnittstellen müssen immer exakt definiert sein. |
*'''SDK:''' Ein Software Development Kit (SDK) ist eine Sammlung von Werkzeugen und Anwendungen, um eine Software zu erstellen. | *'''SDK:''' Ein Software Development Kit (SDK) ist eine Sammlung von Werkzeugen und Anwendungen, um eine Software zu erstellen. | ||
Zeile 267: | Zeile 265: | ||
==Produktübersicht== | ==Produktübersicht== | ||
Der HWR-Chat ist ein Chatprogramm, das übliche Chatfunktionen wie persönlicher Chat, Gruppen-Chat, Dateiübertragung sowie Strukturierung von Kontakten in einer Liste bietet.<br> | Der HWR-Chat ist ein Chatprogramm, das übliche Chatfunktionen wie persönlicher Chat, Gruppen-Chat, Dateiübertragung sowie Strukturierung von Kontakten in einer Liste bietet.<br> | ||
− | Der Chat ist nicht öffentlich zugänglich, sondern explizit für Studenten, Dozenten und andere Mitarbeiter der HWR-Berlin vorgesehen. Aus diesem Grund ist das Anlegen eines neuen Profils nur durch | + | Der Chat ist nicht öffentlich zugänglich, sondern explizit für Studenten, Dozenten und andere Mitarbeiter der HWR-Berlin vorgesehen. Aus diesem Grund ist das Anlegen eines neuen Profils nur durch einen Administrator möglich. |
===Systemarchitektur=== | ===Systemarchitektur=== | ||
Zeile 299: | Zeile 297: | ||
===Datenbank=== | ===Datenbank=== | ||
− | *Zunächst sollen alle User in einer Tabelle festgehalten werden.<br>Diese sollen neben einer eindeutigen ID alle im unten dargestellten ER-Diagramm aufgeführten Attribute enthalten. Die Benutzer- | + | *Zunächst sollen alle User in einer Tabelle festgehalten werden.<br>Diese sollen neben einer eindeutigen ID alle im unten dargestellten ER-Diagramm aufgeführten Attribute enthalten. Die Benutzer-ID und der Nickname sind eindeutig. <br>Eine Besonderheit stellen die Profilbilder dar. Diese sollen auf dem Server abgelegt und nur die Pfade in der Datenbank gespeichert werden. |
− | *Um eine Kontaktbeziehung darzustellen braucht man noch eine "kennt"- Tabelle. Diese soll lediglich zwei IDs der Benutzer enthalten. User kennt User. Dabei ist zu | + | *Um eine Kontaktbeziehung darzustellen braucht man noch eine "kennt"- Tabelle. Diese soll lediglich zwei IDs der Benutzer enthalten. User kennt User. Dabei ist zu beachten, dass nur wenn die Benutzer IDs in beide Richtungen eingetragen sind, die Nutzer sich auch beide kennen. Wird nur eine einseitige Beziehung geführt handelt es sich um eine intiale Kontaktanfrage, wobei der Gegenüber (noch) nicht angenommen hat. |
*Für die Gruppeneinteilung muss eine Tabelle "Gruppe" erstellt werden, die den Namen und eine ID als Primär-Schlüssel enthält.<br>Es soll eine Relation "ist in Gruppe" existieren, bei der eine User-ID und eine Gruppen-ID gespeichert werden. Beide zusammen ergeben den Primärschlüssel. | *Für die Gruppeneinteilung muss eine Tabelle "Gruppe" erstellt werden, die den Namen und eine ID als Primär-Schlüssel enthält.<br>Es soll eine Relation "ist in Gruppe" existieren, bei der eine User-ID und eine Gruppen-ID gespeichert werden. Beide zusammen ergeben den Primärschlüssel. | ||
[[Image:Er-Modell-HWR-Chat.png ]] | [[Image:Er-Modell-HWR-Chat.png ]] | ||
===Login=== | ===Login=== | ||
− | Dieses Zustandsdiagramm beschreibt den Vorgang des Login. Dabei sendet der Client eine Login-Anfrage an den Server, der diese entweder zurückweist | + | Dieses Zustandsdiagramm beschreibt den Vorgang des Login. Dabei sendet der Client eine Login-Anfrage an den Server, der diese entweder zurückweist oder anerkennt.<br> |
[[Datei:Zustandsdiagramm_dbquery.png]] | [[Datei:Zustandsdiagramm_dbquery.png]] | ||
===Gekapseltes Nachrichtenmodell=== | ===Gekapseltes Nachrichtenmodell=== | ||
− | Um die Daten bequem vom Client zum Server senden zu können, soll ein gekapseltes Modell verwendet werden. So können einfach AMessage Objekte versendet werden, um den Rest kann sich jede Funktion selber kümmern. Ist kein Empfänger angegeben, so ist die Nachricht für den Server. Ansonsten leitet der Server diese weiter | + | Um die Daten bequem vom Client zum Server senden zu können, soll ein gekapseltes Modell verwendet werden. So können einfach AMessage Objekte versendet werden, um den Rest kann sich jede Funktion selber kümmern. Ist kein Empfänger angegeben, so ist die Nachricht für den Server. Ansonsten leitet der Server diese weiter und führt gegebenenfalls ergänzende Arbeiten aus.<br> |
− | Das | + | Das bedeutet, dass neben Textnachrichten auch Kontaktanfragen, Gruppenerstellungen, Gruppeneinladungen und Adressänderungen Nachrichten sind.<br> |
Eine Beschreibung des Sachverhaltes stellt folgendes Klassendiagramm dar: <br> | Eine Beschreibung des Sachverhaltes stellt folgendes Klassendiagramm dar: <br> | ||
− | |||
[[Datei:110909-Message Model.png]] | [[Datei:110909-Message Model.png]] | ||
+ | |||
+ | Jede Nachricht hat zwei Attribute vom Typ AAdress, diese können Benutzer oder Gruppen sein. Dabei dient ein Attribut zur Kennzeichnung des Senders, das andere für den Empfänger.<br> | ||
+ | Die im Diagramm dargestellten AMessage-Typen können bei Bedarf um weitere ergänzt werden. | ||
===Versenden einer Nachricht=== | ===Versenden einer Nachricht=== | ||
Zeile 322: | Zeile 322: | ||
===Nachrichtenweiterleitung vom Server=== | ===Nachrichtenweiterleitung vom Server=== | ||
Dieses Aktivitätsdiagramm beschreibt, wie der Server eine Nachricht (in diesem Spezialfall eine Textnachricht), die ein Client versendet hat, an den Empfänger weiterleiten soll.<br> | Dieses Aktivitätsdiagramm beschreibt, wie der Server eine Nachricht (in diesem Spezialfall eine Textnachricht), die ein Client versendet hat, an den Empfänger weiterleiten soll.<br> | ||
− | |||
[[Datei:Aktivitaetsdiagramm_nachricht-weiterleiten.png]] | [[Datei:Aktivitaetsdiagramm_nachricht-weiterleiten.png]] | ||
===Datenerhaltungskonzept: Server Data Access Object=== | ===Datenerhaltungskonzept: Server Data Access Object=== | ||
− | *Die Anmeldung der User soll am Server erfolgen. Dabei lädt der Nutzer sein Profil sowie seine ihm bekannten Kontakte und Gruppen. Diese Daten müssen daher für den Server vorgehalten werden, damit dieser sie bei Bedarf speichern, bearbeiten oder auch löschen kann. Um auch bei einem möglichen Absturz oder beim Herunterfahren konsistente Daten zu gewährleisten, soll hierzu eine Datenbank genutzt werden. | + | *Die Anmeldung der User soll am Server erfolgen. Dabei lädt der Nutzer sein Profil sowie seine ihm bekannten Kontakte und Gruppen. Diese Daten müssen daher für den Server vorgehalten werden, damit dieser sie bei Bedarf speichern, bearbeiten oder auch löschen kann. Um auch bei einem möglichen Absturz oder beim Herunterfahren konsistente Daten zu gewährleisten, soll hierzu eine Datenbank genutzt werden. |
− | *Für die konkrete Implementierung bedeutet | + | *Für die konkrete Implementierung bedeutet dies, dass es zwei unterschiedliche Datenmodelle gibt. Zum Einen die Datenbank selbst (und deren Schnittstelle um Daten auszulesen / zu speichern) und andererseits ein internes Datenmodell des Servers. Beim initialen Start wird die Datenbasis des Servers mit der Datenbank synchronisiert, was im konkreten Fall bedeutet, dass alle Nutzer und Gruppen geladen werden. Werden nun lesende Anfragen gestellt, wird nur die ServerDatenStruktur benutzt, die Datenbank bleibt unangetastet (Performance). Erst wenn Daten verändert werden, muss ein Abgleich der Datenbank mit dem Server erfolgen, damit die Daten konsistent bleiben. |
− | *Die Datenerhaltung auf dem Server erfolgt durch einen Liste von Benutzerobjekten, die wiederum Referenzen auf andere Gruppen/User Objekte besitzen. Diese Objektorientiertheit hat den Vorteil, das bei Änderung eines Users, die User die auf diesen User referenziert worden sind | + | *Die Datenerhaltung auf dem Server erfolgt durch einen Liste von Benutzerobjekten, die wiederum Referenzen auf andere Gruppen/User Objekte besitzen. Diese Objektorientiertheit hat den Vorteil, das bei Änderung eines Users, die User die auf diesen User referenziert worden sind, unmittelbar die aktuellen Daten bereithält. Der Server muss bei Änderungen nur dafür Sorge tragen, dass alle Freunde, die diesen Nutzer kennen, diese Änderung auch mitbekommen. |
− | *Die einzigen Daten die nicht mit der Datenbank synchronisert werden sind die Statuseinträge, da diese | + | *Die einzigen Daten, die nicht mit der Datenbank synchronisert werden, sind die Statuseinträge, da diese lediglich live existieren.<br> |
+ | Wenn die Statusnachricht benutzerdefiniert implementiert wird, würde sie wiederum gespeichert werden. | ||
===Config-Manager=== | ===Config-Manager=== | ||
− | Bestimmte Einstellungen müssen in Konfigurationsdateien gespeichert werden, damit bei Änderung das Programm nicht neu kompiliert werden muss. Das betrifft unter anderem die Adresse des Servers, die Adresse der Datenbank oder das ausgewählte Design des Clients. Wenn eine solche Datei noch nicht existiert, soll diese mit vorgegebenen Standardeinstellungen automatisch erstellt werden. Es soll ein System für beide Konfigurationsdateien (Server, Client) entwickelt und | + | Bestimmte Einstellungen müssen in Konfigurationsdateien gespeichert werden, damit bei Änderung das Programm nicht neu kompiliert werden muss. Das betrifft unter anderem die Adresse des Servers, die Adresse der Datenbank oder das ausgewählte Design des Clients. Wenn eine solche Datei noch nicht existiert, soll diese mit vorgegebenen Standardeinstellungen automatisch erstellt werden. Es soll ein System für beide Konfigurationsdateien (Server, Client) entwickelt und standardisiert werden. Die Konfigurationsdateien sollen "server.conf" und "client.conf" heißen und mit einem Texteditor veränderbar sein. |
===Server-Kommandos=== | ===Server-Kommandos=== | ||
− | Direkt am Server | + | Direkt am Server solldie Eingabe verschiedener Kommandos möglich sein, um so beispielsweise einen neuen Benutzer zu registrieren.<br> |
− | Der Server soll eine Konsole besitzen. | + | Der Server soll eine Konsole besitzen. Folgende Kommandos soll der Server verarbeiten können: |
− | Folgende Kommandos soll der Server | + | |
{| class="wikitable" | {| class="wikitable" | ||
Zeile 349: | Zeile 348: | ||
| register <Name> <Mail>|| Registriert einen neuen Benutzer mit angegebenem Namen und Mail Adresse <br> | | register <Name> <Mail>|| Registriert einen neuen Benutzer mit angegebenem Namen und Mail Adresse <br> | ||
|- | |- | ||
− | | listUsers || | + | | listUsers || Listet alle User auf |
|- | |- | ||
− | | listGroups || | + | | listGroups || Listet alle Gruppen auf |
|- | |- | ||
| resetPassword <ID> || Setzt ein neues Passwort | | resetPassword <ID> || Setzt ein neues Passwort | ||
Zeile 360: | Zeile 359: | ||
|} | |} | ||
− | Bei Bedarf | + | Bei Bedarf sollen ergänzend auch verschiedene Informationen auf der Server-Konsole angezeigt werden können. |
==Produktdaten== | ==Produktdaten== | ||
Zeile 393: | Zeile 392: | ||
*Die Nutzung oder Anpassung des Logos der HWR-Berlin für den Chat ist rechtlich zu prüfen. | *Die Nutzung oder Anpassung des Logos der HWR-Berlin für den Chat ist rechtlich zu prüfen. | ||
*Gespeicherte persönliche und sensible Daten sind vor unbefugtem Zugriff aus datenschutzrechtlichen Gründen zu schützen. | *Gespeicherte persönliche und sensible Daten sind vor unbefugtem Zugriff aus datenschutzrechtlichen Gründen zu schützen. | ||
− | *Für die Passwörter gelten besondere Sicherheitsanforderungen: Diese dürfen nur verschlüsselt gespeichert werden. | + | *Für die Passwörter gelten besondere Sicherheitsanforderungen: Diese dürfen nur stark verschlüsselt gespeichert werden. |
*Die Oberfläche soll ohne weitere Anleitung von jedem intuitiv bedienbar sein. | *Die Oberfläche soll ohne weitere Anleitung von jedem intuitiv bedienbar sein. | ||
*Der Chat-Client soll für alle gängigen Betriebssysteme zur Verfügung gestellt werden. | *Der Chat-Client soll für alle gängigen Betriebssysteme zur Verfügung gestellt werden. | ||
Zeile 458: | Zeile 457: | ||
====Test-Client==== | ====Test-Client==== | ||
*Der Clientrechner muss netzwerkfähig sein, um sich mit dem Server verbinden zu können. | *Der Clientrechner muss netzwerkfähig sein, um sich mit dem Server verbinden zu können. | ||
− | |||
− | |||
− | |||
==Gliederung in Teilprodukte== | ==Gliederung in Teilprodukte== | ||
Zeile 472: | Zeile 468: | ||
===Server=== | ===Server=== | ||
Der Server wird an die HWR-Berlin geliefert und von dieser in ihrem Rechenzentrum betrieben. Der Server stellt mit Hilfe der angebundenen Datenbank Informationen für die Clients zur Verfügung und steuert die Kommunikation zwischen ihnen. | Der Server wird an die HWR-Berlin geliefert und von dieser in ihrem Rechenzentrum betrieben. Der Server stellt mit Hilfe der angebundenen Datenbank Informationen für die Clients zur Verfügung und steuert die Kommunikation zwischen ihnen. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− |