source: webservices/net.sf.basedb.examples/trunk/README @ 1436

Last change on this file since 1436 was 1436, checked in by Nicklas Nordborg, 10 years ago

Preparing 'Web services examples 3.0' release.

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