<%----%> <%--<%@ page language="java" contentType="text/html; charset=ISO-8859-1" pageEncoding="ISO-8859-1"%>--%> <%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> <%@ taglib uri="http://java.sun.com/jsp/jstl/functions" prefix="fn" %> <%@ taglib uri="http://java.sun.com/jsp/jstl/fmt" prefix="fmt" %> <%@ taglib uri="http://displaytag.sf.net" prefix="dt" %> Getting Started

Choose a JABAWS distribution

Choose the JABAWS distribution that better suits your needs and read the quickstart guides below. Detailed information is available in the JABAWS docs pages.


Quick Guide I want to use JABAWS for...
JABAWS Virtual Appliance (VA) Running Multiple Sequence Alignments through Jalview on my own computer
JABAWS Web Application aRchive (WAR) Running JABAWS for my group, lab, or organization on the local infrastructure
JABAWS Java Client Accessing a JABAWS server from my own code

JABAWS Virtual Appliance (VA)

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 manual, but for the impatient, a brief instructions are given below:

If you work on Windows, Linux or Unix:

  1. Download JABAWS Virtual Appliance
  2. Download and install VMWare Player.
  3. Unpack the JABAWS virtual appliance and open it with VMware Player.

If you work on Mac do the same using VMware Fusion, or for free alternative use a WAR JABAWS package.

Testing

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.

  1. Launch the desktop version of Jalview
  2. Open the Jalview desktop's preferences panel (from the Tools->Preferences menu option), select the Webservices panel and press the New Service URL button.
  3. Enter the JABAWS URL for your new server. This is shown once the appliance is booted up.

JABAWS Web Application aRchive (WAR)

This is for anyone who wants to run JABAWS for their group, lab or organization, or wants to enable their local JABA server to use the cluster or perform very large tasks.

  1. Download the JABAWS WAR file
  2. Download and install Apache-Tomcat.
    You will need at least Tomcat version 5.5 of (we would recommend version 7.0) and at least Java 1.6 (i.e. JAVA 6).
  3. Drop the JABAWS WAR file into tomcat/webapps directory.
  4. (Re)start the Tomcat.
  5. Once the tomcat has started, it should automatically unpack the WAR into the webapps directory (if it doesn't, then you'll need to do this manually, it's just a zip archive in the end).
  6. If you are on Mac or other unix-like architecture with GNU compilers available or you'd like to get a maximum performance
    cd to webapps/jabaws/binaries/src/ and execute ./compilebin.sh script to compile all binaries JABAWS depends on.

Testing

You can test that your JABAWS server is working in several ways.

  1. Visit Services Status page available from the JABAWS main page using your web browser.
  2. If you are working on the command line, then use the command line client shipped with the JABAWS war to test it by running:
    java -jar <Path to tomcat WebApp directory>/jabaws/WEB-INF/lib/jaba-client.jar -h=http://localhost:8080/jabaws
    In this example we assumed that your JABAWS server URL is http://localhost:8080 and JABAWS context path is jabaws
  3. Alternately, you can point Jalview at your new server:
    • Launch the desktop version of Jalview
    • Open the Jalview desktop's preferences panel (from the Tools->Preferences menu option), elect the Webservices panel and press the New Service URL button.
    • Enter the URL for the tomcat server, including the context path for the JABAWS web app (e.g. http://localhost:8080/jabaws).

JABAWS Command Line Java Client

This is a single java archive which contains the JABAWS command line client. It requires Java version 1.6 to run, and allows anyone who wants to connect to and to use JABAWS from their own software.

  1. Download the Client Jar file

You can read more about how to use command line client in the CMD Client section of the manual. You can also get command line help by changing to the directory where you downloaded the client jar, and typing:

java -jar jaba-client.jar

A 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.