From ScarletDME
Revision as of 16:48, 27 August 2009 by Diccon (talk | contribs) (→‎Download: added source links)
Jump to navigation Jump to search

This Java API library is a native Java library, which allows you to access QM via the QMClient network interface.

All you need is QMClient running on the server, the IP address, a valid username and password and the Account you want to access.


Currently the API supports almost all of the Documented QMClient commands. Access to them is controlled by the main class QMConnection.


Binary (Jar) download is available here: JavaQMConnect-0.8.jar

Source code

LGPL licenced source code for this library are available in the following locations:

The latest Source is available from the subversion repo

 svn checkout

Or as a source tar ball if you don't want to use Subversion JavaQMConnect-0.8.tar.gz

Both of the above are structured by Netbeans IDE. It is not necessary to use Netbeans if you don't want to, thought I do recommend it. A simple text editor and the Ant build utility would be enough. Or other IDE's like Eclipse will import this structure fine.

Commercial Support

For commercial support or new features Contact Adrian Tesson Associates (


Here is an example of how to use the JavaQM API Lib. Simply place the Jar in the library path or same directory as your classes or Jar file.

import com.openqm.qmconnect.*;

/** Example program that accesses QM with the Java API */
public class Example {
    Example() {
        try {
            /* Initialise the connection */
           QmConnection connection = QmConnection.create("localhost",4243);        
           /* Tell it to log in */
           connection.connect("testuser", "password", "QMSYS");
           /* Open Up the VOC file as an example */
           QmFile vocFile ="VOC");
           /* Read from the Opened VOC file */
           String record =, "MESSAGES");

           System.out.println("This is the MESSAGES Record from the VOC file: " + record);
        } catch (QMException e) {
            System.err.println("Error occurred connecting to QM");