STLDD Software Top Level Design Document: BaseBlockSystem

Transcription

1 Responsible: MH Date: Doc. number: PUSS12004 Version: 1.0 STLDD Software Top Level Design Document: BaseBlockSystem SERG Contents 1 Introduction 2 2 Reference documents 2 3 Overview 2 4 Class diagram 3 5 Database 3 6 Information stored in sessions 4 7 Sequence diagrams class LogIn class Administration

2 Document history Ver. Date Resp. Description MH First baseline version 1 Introduction This document describes the design of the BaseBlockSystem, which is a system with log-in functionality on a web-server solution. The intention is that the system should be used as a basic functionality for authentication and further developed into a system with useful functionality, such as a time-reporting system. The system is developed by the the Department of Computer Science and the Software Engineering Research Group (SERG). 2 Reference documents 1. SRS Software Requirements Specification, v Javadoc for BaseBlockSystem. 3 Overview The system is implemented in a Tomcat server through the following classes and HTML files: class servletbase This class is the superclass for all servlets in the application. It includes basic functionality required by many servlets, like for example a page head written by all servlets and the connection to the database. This application requires a database. For username and password, see the constructor in this class. class LogIn This servlet extends the servletbase and presents a log-in page. The first thing that happens when a user reaches this page is that he/she is logged out if he/she is logged in. Then the user is asked for a user name and password. If the user is logged in he/she is directed to the functionality selection page. class Administration This servlet extents the servletbase and constructs a page for administration purposes. It checks first if the user is logged in and then if it is the administrator. If that is case it displays all users and a form for adding new users. It is also possible to delete users through URL:s in the table. file functionality.html This html file presents a number of functions that the user can select. 2

3 HttpServlet Connection Tomcat Base Block System 1 jdbc ServletBase # conn: Connection # servletbase(): # loggedin( ): boolean # formelement(string par): String # getpageintro(): String LogIn Administration - loginrequestform(): String - checkuser(name: String, password: String): boolean # doget(request: HttpServletRequest, response: HttpServletResponse) # dopost(request: HttpServletRequest, response: HttpServletResponse) - adduserform(): String - checknewname(name: String): String - createpassword(): String - adduser(name: String): boolean - deleteuser(name: String): # doget(request: HttpServletRequest, response: HttpServletResponse) Figure 1: Class diagram The classes are further described in the javadoc, which is part of the SDDD, see Ref. 2. The system also includes a database with one table as described in Ref. 1 and Section 5. 4 Class diagram A class diagram, with the most important classes, is displayed in Figure 1. 5 Database There is one database, base, with one table users: Field Type Null Key Default Extra name varchar(10) NO PRI password varchar(10) YES NULL

4 The database can be constructed from scratch with the following SQL commands: mysql> create database base; mysql> use base; mysql> create table users(name varchar(10), password varchar(10), -> primary key (name)); mysql> insert into users (name, password) -> values( admin, adminpw ); 6 Information stored in sessions During each session the following attributes are stored in the session: Integer state: used to describe if the user is logged in or not. The following two states have been defined: 0 logged out 1 logged in String name: The user name, e.g. admin. 7 Sequence diagrams 7.1 class LogIn Figure 2 displays how a successful login request is handled in servlet LogIn, and Figure 3 displays how an un-successful login request is handled in servlet LogIn. 7.2 class Administration Figure 4 displays what happens in class Administration when an administrator adds a new user. 4

5 :LogIn :PrintWriter :HttpSession quest :Statement sponse dopost() println(getpageintro()) getattribute("state") getparameter("user") getparameter("password") executequarry("select * from users") setattribute("state", LOGIN_TRUE) sendredirect("functionality.html") Figure 2: Sequence diagram for handling of successful login request in class LogIn. (Notice that all messages are not displayed; only the messages that are important for the understanding of the sequence are displayed.) :LogIn :PrintWriter :HttpSession quest :Statement sponse dopost() println(getpageintro()) getattribute("state") getparameter("user") getparameter("password") executequarry("select * from users") println("that was not a valid...") println(loginrequestform()) Figure 3: Sequence diagram for handling of un-successful login request in class LogIn. (Notice that all messages are not displayed; only the messages that are important for the understanding of the sequence are displayed.) 5

6 :Administ ration :PrintWriter :HttpSession quest :Statement doget() println(getpageintro()) getattribute("name") getattribute("state") println("<h1> Administration page </h1>") getparameter("addname") executeupdate("inset into users...") getparameter("deletename") executequarry("select * from users...") println([table]) Figure 4: Sequence diagram describing the addition of a new user in class Administration. (Notice that all messages are not displayed; only the messages that are important for the understanding of the sequence are displayed.) 6