[Download] | [Documentation Home] | [Release Note]

WSO2 Web Services Application Server, v@wso2wsas_version@ - Installation Guide

This installation guide provides information on,

  1. the prerequisites for WSO2 WSAS
  2. installation instructions
  3. starting up WSO2 WSAS, and
  4. accessing the management console

Of the two main sections of this document, one explains the installation of the WSO2 WSAS in Standalone Mode, while the other explains the installation of the WSO2 WSAS into a J2EE compliant servlet container.

For the more adventurous user, WSO2 WSAS can also be built using the source distribution available with this release. The third section of this installation guide explains how to build WSO2 WSAS using the source distribution.

Your feedback on WSO2 WSAS is most appreciated. Please send them to our mailing lists.

Content

Introduction

WSO2 WSAS is a lightweight application server for Web services. It is built on the Apache Axis2 framework and incorporates leading open source components into a simple, easy-to-use, and highly performant package. Web services specifications support include WS-Addressing, WS-Policy, WS-ReliableMessaging, WS-Security and more, giving a fully secure, transactional and reliable infrastructure.

WSO2 WSAS is distributed in several convenient distribution packages, and can be installed either as a standalone server or as part of a J2EE compliant servlet container. WSO2 WSAS is distributed under the Apache License, version 2.0.

[Download WSO2 WSAS ]

System Requirements

