<<PROJECT NAME>>

Software Design Specification

– Hanoi, August 2022 –

Date A* In charge Change Description

*A - Added M - Modified D - Deleted

Page | 2
Table of Contents
I. Overview..................................................................................................................................................4
1. Code Packages.....................................................................................................................................4
2. Database Design..................................................................................................................................4
a. Database Schema.............................................................................................................................4
b. Table Description.............................................................................................................................4
II. Code Designs...........................................................................................................................................5
1. <Feature/Function Name1>.................................................................................................................5
a. Class Diagram...................................................................................................................................5
b. Class Specifications..........................................................................................................................5
c. Sequence Diagram(s).......................................................................................................................5
d. Database queries.............................................................................................................................6
2. <Feature/Function Name2>.................................................................................................................6

Page | 3
I. Overview
1. Code Packages
[Provide the package diagram for each sub-system. The content of this section including the overall
package diagram, the explanation, package and class naming conventions in each package. Please see
the sample & description table format below (please note: package names don’t follow Java package
naming convention yet)]

Package descriptions
No Package Description
01 omemberauthorityrm <Description of the package>
02 registration <Description of the package>
03 fedrpc <Description of the package>
04 ofed <Description of the package>
05 mongoDB <Description of the package>
06 fedtools <Description of the package>
07 …

2. Database Design
a. Database Schema
[Provide the tables relationship like example below – following MySQL database naming convention]

Page | 4
b. Table Description
No Table Description
01 <Table name> <Description of the table>

II. Code Designs

1.1 SignUptoClub

a. Class Diagram
[SignUpToClub]

Page | 5
b. Class Specifications
[Provide the description for each class and the methods in each class, following the table format as
below]

DBConnection
[Provide the detailed description for the class methods]
No Method Description
01 getConnection() This method returns a database connection. It creates a connection to a
database if there is no existing connection. The connection is created by
using the JDBC driver and a connection URL that specifies the database to
connect to.

SignUpToClub
[Provide the detailed description for the class methods]
No Method Description
01 doGet(HttpServletRequest,
HttpServletResponse): void The doGet() method in the LoginController class is responsible for handling
GET requests for the login page. If the user is already logged in, they will be
redirected to the homepage. If not, the method will retrieve the
corresponding view from the server based on the URL and forward the
request and response objects.

02 doPost(HttpServletRequest, For users to enter their information - if the user enters "confirm password"
HttpServletResponse): void incorrectly, it must be re-entered - if the user enters "confirm password"
correctly, the system must perform the hashpass function to encrypt the user
information security string and the validate function to check whether the
phone, username and email have entered the correct structure or not.

Page | 6
c. Sequence Diagram(s)
[Provide the sequence diagram(s) for the feature, see the sample below]

d. Database Queries
[Provide the detailed SQL (select, insert, update...) which are used in implementing the function/screen]
1.2 ViewEvent
a. Class Diagram
[ViewEvent]

b. Class Specifications
[Provide the description for each class and the methods in each class, following the table format as
below]

Page | 7
DBConnection class
[Provide the detailed description for the class methods]
No Method Description
01 getConnection() This method returns a database connection. It creates a connection to a
database if there is no existing connection. The connection is created by
using the JDBC driver and a connection URL that specifies the database to
connect to.

EventController
[Provide the detailed description for the class methods]
No Method Description
01 doGet(HttpServletRequest,
HttpServletResponse): void The doGet() method in the LoginController class is responsible for handling
GET requests for the login page. If the user is already logged in, they will be
redirected to the homepage. If not, the method will retrieve the
corresponding view from the server based on the URL and forward the
request and response objects.

02 doPost(HttpServletRequest, For users to enter their information - if the user enters "confirm password"
HttpServletResponse): void incorrectly, it must be re-entered - if the user enters "confirm password"
correctly, the system must perform the hashpass function to encrypt the user
information security string and the validate function to check whether the
phone, username and email have entered the correct structure or not.

c. Sequence Diagram(s)
[Provide the sequence diagram(s) for the feature, see the sample below]

Page | 8
d. Database Queries
[Provide the detailed SQL (select, insert, update...) which are used in implementing the function/screen]
1.3 ParticipateinEvent
a. Class Diagram
[ParticipateinEvent]

b. Class Specifications
[Provide the description for each class and the methods in each class, following the table format as
below]

DBConnection class
[Provide the detailed description for the class methods]
No Method Description
01 getConnection() This method returns a database connection. It creates a connection to a
database if there is no existing connection. The connection is created by
using the JDBC driver and a connection URL that specifies the database to
connect to.

EventController
[Provide the detailed description for the class methods]

Page | 9
 No Method Description
