Aloha Social Networking Portal - Design Document

Aloha Social Network Design Document

Document/Version Number: Version 1.1

Creation Date: March 28, 2015

Account/Client: SOFTA Inc.

Author: Milind Gokhale;Renuka Deshmukh;Mrunal Pagnis;Vivek Supe

Editor: Milind Gokhale;Renuka Deshmukh;Mrunal Pagnis;Vivek Supe

Last Edit Date: March 28, 2015

File Name: Aloha_Design_Document.docx

Revision History

Date Description Author Comments

03/16/2015 Initial Draft Vivek Supe, Mrunal Pagnis Initial draft of the document

03/20/2015 Version 0.1 Milind Gokhale, Renuka

Deshmukh

Inserted the basic headings

and framework

03/27/2015 Version 1.0 Renuka Deshmukh, Milind

Gokhale

First Revision

Document Approval

This section lists all key people in the architecture and design of project Aloha:

Module Name Printed Name Title Date

Friends, Mutual Friends

and Suggestions Milind Gokhale

Project Lead and

Developer March 27, 2015

Posts Renuka Deshmukh

Database Architect and

developer March 27, 2015

Registration and Profile Mrunal Pagnis

System Architect and


Chat Vivek Supe

Interface Design and


Balaprasath Rajan Professor March 27, 2015

Table of Contents

Aloha Social Network .................................................................................................................................... 0

Design Document ...................................................................................................................................... 0

Revision History ............................................................................................................................................ 0

Document Approval ...................................................................................................................................... 0

Table of Contents .......................................................................................................................................... 0

1 Introduction .......................................................................................................................................... 2

1.1 Purpose ......................................................................................................................................... 2

1.2 Scope ............................................................................................................................................. 2

1.3 Definitions & acronyms ................................................................................................................. 2

1.4 Intended Audience ........................................................................................................................ 2

1.5 Overview ....................................................................................................................................... 2

2 General Description .............................................................................................................................. 3

2.1 Product Perspective ...................................................................................................................... 3

2.2 Tools Used ..................................................................................................................................... 3

2.3 Operating Environment ................................................................................................................ 3

2.4 General Constraints ...................................................................................................................... 3

2.5 Assumptions .................................................................................................................................. 4

3 Architecture Details .............................................................................................................................. 5

3.1 Top level architecture ................................................................................................................... 5

3.2 Application Architecture ............................................................................................................... 5

3.2.1 Web Application Architecture............................................................................................... 6

3.2.2 Database Architecture .......................................................................................................... 6

3.3 Use Cases ...................................................................................................................................... 7

3.3.1 Use Case UC1 ........................................................................................................................ 7

3.3.2 Use Case UC2 ........................................................................................................................ 8

3.3.3 Use Case UC3 ........................................................................................................................ 8

3.3.4 Use Case UC4 ........................................................................................................................ 8

3.3.5 Use Case UC5 ........................................................................................................................ 8

3.3.6 Use Case UC6 ........................................................................................................................ 9

3.3.7 Use Case UC7 ........................................................................................................................ 9

3.3.8 Use Case UC8 ........................................................................................................................ 9

3.3.9 Use Case UC9 ........................................................................................................................ 9

Aloha Social Network: Design Document Chapter 0. Table of Contents

1

3.3.10 Use Case UC10 .................................................................................................................... 10

3.3.11 Use Case UC11 .................................................................................................................... 10

3.3.12 Use Case UC12 .................................................................................................................... 10

3.4 Class Diagram .............................................................................................................................. 11

3.5 Sequence Diagrams ..................................................................................................................... 12

3.5.1 Registration ......................................................................................................................... 12

3.5.2 Manage Account ................................................................................................................. 13

3.5.3 Search Friend ...................................................................................................................... 14

3.5.4 Scribble ................................................................................................................................ 15

3.5.5 Comment............................................................................................................................. 16

3.5.6 ChitChat ............................................................................................................................... 17

3.6 User Interface ............................................................................................................................. 18

3.7 Deployment Diagram .................................................................................................................. 22

3.8 Coding standards and UI Standards ............................................................................................ 22

3.9 Error-Handling ............................................................................................................................. 23

4 Data Model ......................................................................................................................................... 23

4.1 Overview of Aloha DB ................................................................................................................. 23

4.2 Overview of Aloha Logging DB .................................................................................................... 24

