HQU API Summary
The APIs that HQ provides HQU plugins come in two formats:
- Groovy-stylee
- Backend-stylee
Groovy APIs
Using the power of Groovy, HQU can provide APIs which are natural to read and behave in a more intuitive format. This library of utilities
is housed here:
src/org/hyperic/hq/hqu/rendit_sys
Backend APIs
The core of HQ is written in Java, using JBoss Session Beans for transaction management, and Hibernate for persistence. Ultimately, all calls from HQU plugins are translated into Backend API calls.
The APIs in the backend provide full access to every part of HQ, however often expose legacy APIs or model decisions that we would like to deprecate.
All source in the HQ repository, loaded libraries, and all classes in the JVM are available.
Which to use?
Please use the Groovy APIs if possible. This area of the project is expanding on a continual basis and provides the easiest interaction
The Groovy APIs will most likely not give you everything you need, though, so feel free to use all backend APIs but be wary of deprecation.