Software Engineering Groep 3

Transcriptie

1 Software Engineering Groep 3 Software Design Document(1 e iteratie) Koen Gremmelprez (Design Manager) 3 e Bachelor Computerwetenschappen koen.gremmelprez@vub.ac.be se3@tinf.vub.ac.be 22 februari 2009 Document geschiedenis v0.1 22/02/2009 Koen Gremmelprez Draft v0.2 8/03/2009 Kristof Van Moffaert Klassenbeschrijvingen toegevoegd v0.3 16/03/2009 Diane De Coster Extra Klassenbeschrijvingen toegevoegd v0.4 beta 26/03/2009 Koen Gremmelprez Database beschrijvingen toegevoegd(momenteel inconsequent)

2 INHOUDSOPGAVE 2 Inhoudsopgave 1 Inleiding 3 2 Architectuur Presentation Layer Business logic Persistence layer Database design user agenda membership view rule event recurring rule Business logic Agenda Attributen Procedures Membership Attributen Procedures User Attributen Procedures ViewRule Attributen Event Attributen Procedures RecurringEvent Attributen Procedures Logger Attributen Procedures DateManager Attributen Procedures Attributen TimeBuilder Procedures ICalExporter Attributen Procedures Notification Hulpstructuren google-rfc Joda-time library

3 1 INLEIDING 3 1 Inleiding In dit document wordt de tweede en definitieve iteratie van het software design van groep 3 voor het vak Software Engineering vastgelegd. Het document wordt opgesteld en onderhouden door de Design Manager(DM). 2 Architectuur Het systeem is opgebouwd in een veelgebruikt 3 lagen systeem. Het gebruik van de lagen maakt het systeem eenvoudiger in onderhoud. Zo is het bijvoorbeeld mogelijk om de bovenste laag, de presentation layer, te vervangen door een applicatie zonder dat de daaronder liggende lagen aanpassing vereisen. J2EE biedt structuren en mechanismen aan die nauw aansluiten bij deze architectuur en hiervan wordt uiteraard gebruik gemaakt. 2.1 Presentation Layer De presentation layer is de bovenste laag in het systeem. Deze laag staat in voor de grafische opbouw van de pagina s, die vervolgens aan de browser van de gebruiker worden aangeboden. J2EE biedt hiervoor Java Server Pages(JSP) en servlets aan, die uitgevoerd worden binnen onze tomcat application server. De uitwerking van de presentation layer, die de GUI vormt, wordt niet besproken in dit document maar is uitgewerkt in een apart GUI document, opgesteld en onderhouden door de GUI manager. 2.2 Business logic De middelste laag van het systeem, de zogenaamde business logic, bevat alle code die karakteristiek is voor het systeem en de concepten binnen het systeem zelf. Deze laag moet in principe het hele systeem logisch modelleren op een algemene manier, zodat ze door een heel andere soort application layer(bvb. een text-based programma) kan worden gebruikt zonder wijzigingen. Hoewel er in J2EE specifieke voorzieningen zijn voor deze laag, de Enterprise Java Beans(EJB), wordt hier geen gebruik van gemaakt. De voordelen die deze EJB s hebben voornamelijk te maken met het gebruik van meedere servers en het consistent houden van transactions. Omdat deze features voor dit project van minder belang zijn en het gebruik ervan voor nogal wat extra complexiteit zorgt, is er besloten om deze technologie niet te gebruiken. Het team heeft er geen ervaring mee en de leerdrempel rechtvaardigt de toegevoegde waarde niet. Bovendien vereist dit ook een aangepaste application server, aangezien tomcat geen ondersteuning aanbiedt voor EJB s. Onze business logic zal dus bestaan uit standaard java objecten, ook wel Plain Old Java Objects(POJO) genaamd. 2.3 Persistence layer De persistence layer is de onderste laag van het systeem. Deze laag staat in voor de opslag en het opnieuw aanroepen van de gegevens die de business logic nodig heeft. De fundamenten van deze laag worden gevormd door een relationele databank. Er wordt gebruik gemaakt van MySQL, door de goede performantie en grote ondersteuning die deze veelgebruikte database software geniet. Het aanspreken van deze database gebeurt via de JDBC connectiviteit, die in Java zit ingebakken. Wederom zijn er krachtigere alternatieven, die Object Relational Mapping(ORM) toelaten, met als meest gekende het hibernate framework. Maar gezien de complexiteit van deze systemen, gecombineerd met de onervaring binnen het team, lijkt JDBC de betere keuze. Het gebruik van JDBC dient echter wel beperkt te blijven tot de Persistence layer en mag niet voorkomen in de Business logic. Op deze manier blijft de manier van opslag