5 Risks and Mitigation Plans .................................................................................................................. 26

5.1 Hardware failure ......................................................................................................................... 26

5.2 Software failure........................................................................................................................... 26

6 Appendices .......................................................................................................................................... 27

6.1 Appendix 1: Glossary................................................................................................................... 27

Aloha Social Network: Design Document Chapter 1. Introduction

2

1 Introduction

1.1 Purpose This design document is intended to give the overview of implementation of Aloha at a high

level. It also identifies the framework and technologies used for the development and tries to define

the system architecture. This document will also be used for identifying contradictions, if any, prior

to coding phase. The main goal of this document is to make design level information easily

understandable

1.2 Scope This design document is meant to provide an overview of the structure of the system. This

document also includes the database architecture of Aloha along with database diagram for

reference. This document also serves as a mandate for the design standards, data structures and

design patterns to be implemented. UML diagrams are included to show how they different

components interact with each other.

1.3 Definitions & acronyms The following table explains terms and acronyms specific to this SRS.

Term/Acronym Description/Definition

Aloha Aloha is a social networking website.

UC Use Case

Scribble Scribble is a post shared by the user on his slate.

ChitChat Chatting activity between two users registered on Aloha.

Slate Wall where users scribble.

1.4 Intended Audience This document is intended for a varied set of audiences including Product manager, team

lead, stakeholders, developers, QA, system architects, DBA, deployment engineers.

1.5 Overview The remaining document has 5 more sections. The second section gives general description

of the project. Section 3 gives architectural view of the system. Section 4 consists of the data model.

Section 5 gives the consideration of any risks if occurred and their mitigations. Section 6 is a list of

appendix that helps better understand the document.

Aloha Social Network: Design Document Chapter 2. General Description

3

2 General Description

2.1 Product Perspective Aloha is a free online social networking website which allows users to connect with their

friends and family. The product will consist of different modules namely User registration and

setting module, ChitChat module, Friends and suggestions module and Scribbles module. The user

interface will comprise of JSP pages. User Registration module requires user to fill-in his data. Re-

Captcha and e-mail verification are included as an additional security measure.

ChitChat will be implemented using peer-to-peer architecture. ChitChat will also support File-

sharing. Friends and Suggestions module will enable persistent storage of user connections while

suggestions will be implemented using an efficient data structure. Database will be implemented

using MySQL Community Server 5.x.

2.2 Tools Used 1. Tool for drawing Diagrams – Dia is used to create all the UML diagrams of Aloha during the

design phase.

2. Spring Tool Suite – The Spring Tool Suite™ (STS) will be the development environment for

implementing Aloha. Aloha will be developed using Spring MVC framework.

