The GenRocket runtime application interface (API) allows programmers to access the GenRocket runtime to directly modify and create scenarios from their own programs. Programmers will have the following control over a Scenario:

  • Modify Domains, Attributes, Generators and Receivers
  • Add Domains, Attributes, Generators and Receivers to an existing Scenario


 


API Concrete Interfaces (see Index Of API Methods)

There are three concrete interfaces for accessing the GenRocket API

  • The GenRocket Binary Runtime
  • The GenRocket Realtime Socket Engine
  • The GenRocket Realtime REST Engine



The GenRocket Binary Runtime 

Programmers developing applications with languages that compile down to a Java binary (e.g. Groovy, Scala, Jython) can directly access the GenRocket binary runtime.


The GenRocket Realtime Socket Engine 

Programmers developing applications that cannot directly access the GenRocket binary runtime may do by launching the GenRocket Socket Engine and make method calls via a socket.  Each socket call requires sending a request payload as well as receiving a response payload.  All payloads are in JSON.   


The GenRocket Realtime REST Engine

Programmers developing applications that cannot directly access the GenRocket binary runtime may do by launching the GenRocket REST Engine and make method calls via Restful web services.  Each socket call requires sending a request payload as well as receiving a response payload.  All payloads are in JSON.


Attribute Naming Convention

An attributeName has the format of domainName.attributeName.  If the domainName is not contained as the prefix of an attributeName, the domain will not be found.

Examples:

  • User.lastName
  • Organization.title
  • Department.name


Generator Naming Convention

A generatorName must be the conical form of the Generator's name.

Examples:

  • com.genRocket.generator.RangeGen
  • com.genRocket.generator.ListGen
  • com.genRocket.generator.NameGen