Chapter 6. Developer's guide

Table of Contents

6.1. Nova Orchestra APIs
6.1.1. Getting started with Nova Orchestra APIs

This chapter describes how to start playing with Nova Orchestra:

6.1. Nova Orchestra APIs

6.1.1. Getting started with Nova Orchestra APIs

Actually, one API is developed in Nova Orchestra. Others APIs will be available in the future versions of Nova Orchestra. APIs are included in a Maven module. To include this module you have to add following Maven dependency :

<dependency>
  <groupId>org.ow2.orchestra</groupId>
  <artifactId>orchestra-api</artifactId>
  <version>4.0.11</version>
</dependency>
        

If you do not want / can't use Maven, you can create a Maven module which depends only on this dependency and create an assembly. Then copy created jar to your project.

  • QueryRuntimeAPI: to get recorded/runtime informations for instances and activities. It allows also to get activities per state. Then operations in this API applies to process instances and activity instances.

Hereafter you will find an example on how to access to the QueryRuntimeAPI from your client application:

QuerierRuntimeAPI querierRuntimeAPI = AccessorUtil.getQueryRuntimeAPI(String, String);
        

The method getQueryRuntimeAPI takes two arguments of type String. The first argument is the URL of the JMX service. The second is the name of the object JMX. In case we use the default configuration, two constants can be used which are: AccessorUtil.SERVICE_URL and AccessorUtil.OBJECT_NAME.

For a detailed insight on Nova Orchestra APIs, please take a look to the Nova Orchestra javadoc APIs (available under /javadoc directory)