3. [http://stackoverflow.com/tags/spring-tool-suite/info]

4. MySQL Community Server 5.x – MySQL community server will be used as a relational database

backend.

5. Apache Tomcat 7 – Apache Tomcat server will be the server environment to host the java

code and JSP pages.

6. Java – JDK 1.8 will be the java development kit used for implementing Aloha.

7. Git (https://git.iu.edu) – GIT repository will be used for version control and tracking defect.

8. Secure Assist – Cigital SecureAssist Eclipse plugin will be used to find security vulnerabilities

in Aloha. [http://marketplace.eclipse.org/content/cigital-secureassist]

9. Dreamweaver – HTML editor to design JSP pages.

10. CoffeeCup - HTML editor to design JSP pages.

11. Windows 7/8 OS –The development platform will be Windows 7/8 OS.

2.3 Operating Environment Minimum: 2 CPU Cores (Recommended: 4 CPU Cores or more)

Recommended memory: 2 GB for Windows platforms, 1 GB for Linux

Minimum disk space: 500 MB

Recommended disk space: 1024 MB

Java Platform Enterprise Edition (Java EE)

Apache 8.x

JDK 6+ for Spring Framework

MySQL 5.x.x

2.4 General Constraints Aloha will support the following browsers – IE 8+, Chrome 27.0+, and Firefox 30+.

Aloha Social Network: Design Document Chapter 2. General Description

4

Aloha supports English language only.

Aloha requires certificates issued by CA to use HTTPS.

The first version of the website is intended to be viewed best on a desktop browser.

2.5 Assumptions 1. There will be availability of Internet via 3G, 4G or Wi-Fi.

2. Central server of the system must be able to handle all the incoming requests simultaneously.

3. The developer machines will be up and available till the end of the project.

4. All the necessary product licenses will have been acquired.

5. Requirement engineering has been carried out correctly and thoroughly.

6. On implementation the modules of the system will work coherently.

Aloha Social Network: Design Document Chapter 3. Architecture Details

5

3 Architecture Details

3.1 Top level architecture

Figure 1: Aloha Top Level Architecture Diagram

The above diagram gives a block view of Aloha system showing the interaction of different

modules with each other. The numbered arrows show the flow of control between these

modules.

3.2 Application Architecture

Figure 2: Application Architecture Stack


6

3.2.1 Web Application Architecture

Figure 3: Aloha Web Application Architecture Diagram

Spring MVC framework will be used for developing the Aloha web application. It divides

the application into three interconnected parts. Thus the internal representations of the

information are kept separate from the information that is presented to the end-user or accepted

from end-user.

1. Presentation Layer

The presentation layer of the application will be JSP pages displayed to the user.

The JSP pages will be both to display information and to take inputs from user.

2. Controller Layer

The controller initiates the commands to the model to make changes to database.

It also sends commands to the presentation layer views associated to the models.

3. Data Access Layer

The data access layer is used to access the database and make changes to the data.

3.2.2 Database Architecture This layer consists of relational database implemented on MySQL server. For the detailed

database architecture refer section for Data Model (section 4).


7

3.3 Use Cases

Figure 4: Use Case Diagram

3.3.1 Use Case UC1 3.3.1.1 Objective

Registration

3.3.1.2 Priority

High

3.3.1.3 Actors

End-User

3.3.1.4 Pre-conditions

The user has internet and opens the website on his browser.

3.3.1.5 Post-conditions

The user is now a member of Aloha website.


8


Email Verification

3.3.2.2 Priority

High

3.3.2.3 Actors

End-User


The user is registering to aloha website as a new user.


The user is now a registered user on Aloha and can update account, post scribbles, add friends

and chat with other registered friends.


Login

3.3.3.2 Priority

High

3.3.3.3 Actors

End-User


User is a registered member of Aloha.


The user logs in successfully and can now view his profile, friends and scribbles.


Manage Account

3.3.4.2 Priority

Medium

3.3.4.3 Actors

End-User


A user is logged into Aloha.


The user account has been successfully updated as per his requirements, like, update account,

visibility setting, etc.


Delete Account

3.3.5.2 Priority

Medium

3.3.5.3 Actors

End-User


9




Account is successfully deleted.


Add Friend

3.3.6.2 Priority

High

3.3.6.3 Actors

End-User




Friend is added successfully.


List Friends

3.3.7.2 Priority

High

3.3.7.3 Actors

End-User




User sees a list of his friends.


Invite Friend

3.3.8.2 Priority

Low

3.3.8.3 Actors

End-User




Friend invite is sent successfully on his email allowing him to register as a new user.


Scribble

3.3.9.2 Priority

High


10

3.3.9.3 Actors

End-User




Posted scribbles are visible to the user and his friends.


Comment

3.3.10.2 Priority

High

3.3.10.3 Actors

End-User




Posted comments are visible to the user and his friends.


ChitChat

3.3.11.2 Priority

High

3.3.11.3 Actors

End-User




The user successfully performs direct chitchat with his friend.


Send File

3.3.12.2 Priority

High

3.3.12.3 Actors

End-User




The second user successfully receives the send file.


11

3.4 Class Diagram

Figure 5: Class Diagram for Aloha


12

3.5 Sequence Diagrams

3.5.1 Registration

Figure 6: Registration Sequence Diagram


13

3.5.2 Manage Account

Figure 7: Manage Account Sequence Diagram


14

3.5.3 Search Friend

Figure 8: Search Friend Sequence Diagram


15

3.5.4 Scribble

Figure 9: Scribble Sequence Diagram


16

3.5.5 Comment

Figure 10: Comment Sequence Diagram


17

3.5.6 ChitChat

Figure 11: ChitChat Sequence Diagram


18

3.6 User Interface This section shows some of the UI interfaces visible to the user.

Figure 12: Sign In


19

Figure 13: Profile


20

Figure 14: Chat


21

Figure 15: Friends


22

3.7 Deployment Diagram

Figure 16: Aloha Deployment Diagram

3.8 Coding standards and UI Standards Following standards must be strictly followed during the development and

implementation phase of project Aloha:

1. Follow HTML5, CSS3, and JavaScript coding guidelines.

2. Markup should be well formed, semantically correct and generally valid.

3. All markups should be delivered as UTF8. It should be mentioned in the document head and

the HTTP header.

4. JavaScript file should be well commented.

5. Use proper validation of user input on client and server-side.

6. Sun’s JavaBeans coding and naming conventions should be followed.

7. Java code should be well commented.

8. Proper logging and exception handling should be implemented.

Aloha Social Network: Design Document Chapter 4. Data Model

23

3.9 Error-Handling To help the developer understand the different operations being done by the application.

The application will have a database logging which will have crucial logs written to the database

and file logging will have all events logs which may be required in the future. We will be using

log4j which will log entries in 5 levels of priority so that we can fetch logs as per the business

requirement.

4 Data Model

4.1 Overview of Aloha DB

Figure 17: Aloha DB Model

Table Name Description

User This table consists of the user profile data

Friendship This table consists of all the relations between all the users.


24

FriendStatus This is a reference table to track the status between users in friendship table. It can have values like “Accept/Pending”, “Blocked”, etc.

Chat This table saves chitchat history between two users.

Post This table contains all the scribbles posted by users of Aloha.

Comment This table contains all the comments to all the scribbles posted on Aloha.

ProfileSetting This table contains the privacy level setting for each user.

LikeDislike This table manages the likes and dislikes of each scribble.

PrivacyLevel This is a reference table which contains all the possible privacy levels of a user in Aloha.

4.2 Overview of Aloha Logging DB

Figure 18: Aloha DB logging Model

Table Name Description

Log This table contains all the logs for all the activities in Aloha. It will be used for tracing bugs and auditing.

Exception This table contains all the exceptions thrown by the application in the various flows in Aloha. It will be used for tracing bugs and auditing.

ApplicationSetting This table contains settings to enable to disable logging in database.


25

Aloha Social Network: Design Document Chapter 5. Risks and Mitigation Plans

26

5 Risks and Mitigation Plans

5.1 Hardware failure After deployment the development server fails

o Use one of the operational servers if urgent until problem is fixed

One of the operational servers fails

o The two deployment servers will be the replacements of each other, use other.

Any of the development workstations fail

o There are 2 spare workstations in case of workstation failure.

5.2 Software failure Spring Tools Suite crashes or fails

o Re-install a clean copy of STS on the development machine.

Tomcat Server Installation is corrupted.

o Re-install tomcat package and server.

Aloha Social Network: Design Document Chapter 6. Appendices

27

6 Appendices

6.1 Appendix 1: Glossary Term/Acronym Description/Definition

MVC Model View Controller

HTTP Hyper Text Transfer Protocol

HTTPS Hyper Text Transfer Protocol over SSL

CAPTCHA Completely Automated Public Turing test to tell Computers and Humans Apart

DAO Data Access Layer

Tomcat Apache Tomcat Web Server

IE Internet Explorer

OS Operating System

JDK Java Development Kit

CA Certificate Authority

STS Spring Tool Suite

QA Quality Assurance

DBA Database Administrator

Aloha Social Network: Design Document Chapter 6. Appendices

28

References:

1. "Code Standards" Front-end. Accessed March 25, 2015.

http://standards.findsubstance.com/frontend/.

2. "Online Diagram Software to Draw Flowcharts, UML & More" Creately. Accessed March 20,

2015. http://creately.com/.

3. Gokhale, Milind, Renuka Deshmukh, Vivek Supe, and Mrunal Pagnis. "SRS_Aloha_My_Group"

February 1, 2015. Accessed March 28, 2015.

https://iu.app.box.com/files/0/f/3167866963/1/f_26849929211.

4. "Spring MVC Application Flow" Accessed March 26, 2015. http://www.goospoos.com/wp-

content/uploads/2009/12/Spring24.jpg.

5. "High Level Design Distributed Network Traffic Controller." Accessed March 28, 2015.

https://people.ok.ubc.ca/rlawrenc/research/Students/CJ_05_Design.pdf.

http://standards.findsubstance.com/frontend/

http://creately.com/

Aloha Social Networking Portal - Design Document

Social Media

Transcript of Aloha Social Networking Portal - Design Document