toolkit_api

Toolkit API

Toolkit API is a Java API for controlling many aspects of Toolkit. The API (a Jar file to be included in your Java project) talks to an installation of Toolkit using a series of REST calls. Most of this document focuses on the API developer and not the user but for the user there is documentation:

JavaDocs

I maintain the JavaDocs for the API at http://ihexds.nist.gov/XdsDocs/api/javadoc/index.html.

Managing the Transaction Received notification

See here

The module tk-api is a wrapper around the two modules that matter, toolkit-api and toolkit-services-common.

The module toolkit-api is the API for toolkit, mostly Java Interface files. Toolkit-services-common (which will be renamed to toolkit-api-impl soon) is the implementation of the API. This API uses Jersey based REST calls to call the main toolkit which must be installed locally. This installation need not be on the same machine but connections from the API to toolkit and from toolkit to the API will be built. If there is a firewall between the API and toolkit then ports will have to be managed. I suggest these two components reside on the same machine.

The API is initialized with the location of the supporting toolkit installation. This location is the URL

http://hostname:port/xdstools2

Runtime Dependencies

As of Toolkit version 6.3.4, here are the dependencies for using the API. First, the main module for the API is toolkit-api. To know versions for external modules look at module tk-deps.