01 doGet(HttpServletRequest,
HttpServletResponse): void The doGet() method in the LoginController class is responsible for handling
GET requests for the login page. If the user is already logged in, they will be
redirected to the homepage. If not, the method will retrieve the
corresponding view from the server based on the URL and forward the
request and response objects.

02 doPost(HttpServletRequest, For users to enter their information - if the user enters "confirm password"
HttpServletResponse): void incorrectly, it must be re-entered - if the user enters "confirm password"
correctly, the system must perform the hashpass function to encrypt the user
information security string and the validate function to check whether the
phone, username and email have entered the correct structure or not.

c. Sequence Diagram(s)
[Provide the sequence diagram(s) for the feature, see the sample below]

d. Database Queries
[Provide the detailed SQL (select, insert, update...) which are used in implementing the function/screen]
1.4 ParticipateinClub
a. Class Diagram
[ParticipateinClub]

Page | 10
b. Class Specifications
[Provide the description for each class and the methods in each class, following the table format as
below]

DBConnection class
[Provide the detailed description for the class methods]
No Method Description
01 getConnection() This method returns a database connection. It creates a connection to a
database if there is no existing connection. The connection is created by
using the JDBC driver and a connection URL that specifies the database to
connect to.

ClubController
[Provide the detailed description for the class methods]

Page | 11
 No Method Description
01 doGet(HttpServletRequest,
HttpServletResponse): void The doGet() method in the LoginController class is responsible for handling
GET requests for the login page. If the user is already logged in, they will be
redirected to the homepage. If not, the method will retrieve the
corresponding view from the server based on the URL and forward the
request and response objects.

02 doPost(HttpServletRequest, For users to enter their information - if the user enters "confirm password"
HttpServletResponse): void incorrectly, it must be re-entered - if the user enters "confirm password"
correctly, the system must perform the hashpass function to encrypt the user
information security string and the validate function to check whether the
phone, username and email have entered the correct structure or not.

c. Sequence Diagram(s)
[Provide the sequence diagram(s) for the feature, see the sample below]

d. Database Queries
[Provide the detailed SQL (select, insert, update...) which are used in implementing the function/screen]
1.5ViewClub
a. Class Diagram
[ViewClub]

Page | 12
b. Class Specifications
[Provide the description for each class and the methods in each class, following the table format as
below]

DBConnection class
[Provide the detailed description for the class methods]
No Method Description
01 getConnection() This method returns a database connection. It creates a connection to a
database if there is no existing connection. The connection is created by
using the JDBC driver and a connection URL that specifies the database to
connect to.

ClubController
[Provide the detailed description for the class methods]
No Method Description
01 doGet(HttpServletRequest,
HttpServletResponse): void The doGet() method in the LoginController class is responsible for handling
GET requests for the login page. If the user is already logged in, they will be
redirected to the homepage. If not, the method will retrieve the
corresponding view from the server based on the URL and forward the
request and response objects.

02 doPost(HttpServletRequest, For users to enter their information - if the user enters "confirm password"
HttpServletResponse): void incorrectly, it must be re-entered - if the user enters "confirm password"
correctly, the system must perform the hashpass function to encrypt the user
information security string and the validate function to check whether the
phone, username and email have entered the correct structure or not.

Page | 13
c. Sequence Diagram(s)
[Provide the sequence diagram(s) for the feature, see the sample below]

d. Database Queries
[Provide the detailed SQL (select, insert, update...) which are used in implementing the function/screen]
1.6 ViewActivitiesPoint.
a. Class Diagram
[ViewClub]

b. Class Specifications
[Provide the description for each class and the methods in each class, following the table format as
below]

Page | 14
DBConnection class
[Provide the detailed description for the class methods]
No Method Description
01 getConnection() This method returns a database connection. It creates a connection to a
database if there is no existing connection. The connection is created by
using the JDBC driver and a connection URL that specifies the database to
connect to.

ActivitiesController
[Provide the detailed description for the class methods]
No Method Description
01 doGet(HttpServletRequest,
HttpServletResponse): void The doGet() method in the LoginController class is responsible for handling
GET requests for the login page. If the user is already logged in, they will be
redirected to the homepage. If not, the method will retrieve the
corresponding view from the server based on the URL and forward the
request and response objects.

02 doPost(HttpServletRequest, For users to enter their information - if the user enters "confirm password"
HttpServletResponse): void incorrectly, it must be re-entered - if the user enters "confirm password"
correctly, the system must perform the hashpass function to encrypt the user
information security string and the validate function to check whether the
phone, username and email have entered the correct structure or not.

c. Sequence Diagram(s)
[Provide the sequence diagram(s) for the feature, see the sample below]

Page | 15
d. Database Queries
[Provide the detailed SQL (select, insert, update...) which are used in implementing the function/screen]

2. <Feature/Function Name2>
…

Page | 16