4 3 DATABASE DESIGN 4 helemaal vrij en is opslag in een compleet ander formaat, bijvoorbeeld simpele tekstbestanden, relatief eenvoudig te implementeren. 3 Database design Figuur 1: Het database design wordt weergegeven in figuur 1. In wat volgt wordt er bij sommige velden wat extra uitleg gegeven. 3.1 user De records in user stellen gebruikers van het systeem voor. u id primaire sleutel, auto increment login moet uniek zijn password Moet versleuteld zijn opgeslagen salt Password salt 3.2 agenda a id primaire sleutel, auto increment u id u id van de adminstrator van de deze calendar

5 3 DATABASE DESIGN membership Een record in membership stelt het lidmaatschap van de ene kalender bij de andere voor. De status bepaalt of het al dan niet om een bevestigd lidmaatschap gaat. parent moet verschillen van child child moet verschillen van parent status mogelijke waarden: 0 aangevraagd door parent, nog niet bevestigd door child 1 aangevraagd door child, nog niet bevestigd door parent 10 aangevraagd door parent, afgewezen door child 11 aangevraagd door child, afgewezen door parent 20 volwaardige membership 3.4 view rule De records van view rule stellen extra regels voor, die de normale toegang tot kalenders tegenover bepaalde gebruikers kunnen overroepen. rights bepaalt de rechten van de user voor deze rule. Mogelijke waarden: 0 geen toegang 1 lees-toegang tag match bepaalt in hoeverre de tag moet overeenkomen. Mogelijke waarden: 0 alles matcht (regel heeft effect op hele kalender) 1 kalender-tag moeten beginnen met right-tag 2 kalender-tag moeten eindigen op right-tag 3 kalender-tag moeten right-tag bevatten 4 kalender-tag moeten identiek zijn aan right-tag 3.5 event De records in event stellen een tijdsslot in een agenda voor. s id primaire sleutel, auto increment type bepaalt wat het slot voorstelt. Mogelijke waarden: 0 afspraak 1 geblokkeerde ruimte(blockedslot) duration in minuten

6 4 BUSINESS LOGIC recurring rule Een record in de recurring rule tabel stelt een rrule uit de RFC-2445 standaard voor. De fields komen overeen met de specificaties van een RRule. Bij de fields waar meerdere waarden mogelijk zijn, worden de waarden samen opgeslagen in ASCII, geformateerd volgens de RFC specificaties. Voor een uitgebreide beschrijving van alle fields verwijzen we door naar de RFC-2445 specificaties. rr id primaire sleutel, auto increment e id Het id van de event waarop de recurring rule gedefinieerd is. 4 Business logic Figuur 2: In deze sectie zullen we de verschillende componenten van figuur [?] bespreken. We hebben oog voor de verschillende attributen en functies binnen een klasse. 4.1 Agenda Een centrale klasse in dit project is de agenda klasse. Deze is hiërarchisch gelinkt aan superof subagenda s. Het bevat op zijn beurt verschillende events, die afspraken voorstellen in de reële wereld.

