webservices/net.sf.basedb.examples/trunk/README

Code
Comments
Other
Rev Date Author Line
651 11 Apr 08 nicklas 1 == Requirements ==
651 11 Apr 08 nicklas 2
1459 11 Nov 11 nicklas 3  1. Access to a BASE 3.1 server with web services
651 11 Apr 08 nicklas 4  2. Java 1.6 or later.
1436 02 Nov 11 nicklas 5  3. Ant 1.8 or later.
651 11 Apr 08 nicklas 6
651 11 Apr 08 nicklas 7 == Introduction ==
651 11 Apr 08 nicklas 8
651 11 Apr 08 nicklas 9 This package contains some simple web services examples. 
651 11 Apr 08 nicklas 10
651 11 Apr 08 nicklas 11 == Installation and use ==
651 11 Apr 08 nicklas 12
651 11 Apr 08 nicklas 13  1. Unpack the tar.gz file to a directory of your choice. 
1407 18 Oct 11 nicklas 14  2. Create a 'build.properties' file and enter connection options
1407 18 Oct 11 nicklas 15     as key=value pairs:
651 11 Apr 08 nicklas 16     * services.url 
651 11 Apr 08 nicklas 17       The URL to the BASE web server. It should be the same URL as you use to login
651 11 Apr 08 nicklas 18       with the web interface with '/services' appended to it. For example:
1407 18 Oct 11 nicklas 19       services.url=http://localhost:8080/base2/services
1407 18 Oct 11 nicklas 20       
651 11 Apr 08 nicklas 21     * services.login
651 11 Apr 08 nicklas 22       The username for your account on the BASE web server.
1407 18 Oct 11 nicklas 23       
651 11 Apr 08 nicklas 24     * services.password
651 11 Apr 08 nicklas 25       Your password for the BASE web server.
1407 18 Oct 11 nicklas 26       
651 11 Apr 08 nicklas 27     * download.dir
651 11 Apr 08 nicklas 28       Set this option to a valid directory path to enable download of raw data from 
651 11 Apr 08 nicklas 29       all raw bioassays. NOTE! Be careful with this option if you have a lot of data.
1407 18 Oct 11 nicklas 30       All files from all raw bioassays will be downloaded!
1407 18 Oct 11 nicklas 31       
651 11 Apr 08 nicklas 32   3. Run `ant test` to run the example code
651 11 Apr 08 nicklas 33     
651 11 Apr 08 nicklas 34 You may also override the connection options on the command line. Use one or
651 11 Apr 08 nicklas 35 several `-D` options when starting Ant (on one line): 
651 11 Apr 08 nicklas 36
651 11 Apr 08 nicklas 37 `ant -Dservices.url=http://localhost/base/services 
651 11 Apr 08 nicklas 38  -Dservices.login=mylogin -Dservices.password=mypassword
1407 18 Oct 11 nicklas 39  -Ddownload.dir=./download test`
651 11 Apr 08 nicklas 40
651 11 Apr 08 nicklas 41 == Compiling ==
651 11 Apr 08 nicklas 42
651 11 Apr 08 nicklas 43 Type `ant` to compile the code.
651 11 Apr 08 nicklas 44
651 11 Apr 08 nicklas 45 Type `ant package` to create a download downloadable tar.gz package in the project
651 11 Apr 08 nicklas 46     directory.
651 11 Apr 08 nicklas 47
651 11 Apr 08 nicklas 48