<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Investigator Toolkit APIs — v2.1.0-beta</title>
<link rel="stylesheet" href="../_static/dataone.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.1.0-beta',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/mathjax_pre.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="//cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML"></script>
<script type="text/javascript" src="../_static/sidebar.js"></script>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Data Types in CICore" href="Types.html" />
<link rel="prev" title="Coordinating Node APIs" href="CN_APIs.html" />
<link media="only screen and (max-device-width: 480px)" href="../_static/small_dataone.css" type= "text/css" rel="stylesheet" />
</head>
<body role="document">
<div class="version_notice">
<p>
<span class='bold'>Warning:</span> These documents are under active
development and subject to change (version 2.1.0-beta).<br />
The latest release documents are at:
<a href="https://purl.dataone.org/architecture">https://purl.dataone.org/architecture</a>
</p>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Types.html" title="Data Types in CICore"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="CN_APIs.html" title="Coordinating Node APIs"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html"></a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">DataONE APIs</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-ITK_APIs">
<span id="investigator-toolkit-apis"></span><h1>Investigator Toolkit APIs<a class="headerlink" href="#module-ITK_APIs" title="Permalink to this headline">¶</a></h1>
<p>Components of the Investigator Toolkit leverage the service interfaces exposed
by Coordinating and Member Nodes to facilitate content discovery, retrieval,
and creation.</p>
<p>Documentation for specific tools is maintained separately with the respective
distributions.</p>
<p>Developers are strongly encouraged to utilize at least the <code class="docutils literal"><span class="pre">common</span></code> and
<code class="docutils literal"><span class="pre">libclient</span></code> libraries for their implementations, as these will handle the
necessary communications and message processing for interaction with the
DataONE service interfaces.</p>
<div class="section" id="java-tools">
<h2>Java Tools<a class="headerlink" href="#java-tools" title="Permalink to this headline">¶</a></h2>
<p>The DataONE developed Java libraries are available through the <a class="reference external" href="https://repository.dataone.org/software/cicore/trunk/">DataONE
subversion repository</a> as source, and as compiled artifacts through the
DataONE private Maven repository which is located at:</p>
<blockquote>
<div><a class="reference external" href="http://maven.dataone.org/">http://maven.dataone.org/</a></div></blockquote>
<p>These can be readily integrated into Maven project by adding the repository to
the pom.xml file:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">repository</span><span class="o">></span>
<span class="o"><</span><span class="nb">id</span><span class="o">></span><span class="n">dataone</span><span class="o">.</span><span class="n">org</span><span class="o"></</span><span class="nb">id</span><span class="o">></span>
<span class="o"><</span><span class="n">url</span><span class="o">></span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">maven</span><span class="o">.</span><span class="n">dataone</span><span class="o">.</span><span class="n">org</span><span class="o"></</span><span class="n">url</span><span class="o">></span>
<span class="o"><</span><span class="n">releases</span><span class="o">></span>
<span class="o"><</span><span class="n">enabled</span><span class="o">></span><span class="n">true</span><span class="o"></</span><span class="n">enabled</span><span class="o">></span>
<span class="o"></</span><span class="n">releases</span><span class="o">></span>
<span class="o"><</span><span class="n">snapshots</span><span class="o">></span>
<span class="o"><</span><span class="n">enabled</span><span class="o">></span><span class="n">true</span><span class="o"></</span><span class="n">enabled</span><span class="o">></span>
<span class="o"></</span><span class="n">snapshots</span><span class="o">></span>
<span class="o"></</span><span class="n">repository</span><span class="o">></span>
</pre></div>
</div>
<p>Documentation for the libraries is generated by the Maven <code class="docutils literal"><span class="pre">javadoc:javadoc</span></code>
goal. Javadocs for some libraries is available on the <a class="reference external" href="http://jenkins-1.dataone.org/jenkins">continuous build
environment</a>.</p>
<p>The two main libraries for client application development include
<code class="docutils literal"><span class="pre">d1_common_java</span></code> ( <a class="reference external" href="http://jenkins-1.dataone.org/jenkins/job/d1_common_java/ws/d1_common_java/target/site/apidocs/index.html">documentation</a> ) which provides message
generation and parsing capabilities, and <code class="docutils literal"><span class="pre">d1_libclient_java</span> <span class="pre">provides</span></code>
( <a class="reference external" href="http://jenkins-1.dataone.org/jenkins/job/d1_libclient_java/ws/d1_libclient_java/target/site/apidocs/index.html">documentation</a> ) the implementation of methods that
support communication with Member and Coordinating Nodes through the DataONE
service interfaces.</p>
</div>
<div class="section" id="python-tools">
<h2>Python Tools<a class="headerlink" href="#python-tools" title="Permalink to this headline">¶</a></h2>
<p>The DataONE developed Python libraries are distributed through <a class="reference external" href="https://pypi.python.org">PyPi</a>, and the
latest versions can be found there by <a class="reference external" href="https://pypi.python.org/pypi?%3Aaction=search&term=dataone&submit=search">searching for “dataone”</a>.</p>
<p>The core libraries of <a class="reference external" href="https://pypi.python.org/pypi/dataone.common">dataone.common</a>, <a class="reference external" href="https://pypi.python.org/pypi/dataone.certificate_extensions">dataone.certificate_extensions</a>,
and <a class="reference external" href="https://pypi.python.org/pypi/dataone.libclient">dataone.libclient</a> 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 <a class="reference external" href="https://repository.dataone.org/software/cicore/trunk/">DataONE subversion repository</a>, and generated documentation
is available from <a class="reference external" href="http://pythonhosted.org">pythonhosted.org</a> for the respective components (see
documentation links in the PyPi entries for each component).</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="http://dataone.org">
<img class="logo" src="../_static/dataone_logo.png" alt="Logo"/>
</a></p>
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Investigator Toolkit APIs</a><ul>
<li><a class="reference internal" href="#java-tools">Java Tools</a></li>
<li><a class="reference internal" href="#python-tools">Python Tools</a></li>
</ul>
</li>
</ul>
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation Overview</a><ul>
<li><a href="index.html">DataONE APIs</a><ul>
<li>Previous: <a href="CN_APIs.html" title="previous chapter">Coordinating Node APIs</a></li>
<li>Next: <a href="Types.html" title="next chapter">Data Types in CICore</a></li>
</ul></li>
</ul></li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
<div id="copyright">
© Copyright <a href="http://www.dataone.org">2009-2017, DataONE</a>.
[ <a href="../_sources/apis/ITK_APIs.txt"
rel="nofollow">Page Source</a> |
<a href='https://redmine.dataone.org/projects/d1/repository/changes/documents/Projects/cicore/architecture/api-documentation/source/apis/ITK_APIs.txt'
rel="nofollow">Revision History</a> ]
</div>
<div id="acknowledgement">
<p>This material is based upon work supported by the National Science Foundation
under Grant Numbers <a href="http://www.nsf.gov/awardsearch/showAward?AWD_ID=0830944">083094</a> and <a href="http://www.nsf.gov/awardsearch/showAward?AWD_ID=1430508">1430508</a>.</p>
<p>Any opinions, findings, and conclusions or recommendations expressed in this
material are those of the author(s) and do not necessarily reflect the views
of the National Science Foundation.</p>
</div>
</div>
<!--
<hr />
<div id="HCB_comment_box"><a href="http://www.htmlcommentbox.com">HTML Comment Box</a> is loading comments...</div>
<link rel="stylesheet" type="text/css" href="_static/skin.css" />
<script type="text/javascript" language="javascript" id="hcb">
/*<! -*/
(function()
{s=document.createElement("script");
s.setAttribute("type","text/javascript");
s.setAttribute("src", "http://www.htmlcommentbox.com/jread?page="+escape((typeof hcb_user !== "undefined" && hcb_user.PAGE)||(""+window.location)).replace("+","%2B")+"&mod=%241%24wq1rdBcg%24Gg8J5iYSHJWwAJtlYu/yU."+"&opts=21407&num=10");
if (typeof s!="undefined") document.getElementsByTagName("head")[0].appendChild(s);})();
/* ->*/
</script>
-->
</body>
</html>