7 4 BUSINESS LOGIC Attributen id name Type: Int Beschrijving :Een agenda bevat een uniek id om een agenda te identificeren. Type: String Beschrijving : De gebruiker heeft de mogelijkheid een agenda een bepaalde naam toe te wijzen. description Type: String Beschrijving : Naast een naam, kan een agenda een beschrijving bevatten. Dit is in feite de tag informatie waarop andere gebruikers kunnen zoeken Procedures register Parameters : User admin, String name, String description Resultaat : Een Agenda object Beschrijving : De register procedure zal een nieuwe agenda toevoegen in het systeem. Bij de aanmaak van een agenda object wordt naast de administrator van nieuwe agenda, ook de agendanaam en de beschrijving meegeleverd. unregister Resultaat : boolean Beschrijving : Deze procedure zal een agenda loskoppelen van zijn eventuele superen subklassen. De booleaanse waarde indiceert of de procedure succesvol was of niet. Agenda Parameters : int id Beschrijving : Dit is de constructor van de Agenda klasse. Het unieke agendaid zal meegeleverd worden als paramater en wordt zodoende ook opgeslaan in de databank. getappointmentsinday Parameters : Date d, User u Resultaat : vector< Event > Beschrijving : Gegeven een datum en een gebruiker van het systeem, zal deze procedure elke afspraak( d.i. een event) uit de agenda die voldoet aan deze voorwaarden opslaan in een vector datastructuur. getappointmentsinweek

8 4 BUSINESS LOGIC 8 Parameters : Date d, User u Resultaat : vector< Event > Beschrijving : Gegeven een datum en een gebruiker van het systeem, zal deze procedure elke afspraak( d.i. een event) uit de agenda die voldoet aan deze voorwaarden opslaan in een vector datastructuur. getappointmentsinmonth search Parameters : Date d, User u Resultaat : vector< Event > Beschrijving : Gegeven een datum en een gebruiker van het systeem, zal deze procedure elke afspraak( d.i. een event) uit de agenda die voldoet aan deze voorwaarden opslaan in een vector datastructuur. Parameters : String term, User u Resultaat : vector< Event > Beschrijving : De search-procedure zal de agenda overlopen en zoeken naar de meegeleverde term. Dit is een tag of een titel van een afspraak, waarnaar de meegeleverde user op zoek is. getparents Resultaat : vector< Agenda > Beschrijving : getparents() geeft diens superagenda s terug van de eerste generatie en slaat deze op in een vector datastructuur. getchildren Resultaat : vector< Agenda > Beschrijving : getchildren() geeft diens subagenda s terug van de eerste generatie en slaat deze op in een vector datastructuur. requestparent Parameters : Agenda parent Resultaat : boolean Beschrijving : de requestparent procedure bevat de functionaliteit om een aanvraag in te dienen om superagenda te worden van de meegeleverde agenda. requestchild Parameters : Agenda child Resultaat : boolean Beschrijving : de requestchild procedure bevat de functionaliteit om een aanvraag in te dienen om subagenda te worden van de meegeleverde agenda.

9 4 BUSINESS LOGIC Membership Deze klasse bevat de status van de relatie tussen verschillende agenda s. Deze status is belangrijk bij het versturen van een eventuele aanvraag of confirmatie van lidmaanschap van agenda s. Afhankelijk van deze status kunnen we de gebruiker verscheidene boodschappen melden over diens agenda s Attributen Status Type: MembershipStatus Beschrijving : Deze waarde bevat de huidige status van de relatie tussen twee agenda s Procedures setstatus Parameters : MembershipStatus Beschrijving : De setter om de waarde van de relatie te wijzigen. getstatus 4.3 User Resultaat : MembershipStatus status Beschrijving : De getter om de waarde van de relatie te verkrijgen. Deze klasse beschrijft de gebruikers van het systeem. Zij beschikken over één of meerdere agenda s die ze kunnen bekijken indien ze administrator zijn van deze agenda of van een subagenda of indien speciaal gespecificeerd in de viewrules Attributen id login Type : Int Beschrijving : Een gebruiker heeft een uniek id om zich te identificeren in het systeem. Dit id is voor de gebruiker zelf niet zichtbaar. Type : String Beschrijving : Een user heeft een unieke login naam waarmee hij zichzelf kan aanmelden. password Type : String Beschrijving : Om zich aan te melden heeft de user naast zijn unieke login naam ook een paswoord nodig. Dit beschermt zijn account tegen onrechtmatig gebruik.

