deployment & maintenance document - Find and develop open ...

SEMANTIC TOOL FOR COLLABORATIVE JAVA SOFTWARE 

MAINTENANCE AND REUSE 

RESEARCH COLLABORATION PROJECT WITH MITANI SANGYO 

DEPLOYMENT 

& MAINTENANCE 

DOCUMENT 

Department of Software Engineering 

School of Information and Communication Technology 

Hanoi University of Technology

Deployment & Maintenance Document 

INDEX 

INDEX .................................................................................................. 1 

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

2 Server Deployment ......................................................................... 2 

2.1 Install JDK ................................................................................................ 2 

2.2 Install Apache Tomcat Server ................................................................ 4 

2.3 Deploy services in Apache Tomcat server ............................................ 9 

3 Client Deployment ........................................................................ 14 

1


1 Introduction 

This document will introduce how to deploy both server and client parts in the Win7 OS. 

All pre-requisite softwares are provided in the Pre-requisite Softs folder of the DVD 

To deploy in other system, download corresponding JDK, Apache Tomcat server 

versions in their home sites: 

JDK: http://www.oracle.com/technetwork/java/javase/downloads/index.html 

Apache Tomcat: http://tomcat.apache.org/ 

The installation will be similar on most of OS. 

2 Server Deployment 

Select a quite powerful computer to be a good server. Server will provide services for 

clients-in form of a plug-in in IDE Eclipse 

There are 2 pre-requisite softwares to deploy server: 

JDK: Provide Java Virtual Machine for any Java application 

Apache Tomcat server: To deploy Services. 

This guide will introduce how to install all software in the win7 OS. 

2.1 Install JDK 

JDK Version: jdk-6u10-windows-i586-p, is provided in the Pre-requisite Softs folder 

1. Double click on the file jdk-6u10-windows-i586-p.exe 

2. Select Accept button 

2

3. Select Next button 


4. Wait a moment to finish the installation 

5. Click finish 

3


2.2 Install Apache Tomcat Server 

Apache Tomcat Server version: apache-tomcat-6.0.20, is provided in the Pre-requisite 

Softs folder 

1. Double click on the file apache-tomcat-6.0.20.exe 


4

3. Select I Agree button 



5


5. Choose folder to install Tomcat and select Next button 

6. Set the configuration of Tomcat server (Port, user & pass for administrator). 

Suggestion: let the port be default: 8080. Then select Next button 

6


7. Select JRE folder (it will be automatically settled if you successfully install JDK 

in the previous section). Then select Install button 

8. Select Finish button 

7


2.3 Setting Tomcat memory heap size 

8


Because of huge owl data, administrator has to set Tomcat memory heap size: 

1. Open Tomcat configuration GUI 

2. Open tab Java 

3. Set field Maximum memory pool to 1024MB or higher 

4. Restart service or Tomcat, if any 

2.4 Deploy services in Apache Tomcat server 

After successfully installing pre-requisite softs, we now will deploy our services 

1. Open Tomcat setup folder. Then, go into bin folder 

2. Double click on tomcat6w.exe 

3. Select Start button (if this button is disabled, then tomcat is already running) 

4. Wait a moment 

9


5. Open the browser (In this guide, we use firefox. Other browsers are absolutely 

similar). Enter “http://localhost:8080/” in the address box, then hit enter on the 

keyboard 

6. Select Tomcat Manager link, enter the administration account (is settled when 

installing Tomcat in the previous section). Then click OK 

10


7. Scroll the page to the WAR file to deploy part: 

8. Select the SEService.war file (Provided in the Products folder of the DVD). 

Then select button Deploy and wait a moment 

11


9. The page will be refreshed. Scroll a little bit to view the link SEService. If it is 

seen, then the deployment is successful. 

10. Select SEService Link to check 

12


11. Enter http://localhost:8080/SEService/WebServicePort?wsdl in the address bar. 

This is our first set of services. 

12. Enter http://localhost:8080/SEService/DataServicePort?wsdl in the address bar. 

This is our second set of services. 

13


13. If necessary, check the firewall, or open port 8080 (Ask your internet 

administrator for detail) 

3 Client Deployment 

Client will be installed as an plug-in of IDE Eclipse. 

To install IDE Eclipse, we have to install JDK first, then extract Eclipse.zip file 

3.1 Install JDK 

Refer to the install JDK part of the Server Deployment 

3.2 Install Eclipse 

Download any Eclipse version at http://www.eclipse.org/downloads/. Or it can be access 

from in the Pre-requisite Softs folder of the DVD (That version is helios-newest version 

at the time of this document writing: eclipse-jee-helios-win32.zip). 

Extract eclipse-jee-helios-win32.zip to any folder in the Client machine. Then, eclipse is 

successfully installed. 

3.3 Install MitaniSEPlugin 

MitaniSEPlugin is an Eclipse plug-in that assist developers, tester, … and project 

manager of a collaborated Project . It is provided in the Products folder of the DVD 

14


To install this Plug-in in IDE Eclipse: 

