SENIOR DESIGN PROJECT. Project name: Sharewood. High-Level Design Report. Project Group Member Names: Merve Sezer. Evrim Şay.

Transcription

1 SENIOR DESIGN PROJECT Project name: Sharewood High-Level Design Report Project Group Member Names: Merve Sezer Evrim Şay Doğancan Yarka Oğulcan Söyler N. Doğukan Erkınay Supervisor: H. Altay Güvenir Jury Members: İbrahim Körpeoğlu Öznur Taştan Innovation Expert: Hasan Çomak Progress Report December 31, 2013 This report is submitted to the Department of Computer Engineering of Bilkent University in partial fulfillment of the requirements of the Senior Design Project course CS491

2 Table of Contents Table of Figures... 3 Introduction... 4 Purpose of the System... 4 Design goals... 4 Availability... 4 Accessibility... 4 Efficiency... 4 Flexibility... 4 Manageability... 5 Portability... 5 Integrity... 5 Performance... 5 Robustness... 5 Simplicity... 5 Reliability... 6 Scalability... 6 Current Software Architecture... 7 Revised Class Diagram... 7 Proposed Software Architecture... 8 Overview... 8 Subsystem Decomposition... 8 Government and LocalStaff (muhtar)(website)... 8 Android Application... 8 Database Manager... 8 WebService... 8 Hardware/Software Mapping... 9 Persistent Data Management Figure entity relationship diagram Access Control and Security... 10

3 Global Software Control Boundary Conditions ATAM Software Evaluation Glossary References Table of Figures Figure 1 Class Diagram... 7 Figure 2 Subsystem Decomposition... 8 Figure 3 Deployment Diagram... 9 Figure 4 Entity Relationship Diagram... 10

4 Introduction Purpose of the System Sharewood is a system that aims to provide a marketplace where individuals can donate their goods with the help of a database includes people in demand for these goods. It also provides users the opportunity to organize and participate events arranged for the sake people in need. Sharewood purposes to work up on interaction between caring and needy people. Sharewood will operate on android operating system as an application for users and will be available as a web application for staffs access. With the help of Android OS platform, people will have an easy chance to donate, while the sharing system pair donations with people who are in need automatically. Fair contribution of the donations will be achieved by the standardized systematic distribution of donations. Design goals Availability This application must be long lasting and be available for the use of public institutions. Accessibility System will be accessible through Android applications market, Google Play ; Mobile Android users can download the application from that Google Play to their mobile devices. Public institutions, which are affiliated to use our system, will be permitted to have an access to the system s website. With that website, they will be able to access admin panel where they can control goods and information of people in need one by one. Users information will be added automatically when users sign up and accept their induction to the database. Efficiency Mobile devices, that have an access Android application market, should be able to run our system without any difficulties. All data will be kept in the database of a public institution, which leads to a convenience of decreasing costs for the system itself, due to less need for disk space. We will give numerical predictions while implementing the code. On the other hand, data of users will increase the unhindered need for more disk space. Moreover, Google Map searches and routing the way will decrease performance as it will causes delays. Flexibility System has to be innovative for future add-ons according to the demands of users and public institutions in future. We should not disregard this while implementing the code. For instance, we can set up a website for users in the future which will increase the target group we will reach.

5 Manageability System will have an admin panel that will provide the control of the data and system itself. This privilege will be only for state, other than staff. It will have a simple interface, so it will be user friendly. Portability It is a mobile online application on the platform of Android OS. So, portability is not an issue in our case. Every mobile device, which has Android OS, will be able to run this application, when users need. Integrity There will be several security checkpoints as a part of Sharewood database to increase protection. Two major security checks will be on state and public. All the user data will be stored all together in both of them to assure security of information as RAID architecture. For unregistered users, there will be only permission to read. After signing up, user will be granted permission to create new object (create) and changing existing object's information (update). Performance Performance will be depending on devices hardware and also on the written algorithm. Codes must be written with the fastest algorithm. In addition, if the device can connect network via wireless network connection, application have to connect with that wireless network connection, too. However, Google Map and its API s is the most important part of the application while considering performance as it takes a long time to response while searching on Google Map, users can give up using the application due to long period of time to see through. Google Map code must be integrated to application code efficiently. Robustness System has to save initial conditions and data regularly, if an error occurs. We have to create a crash free code, but if a crash is experienced, application should be able to restart itself. Simplicity Simplicity should be hold in high regard in these days, as users want to use an application easily instead of spending time on it. Sharewood application will be user friendly in order to reach different user types with different knowledge level on technology without spending time to solve it. Users should reach what they want easily thanks to instructive direction buttons. When we consider elder people, who are included in our target group, application s components should not be very small, bright or dim. Also, application should not comprise lots of pages in order to increase the flow of progress. User should do what his or her want in a page. Therefore, there will be no need to go backwards or forward between many pages. Thus, application will provide fast and easy access to its users.

6 Reliability Sharewood s database will possess much personal information that is in need to be protected. States and ours most important responsibility is the secrecy. Also, the aim of the system is a sensitive issue, helping people in need. Beside of secrecy, state and application have to make users sure about their deliveries are sent to the right places. System has to provide these two conditions to be reliable. Scalability Scalability is an important issue for an online application. Because of Sharewood s potential to be widespread among state institutions and have an increasing numbers of people will access the system, we have to use threading in coding. Also, webpage will take constraints of MySQL away. Therefore, lots of users from different devices and networks can access the system at the same time.