10 4 BUSINESS LOGIC 10 firstname Type : String Beschrijving : De voornaam van de gebruiker zodat andere gebruikers hem kunnen identificeren. lastname mail Type : String Beschrijving : De achternaam van de gebruiker zodat andere gebruikers hem kunnen identificeren. Type : String Beschrijving : Het adres van de gebruiker. Momenteel nog puur informatief maar kan mogelijk in de toekomst gebruikt worden om de gebruiker toe te laten meldingen per mail te ontvangen Procedures register Parameters : String login, String password, String mail, String firstname, String lastname Resultaat : Boolean Beschrijving : Deze procedure zal een nieuwe gebruiker toevoegen aan het systeem. Alle attributen moeten meegegeven worden behalve het id die automatisch door het systeem wordt toegekend. De booleaanse waarde indiceert of de procedure succesvol was of niet. Deze procedure is static. unregister User User Resultaat : boolean Beschrijving : Deze procedure verwijdert de gebruikers uit het systeem. Ook de viewrules en de agenda s waarvan de gebruiker administrator was worden verwijderd. Parameters : int id Beschrijving : Dit is een constructor van de User klasse. De usermanager klasse gebruikt deze om een User object aan te maken eens het uitgelezen is uit de database. Bijvoorbeeld wanneer we info willen halen uit een user. Parameters : String login, String password

11 4 BUSINESS LOGIC 11 Beschrijving : Dit is een tweede constructor van de User klasse. Deze wordt gebruikt wanneer de client een login request zend. De User klasse roept dan de usermanager op om het User object aan te maken indien de login succesvol was. En anders wordt er een error te gegooid. getviewruleagendas Resultaat : vector< Agenda > Beschrijving : Deze procedure geeft een lijst terug met alle agenda s waarop de gebruiker leestoegang heeft gespecificeerd door de viewrules. getagendatree Resultaat : sometreestructure< Agenda > Beschrijving : Deze procedure geeft een boomstructuur terug van alle agenda s die de gebruiker kan zien. Zij het doordat hij administrator is, administrator van een subagenda of doordat er een speciale viewrule is gespecificeerd. getsuperagendas Resultaat : vector< Agenda > Beschrijving : Deze procedure geeft een lijst terug met alle agenda s die de gebruiker kan bekijken doordat hij administrator is van een subagenda. getadminagendas Resultaat : vector< Agenda > Beschrijving : Deze procedure geeft een lijst terug met alle agenda s waarvan de gebruiker administrator is. getnotifications Resultaat : vector< Notification > Beschrijving : Deze procedure geeft een lijst terug met alle meldingen die aan de gebruiker gericht zijn. Met andere woorden, meldingen waarin de gebruiker vermeld staat als requestee. 4.4 ViewRule Deze klasse beschrijft de viewrules. De viewrules geven lees-toegang tot agenda s aan gebruikers zonder dat deze administrator zijn van deze agenda of van een subagenda. Om deze lees-toegang te verlenen moet de viewrule zijn goedgekeurd door zowel de gebruiker als de administrator van de agenda.

12 4 BUSINESS LOGIC Attributen Uid Aid tag status 4.5 Event Type : Int Beschrijving : Het User ID van de gebruiker waarvoor de ViewRule geldt. Type : Int Beschrijving : Het ID van de agenda waarvoor de ViewRule geldt. Type : String Beschrijving : Dit attribuut specificeert of de ViewRule enkel betrekking heeft op Events met een welbepaalde tag. Type : MemberschipStatus Beschrijving : De status van de viewrule. De event klasse stelt een afspraak uit de databank voor. Samen met de gebruikelijke informatie, zoals bijvoorbeeld naam, locatie, e.d. Bevat deze klasse eveneens de eventuele recurrentieregels Attributen name Type: String Beschrijving : De naam van een event wordt opgeslaan. location Type: String Beschrijving : De locatie van een event wordt opgeslaan. starttime Type: datetime Beschrijving : De begindatum van een event wordt opgeslaan. duration Type: Int Beschrijving : De duur van een event wordt opgeslaan.

