WSO2 Gadget Server 1.4.2

• Release Notes
• Contents
• Home

Downloads

• Releases

Documentation

• Installation Guide
• Build From Source

Administrative Tasks

• User and Portal Permissions
• Gadget Repository
• Role Based Gadgets
• Gadget Archive Deployment

Portal User Tasks

• User Registration
  • Username / Password Based
  • OpenID based
  • Inforcard Based
• Anonymous Mode
• Signed-In Mode
• Adding Gadgets to Portal
  • Via URL
  • Via Repository
• Organizing the Portal
  • Managing Portal Themes
  • Configuring Gadgets
  • Tabs/Custom Layouts/ Cloning
  • Moving / Coping Gadget
  • Finding Gadget Details

Gadget Authoring

• Hello World Gadget
• SOAP Request Gadget
• OAuth Support
• Inter Gadget Communication
• Gadget Spec
• API Reference

Get Involved

• Checkout the Source
• Mailing Lists

Project Information

• License

Other References

• WSO2 Oxygen Tank Library
• Gadget Server Community Forum

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

Source Distribution

This page of the installation guide explains how to build the WSO2 Gadget Server using the source distribution of the release.

Introduction

Download the Gadget Server source distribution from Download

System Requirements

Java Runtime Environment	version 1.6.0_24 or higher (For instructions on setting up the JRE in different operating systems, visit http://java.sun.com)
Maven	2.1.0 or higher download). Please download maven 2.x version.
Operating System	Tested on Windows XP, Linux(Fedora core, Ubuntu and Gentoo), Mac OS X & Sun Solaris

Setting Up the Environment and Tools

Maven:

The WSO2 Gadget Server build is based on Maven. Hence, a prerequisite to build WSO2 Gadget Server from the source distribution is to have Maven (version 2.1.0 or later) and JDK (version 1.6.0_24 or later) installed. Extensive instructions are available on the Maven site.

You may need to set the MAVEN_OPTS if you come across OutOfMemory errors during the build. e.g. you may need to set MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=128m

This guide however contains the easiest path for quick environment setting. Advanced users can learn more about Maven.

• MS Windows
  1. Download and run the Windows installer package
  2. Set the 'Environment Variables' (create the system variable M2_HOME and edit the path. e.g., "set M2_HOME=C:\Program Files\Apache Software Foundation\maven-2.1.x"; set path=%path%;%M2_HOME%\bin)
  3. Make sure that the system variable JAVA_HOME is set to the location of your JDK, e.g., C:\Program Files\Java\jdk1.6.x
  4. Run 'mvn --version' to verify that it is correctly installed.
• Unix based OS (Linux etc)
  • The tar ball or the zip archive is the best option. Once the archive is downloaded, expand it to a directory of choice and set the environment variable M2_HOME and add M2_HOME/bin to the path as well. You can also refer to more instructions on how to install Maven in Unix based operating systems.

Once Maven is properly installed, you can start building the WSO2 Gadget Server for Java.

Building WSO2 Gadget Server from the Source Distribution

The source distribution is available as a zipped archive. All the necessary build scripts are included with the source distribution. Expand the source archive to a directory of your choice. You can run the following commands inside that directory to build the WSO2 Gadget Server. The list of commands that can be run are as follows: Note: The first time you run Maven, it will automatically download the dependent .jars. Therefore, the first run will take more time. The third party libraries required by WSO2 Gadget Server will be downloaded from the Maven2 repositories specified in the main pom.xml file.

mvn clean install	To create the complete release artifacts including the binary and source distributions.
mvn clean install -Dtest=false -DfailIfNoTests=false	To create the complete release artifacts including the binary and source distributions, without running any of the unit tests.
mvn clean install -Dtest=false -DfailIfNoTests=false -o	To create the complete release artifacts including the binary and source distributions, without running any of the unit tests, in offline mode.
mvn clean install site	Will also generate the project site and all the reports of the analysis tools integrated with Gadget Server such as Findbugs, Checkstyle etc. The index file will be generated in the target/site directory.

All the sources of the major 3rd party components included in WSO2 Gadget Server can be found in the source distribution. For the purpose of debugging applications, you could attach these sources.

---