WRM Software Design Document

[Company name] [WRM] [Project lead Name] [06/05/2009] [Document Ver !on]

""""""""""""""""""""""""""""""

[Project #ead $!%nature &loc']

""""""""""""""""""""""""""""""

[Project Mana%er $!%nature &loc']

TABLE CONTENTS
INTRODUCTION..............................................................................................................3 DESIGN OVERVIEW.......................................................................................................4 USER CHARACTERISTICS...........................................................................................4 REQUIREMENTS AND CONSTRAINTS.....................................................................4 SYSTEM ARCHITECTURE............................................................................................6 DETAILED DESIGN......................................................................................................10 DATA ARCHITECTURE...............................................................................................14 INTERFACE REQUIREMENTS..................................................................................16 USER INTERFACE........................................................................................................16

Version 1.0

[WRM] Software Requirements Management Plan06/05/2009 Revi i!" S#ee$ Re(! !on Num)er 0, Date Date &r!e* ummary o* c+an%e &a el!ne dra*t document

ii

Revision Sheet

Version 1.0

[WRM] Software Design Document Date

I"$%!&'($i!"
-+! document pec!*!e t+e cla d!a%ram et *or We) Rec!pe Mana%ement !te. We) )a ed Rec!pe Mana%ement /WRM0 ! a $oc!al Net1or'!n% $!te2 -+e purpo e o* t+e !te ! to !mplement appl!cat!on *or ea y rec!pe (!e1!n%2 a(!n% and +ar!n%.

1.1)'%*! e
-+! document pec!*!e t+e (+, e &i,-%,. *or t+! project3 !t pro(!de deta!l *or t+e cla e o* t+e pro%ram. -+e deta!l 2 *or eac+ cla !nclude 4 de cr!pt!on o* t+e cla 2 relat!on +!p 1!t+ ot+er cla e 2 *unct!on 2 met+od 2 attr!)ute and propert!e o* t+e cla . -+! $DD ! !ntended *or t+e *ollo1!n% aud!ence4 -+e y tem de(elopment team t+at 1!ll !mplement t+e cla e de*!ned !n t+! document.

1./S(!*e
-+e de !%n o* t+e cla e 1!ll )e )a ed on t+e -+ree5#ayer 6rc+!tecture 4 data layer2 lo%!c layer and 789 layer2 -+e !mplementat!on 1!ll )e )a ed on :a(a $+!nd!% ;pen $oc!al Re*erence !mplementat!on. -+! document de*!ne all t+e y tem cla e *or t+e data and lo%!c layer2 and t+e )a e cla e o* t+e 789 layer. -+e 789 layer conta!n t+e 1e) pa%e and *orm . ome o* t+e pa%e o* t+e y tem 1!ll )e )u!lt at run t!me )y t+e 7ad%et $er(er /e<pla!ned !n ect. 502 -+e ot+er 7u! layer cla e 1!ll )e de*!ned later. -+e cla e de*!n!t!on m!%+t c+an%e t+rou%+out t+e de(elopment proce 2 t+! document 1!ll e(ol(e 1!t+ t+e de(elopment l!*ecycle.

1.3De0i"i$i!" 1 A(%!"2. 1 ,"& A33%evi,$i!"

$DD D=D CD $CM WRM $6R $N$ $o*t1are De !%n Document Data =lo1 D!a%ram Cla D!a%ram $o*t1are Con*!%urat!on Mana%ement We) Rec!pe Mana%ement $mart 6%ent Re>ue t $oc!al Net1or'!n% $!te

Version 1.0

[WRM] Software Requirements Management Plan06/05/2009

1.4Re0e%e"(e
;t+er document or mater!al o* 1+!c+ t+e reader +ould )e a1are4 $R$4 $o*t1are Re>u!rement $pec!*!cat!on5WRM.

