georgebatalinski/beacon-of-beacons

Beacon Network.

#Beacon Network

##Contents

• What it is
• System requirements
• How to set up the runtime
• How to run it
• How to test it
• How to use it
• License and terms of use
• Technologies

##What it is Beacon Network (formerly known as the Beacon of Beacons, or BoB, for short) provides a unified REST API to publicly available GA4GH Beacons (see http://ga4gh.org/#/beacon for more details about the Beacon project itself). Beacon Network standardizes the way beacons are accessed and aggregates their results, thus addressing one of the missing parts of the Beacon project itself.

##System requirements Java 1.7 or newer, Maven 3.1 or newer, Java EE runtime (WildFly 8 recommended).

How to set up the runtime

Beacon Network needs access to a database through a JTA datasource (java:/jboss/datasources/bob). Make sure you have the required datasource on your application server or change the configuration in persistence.xml.

As Beacon Network can execute many queries in parallel, it's advisable to increase the pool sizes for EJB subsystem in Wildfly, particularly slsb-strict-max-pool (bean-instance-pools) and default (thread-pools).

##How to run it Start the server:

For Unix:       JBOSS_HOME/bin/standalone.sh -c standalone-full.xml
For Windows:    JBOSS_HOME\bin\standalone.bat -c standalone-full.xml

Build the project:

mvn clean install

Deploy (from bob-rest module):

mvn wildfly:deploy

After deployment, the application will be running on http://localhost:8080/.

To undeploy when you're done, run:

mvn wildfly:undeploy

##How to test it

To run tests for the persistence layer, execute the following in bob-data module:

mvn test -Pall-tests-managed

To test the supported beacons, execute the same command in bob-rest module. Note that the tests need access to a Wildfly instance, the path to which can be set in $JBOSS_HOME environment variable.

##How to use it Visit the project website for more information: http://mcupak.github.io/beacon-of-beacons/

##License and terms of use The code in this repository is licensed under the MIT license. An instance of the Beacon Network is a subject to these terms of use.

##Technologies Java EE. CDI, EJB, JAX-RS, JAXB, Bean Validation, JPA. Tested with Arquillian/ShrinkWrap/AssertJ.