Publishing javadoc for jndn-management:0.9.8
diff --git a/com/intel/jndn/management/NFD.html b/com/intel/jndn/management/NFD.html
index 19eb1a8..d6fe5a4 100644
--- a/com/intel/jndn/management/NFD.html
+++ b/com/intel/jndn/management/NFD.html
@@ -2,16 +2,16 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Mar 25 12:53:40 PDT 2015 -->
+<!-- Generated by javadoc (version 1.7.0_51) on Mon Apr 13 09:43:52 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
-<title>NFD (jndn-management 0.9.7 API)</title>
-<meta name="date" content="2015-03-25">
+<title>NFD (jndn-management 0.9.8 API)</title>
+<meta name="date" content="2015-04-13">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="NFD (jndn-management 0.9.7 API)";
+ parent.document.title="NFD (jndn-management 0.9.8 API)";
}
//-->
</script>
@@ -224,6 +224,12 @@
</td>
</tr>
<tr class="altColor">
+<td class="colFirst"><code>static net.named_data.jndn.KeyLocator</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#getKeyLocator(net.named_data.jndn.Face)">getKeyLocator</a></strong>(net.named_data.jndn.Face forwarder)</code>
+<div class="block">Retrieve the <code>KeyLocator</code> for an NFD.</div>
+</td>
+</tr>
+<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../com/intel/jndn/management/types/RibEntry.html" title="class in com.intel.jndn.management.types">RibEntry</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#getRouteList(net.named_data.jndn.Face)">getRouteList</a></strong>(net.named_data.jndn.Face forwarder)</code>
<div class="block">Retrieve a list of routing entries from the RIB; calls
@@ -231,7 +237,7 @@
are dropped).</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#ping(net.named_data.jndn.Face, net.named_data.jndn.Name)">ping</a></strong>(net.named_data.jndn.Face face,
net.named_data.jndn.Name name)</code>
@@ -239,7 +245,7 @@
responding to requests.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#pingLocal(net.named_data.jndn.Face)">pingLocal</a></strong>(net.named_data.jndn.Face face)</code>
<div class="block">Ping a forwarder on an existing face to verify that the forwarder is
@@ -248,7 +254,7 @@
same machine as the NDN forwarding daemon.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#register(net.named_data.jndn.Face, net.named_data.jndn.ControlParameters)">register</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.ControlParameters controlParameters)</code>
@@ -259,7 +265,7 @@
for protocol documentation.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#register(net.named_data.jndn.Face, int, net.named_data.jndn.Name, int)">register</a></strong>(net.named_data.jndn.Face forwarder,
int faceId,
@@ -269,7 +275,7 @@
is provided a faceId.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#register(net.named_data.jndn.Face, java.lang.String, net.named_data.jndn.Name, int)">register</a></strong>(net.named_data.jndn.Face forwarder,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> uri,
@@ -279,7 +285,7 @@
forwarder to the given URI/route pair.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>static net.named_data.jndn.Data</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#retrieveDataSet(net.named_data.jndn.Face, net.named_data.jndn.Name)">retrieveDataSet</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.Name datasetName)</code>
@@ -288,7 +294,7 @@
<a href="http://redmine.named-data.net/projects/nfd/wiki/StatusDataset">http://redmine.named-data.net/projects/nfd/wiki/StatusDataset</a></div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/intel/jndn/management/types/ControlResponse.html" title="class in com.intel.jndn.management.types">ControlResponse</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#sendCommand(net.named_data.jndn.Face, net.named_data.jndn.Interest)">sendCommand</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.Interest interest)</code>
@@ -297,7 +303,7 @@
from the forwarder.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#setStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name, net.named_data.jndn.Name)">setStrategy</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.Name prefix,
@@ -309,7 +315,7 @@
for protocol documentation.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#unregister(net.named_data.jndn.Face, net.named_data.jndn.ControlParameters)">unregister</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.ControlParameters controlParameters)</code>
@@ -320,7 +326,7 @@
for protocol documentation.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#unregister(net.named_data.jndn.Face, net.named_data.jndn.Name)">unregister</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.Name route)</code>
@@ -331,7 +337,7 @@
for protocol documentation.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#unregister(net.named_data.jndn.Face, net.named_data.jndn.Name, int)">unregister</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.Name route,
@@ -343,7 +349,7 @@
for protocol documentation.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#unregister(net.named_data.jndn.Face, net.named_data.jndn.Name, java.lang.String)">unregister</a></strong>(net.named_data.jndn.Face forwarder,
net.named_data.jndn.Name route,
@@ -524,6 +530,23 @@
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
</ul>
+<a name="getKeyLocator(net.named_data.jndn.Face)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getKeyLocator</h4>
+<pre>public static net.named_data.jndn.KeyLocator getKeyLocator(net.named_data.jndn.Face forwarder)
+ throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a>,
+ <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Retrieve the <code>KeyLocator</code> for an NFD.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>the <code>KeyLocator</code> of the NFD's key</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the key is not available</dd>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the request fails</dd></dl>
+</li>
+</ul>
<a name="addNextHop(net.named_data.jndn.Face, int, net.named_data.jndn.Name)">
<!-- -->
</a>
@@ -789,11 +812,11 @@
<div class="block">Build an interest to retrieve a segmented data set from the NFD; for
details on the DataSet, see
<a href="http://redmine.named-data.net/projects/nfd/wiki/StatusDataset">http://redmine.named-data.net/projects/nfd/wiki/StatusDataset</a></div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>datasetName</code> - </dd>
-<dt><span class="strong">Returns:</span></dt><dd></dd>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - the <code>Face</code> to an NFD</dd><dd><code>datasetName</code> - the <code>Name</code> of the dataset to retrieve</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the re-assembled <code>Data</code> packet</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
-<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code></dd></dl>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the request fails</dd>
+<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - if the returned TLV is not the expected type</dd></dl>
</li>
</ul>
<a name="sendCommand(net.named_data.jndn.Face, net.named_data.jndn.Interest)">
@@ -816,7 +839,7 @@
<a href="http://redmine.named-data.net/projects/nfd/wiki/ControlCommand,">http://redmine.named-data.net/projects/nfd/wiki/ControlCommand,</a>
the requested interest must have encoded ControlParameters appended to the
interest name</dd>
-<dt><span class="strong">Returns:</span></dt><dd></dd>
+<dt><span class="strong">Returns:</span></dt><dd>a <a href="../../../../com/intel/jndn/management/types/ControlResponse.html" title="class in com.intel.jndn.management.types"><code>ControlResponse</code></a></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dd><code>net.named_data.jndn.encoding.EncodingException</code></dd>