7 Current Software Architecture Revised Class Diagram Figure 1 Class Diagram

8 Proposed Software Architecture Overview In this part, proposed software architecture will be explained by the following subsections: subsystem decomposition, hardware & software mapping, persistent data management, access control & security, global software controls and boundary conditions respectively. Subsystem Decomposition Figure 2 Subsystem Decomposition Government and LocalStaff (muhtar)(website) Government will access the system through the website of ShareWood. The website is a component of the whole system, which provides controlling deliveries, user and people in need profiles. HTML, CSS and PHP will be used for the basic website. Android Application Android Application has two sub components, user and delivery interface. Components are implemented with JSON because of easy connection with WebService. Application will be implemented with JAVA. Database Manager Database Manager is the controller of information that is collected in database. Database stores user information that includes their addresses, item photos and counts. WebService WebService provides the connection between application and server, database. Thanks to WebService lots of user can access database. In other words, WebService shows

9 itself a user to MySQL, therefore, it breaks the number of user constraint of MySQL. Besides, it decreases the traffic of the server. Hardware/Software Mapping Figure 3 Deployment Diagram

10 Persistent Data Management Figure entity relationship diagram Access Control and Security Figure 4 Entity Relationship Diagram Login operation is the way to access Sharewood Application. When the user sends a login request, the necessary parts of login operation are checked with the corresponding data stored in the database system. Then, the system grants or denies the login request according to the response of the database. If the request is granted, user goes to the corresponding page of the application. Otherwise, the system rejects the request and provides an error for access. In Sharewood application, there is a necessity to protect information stored in database system. User cannot reach applications any pages without entering their passwords. Every user account is protected by their passwords. Global Software Control Sharewood has two different types of global software controls. One of them is the mobile phone application, which is our main component in this project. The other is webbased application. These two control mechanisms have almost the same properties; however their used areas are different. Web based application can be used merely by admin, staff and local staff. Firstly, we have an application for various smart phones and this program makes the global software controls. When the user has the suitable software for his/her smart phone, the application runs. For the smart phone application part of the

11 software control, we need the application and a smart phone itself. For web based application users need web browser. ShareWood should be event driven. While users are served with this application, a variety of different functionalities are provided. According to the applicability of users requests, server decides either to give service to the users or to continue listening. Boundary Conditions Initialization Application will start with home page, which shows number of deliveries and events done. Therefore, everybody can see homepage, however, all other pages requires username and password that are defined sing up process before. Termination or Logging Out Users can terminate application with simply closing it or they can log out without closing it. Failure -When Database connection is lost, application returns with an error to the user. -When network connection is lost, application returns with an error to the user. If application is released on Android Market for all devices and any device does not support application because of its version, application returns with an error to the user. ATAM Software Evaluation Table for ATAM (Architecture Tradeoff Analysis Method) is used to understand consequences of architectural decisions with respect to the quality attribute requirements of the system.

12 Quality Attribute Attribute Refinement Scenarios Transaction Response Time User changes his/her password or username and transaction completes in less than 0.40 seconds PERFORMANCE User tries to see the picture uploaded to the system, and the picture is loaded in less 2 seconds System Response Time Belediye stuff tries check the address as donation is arrived, and the list of people in need is loaded in less than 5 seconds User tries to open the list of voluntary meeting and he/she is able to see the list in less than 3 seconds User Operations User adds a new item to donate, adds the picture and saves the item to the system there is no delay USABILITY Muhtar Operations Muhtar adds a new list of people in need to the system without any delay Belediye Stuff Operations Belediye stuff lists the name of the people in need, lists the addresses and all operations is completed without any delay SECURITY Data Security Nonody is able to access personal information (password, username, ) in the system Hardware System Failure If there is a problem with electricity and the machine shuts down, the system will be logged out. AVAILABILITY Software Failure If there is failure with software a warning will be occurred and admin will be notified. RECOVERABILITY Database Recoverability In the case of a problem with database, system recovers the data from the backup. Mobile device System is available to use with Android mobile devices ADAPTABILITY PC application System is available to use on a PC using a web browser

13 Glossary ATAM: Architecture Tradeoff Analysis Method Guests: Guests are the users who can visit the application, see signing up and sign in options without performing any other operation on the application. Registered User: Registered users are the users who have created an account by signing up into the application. System: System matches up aids with people who need these aids automatically Muhtar(local staff): Muhtar has special profiles which provides to change database that includes people in need. This profile will be available on web. Municipality staff: Municipality staff has special profiles which provides too matched donation and people in need and the staff can determine delivered and undelivered donations. This profile will be able on web. Admin: Admin can add new muhtar and municipality staff to the system also can delete any user from the system. This profile will be able on web. Android OS: an operating system that runs on many mobile devices Json: Java Script Object Notation References

14 Clements, Paul. Documenting software architectures: views and beyond. Boston: Addison-Wesley, Print. IEEE Policies, Section 7- Professional Activities (Part A IEEE Policies) [Online]. Available: Horstmann, Cay S. Object-oriented design & patterns. Hoboken, NJ: Wiley, Print. Object-Oriented Software Engineering, Using UML, Patterns, and Java, 3rd Edition, by Bernd Bruegge and Allen H. Dutoit, Prentice-Hall, 2010