Activity-REST Framework

The Activity-REST framework facilitates the development of RESTful adapter services that wraps command line analysis tools.

Usage

The Activity-REST framework was not published to a Maven repository yet. Thus, in order to use it for your projects, first download the repository and install the bundles at your user's local repository. You can follow the following commands for this step:

git clone https://github.com/cawal/activity-rest-framework
cd activity-rest-framework
mvn clean install -DskipTests

Then, the easiest way to use the Activity-REST framework to create a new analysis service is to use the provided Maven artifact. In the example bellow, set the values for the variables MY_GROUP_ID, MY_SERVICE_ID and MY_VERSION with the desired values for these properties in your service.

MY_GROUP_ID=<base package identifier>
MY_SERVICE_ID=<service identifier>
MY_VERSION=<a version string>

mvn archetype:generate \
	-DarchetypeGroupId=activity-rest \
	-DarchetypeArtifactId=archetype \
	-DarchetypeVersion=0.0.1-SNAPSHOT \
	-DgroupId=${MY_GROUP_ID} \
	-DartifactId=${MY_SERVICE_ID} \
	-Dversion=${MY_VERSION}

Then, edit the activity.aadl file in the main service folder in order to describe the analysis activity and the underlying command line tool. Information obout the Analysis Activity Description Language can be found here. Finally, compile the service code and obtain the deployable WAR using Maven:

mvn clean
mvn package

The produced WAR can be deployed to a Java/Jakarta EE application server. Nowadays, it is tested against Tomcat v9.0.

Repository organization

The dsl folder contains a number of Java projects related to the support for the Analysis Activity Description Language. These projects include the AADL metamodel created using EMF, as well as the AADL textual grammar and supporting editor created using Xtext.

The framework folder contains a number of Java projects related to the Activity-REST framework itself. These projects includes the main framework project, as well as a additional project for aggregating resources that facilitate Activity-REST service tests and a Maven archetype project to facilitate the creation of new Activity-REST services.

The docs folder contains the main documentation of the project. These docs are compiled using Jekyll in order to produce a github.io site.

The contents in the main folders are organized following independent schemas. Refer to the README in each folder for more information about its rationale.

Contributing

Feel free to submit issues and enhancement requests.