13 4 BUSINESS LOGIC Procedures getname Resultaat : String Beschrijving : De getter om de naam van de event te verkrijgen. setname Parameters : String newname Beschrijving : De setter om de naam van de event te wijzigen. getlocation Resultaat : String Beschrijving : De getter om de locatie van de event te verkrijgen. setlocation Parameters : String newlocation Beschrijving : De setter om de locatie van de event te wijzigen. getstarttime Resultaat : datetime Beschrijving : De getter om de startdatum van de event te verkrijgen. setstarttime Parameters : datetime dt Beschrijving : De setter om de startdatum van de event te wijzigen. getduration Resultaat : Int Beschrijving : De getter om de duur van de event te verkrijgen. setduration Parameters : Int dur Beschrijving : De setter om de duur van de event te wijzigen. partofrecurring Resultaat : boolean Beschrijving : De functie om na te kijken of deze event deel is van een wederkerige afspraak. Met behulp van de recurringrule zal deze functie kunnen bereken of de eigenlijke afspraak een wederkerige afspraak betreft.

14 4 BUSINESS LOGIC RecurringEvent Wederkerige afspraken zullen gebruik maken van deze klasse om opgeslaan te worden op de databank. Hiervoor maken we gebruik van de google-rfc-2445 bibliotheek. Deze bevat recurrentieregels om op een efficiënte manier wederkerigheid op te slaan, meerbepaald Rrule. Deze library biedt ook de mogelijkheid om uitzonderingen op de regel toe te laten. Deze worden vervolgens gebundeld in een RDateList Attributen rrule exdate Type: Rrule Beschrijving : De recurrentieregel van de RFC-2445 library. Type: RDateList Beschrijving : De uitzonderingen op de regel worden eveneens opgeslaan in een lijstachtige structuur Procedures getexpandedappointments 4.7 Logger Parameters : Date startdate, Data enddate Resultaat : vector< Event > Beschrijving : Deze functie zal de recurentieregel toepassen op de bijhorende event en zal events construeren, afgeleid van deze regel. De regel wordt als het ware uitgeschreven en er wordt een instantie van de event klasse geconstrueert voor elk voorkomen in de recurrentieregel. Eén van de opgelegde vereisten uit het SRS was de mogelijkheid om een logmechanisme in te bouwen. Op deze manier worden alle acties van de gebruiker en het systeem opgeslaan in een externe file. Het is deze klasse die zal instaan voor deze functionaliteit Attributen destination Type: File Beschrijving : Het externe bestand waarnaar alle informatie geschreven wordt Procedures log Parameters : String s Beschrijving : De meegeleverde string wordt geschreven naar het externe bestand.

15 4 BUSINESS LOGIC DateManager De DateManager klasse zal afhankelijk van een meegeleverde datum, alleshande eigenschappen kunnen bepalen die handig zijn voor zowel de Business als de Presentation Layer. Het maakt gebruik van de bibliotheek joda-time om de het begin van een week of maand te bepalen. Dit, samen met allerhande procedures die werken met datums Attributen currenttime Type: DateTime object Beschrijving : De huidige tijd, opgeslaan in een DateTime obeject van Joda-Time Procedures DateManager Resultaat : Een nieuwe DateManager object Beschrijving : Het DateManager object wordt geïnitialiseerd met de huidige tijd. getcurrenttime Resultaat : currenttime Beschrijving : Getter voor de huidige tijd. resetcurrenttime Beschrijving : Reset de tijd naar de huidige tijd. getstartofweek Resultaat : DateTime object Beschrijving : Aan de hand van currenttime, berekent deze procedure de begindatum van de week. getstartofmonth Resultaat : DateTime object Beschrijving : Aan de hand van currenttime, berekent deze procedure de begindatum van de maand. getstartofyear Resultaat : DateTime object