1. Close IDE Eclipse if it is opened. 

2. Open the Eclipse Extraction folder in the previous step 

3. Open plugins folder. Copy MitaniSEPlugin_1.0.0.jar from Products folder of 

the DVD to this folder. 

15

4. Open Eclipse application 


5. Select Workbench icon to begin working with Eclipse 

16


1 2 

6. Click on the Open SED Perspective (2) item on the menu or hit on the quick 

item (1) in Eclipse bar to activate MitaniSEPlugin Perspective. 

17


7. This perspective containing 6 views. But to work with them, you have to choose 

server and login successfully. 

8. Enter the server link (As settled in the Server Deployment Server Section). Hit the 

Test button, if the following dialog appear, then everything is OK 

Note that, by default, the server URI will be http://192.168.0.100:8080/. It 

includes 3 parts: http://, the IP of server: (in this case: 192.168.0.100) and the port 

of Apache Tomcat (in this case: 8080, as settled when installing Tomcat) 

If the connection is OK, you can press hit button Store URI, which will store the 

Server URI in the Eclipse. Hence, even when you close the Eclipse, and reopen it 

in another day, the value still can be retrieved. 

9. Now, the client is working well. Refer to other documents to understand how to 

use our software in form of an Eclipse plug-in 

18


3.4 Important notes 

To ensure security, users can do anything before login. Hence, Opening or activating 

other views except Account Management view will trigger errors. For example, error in 

Document and Source code Support’s View: 

After successful login, to reactivate error view, close it first, then right click at the SE 

perspective and use the Reset function 

In the process of working with Eclipse, if you have already closed some views, to reopen 

them, there are several options: 

Reset the SE perspective 

19


Reactivate the SE perspective, then use Window Show Views function 

4 Server maintenance 

If any problem occurs, we can reset the server, as the following instruction 

4.1 Introduction of the Server files: 

Open tomcat installation folder: 

Every deployments will be webapps folder. SEService is our concerns. 

20

Double click on the SEService folder 

Access /WEB-INF/Data folder: 


21


JavaDocumentOntology: Ontology of the system. This file will never changes. It is used 

when we have worked with the system for the first time 

db.xml: Configuration file, containing all user accounts. Each time the administration 

creates a user, this file will be updated. There are 3 types of information for each user: 

User name 

Password 

His corresponding URI in the semantic annotation 

When user/admin changes their password, this file also will be automatically updated. 

Right after deploying the service, there just one account for admin, with user name and 

password both being “admin” 

Annotation: Folder, containing the following important data: 

Rule folder: containing all semantic rules of the system. This folder will never 

changes 

22


Backup Folder: It may not appear right after the server deployment. However, 

when the administration use the backup function in the Annotation Editor 

View, an owl file will be created in this folder. This owl file contains all data of 

the system, and can be used to restore the system when necessary. 

o Therefore, periodically, the administration should use back up function to 

guarantee the system is reverted back when coping with conflicts, errors, 

etc. 

Some owl files (Directly contained in Annotation folder) 

o If there is an owl file (file with .owl extension) in the Annotation folder, 

when the Tomcat server is restarted, it will load all semantic annotation in 

this file to the whole system. 

o Tomcat server will load all direct .owl files in this Annotation folder 

4.2 What the administration should do if the system getting with 

fatal error? 

First of all, the administrator should use backup function in the Annotation Editor View 

Next, when the system is in fatal error: 

1. Stop Tomcat service, and restart. All data that is not saved will be lost. If the 

system is working well when checking, then the following steps can be omitted. 

2. Stop Tomcat service again and do as followings 

3. Open Tomcat Installation folder. Go into webapps folder, SEService folder, 

WEB-INF folder, Data folder, Annotation folder respectively. 

4. Open Backup folder, choose the version of the backup file that you want (The 

name of backup file: BackupOwlData_MM_dd_yyyy’T’hh_mm_ss. For 

example: BackupOwlData_09_19_2010T09_32_21). Copy that file to Annotation 

folder. (If there are more than one .owl file in the Annotation folder, it’s OK but 

remember to remove error and unnecessary files. All data from .owl file directly 

in the Annotation folder will be loaded to the system) 

23

5. Restart the service. 


5 Install Test-Data 

After installing system for the first time, Server works with blank data of Users account 

and Software Source Code Annotation. 

If you wish to test system with pre-build data: use files in Products/TestData directory 

of the DVD. 

1. Replace db.xml in the Webroot/Data of Tomcat/Webapp/SEService/WEB- 

INF/Data by db.xml 

2. Add owl file (8MB) to the sub folder Annotation 

Some Accounts to login (Admin can open the db.xml file to check ) 

1. DatTT pass 123 

2. hienpt pass 123 

3. ducna pass 123 

Remember to Config memory heap size of Tomcat: 

1. Open Tomcat configuration GUI 

2. Open tab Java 

3. Set field Maximum memory pool to 1024MB or higher 

4. Restart service or Tomcat, if any 

24

deployment & maintenance document - Find and develop open ...

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?