Investigator Toolkit APIs

Components of the Investigator Toolkit leverage the service interfaces exposed by Coordinating and Member Nodes to facilitate content discovery, retrieval, and creation.

Documentation for specific tools is maintained separately with the respective distributions.

Developers are strongly encouraged to utilize at least the common and libclient libraries for their implementations, as these will handle the necessary communications and message processing for interaction with the DataONE service interfaces.

Java Tools

The DataONE developed Java libraries are available through the DataONE subversion repository as source, and as compiled artifacts through the DataONE private Maven repository which is located at:

http://maven.dataone.org/

These can be readily integrated into Maven project by adding the repository to the pom.xml file:

<repository>
  <id>dataone.org</id>
  <url>http://maven.dataone.org</url>
  <releases>
    <enabled>true</enabled>
  </releases>
  <snapshots>
    <enabled>true</enabled>
  </snapshots>
</repository>

Documentation for the libraries is generated by the Maven javadoc:javadoc goal. Javadocs for some libraries is available on the continuous build environment.

The two main libraries for client application development include d1_common_java ( documentation ) which provides message generation and parsing capabilities, and d1_libclient_java provides ( documentation ) the implementation of methods that support communication with Member and Coordinating Nodes through the DataONE service interfaces.

Python Tools

The DataONE developed Python libraries are distributed through PyPi, and the latest versions can be found there by searching for “dataone”.

The core libraries of dataone.common, dataone.certificate_extensions, and dataone.libclient provide low level support for message generation and parsing, x509 certificate processing, and communications with the Coordinating and Member Node service interfaces respectively. The source for each of these is available in the DataONE subversion repository, and generated documentation is available from pythonhosted.org for the respective components (see documentation links in the PyPi entries for each component).