Choose the JABAWS distribution that better suits your needs and read the Getting Started guides below. Detailed information is available in the documentation pages.
|Quick Guide||I want to use JABAWS for...|
|Jalview and the JABAWS Public Server||Running JABAWS services through Jalview on the JABAWS public server|
|Command Line Interface (CLI)||Accessing a public or private JABAWS server from my own software|
|Web Application aRchive (WAR)||Running JABAWS for my group, lab, or organization on the local infrastructure|
|Virtual Appliance (VA)||Running JABAWS services through Jalview on my computer with a private server|
This is the easiest way to run JABAWS web-services. Simply launch Jalview and run any of the methods provided under the 'Web Service' menu. Jalview uses the public JABAWS server by default. If you are concerned about privacy or want to run sensitive analysis on your own hardware, you can either setup a local JABAWS Virtual Appliance (VA) or configue the JABAWS Web Application aRchive (WAR) in your infrastructure.
This is a single Java archive which contains the JABAWS command line interface (CLI) client. It allows anyone who wants to connect to the JABAWS web-services running at the University of Dundee's Public Server, or to run a local private JABAWS server from their own software. You can read more about how to use JABAWS command line (CLI) client given in the documentation pages, but a brief instructions are given below:
java -jar jabaws-full-client-2.2.0.jar
The JABA Web Services are WS-I compliant. This means that you can access them from any language that has libraries or functions for consuming interoperable SOAP web services. More information on how to develop software that access JABAWS services is provided in the documentation pages.
The JABAWS Web Application aRchive (WAR) is for anyone who wants to run JABAWS for their group, lab or organization, or wants to enable their local JABAWS server to use the cluster or perform very large tasks. Complete documentation is provided in the documentation pages, but brief instructions are given below:
You can test that your JABAWS server is working in several ways.
In this example we assumed that your JABAWS server URL is
java -jar <Path to tomcat WebApp directory>/jabaws/WEB-INF/lib/jabaws-client.jar -h=http://localhost:8080/jabaws
The Virtual Appliance (VA) package allows you to run a JABAWS server installed on TurnKey Linux as a virtual machine on your laptop or desktop computer. A complete guide to the JABAWS VA is given in the documentation pages, but for the impatient, brief instructions are given below:
If you work on Windows, Linux or Unix:
If you work on Mac do the same using VMware Fusion.
To check that your JABAWS virtual appliance is working visit the Services Status page available from the main JABAWS menu. For this enter the JABAWS URL for your new server into a web browser. This is shown once the appliance is booted up.
Alternatively you can use Jalview to complete the testing.
Site Last updated: 27 March 2018 by Fábio Madeira. This site was built using the Bootstrap framework.