Citadel With Vert.X

This is a Maven project. You can use any mvn commands.

System Requirements

1. Mongodb

   (1) Install

2. Hbase

   (1) Install

   (2) Follow instruction 2.1 and 2.2. The standalone version is sufficient for now.

   (3) Copy hbase-site.xml into ${projectDir}/conf/

3. Geomesa

   (1) Necessary packages will be installed via Maven.

4. Virtuoso

   (1) Install

5. Redis

   (1) Install

Set up dev env.

mvn eclipse:eclipse

Test Comma

mvn test

Packaging

mvn clean package

Naviation

1. MainVerticle contains all the verticles to be deployed (currently only one.)
2. model package contains data model we will use. It will be shared across different packages.
3. timeseries package is not used for now.
4. Best practice is to use different verticles for different services and then do port-forwarding to 80. Currently all APIs should be collected in RestApi Verticle.

(For Developers) Add your module?

1. Citadel is based on Vert.x. You can add your microservice in any langauge based on JVM easily. The module would be a verticle and communicate with the others through EventBus. Please refer the structure of metadata pacakge.
2. RestApi.java routes all functions in the modules in 1. to appropriate URLs. (This is not the best practice but it seems to be a way only with a verticle. Suggestion?)
3. Please follow Google Java Style Guide. There is an eclipse format file.
4. DO NOT just print and pass inside catch clauses. Properly handle exceptions. A normal way of handling them is passing as a failed result.

Notes

1. Eclipse may say it includes errors in models package. It complains about the code that should be generated during compile time.
2. Reference implementation: https://github.com/cescoffier/vertx-microservices-workshop
3. Reference documentation: http://escoffier.me/vertx-hol/ and http://vertx.io/.