Java Runtime Environment 1.4 or 1.5 (For instructions on setting up the JRE in different operating systems, visit http://java.sun.com)
Memory No minimum requirement
Disk No minimum requirement.

Approximately 40 MB will be used for the .zip distribution

Operating System Tested on Windows XP, Linux, Mac OS X, Fedora core, Ubuntu, Gentoo

Installing WSO2 Web Services Application Server v@wso2wsas_version@ in the Standalone Mode

Installing on Microsoft Windows

Note: The WSO2 WSAS, v@wso2wsas_version@ release has been successfully tested only on Windows XP.

There are two methods of installation on the MS Windows operating system.

  1. Using the Installation Wizard (WSO2 WSAS for Java, v@wso2wsas_version@ Setup wizard)
  2. Using the Binary Distribution

Running the Installation Wizard

Download the wso2wsas-@wso2wsas_version@.msi

Execute the .msi and follow the instructions on the WSO2 WSAS , v@wso2wsas_version@ Setup wizard

The first page of the installation wizard is as follows.

Figure1:Installation Wizard Page1

Click Next. It will lead you to the End-User License Agreement.

Figure2:Installation Wizard Page2-EULA

Select the check box to accept the terms in the license agreement; this will enable the Next button. Click Next to move to the Custom Setup page shown below. Custom Setup will allow you to select the features you want to install.

Figure2:Installation Wizard Page3-Custom


On the next screen you'll be shown the custom installation features select section.

Figure2:Installation Wizard Page3-Browse for Location

Click Next on the Custom Setup Page to move to the Ready to Install page displayed below. Click Install. WSO2 WSAS , v@wso2wsas_version@ will be installed in your computer.

Figure6:Installation Wizard Page5-Ready to install

Once the installation is complete and the setup exits, click Finish on the WSAS setup wizard. You willl be able to view WSO2 WSAS on the programs list of the Start menu of Windows. A shortcut to WSO2 WSAS , v@wso2wsas_version@ will also appear on the Desktop.

On the programs list of the Start menu, WSO2 WSAS will have the following options :

Figure7:Programme on start menu

Once you add WSO2 WSAS as an NT service to Windows services, you can start this service from Services in Administrative tools of the Control Panel.

Figure8:Network service

Installing using Binary Distribution

The following steps will take you through the installation for the MS Windows operating system.

  1. Download the WSO2 WSAS binary distribution.
  2. Extract the zip archive.
  3. Set the JAVA_HOME environment variable to your Java installation.
  4. Execute the WSO2 WSAS starting script. e.g., C:\wso2wsas-@wso2wsas_version@\bin\wso2wsas.bat
  5. Check your WSO2 WSAS instance using the URL https://localhost:9443

Installing on Linux

Again, there are two methods of installing on Linux:

  1. Using Binary Distribution
  2. Using Binary Installers (deb/rpm)

Installing using Binary Distribution

  1. Download the WSO2 WSAS binary distribution.
  2. Extract the zip archive. e.g., unzip wso2wsas-@wso2wsas_version@.zip -d /opt
  3. Set the JAVA_HOME environment variable to your Java installation using the export command or by editing /etc/profile. e.g., export JAVA_HOME="/opt/j2sdk"
  4. Execute the WSO2 WSAS starting script. e.g., cd /opt/wso2wsas-@wso2wsas_version/bin; sh wso2wsas.sh
  5. Check your WSO2 WSAS instance using the URL https://localhost:9443

Installing using Binary Installers (deb/rpm)

The following steps will take you through the binary distribution installation.

  1. Download WSO2 WSAS deb or RPM binary.
  2. Install Debian binary ( deb ) e.g., dpkg -i wso2wsas-java-@wso2wsas_version@.deb (To install deb, log on to the system as root user.)
  3. Install RPM binary ( rpm ) e.g., rpm -Uvh wso2wsas-java-@wso2wsas_version@.i386.rpm (To install rpm, log on to the system as root user.)
  4. Execute/start the WSO2 WSAS from the shell. e.g., /etc/init.d/wso2wsas start
  5. (You can also stop the server from the shell. e.g., /etc/init.d/wso2wsas stop)

Troubleshooting Installation

When trying to execute the WSO2 WSAS binary from a shell, e.g., /usr/bin/wso2wsas (after WSO2 WSAS , v@wso2wsas_version@ has been installed), if the error message 'Permission denied' pops up, then check the file permission of the run.sh script and set the execution permission.

Modify/ Repair/ Remove Installation

On MS Windows systems,

Figure9:modify_repair_remove

In Debian Linux systems, use the dpkg utility to remove the WSO2 WSAS installation. e.g., dpkg -r wso2wsas-java-@wso2wsas_version@

In Redhat Linux systems, use the rpm utility to remove the WSO2 WSAS installation. e.g.,: rpm -e wso2wsas-java-@wso2wsas_version@

Accessing the Management Console

Once WSO2 WSAS , v@wso2wsas_version@ has been successfully installed, in order to access the Management Console, first start the server, launch a web browser instance, and then point it to the URL https://localhost:9443/ (if you are using the default settings). This will take you to the "Sign In" page of the Management Console as displayed below.

Note: By default, WSO2 WSAS has two listeners, HTTP and HTTPS. The HTTP listener opens on port 9762, while the HTTPS listener opens on port 9443. The administrator functions are exposed only via the HTTPS port.

Figure10:mgtconsole

For details on WSO2 WSAS Management Console see the Administrator's Guide

Installing WSO2 Web Services Application Server, v@wso2wsas_version@ in a Servlet Container

This section provides instructions on how to install the WSO2 WSAS in a Servlet container. This also includes information on how to configure WSO2 WSAS on JBoss, Geronimo and Tomcat servers. Some guidelines on installing WSO2 WSAS on other application servers have also been included.

Your feedback on WSO2 WSAS is most appreciated. Please send them to our mailing lists.

Introduction

The WSO2 WSAS Servlet should be installed on a J2EE compliant servlet container.

WSO2 WSAS has been fully tested on the following J2EE Application Servers, and specific installation instructions for each server are listed under the Application Server Specific Installation section.

J2EE Application Servers

Apache Tomcat Server:

JBoss AS:

Apache Geronimo AS:

BEA WebLogic AS

General:

Web application servers that do not fall under the above list will have to follow the Generic Application Server Installation Steps described below.

Application Server Specific Information

Installation Instructions

Follow the simple installation steps to successfully install WSO2 WSAS into a JBoss AS, Apache Geronimo AS or Apache Tomcat server.

1. Download the WSO2 WSAS binary distribution if you haven't done so. Download Unzip wso2wsas-@wso2wsas_version@.zip to a desired location. (eg: c:\wso2-wsas on windows or /home/wso2wsas on linux). This folder will be referred to as WSO2WSAS_HOME.