16 4 BUSINESS LOGIC 16 Beschrijving : Aan de hand van currenttime, berekent deze procedure de begindatum van het jaar. getstartofday Resultaat : DateTime object Beschrijving : Aan de hand van currenttime, berekent deze procedure het begin van de dag. getendofweek Resultaat : DateTime object Beschrijving : Aan de hand van currenttime, berekent deze procedure de einddatum van de week. getendofmonth Resultaat : DateTime object Beschrijving : Aan de hand van currenttime, berekent deze procedure de einddatum van de maand. getendofyear Resultaat : DateTime object Beschrijving : Aan de hand van currenttime, berekent deze procedure de einddatum van het jaar. getendofday Resultaat : DateTime object Beschrijving : Aan de hand van currenttime, berekent deze procedure het eind van de dag. numberofdaysinmonth Resultaat : Integer Beschrijving : Aan de hand van currenttime, berekent deze procedure het aantal dagen van de huidige maand. numberofdaysinweek Resultaat : Integer Beschrijving : Aan de hand van currenttime, berekent deze procedure het aantal weken van de huidige maand. numberofdaysinyear

17 4 BUSINESS LOGIC 17 Resultaat : Integer Beschrijving : Aan de hand van currenttime, berekent deze procedure het aantal dagen van het huidige jaar Attributen currenttime Type: DateTime object Beschrijving : De huidige tijd, opgeslaan in een DateTime obeject van Joda-Time. 4.9 TimeBuilder De TimeBuilder klasse is een klasse die voornamelijk gebruikt zal worden om de conversie te maken tussen Joda-Time objecten en DateTime objecten van SQL in de databank. Het is zo dat Agenda s, Events en dergelijke zowel in de databank als in het lokale geheugen voorgesteld kunnen worden. Ze maken echter gebruik van verschillende notaties om tijd voor te stellen. Het is deze klasse die instaat voor de conversie tussen beiden. Een ander nut van deze klasse, is dat het ook instaat voor de conversie tussen objecten van Joda-Time en objecten van de Google RFC 2445 bibliotheek. Deze bibliotheek gebruiken we voor het voor te stellen van recurrentie in events Procedures builddatetime Parameters : String s Resultaat : DateTime object van Joda-Time Beschrijving : De meegeleverde string wordt omgezet naar een DateTime object van Joda-Time. builddatetimestring Parameters : DateTime object van Joda-Time Resultaat : String Beschrijving : Het meegeleverde DateTime object van Joda-Time wordt omgezet naar een string. builddatevalue Parameters : DateTime object van Joda-Time Resultaat : DateValue Beschrijving : Het meegeleverde DateTime object van Joda-Time wordt omgezet naar een DateValue object van de Google RFC bibliotheek ICalExporter Deze klasse zal instaan voor het exporteren van de kalender naar de ICalStandaard.

18 5 HULPSTRUCTUREN Attributen Procedures 4.11 Notification Een Notification object stelt een mededeling voor die aan een gebruiker moet worden gemeld. De klasse heeft 4 verschillende subklassen, die de mogelijke mededelingen voorstellen. ChildRequestNfcn Een gebruiker ontvangt deze Notification wanneer een Agenda Membership heeft aangevraagd aan een Agenda waarvan de gebruiker admin is. ParentRequestNfcn Een gebruiker ontvangt deze Notification wanneer Agenda A Agenda B uitnodigt om lid van A te worden, waarbij de gebruiker admin is van agenda B. ViewAgendaRequestNfcn Een gebruiker ontvangt deze Notification wanneer een Agenda de gebruiker uitnodigt om toegang tot de agenda te verkrijgen via een ViewRule. ViewUserRequestNfcn Een gebruiker A ontvangt deze Notification wanneer een gebruiker B toegang tot een Agenda heeft aangevraagd via een ViewRule, waarbij gebruiker A admin van die Agenda is. 5 Hulpstructuren 5.1 google-rfc-2445 Deze library implementeert de RFC-2445 standaard. Wij maken gebruik van de voorzieningen met betrekking tot wederkerende afspraken. 5.2 Joda-time library De joda-time library biedt faciliteiten om eenvoudiger te rekenen met tijd. Meer info over deze library is te vinden in de tutorial[?].