root/other-projects/trunk/gs3-webservices-democlient/README.txt @ 15860

Revision 15860, 4.0 KB (checked in by ak19, 12 years ago)

Tells user they might need to change permissions on the gs3democlient.sh to make it executable before trying to run it

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