1 | ***********************************************************
|
---|
2 | README
|
---|
3 | ***********************************************************
|
---|
4 | Application: Greenstone 3 (QBR) web services demo-client
|
---|
5 |
|
---|
6 | Summary: Demo-client application in Java for the QBR (Query,
|
---|
7 | Browse and Retrieve) web services of Greenstone 3. Also
|
---|
8 | provides similar access to a Fedora repository of Greenstone
|
---|
9 | collections created by Greenstone's FLI application.
|
---|
10 |
|
---|
11 | This is a Java demonstration application for Greenstone 3
|
---|
12 | that presents a graphical user interface to Greenstone 3's
|
---|
13 | Query, Browsing and Retrieval functionality.
|
---|
14 |
|
---|
15 | The application allows one to search collections and browse
|
---|
16 | them by classifiers, displaying the results.
|
---|
17 |
|
---|
18 | It uses the new QBRSOAPServer web services of Greenstone 3
|
---|
19 | to access its search and (document and metadata) retrieval
|
---|
20 | operations, thereby demonstrating the use of Greenstone
|
---|
21 | 3's QBR web services.
|
---|
22 |
|
---|
23 | It also lets you browse Greenstone collections exported by
|
---|
24 | the FLI application into a Fedora repository. If Fedora
|
---|
25 | Generic Search is installed and if your "Fedora-Greenstone"
|
---|
26 | collections are indexed, some basic querying features will
|
---|
27 | be available in the demo-client's interface. A tool to help
|
---|
28 | install Fedora Generic Search once you have Fedora (2.2.1 or
|
---|
29 | greater) installed is included.
|
---|
30 |
|
---|
31 | Documentation on how to use the application, as well as
|
---|
32 | related matters like deploying the QBR web services and
|
---|
33 | using FLI can be found in the docs/HowToFiles folder when
|
---|
34 | the distribution is unzipped.
|
---|
35 |
|
---|
36 |
|
---|
37 | ***********************************************************
|
---|
38 | What you need and how to run
|
---|
39 | ***********************************************************
|
---|
40 | - It runs on Windows XP (not tested on Vista yet) and Linux.
|
---|
41 | - You need Java 1.5 or higher installed and JAVA_HOME set.
|
---|
42 | - The Greenstone 3 server the demo-client is to communicate
|
---|
43 | with must be up-to-date with the latest source code from
|
---|
44 | the Greenstone SVN repository. The Greenstone 3 server must
|
---|
45 | have the new QBRSOAPServer web services deployed on it. See
|
---|
46 | section C.
|
---|
47 |
|
---|
48 | A. If you've downloaded the zip file:
|
---|
49 | 1. Unzip it into a folder.
|
---|
50 | 2. Open an xterm and go into the folder where you extracted
|
---|
51 | it and type:
|
---|
52 | ./gs3democlient.sh
|
---|
53 | (If you don't have execute permissions, type
|
---|
54 | chmod u+x gs3democlient.sh
|
---|
55 | ./gs3democlient.sh
|
---|
56 | )
|
---|
57 | If you're on Windows, you can double-click on
|
---|
58 | gs3democlient.bat or otherwise open a DOS prompt, navigate
|
---|
59 | into the folder where you extracted the zip folder and type
|
---|
60 | gs3democlient.bat
|
---|
61 | 3. From the drop-down box at the top choose "greenstone"
|
---|
62 | and type the WSDL URL of the QBRSOAPServer deployed on the
|
---|
63 | Greenstone 3 server you wish to connect to. See section C.
|
---|
64 |
|
---|
65 |
|
---|
66 | B. If you've checked out the code and application from SVN,
|
---|
67 | you'll need JDK 5 as it is used to compile the code. To get
|
---|
68 | the application running from SVN:
|
---|
69 | 1. Go into the folder where you've checked it out into.
|
---|
70 | 2. (You'll need an internet connection for this step because
|
---|
71 | it will download the file CheckJavaVersion.java)
|
---|
72 | Open an x-term when on Linux or a DOS prompt when on windows
|
---|
73 | and type:
|
---|
74 | ant build-demo-client
|
---|
75 | This will generate the executable.
|
---|
76 | To run, type
|
---|
77 | ./gs3democlient.sh
|
---|
78 | on Linux and
|
---|
79 | gs3democlient.bat
|
---|
80 | if you're on windows. (If you've got JAVA_HOME pointing to
|
---|
81 | JDK 1.5, you can also double-click on gs3democlient.bat to
|
---|
82 | get it running.)
|
---|
83 | 3. From the drop-down box at the top choose "greenstone"
|
---|
84 | and type the WSDL URL of the QBRSOAPServer deployed on the
|
---|
85 | Greenstone 3 server you wish to connect to. See section C.
|
---|
86 |
|
---|
87 |
|
---|
88 | C. Deploying the QBRSOAPServer web services on the up-to-
|
---|
89 | date Greenstone 3 server
|
---|
90 | 1. Go the Greenstone 3 installation folder
|
---|
91 | 2. Type
|
---|
92 | ant soap-deploy-site
|
---|
93 | Then it will prompt you for 3 things. Press Enter to accept
|
---|
94 | localsite, type "QBRSOAPServer" and Press Enter again to
|
---|
95 | accept QBRSOAPServerlocalsite. Then point your browser to
|
---|
96 | http://HOST:PORT/greenstone3/services to see if the QBRSOAP-
|
---|
97 | Server web services are deployed and to get the link to its
|
---|
98 | WSDL URL needed by the demo-client application.
|
---|
99 |
|
---|
100 |
|
---|
101 | For detailed instructions, please refer to the html files
|
---|
102 | in the folder docs/HowToFiles
|
---|