Introduction

This page describes the steps required to setup the development environment for Bindaas. 

Checkout Source Code

The source code of Bindaas is hosted and managed in Bitbucket using GIT. Use the following command to clone the Bindaas repository :

Directory Structure

The directory structure of Bindaas source tree is shown below :

source/dependencies

This directory contains third-party and startup bundles, along with OSGi configuration file.

source/maven/master

This is parent directory for all maven projects. In order to incorporate a new Bindaas eclipse project into existing build, a new maven project must be created under this directory. Refer #TBD to see steps required to add a project to maven build.

projects

Parent directory for all Bindaas projects

projects/core

Home for all core Bindaas projects. These projects are included in standard binary distribution of Bindaas and are mandatory with few exceptions.

projects/misc

Home for experimental or non-critical projects

projects/plugins

Parent directory for all types of Bindaas plugins. The data_providers directory contains different Data Providers. The transformers directory contains other types of plugins such as Query Modifier, Query Results Modifier and Submit Payload Modifier.

projects/security_providers

Home for all projects providing implementation for Bindaas's Security API

projects/test

Junit Test cases

Run maven build

In order to complete this step make sure you have maven installed and that $MAVEN_HOME/bin is present on the system $PATH

 

Compile the source code using maven :

 

It should build the entire Bindaas repository. The artifacts generated are stored in target directory of respective maven projects found under master.

Setup Eclipse

Bindaas has been developed exclusively using Eclipse IDE. Although, it may be possible to develop Bindaas plugins using other IDE(s) it hasn't been tried. Eclipse is a powerful and feature rich IDE for Java with native support for developing OSGi applications. This section documents steps required to setup eclipse for developing Bindaas based plugins. 

Eclipse can be downloaded from eclipse.org. Version greater than or equal to 4.0.0 is required. Additionally, since Bindaas heavily relies on Spring Framework, it is advisable to install Spring plugin in eclipse using their update site

Ensure Java Runtime Environment is set to use JDK 6

If the Java Runtime Environment is not set correctly Bindaas will not start. JRE can be set/changed under Preferences>Java>Installed JREs

Configure Target Runtime Environment 

The following screencast describes the process of setting-up OSGi Target Runtime Environment and creating a new run configuration. 

 

List of directories to include in Target Runtime Environment
  • source/maven/master/dist/bundles/system
  • source/maven/master/dist/bundles/third-party
  • source/maven/master/dist/bin

 

 

Verify Setup

To verify everything is setup correctly visit the following url in your web-browser :

 

You should be greeted by Bindaas's Login page :