De i-" Ove%vie4
1.5B,(6-%!'"& I"0!%.,$i!"
-+e de !%n o* t+e cla e 1!ll )e )a ed on t+e -+ree5#ayer 6rc+!tecture . Cla e !n t+e data layer con ! t o* Data)a e $er(er 2 !n t+! cla e t+e !n*ormat!on ! tored and retr!e(ed. -+! layer 'eep data neutral and !ndependent *rom appl!cat!on er(er or )u !ne lo%!c. 7!(!n% data !t o1n layer al o !mpro(e cala)!l!ty and per*ormance. Cla e !n t+e lo%!c layer con ! t all t+e )u !ne lo%!c and proce e o* t+e pro%ram. Cla e !n t+e 789 layer con ! t all t+e 1e) pa%e /*orm t+at 1!ll )e (!e1 )y t+e u er . -+e !mplementat!on o* t+e !te2 1!ll )e )a ed on :a(a $+!nd!% ;pen $oc!al Re*erence !mplementat!on 1+!c+ ! a et o* common 6P9 *or )u!ld!n% oc!al net1or'. 6 ment!oned2 t+e cla ? de*!n!t!on m!%+t c+an%e t+rou%+out t+e de(elopment proce .

U e% C#,%,($e%i $i(
-+e )a e u er 1+!c+ 1!ll u e t+e y tem are not e<per!enced computer u er 2 t+ere*ore t+e y tem 1!ll )e (ery ea y and !ntu!t!(e to u e. -+e u er ! e<p ec t e d to und er t a n d and u e comp u t e r )a !c2 !nput/o u t p u t de(!ce uc+ a a 'ey)o a r d and mou e and 1e) ur*!n%. -+ere are t+ree type o* u er 4 G'e $ U e%7 6n anonymou u er !n !te. Re-i $e%e& U e%7 8 er t+at re%! tered )y *!ll !n a re%! trat!on *orm. A&.i"i $%,$!%7 -+e 1e) !te adm!n! trator 1!t+ e<panded pr!(!le%e .

9n t+e (+, e &i,-%,. 1e de*!ne a pe a r e d cla *or eac + type o* u er. =or t+e %ue t and re%! t e r e d u er2 !n t+e 789 layer2 t+e 789 cla e 1!ll )e de*!ne d 1!t+ e<tr a care *or u er *r!endly de !%n.

Re8'i%e.e"$ ,"& C!" $%,i"$

4 Version 1.0

[WRM] Software Design Document Date

1.6)e%0!%.,"(e Re8'i%e.e"$
&y u !n% 1e) er(er t+at er(e all cl!ent re>ue t t+rou%+ poplar 1e) )ro1 er@ 1e en ure t+at t+e appl!cat!on meet t+e per*ormance re>u!rement a de cr!)e !n t+e $R$ document. -+e 1e) er(er *or1ard re>ue t to ;pen $oc!al Net1or' er(er. -+e ;$N er(er comm!ttee to per*ormance t+at meet our re>ue t and ! %ood !n*ra tructure *or per*ormance a urance.

1.9Se('%i$2 Re8'i%e.e"$
8 !n% t+e ;$N ecur!ty y tem named ;6ut+ 1!ll en ure u er aut+ent!cat!on rule )a ed.

1.:De i-" C!" $%,i"$

-+e )!%%e t con tra!nt ! t!me. &y c+edul!n% project del!(er!n% to *!r t >uarter o* :une not all component 1!ll )e del!(ered.

Version 1.0

[WRM] Software Requirements Management Plan06/05/2009

S2 $e. A%(#i$e($'%e
I"$%!&'($i!" -+e purpo e o* t+! document ! to e<pl!cate t+e deta!led tec+n!cal arc+!tecture o* t+e WRM We) !te2 1+!c+ ! a $oc!al Net1or'!n% $!te /$N$0 )a ed on :a(a $+!nd!% ;pen $oc!al Re*erence !mplementat!on. S!0$4,%e S$,(6 -+! ect!on enl! t all t+e o*t1are t+at +a )een u ed *or t+e appl!cat!on de(elopment. :a(a ,.6 :a(aD& /Der)y0 :a(a $+!nd!% $er(er/;pen$oc!al50.90 7la *! + VA Prelude $er(er /:2BB :a(a 6ppl!cat!on $er(er0 :$= ,.2 1!t+ =acelet ,., O*e" S!(i,+ Ove%vie4 ;pen $oc!al ! a et o* common 6P9 *or )u!ld!n% oc!al. ;pen $oc!al allo1 de(eloper to 1r!te appl!cat!on to a common tandard 6P9 t+at 1!ll run on mult!ple 1e) !te . 9t ! )e!n% de(eloped )y 7oo%le !n conjunct!on 1!t+ partner *rom t+e We)/$oc!al 6ppl!cat!on de(elopment commun!ty -+e core ;pen $oc!al er(!ce !nclude People and =r!end Data 6P9 5 6cce *r!end !n*ormat!on pro%rammat!cally. 6ct!(!t!e Data 6P9 5 $ee 1+at you@re *r!end are up to $+are 1+at you are do!n%. Per ! tence Data 6P9 5 $+are data 1!t+ your *r!end 2 t+e 1orld. 6dd!t!onal 7ad%et er(!ce !nclude 7ad%et Core 5 8t!l!t!e +andl!n% %ad%et pre*erence 2 9;2 :$;N. 7ad%et =eature5$pec!*!c 5 8t!l!t!e *or 1or'!n% 1!t+ *la +2 1!ndo1 mana%ement2 ta) 2 rpc2 M!n!Me a%e. +ttp4//111.open oc!al.or%/

Version 1.0

[WRM] Software Design Document Date

A%(#i$e($'%,+ C!.*!"e"$

Fi-'%e WRM A**+i(,$i!" A%(#i$e($'%,+

Version 1.0

[WRM] Software Requirements Management Plan06/05/2009

S#i"&i- A**+i(,$i!" Ove%vie4 W+at ! $+!nd!%C D;pen $ource o*t1are t+at allo1 you to er(e ;pen $oc!al appl!cat!on E. $+!nd!% ! an ;pen $oc!al conta!ner and +elp you to tart +o t!n% ;pen $oc!al app >u!c'ly )y pro(!d!n% t+e code to render %ad%et 2 pro<y re>ue t 2 and +andle RB$- and RPC re>ue t . $+!nd!%? pr!mary %oal ! to pro(!de !n*ra tructure *or t+o e 1! +!n% to +o t ;pen $oc!al app on t+e!r 1e) !te . +ttp4//!ncu)ator.apac+e.or%/ +!nd!%/ $+!nd!% ! t+e re*erence !mplementat!on o* ;pen $oc!al 6P9 pec!*!cat!on 2 a tandard et o* $oc!al Net1or' 6P9 1+!c+ !nclude 4 Pro*!le Relat!on +!p 6ct!(!t!e $+ared appl!cat!on 6ut+ent!cat!on 6ut+or!Fat!on S#i"&i- e%ve% i&e .,i" (!.*!"e"$ -+! ! )a !cally 1e) conta!ner t+at +o t :a(a $oc!al Net1or'!n% $!te /$N$0 1+!c+ upport (ar!ou d!**erent *eature . -o ma'e t+! !te open oc!al compat!)le2 !.e.2 !t can +o t t+e ;pen $oc!al %ad%et 3 !t ! !nte%rated 1!t+ $+!nd!% :a(a $er(er2 1+!c+ ! an open ource !mplementat!on o* t+e ;pen $oc!al pec!*!cat!on and %ad%et pec!*!cat!on. $N$ !te ! al o re*erred a conta!ner2 a !t can +o t t+e ;pen $oc!al %ad%et and con*orm to t+e open oc!al pec!*!cat!on . 7ad%et $er(er 5 -+e ole re pon !)!l!ty o* t+! component ! to +andle t+e 7ad%et Render!n% re>ue t and return t+e rendered component o(er t+e G--P protocol. -+! component 1or' (! 5H5(! 7ad%et $er(er 1+!c+ render t+e %ad%et IM# !nto :a(a$cr!pt and G-M# *or t+e conta!ner to e<po e (!a t+e conta!ner :a(a$cr!pt. ;pen $oc!al Conta!ner 5 :a(a$cr!pt en(!ronment *or people2 act!(!t!e 2 per ! tence. $oc!al Data $er(let 5 Gandle re>ue t *or data and end to data +andler . ;pen $oc!al RB$- 6P9 5 -+e Re t*ul capa)!l!t!e o* t+e $+!nd!% conta!ner are e<po ed t+rou%+ t+! +andler. 9t er(e to *ul*!ll t+e ;pen $oc!al data re>ue t (!a RB$-*ul call . W+en a %ad%et ! rendered 1!t+!n t+e $N$2 !t !multaneou ly ma'e t+e ;pen$oc!al data re>ue t2 1+!c+ ! +andled t+rou%+ t+! component o* $+!nd!% Conta!ner..

Version 1.0

[WRM] Software Design Document Date

O*e" S!(i,+ C!"$,i"e% ; WRM I.*+e.e"$,$i!" $+!nd!% $er(!ce #ayer compr! e o* t+e er(!ce 1+!c+ con*orm to ;pen$oc!al pec . 9t compr! e o* People $er(!ce2 6ct!(!ty $er(!ce2 and 6ppl!cat!on $er(!ce. Bla)orat!on to eac+ o* t+e er(!ce ! %!(en )elo14 People $er(!ce People $er(!ce pro(!de t+e l! t o* people and *r!end )ound to t+! WRM $N$. -+! er(!ce *orm t+e ep!center o* complete ;pen$oc!al pec. 6ct!(!ty $er(!ce -+e 6ct!(!ty $er(!ce de*!ne t+e er(!ce pro(!der !nter*ace to retr!e(e t+e act!(!t!e /Rec!pe act!(!ty0 *rom t+e underly!n% $N$ data)a e. 6ppl!cat!on Data $er(!ce -+e 6ppl!cat!on $er(!ce de*!ne t+e er(!ce pro(!der !nter*ace t+at ! u ed to retr!e(e !n*ormat!on )ound to a per on. 6l o2 t+ere are met+od to update a delete data.

Version 1.0

[WRM] Software Requirements Management Plan06/05/2009

De$,i+e& De i-"

C+,

Di,-%,.

Fi-'%e C+,

Di,-%,.

10

Version 1.0

[WRM] Software Design Document Date

C+,
Name Purpose Superclass Interface Attributes

De (%i*$i!"
WRMDataService.java

Gandle t+e u er per onal data. 8 e t+e WRMData#ayer to retr!e(e t+e data *rom t+e D&2 or update t+e data !n t+e D&.

or%.apac+e. +!nd!%. oc!al.open oc!al.Data$er(!ce WRMData#ayer %etPer onData/0 J return Re pon e9tem conta!n!n% u er data to )e u ed )y $+!nd!% updatePer onData/0 J update u er data and return a Re pon e9tem to )e u ed )y $+!nd!%
WRMPeopleService.java

perations

Name

Purpose Superclass Interface Attributes

Gandle t+e u er contact !n*ormat!on. 8 e t+e WRMData#ayer to retr!e(e t+e contact !n*ormat!on *rom t+e D&2 or update t+e contact !n*ormat!on !n t+e D&.

or%.apac+e. +!nd!%. oc!al.open oc!al.People$er(!ce WRMData#ayer %etPeople/0 J return Re pon e9tem conta!n!n% #! t o* KPer onL accord!n% to 9D to )e u ed )y $+!nd!% %etContact ;*8 er/0 J return Re pon e9tem conta!n!n% #! t o* KPer onL *r!end to )e u ed )y $+!nd!% %etPer on/0 5 return Re pon e9tem a KPer onL accord!n% to 9D to )e u ed )y $+!nd!%

perations

11

Version 1.0

[WRM] Software Requirements Management Plan06/05/2009

Name Purpose Superclass Interface Attributes WRMRecipeService.java

Gandle a rec!pe data. 8 e t+e WRMData#ayer to retr!e(e t+e rec!pe data *rom t+e D&2 or update t+e rec!pe data !n t+e D&.

or%.apac+e. +!nd!%. oc!al.open oc!al.6ct!(!t!e $er(!ce WRMData#ayer %etRec!pe /0 J return Re pon e9tem conta!n!n% #! t o* KRec!peL accord!n% to 9D to )e u ed )y $+!nd!% createRec!pe/0 J create a ne1 Rec!pe and return Re pon e9tem conta!n!n% !t to )e u ed )y $+!nd!% %etRec!pe/0 5 return Re pon e9tem a K Rec!peL accord!n% to 9D to )e u ed )y $+!nd!%
!roup.java

perations

Name Purpose Superclass Interface

Gandle %roup de*!n!t!on and data

Attributes

name J name o* t+e %roup de cr!pt!on J de cr!pt!on o* t+e %roup per on J l! t o* KPer onL !n t+e %roup addPer on/0 J add a KPer onL to t+e %roup remo(ePer on/0 J remo(e a KPer onL *rom t+e %roup

perations

12

Version 1.0

[WRM] Software Design Document Date

Name Purpose Superclass Interface Person.java

Bnt!ty 1+!c+ +old a per on !n*ormat!on

Attributes

!d J !d o* t+e per on name J name o* t+e per on pu)l! +ed J date t+e account 1a created updated J date t+e account 1a updated )!rt+day J )!rt+day o* t+e per on %ender J %ender o* t+e per on note J note !n erted )y t+e per on rec!pe J l! t o* KRec!peL o* t+e per on addre J addre o* t+e per on addRec!pe/0 J create a ne1 Rec!pe !* needed and !n ert t+e Rec!pe to t+e Per on l! t o* Rec!pe remo(eRec!pe/0 J remo(e a Rec!pe *rom t+e Per on l! t o* Rec!pe
A""ress.java

perations

Name Purpose Superclass Interface

Bnt!ty 1+!c+ +old a per on@ addre

deta!l

Attributes

treet6ddre po talCode country c!ty

13

Version 1.0

[WRM] Software Requirements Management Plan06/05/2009

Name Purpose Superclass Interface Recipe.java

Bnt!ty 1+!c+ +old a rec!pe@ deta!l

Attributes

name J name o* t+e Rec!pe de cr!pt!on J de cr!pt!on o* t+e Rec!pe ummary J ummary o* t+e Rec!pe a(%7rade J a(era%e %rade o* t+e Rec!pe num;*7rader J num)er o* KPer onL 1+o %raded t+e Rec!pe (! !)!l!ty J determ!ne t+e le(el o* (! !)!l!ty o* t+e Rec!pe /pr!(ate/%roup/pu)l!c0 %radeRec!pe/0 J calculate t+e %rade o* t+e Rec!pe a*ter %ett!n% a ne1 %rade comment/0 J add a comment on t+e Rec!pe etV! !)!l!ty/0 J et t+e (! !)!l!ty o* t+e Rec!pe

perations

D,$, A%(#i$e($'%e
1.<D,$, A",+2 i
[6 )r!e* de cr!pt!on o* t+e procedure u ed !n upport o* data analy ! act!(!t!e +ould )e de cr!)ed !n t+! ect!on. 6ny analy ! o* t+e data t+at re ulted !n a c+an%e to t+e y tem de !%n2 or t+at !mpacted y tem de !%n2 +ould )e noted.] 6t t+! ta%e at lea t A $tored Procedure 1!ll )e u ed to analy data. Data 6naly ! pro(!ded )y tored procedure 4 6(era%e rec!pe %rade. 8 er rec!pe . 8 er lo%!n. 8 er *r!end . ;t+er Data 6naly ! 1!ll )e con !dered on demand.

1.10

O'$*'$ S*e(i0i(,$i!"
ta%e2 end!n% ma!l !

$end!n% ma!l *eature 1!ll )e upport !* Ma!l $er(er ! pre ente.!n t+! a *eature.

1.11
14

L!-i(,+ D,$,3, e M!&e+

Version 1.0

[WRM] Software Design Document Date

Fi-'%e D,$, M!&e+ 1

15

Version 1.0

[WRM] Software Requirements Management Plan06/05/2009

I"$e%0,(e Re8'i%e.e"$
9nter*ace re>u!rement are re*erenced !n t+e $R$ document c+apter 2.2 and M.A.

U e% I"$e%0,(e
WRM 1e) !te 789 ! )a ed on ;pen$oc!al -emplate .

16

Version 1.0