blob: 1e99a2fd9b3b55b48552fe965b952ed15df56014 [file] [log] [blame]
Andrew Brown6ac7d4a2015-03-24 09:42:42 -07001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
Andrew Brown6859f772015-05-11 14:26:53 -07005<!-- Generated by javadoc (version 1.7.0_51) on Mon May 11 14:26:38 PDT 2015 -->
Andrew Brown6ac7d4a2015-03-24 09:42:42 -07006<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
Andrew Brown6859f772015-05-11 14:26:53 -07007<title>NFD (jndn-management 0.10.0 API)</title>
8<meta name="date" content="2015-05-11">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -07009<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
10</head>
11<body>
12<script type="text/javascript"><!--
13 if (location.href.indexOf('is-external=true') == -1) {
Andrew Brown6859f772015-05-11 14:26:53 -070014 parent.document.title="NFD (jndn-management 0.10.0 API)";
Andrew Brown6ac7d4a2015-03-24 09:42:42 -070015 }
16//-->
17</script>
18<noscript>
19<div>JavaScript is disabled on your browser.</div>
20</noscript>
21<!-- ========= START OF TOP NAVBAR ======= -->
22<div class="topNav"><a name="navbar_top">
23<!-- -->
24</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
25<!-- -->
26</a>
27<ul class="navList" title="Navigation">
28<li><a href="../../../../overview-summary.html">Overview</a></li>
29<li><a href="package-summary.html">Package</a></li>
30<li class="navBarCell1Rev">Class</li>
31<li><a href="class-use/NFD.html">Use</a></li>
32<li><a href="package-tree.html">Tree</a></li>
33<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
34<li><a href="../../../../index-all.html">Index</a></li>
35<li><a href="../../../../help-doc.html">Help</a></li>
36</ul>
37</div>
38<div class="subNav">
39<ul class="navList">
40<li><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management"><span class="strong">Prev Class</span></a></li>
Andrew Brown6859f772015-05-11 14:26:53 -070041<li><a href="../../../../com/intel/jndn/management/Strategies.html" title="class in com.intel.jndn.management"><span class="strong">Next Class</span></a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -070042</ul>
43<ul class="navList">
44<li><a href="../../../../index.html?com/intel/jndn/management/NFD.html" target="_top">Frames</a></li>
45<li><a href="NFD.html" target="_top">No Frames</a></li>
46</ul>
47<ul class="navList" id="allclasses_navbar_top">
48<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
49</ul>
50<div>
51<script type="text/javascript"><!--
52 allClassesLink = document.getElementById("allclasses_navbar_top");
53 if(window==top) {
54 allClassesLink.style.display = "block";
55 }
56 else {
57 allClassesLink.style.display = "none";
58 }
59 //-->
60</script>
61</div>
62<div>
63<ul class="subNavList">
64<li>Summary:&nbsp;</li>
65<li>Nested&nbsp;|&nbsp;</li>
66<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
67<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
68<li><a href="#method_summary">Method</a></li>
69</ul>
70<ul class="subNavList">
71<li>Detail:&nbsp;</li>
72<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
73<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
74<li><a href="#method_detail">Method</a></li>
75</ul>
76</div>
77<a name="skip-navbar_top">
78<!-- -->
79</a></div>
80<!-- ========= END OF TOP NAVBAR ========= -->
81<!-- ======== START OF CLASS DATA ======== -->
82<div class="header">
83<div class="subTitle">com.intel.jndn.management</div>
84<h2 title="Class NFD" class="title">Class NFD</h2>
85</div>
86<div class="contentContainer">
87<ul class="inheritance">
88<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
89<li>
90<ul class="inheritance">
91<li>com.intel.jndn.management.NFD</li>
92</ul>
93</li>
94</ul>
95<div class="description">
96<ul class="blockList">
97<li class="blockList">
98<hr>
99<br>
100<pre>public class <span class="strong">NFD</span>
101extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
102<div class="block">Helper class for interacting with an NDN forwarder daemon; see
Andrew Brown7969d392015-03-25 12:08:09 -0700103 <a href="http://redmine.named-data.net/projects/nfd/wiki/Management">http://redmine.named-data.net/projects/nfd/wiki/Management</a>
104 for explanations of the various protocols used.</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700105<dl><dt><span class="strong">Author:</span></dt>
106 <dd>Andrew Brown <andrew.brown@intel.com></dd></dl>
107</li>
108</ul>
109</div>
110<div class="summary">
111<ul class="blockList">
112<li class="blockList">
113<!-- =========== FIELD SUMMARY =========== -->
114<ul class="blockList">
115<li class="blockList"><a name="field_summary">
116<!-- -->
117</a>
118<h3>Field Summary</h3>
119<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
120<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
121<tr>
122<th class="colFirst" scope="col">Modifier and Type</th>
123<th class="colLast" scope="col">Field and Description</th>
124</tr>
125<tr class="altColor">
126<td class="colFirst"><code>static long</code></td>
127<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#DEFAULT_TIMEOUT">DEFAULT_TIMEOUT</a></strong></code>&nbsp;</td>
128</tr>
129<tr class="rowColor">
130<td class="colFirst"><code>static int</code></td>
131<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#OK_STATUS">OK_STATUS</a></strong></code>&nbsp;</td>
132</tr>
133</table>
134</li>
135</ul>
136<!-- ======== CONSTRUCTOR SUMMARY ======== -->
137<ul class="blockList">
138<li class="blockList"><a name="constructor_summary">
139<!-- -->
140</a>
141<h3>Constructor Summary</h3>
142<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
143<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
144<tr>
145<th class="colOne" scope="col">Constructor and Description</th>
146</tr>
147<tr class="altColor">
148<td class="colOne"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#NFD()">NFD</a></strong>()</code>&nbsp;</td>
149</tr>
150</table>
151</li>
152</ul>
153<!-- ========== METHOD SUMMARY =========== -->
154<ul class="blockList">
155<li class="blockList"><a name="method_summary">
156<!-- -->
157</a>
158<h3>Method Summary</h3>
159<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
160<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
161<tr>
162<th class="colFirst" scope="col">Modifier and Type</th>
163<th class="colLast" scope="col">Method and Description</th>
164</tr>
165<tr class="altColor">
166<td class="colFirst"><code>static void</code></td>
167<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#addNextHop(net.named_data.jndn.Face, int, net.named_data.jndn.Name)">addNextHop</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
168 int&nbsp;faceId,
169 net.named_data.jndn.Name&nbsp;prefix)</code>
170<div class="block">Helper method to register a new face on the forwarder; as mentioned at
Andrew Brown7969d392015-03-25 12:08:09 -0700171 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>,
172 this is more for debugging; use 'register' instead</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700173</td>
174</tr>
175<tr class="rowColor">
176<td class="colFirst"><code>static int</code></td>
177<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#createFace(net.named_data.jndn.Face, java.lang.String)">createFace</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
178 <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>&nbsp;uri)</code>
179<div class="block">Create a new face on the given forwarder.</div>
180</td>
181</tr>
182<tr class="altColor">
183<td class="colFirst"><code>static void</code></td>
184<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#destroyFace(net.named_data.jndn.Face, int)">destroyFace</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
185 int&nbsp;faceId)</code>
186<div class="block">Destroy a face on given forwarder.</div>
187</td>
188</tr>
189<tr class="rowColor">
190<td class="colFirst"><code>static void</code></td>
191<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#disableLocalControlHeader(net.named_data.jndn.Face, com.intel.jndn.management.types.LocalControlHeader)">disableLocalControlHeader</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
192 <a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a>&nbsp;header)</code>
193<div class="block">Disable a local control feature on the given forwarder.</div>
194</td>
195</tr>
196<tr class="altColor">
197<td class="colFirst"><code>static void</code></td>
198<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#enableLocalControlHeader(net.named_data.jndn.Face, com.intel.jndn.management.types.LocalControlHeader)">enableLocalControlHeader</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
199 <a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a>&nbsp;header)</code>
200<div class="block">Enable a local control feature on the given forwarder.</div>
201</td>
202</tr>
203<tr class="rowColor">
204<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>&lt;<a href="../../../../com/intel/jndn/management/types/FaceStatus.html" title="class in com.intel.jndn.management.types">FaceStatus</a>&gt;</code></td>
205<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#getFaceList(net.named_data.jndn.Face)">getFaceList</a></strong>(net.named_data.jndn.Face&nbsp;forwarder)</code>
206<div class="block">Retrieve a list of faces and their status from the given forwarder; calls
207 /localhost/nfd/faces/list which requires a local Face (all non-local
208 packets are dropped)</div>
209</td>
210</tr>
211<tr class="altColor">
212<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>&lt;<a href="../../../../com/intel/jndn/management/types/FibEntry.html" title="class in com.intel.jndn.management.types">FibEntry</a>&gt;</code></td>
213<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#getFibList(net.named_data.jndn.Face)">getFibList</a></strong>(net.named_data.jndn.Face&nbsp;forwarder)</code>
214<div class="block">Retrieve a list of FIB entries and their NextHopRecords from the given
215 forwarder; calls /localhost/nfd/fib/list which requires a local Face (all
216 non-local packets are dropped).</div>
217</td>
218</tr>
219<tr class="rowColor">
Andrew Brown7969d392015-03-25 12:08:09 -0700220<td class="colFirst"><code>static <a href="../../../../com/intel/jndn/management/types/ForwarderStatus.html" title="class in com.intel.jndn.management.types">ForwarderStatus</a></code></td>
221<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#getForwarderStatus(net.named_data.jndn.Face)">getForwarderStatus</a></strong>(net.named_data.jndn.Face&nbsp;forwarder)</code>
222<div class="block">Retrieve the status of the given forwarder; calls /localhost/nfd/status
223 which requires a local Face (all non-local packets are dropped)</div>
224</td>
225</tr>
226<tr class="altColor">
Andrew Brown3a3cd4e2015-04-13 09:44:12 -0700227<td class="colFirst"><code>static net.named_data.jndn.KeyLocator</code></td>
228<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&nbsp;forwarder)</code>
229<div class="block">Retrieve the <code>KeyLocator</code> for an NFD.</div>
230</td>
231</tr>
232<tr class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700233<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>&lt;<a href="../../../../com/intel/jndn/management/types/RibEntry.html" title="class in com.intel.jndn.management.types">RibEntry</a>&gt;</code></td>
234<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&nbsp;forwarder)</code>
235<div class="block">Retrieve a list of routing entries from the RIB; calls
236 /localhost/nfd/rib/list which requires a local Face (all non-local packets
237 are dropped).</div>
238</td>
239</tr>
Andrew Brown3a3cd4e2015-04-13 09:44:12 -0700240<tr class="altColor">
Andrew Brown6859f772015-05-11 14:26:53 -0700241<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>&lt;<a href="../../../../com/intel/jndn/management/types/StrategyChoice.html" title="class in com.intel.jndn.management.types">StrategyChoice</a>&gt;</code></td>
242<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#getStrategyList(net.named_data.jndn.Face)">getStrategyList</a></strong>(net.named_data.jndn.Face&nbsp;forwarder)</code>
243<div class="block">Retrieve the list of strategy choice entries from the NFD; calls
244 /localhost/nfd/rib/list which requires a local Face (all non-local packets
245 are dropped).</div>
246</td>
247</tr>
248<tr class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700249<td class="colFirst"><code>static boolean</code></td>
250<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&nbsp;face,
251 net.named_data.jndn.Name&nbsp;name)</code>
252<div class="block">Request a name on an existing face to verify the forwarder is working and
253 responding to requests.</div>
254</td>
255</tr>
Andrew Brown6859f772015-05-11 14:26:53 -0700256<tr class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700257<td class="colFirst"><code>static boolean</code></td>
258<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&nbsp;face)</code>
259<div class="block">Ping a forwarder on an existing face to verify that the forwarder is
260 working and responding to requests; this version sends a discovery packet
261 to /localhost/nfd which should always respond if the requestor is on the
262 same machine as the NDN forwarding daemon.</div>
263</td>
264</tr>
Andrew Brown6859f772015-05-11 14:26:53 -0700265<tr class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700266<td class="colFirst"><code>static void</code></td>
267<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&nbsp;forwarder,
268 net.named_data.jndn.ControlParameters&nbsp;controlParameters)</code>
269<div class="block">Register a route on the forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700270 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
271 for command-line usage and
272 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
273 for protocol documentation.</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700274</td>
275</tr>
Andrew Brown6859f772015-05-11 14:26:53 -0700276<tr class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700277<td class="colFirst"><code>static void</code></td>
278<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&nbsp;forwarder,
279 int&nbsp;faceId,
280 net.named_data.jndn.Name&nbsp;route,
281 int&nbsp;cost)</code>
282<div class="block">Register a route on a forwarder; this will not create a new face since it
283 is provided a faceId.</div>
284</td>
285</tr>
Andrew Brown6859f772015-05-11 14:26:53 -0700286<tr class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700287<td class="colFirst"><code>static void</code></td>
288<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&nbsp;forwarder,
289 <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>&nbsp;uri,
290 net.named_data.jndn.Name&nbsp;route,
291 int&nbsp;cost)</code>
292<div class="block">Register a route on a forwarder; this will create a new face on the
293 forwarder to the given URI/route pair.</div>
294</td>
295</tr>
Andrew Brown6859f772015-05-11 14:26:53 -0700296<tr class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700297<td class="colFirst"><code>static net.named_data.jndn.Data</code></td>
298<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&nbsp;forwarder,
299 net.named_data.jndn.Name&nbsp;datasetName)</code>
300<div class="block">Build an interest to retrieve a segmented data set from the NFD; for
301 details on the DataSet, see
Andrew Brown7969d392015-03-25 12:08:09 -0700302 <a href="http://redmine.named-data.net/projects/nfd/wiki/StatusDataset">http://redmine.named-data.net/projects/nfd/wiki/StatusDataset</a></div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700303</td>
304</tr>
Andrew Brown6859f772015-05-11 14:26:53 -0700305<tr class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700306<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>
307<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&nbsp;forwarder,
308 net.named_data.jndn.Interest&nbsp;interest)</code>
309<div class="block">Send an interest as a command to the forwarder; this method will convert
310 the interest to a command interest and block until a response is received
311 from the forwarder.</div>
312</td>
313</tr>
Andrew Brown6859f772015-05-11 14:26:53 -0700314<tr class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700315<td class="colFirst"><code>static void</code></td>
316<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&nbsp;forwarder,
317 net.named_data.jndn.Name&nbsp;prefix,
318 net.named_data.jndn.Name&nbsp;strategy)</code>
319<div class="block">Set a strategy on the forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700320 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
321 for command-line usage and
322 <a href="http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice">http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice</a>
323 for protocol documentation.</div>
324</td>
325</tr>
Andrew Brown6859f772015-05-11 14:26:53 -0700326<tr class="rowColor">
Andrew Brown7969d392015-03-25 12:08:09 -0700327<td class="colFirst"><code>static void</code></td>
328<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&nbsp;forwarder,
329 net.named_data.jndn.ControlParameters&nbsp;controlParameters)</code>
330<div class="block">Unregister a route on a forwarder; see
331 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
332 for command-line usage and
333 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700334 for protocol documentation.</div>
335</td>
336</tr>
Andrew Brown6859f772015-05-11 14:26:53 -0700337<tr class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700338<td class="colFirst"><code>static void</code></td>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700339<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&nbsp;forwarder,
340 net.named_data.jndn.Name&nbsp;route)</code>
341<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700342 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
343 for command-line usage and
344 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
345 for protocol documentation.</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700346</td>
347</tr>
Andrew Brown6859f772015-05-11 14:26:53 -0700348<tr class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700349<td class="colFirst"><code>static void</code></td>
350<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&nbsp;forwarder,
351 net.named_data.jndn.Name&nbsp;route,
352 int&nbsp;faceId)</code>
353<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700354 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
355 for command-line usage and
356 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
357 for protocol documentation.</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700358</td>
359</tr>
Andrew Brown6859f772015-05-11 14:26:53 -0700360<tr class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700361<td class="colFirst"><code>static void</code></td>
362<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&nbsp;forwarder,
363 net.named_data.jndn.Name&nbsp;route,
364 <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>&nbsp;uri)</code>
365<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700366 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
367 for command-line usage and
368 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
369 for protocol documentation.</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700370</td>
371</tr>
Andrew Brown6859f772015-05-11 14:26:53 -0700372<tr class="rowColor">
373<td class="colFirst"><code>static void</code></td>
374<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/NFD.html#unsetStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name)">unsetStrategy</a></strong>(net.named_data.jndn.Face&nbsp;forwarder,
375 net.named_data.jndn.Name&nbsp;prefix)</code>
376<div class="block">Set a strategy on the forwarder; see
377 <a href="../../../../com/intel/jndn/management/NFD.html#setStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name, net.named_data.jndn.Name)"><code>setStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name, net.named_data.jndn.Name)</code></a>
378 for more information.</div>
379</td>
380</tr>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700381</table>
382<ul class="blockList">
383<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
384<!-- -->
385</a>
386<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
387<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
388</ul>
389</li>
390</ul>
391</li>
392</ul>
393</div>
394<div class="details">
395<ul class="blockList">
396<li class="blockList">
397<!-- ============ FIELD DETAIL =========== -->
398<ul class="blockList">
399<li class="blockList"><a name="field_detail">
400<!-- -->
401</a>
402<h3>Field Detail</h3>
403<a name="DEFAULT_TIMEOUT">
404<!-- -->
405</a>
406<ul class="blockList">
407<li class="blockList">
408<h4>DEFAULT_TIMEOUT</h4>
409<pre>public static final&nbsp;long DEFAULT_TIMEOUT</pre>
410<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.intel.jndn.management.NFD.DEFAULT_TIMEOUT">Constant Field Values</a></dd></dl>
411</li>
412</ul>
413<a name="OK_STATUS">
414<!-- -->
415</a>
416<ul class="blockListLast">
417<li class="blockList">
418<h4>OK_STATUS</h4>
419<pre>public static final&nbsp;int OK_STATUS</pre>
420<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#com.intel.jndn.management.NFD.OK_STATUS">Constant Field Values</a></dd></dl>
421</li>
422</ul>
423</li>
424</ul>
425<!-- ========= CONSTRUCTOR DETAIL ======== -->
426<ul class="blockList">
427<li class="blockList"><a name="constructor_detail">
428<!-- -->
429</a>
430<h3>Constructor Detail</h3>
431<a name="NFD()">
432<!-- -->
433</a>
434<ul class="blockListLast">
435<li class="blockList">
436<h4>NFD</h4>
437<pre>public&nbsp;NFD()</pre>
438</li>
439</ul>
440</li>
441</ul>
442<!-- ============ METHOD DETAIL ========== -->
443<ul class="blockList">
444<li class="blockList"><a name="method_detail">
445<!-- -->
446</a>
447<h3>Method Detail</h3>
448<a name="pingLocal(net.named_data.jndn.Face)">
449<!-- -->
450</a>
451<ul class="blockList">
452<li class="blockList">
453<h4>pingLocal</h4>
454<pre>public static&nbsp;boolean&nbsp;pingLocal(net.named_data.jndn.Face&nbsp;face)</pre>
455<div class="block">Ping a forwarder on an existing face to verify that the forwarder is
456 working and responding to requests; this version sends a discovery packet
457 to /localhost/nfd which should always respond if the requestor is on the
458 same machine as the NDN forwarding daemon.</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700459<dl><dt><span class="strong">Parameters:</span></dt><dd><code>face</code> - only a localhost Face</dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700460<dt><span class="strong">Returns:</span></dt><dd>true if successful, false otherwise</dd></dl>
461</li>
462</ul>
463<a name="ping(net.named_data.jndn.Face, net.named_data.jndn.Name)">
464<!-- -->
465</a>
466<ul class="blockList">
467<li class="blockList">
468<h4>ping</h4>
469<pre>public static&nbsp;boolean&nbsp;ping(net.named_data.jndn.Face&nbsp;face,
470 net.named_data.jndn.Name&nbsp;name)</pre>
471<div class="block">Request a name on an existing face to verify the forwarder is working and
472 responding to requests. Note that the name must be served or cached on the
473 forwarder for this to return true.</div>
474<dl><dt><span class="strong">Parameters:</span></dt><dd><code>face</code> - </dd><dd><code>name</code> - </dd>
475<dt><span class="strong">Returns:</span></dt><dd>true if successful, false otherwise</dd></dl>
476</li>
477</ul>
Andrew Brown7969d392015-03-25 12:08:09 -0700478<a name="getForwarderStatus(net.named_data.jndn.Face)">
479<!-- -->
480</a>
481<ul class="blockList">
482<li class="blockList">
483<h4>getForwarderStatus</h4>
484<pre>public static&nbsp;<a href="../../../../com/intel/jndn/management/types/ForwarderStatus.html" title="class in com.intel.jndn.management.types">ForwarderStatus</a>&nbsp;getForwarderStatus(net.named_data.jndn.Face&nbsp;forwarder)
485 throws <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></pre>
486<div class="block">Retrieve the status of the given forwarder; calls /localhost/nfd/status
487 which requires a local Face (all non-local packets are dropped)</div>
488<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd>
489<dt><span class="strong">Returns:</span></dt><dd>the forwarder status object, see
490 <a href="http://redmine.named-data.net/projects/nfd/wiki/ForwarderStatus">
491 http://redmine.named-data.net/projects/nfd/wiki/ForwarderStatus</a>.</dd>
492<dt><span class="strong">Throws:</span></dt>
493<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>
494</li>
495</ul>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700496<a name="getFaceList(net.named_data.jndn.Face)">
497<!-- -->
498</a>
499<ul class="blockList">
500<li class="blockList">
501<h4>getFaceList</h4>
502<pre>public static&nbsp;<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>&lt;<a href="../../../../com/intel/jndn/management/types/FaceStatus.html" title="class in com.intel.jndn.management.types">FaceStatus</a>&gt;&nbsp;getFaceList(net.named_data.jndn.Face&nbsp;forwarder)
503 throws <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></pre>
504<div class="block">Retrieve a list of faces and their status from the given forwarder; calls
505 /localhost/nfd/faces/list which requires a local Face (all non-local
506 packets are dropped)</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700507<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd>
508<dt><span class="strong">Returns:</span></dt><dd>a list of face status objects, see
509 http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt.</dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700510<dt><span class="strong">Throws:</span></dt>
511<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>
512</li>
513</ul>
514<a name="getFibList(net.named_data.jndn.Face)">
515<!-- -->
516</a>
517<ul class="blockList">
518<li class="blockList">
519<h4>getFibList</h4>
520<pre>public static&nbsp;<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>&lt;<a href="../../../../com/intel/jndn/management/types/FibEntry.html" title="class in com.intel.jndn.management.types">FibEntry</a>&gt;&nbsp;getFibList(net.named_data.jndn.Face&nbsp;forwarder)
521 throws <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></pre>
522<div class="block">Retrieve a list of FIB entries and their NextHopRecords from the given
523 forwarder; calls /localhost/nfd/fib/list which requires a local Face (all
524 non-local packets are dropped).</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700525<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd>
526<dt><span class="strong">Returns:</span></dt><dd>a list of FIB entries, see
527 http://redmine.named-data.net/projects/nfd/wiki/FibMgmt#FIB-Dataset.</dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700528<dt><span class="strong">Throws:</span></dt>
529<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>
530</li>
531</ul>
532<a name="getRouteList(net.named_data.jndn.Face)">
533<!-- -->
534</a>
535<ul class="blockList">
536<li class="blockList">
537<h4>getRouteList</h4>
538<pre>public static&nbsp;<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>&lt;<a href="../../../../com/intel/jndn/management/types/RibEntry.html" title="class in com.intel.jndn.management.types">RibEntry</a>&gt;&nbsp;getRouteList(net.named_data.jndn.Face&nbsp;forwarder)
539 throws <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></pre>
540<div class="block">Retrieve a list of routing entries from the RIB; calls
541 /localhost/nfd/rib/list which requires a local Face (all non-local packets
542 are dropped).</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700543<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd>
544<dt><span class="strong">Returns:</span></dt><dd>a list of RIB entries, i.e. routes, see
545 http://redmine.named-data.net/projects/nfd/wiki/RibMgmt#RIB-Dataset.</dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700546<dt><span class="strong">Throws:</span></dt>
547<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>
548</li>
549</ul>
Andrew Brown6859f772015-05-11 14:26:53 -0700550<a name="getStrategyList(net.named_data.jndn.Face)">
551<!-- -->
552</a>
553<ul class="blockList">
554<li class="blockList">
555<h4>getStrategyList</h4>
556<pre>public static&nbsp;<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>&lt;<a href="../../../../com/intel/jndn/management/types/StrategyChoice.html" title="class in com.intel.jndn.management.types">StrategyChoice</a>&gt;&nbsp;getStrategyList(net.named_data.jndn.Face&nbsp;forwarder)
557 throws <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></pre>
558<div class="block">Retrieve the list of strategy choice entries from the NFD; calls
559 /localhost/nfd/rib/list which requires a local Face (all non-local packets
560 are dropped).</div>
561<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd>
562<dt><span class="strong">Returns:</span></dt><dd>a list of strategy choice entries, i.e. routes, see
563 http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice.</dd>
564<dt><span class="strong">Throws:</span></dt>
565<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>
566</li>
567</ul>
Andrew Brown3a3cd4e2015-04-13 09:44:12 -0700568<a name="getKeyLocator(net.named_data.jndn.Face)">
569<!-- -->
570</a>
571<ul class="blockList">
572<li class="blockList">
573<h4>getKeyLocator</h4>
574<pre>public static&nbsp;net.named_data.jndn.KeyLocator&nbsp;getKeyLocator(net.named_data.jndn.Face&nbsp;forwarder)
575 throws <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a>,
576 <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>
577<div class="block">Retrieve the <code>KeyLocator</code> for an NFD.</div>
578<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost <code>Face</code></dd>
579<dt><span class="strong">Returns:</span></dt><dd>the <code>KeyLocator</code> of the NFD's key</dd>
580<dt><span class="strong">Throws:</span></dt>
581<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>
582<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>
583</li>
584</ul>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700585<a name="addNextHop(net.named_data.jndn.Face, int, net.named_data.jndn.Name)">
586<!-- -->
587</a>
588<ul class="blockList">
589<li class="blockList">
590<h4>addNextHop</h4>
591<pre>public static&nbsp;void&nbsp;addNextHop(net.named_data.jndn.Face&nbsp;forwarder,
592 int&nbsp;faceId,
593 net.named_data.jndn.Name&nbsp;prefix)
594 throws <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></pre>
595<div class="block">Helper method to register a new face on the forwarder; as mentioned at
Andrew Brown7969d392015-03-25 12:08:09 -0700596 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>,
597 this is more for debugging; use 'register' instead</div>
598<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>faceId</code> - </dd><dd><code>prefix</code> - </dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700599<dt><span class="strong">Throws:</span></dt>
600<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>
601</li>
602</ul>
603<a name="createFace(net.named_data.jndn.Face, java.lang.String)">
604<!-- -->
605</a>
606<ul class="blockList">
607<li class="blockList">
608<h4>createFace</h4>
609<pre>public static&nbsp;int&nbsp;createFace(net.named_data.jndn.Face&nbsp;forwarder,
610 <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>&nbsp;uri)
611 throws <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></pre>
612<div class="block">Create a new face on the given forwarder. Ensure the forwarding face is on
613 the local machine (management requests are to /localhost/...) and that
614 command signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700615<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>uri</code> - </dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700616<dt><span class="strong">Returns:</span></dt><dd></dd>
617<dt><span class="strong">Throws:</span></dt>
618<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>
619</li>
620</ul>
621<a name="destroyFace(net.named_data.jndn.Face, int)">
622<!-- -->
623</a>
624<ul class="blockList">
625<li class="blockList">
626<h4>destroyFace</h4>
627<pre>public static&nbsp;void&nbsp;destroyFace(net.named_data.jndn.Face&nbsp;forwarder,
628 int&nbsp;faceId)
629 throws <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></pre>
630<div class="block">Destroy a face on given forwarder. Ensure the forwarding face is on the
631 local machine (management requests are to /localhost/...) and that command
632 signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700633<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>faceId</code> - </dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700634<dt><span class="strong">Throws:</span></dt>
635<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>
636</li>
637</ul>
638<a name="enableLocalControlHeader(net.named_data.jndn.Face, com.intel.jndn.management.types.LocalControlHeader)">
639<!-- -->
640</a>
641<ul class="blockList">
642<li class="blockList">
643<h4>enableLocalControlHeader</h4>
644<pre>public static&nbsp;void&nbsp;enableLocalControlHeader(net.named_data.jndn.Face&nbsp;forwarder,
645 <a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a>&nbsp;header)
646 throws <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></pre>
647<div class="block">Enable a local control feature on the given forwarder. See
Andrew Brown7969d392015-03-25 12:08:09 -0700648 <a href="http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Enable-a-LocalControlHeader-feature">http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Enable-a-LocalControlHeader-feature</a></div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700649<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>header</code> - </dd>
650<dt><span class="strong">Throws:</span></dt>
651<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>
652</li>
653</ul>
654<a name="disableLocalControlHeader(net.named_data.jndn.Face, com.intel.jndn.management.types.LocalControlHeader)">
655<!-- -->
656</a>
657<ul class="blockList">
658<li class="blockList">
659<h4>disableLocalControlHeader</h4>
660<pre>public static&nbsp;void&nbsp;disableLocalControlHeader(net.named_data.jndn.Face&nbsp;forwarder,
661 <a href="../../../../com/intel/jndn/management/types/LocalControlHeader.html" title="enum in com.intel.jndn.management.types">LocalControlHeader</a>&nbsp;header)
662 throws <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></pre>
663<div class="block">Disable a local control feature on the given forwarder. See
Andrew Brown7969d392015-03-25 12:08:09 -0700664 <a href="http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Disable-a-LocalControlHeader-feature">http://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Disable-a-LocalControlHeader-feature</a></div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700665<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>header</code> - </dd>
666<dt><span class="strong">Throws:</span></dt>
667<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>
668</li>
669</ul>
670<a name="register(net.named_data.jndn.Face, net.named_data.jndn.ControlParameters)">
671<!-- -->
672</a>
673<ul class="blockList">
674<li class="blockList">
675<h4>register</h4>
676<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;forwarder,
677 net.named_data.jndn.ControlParameters&nbsp;controlParameters)
678 throws <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></pre>
679<div class="block">Register a route on the forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700680 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
681 for command-line usage and
682 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
683 for protocol documentation. Ensure the forwarding face is on the local
684 machine (management requests are to /localhost/...) and that command
685 signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
686<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>controlParameters</code> - </dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700687<dt><span class="strong">Throws:</span></dt>
688<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>
689</li>
690</ul>
691<a name="register(net.named_data.jndn.Face, java.lang.String, net.named_data.jndn.Name, int)">
692<!-- -->
693</a>
694<ul class="blockList">
695<li class="blockList">
696<h4>register</h4>
697<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;forwarder,
698 <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>&nbsp;uri,
699 net.named_data.jndn.Name&nbsp;route,
700 int&nbsp;cost)
701 throws <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></pre>
702<div class="block">Register a route on a forwarder; this will create a new face on the
703 forwarder to the given URI/route pair. See register(Face,
704 ControlParameters) for more details documentation.</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700705<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>uri</code> - </dd><dd><code>cost</code> - </dd><dd><code>route</code> - </dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700706<dt><span class="strong">Throws:</span></dt>
707<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>
708</li>
709</ul>
710<a name="register(net.named_data.jndn.Face, int, net.named_data.jndn.Name, int)">
711<!-- -->
712</a>
713<ul class="blockList">
714<li class="blockList">
715<h4>register</h4>
716<pre>public static&nbsp;void&nbsp;register(net.named_data.jndn.Face&nbsp;forwarder,
717 int&nbsp;faceId,
718 net.named_data.jndn.Name&nbsp;route,
719 int&nbsp;cost)
720 throws <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></pre>
721<div class="block">Register a route on a forwarder; this will not create a new face since it
722 is provided a faceId. See register(Face, ControlParameters) for full
723 documentation</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700724<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>faceId</code> - </dd><dd><code>route</code> - </dd><dd><code>cost</code> - </dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700725<dt><span class="strong">Throws:</span></dt>
726<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>
727</li>
728</ul>
729<a name="unregister(net.named_data.jndn.Face, net.named_data.jndn.ControlParameters)">
730<!-- -->
731</a>
732<ul class="blockList">
733<li class="blockList">
734<h4>unregister</h4>
735<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
736 net.named_data.jndn.ControlParameters&nbsp;controlParameters)
737 throws <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></pre>
738<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700739 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
740 for command-line usage and
741 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
742 for protocol documentation. Ensure the forwarding face is on the local
743 machine (management requests are to /localhost/...) and that command
744 signing has been set up (e.g. forwarder.setCommandSigningInfo()</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700745<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>controlParameters</code> - </dd>
746<dt><span class="strong">Throws:</span></dt>
747<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>
748</li>
749</ul>
750<a name="unregister(net.named_data.jndn.Face, net.named_data.jndn.Name)">
751<!-- -->
752</a>
753<ul class="blockList">
754<li class="blockList">
755<h4>unregister</h4>
756<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
757 net.named_data.jndn.Name&nbsp;route)
758 throws <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></pre>
759<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700760 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
761 for command-line usage and
762 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
763 for protocol documentation. Ensure the forwarding face is on the local
764 machine (management requests are to /localhost/...) and that command
765 signing has been set up (e.g. forwarder.setCommandSigningInfo()</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700766<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>route</code> - </dd>
767<dt><span class="strong">Throws:</span></dt>
768<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>
769</li>
770</ul>
771<a name="unregister(net.named_data.jndn.Face, net.named_data.jndn.Name, int)">
772<!-- -->
773</a>
774<ul class="blockList">
775<li class="blockList">
776<h4>unregister</h4>
777<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
778 net.named_data.jndn.Name&nbsp;route,
779 int&nbsp;faceId)
780 throws <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></pre>
781<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700782 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
783 for command-line usage and
784 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
785 for protocol documentation. Ensure the forwarding face is on the local
786 machine (management requests are to /localhost/...) and that command
787 signing has been set up (e.g. forwarder.setCommandSigningInfo()</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700788<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>route</code> - </dd><dd><code>faceId</code> - </dd>
789<dt><span class="strong">Throws:</span></dt>
790<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>
791</li>
792</ul>
793<a name="unregister(net.named_data.jndn.Face, net.named_data.jndn.Name, java.lang.String)">
794<!-- -->
795</a>
796<ul class="blockList">
797<li class="blockList">
798<h4>unregister</h4>
799<pre>public static&nbsp;void&nbsp;unregister(net.named_data.jndn.Face&nbsp;forwarder,
800 net.named_data.jndn.Name&nbsp;route,
801 <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>&nbsp;uri)
802 throws <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></pre>
803<div class="block">Unregister a route on a forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700804 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
805 for command-line usage and
806 <a href="http://redmine.named-data.net/projects/nfd/wiki/RibMgmt">http://redmine.named-data.net/projects/nfd/wiki/RibMgmt</a>
807 for protocol documentation. Ensure the forwarding face is on the local
808 machine (management requests are to /localhost/...) and that command
809 signing has been set up (e.g. forwarder.setCommandSigningInfo()</div>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700810<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - </dd><dd><code>route</code> - </dd><dd><code>uri</code> - </dd>
811<dt><span class="strong">Throws:</span></dt>
812<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>
813</li>
814</ul>
815<a name="setStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name, net.named_data.jndn.Name)">
816<!-- -->
817</a>
818<ul class="blockList">
819<li class="blockList">
820<h4>setStrategy</h4>
821<pre>public static&nbsp;void&nbsp;setStrategy(net.named_data.jndn.Face&nbsp;forwarder,
822 net.named_data.jndn.Name&nbsp;prefix,
823 net.named_data.jndn.Name&nbsp;strategy)
824 throws <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></pre>
825<div class="block">Set a strategy on the forwarder; see
Andrew Brown7969d392015-03-25 12:08:09 -0700826 <a href="http://named-data.net/doc/NFD/current/manpages/nfdc.html">http://named-data.net/doc/NFD/current/manpages/nfdc.html</a>
827 for command-line usage and
828 <a href="http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice">http://redmine.named-data.net/projects/nfd/wiki/StrategyChoice</a>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700829 for protocol documentation. Ensure the forwarding face is on the local
830 machine (management requests are to /localhost/...) and that command
831 signing has been set up (e.g. forwarder.setCommandSigningInfo()).</div>
Andrew Brown6859f772015-05-11 14:26:53 -0700832<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face</dd><dd><code>prefix</code> - the <code>Name</code> prefix</dd><dd><code>strategy</code> - the <code>Name</code> of the strategy to set, e.g.
833 /localhost/nfd/strategy/broadcast</dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700834<dt><span class="strong">Throws:</span></dt>
Andrew Brown6859f772015-05-11 14:26:53 -0700835<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> - if the command fails</dd></dl>
836</li>
837</ul>
838<a name="unsetStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name)">
839<!-- -->
840</a>
841<ul class="blockList">
842<li class="blockList">
843<h4>unsetStrategy</h4>
844<pre>public static&nbsp;void&nbsp;unsetStrategy(net.named_data.jndn.Face&nbsp;forwarder,
845 net.named_data.jndn.Name&nbsp;prefix)
846 throws <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></pre>
847<div class="block">Set a strategy on the forwarder; see
848 <a href="../../../../com/intel/jndn/management/NFD.html#setStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name, net.named_data.jndn.Name)"><code>setStrategy(net.named_data.jndn.Face, net.named_data.jndn.Name, net.named_data.jndn.Name)</code></a>
849 for more information. Ensure the forwarding face is on the local machine
850 (management requests are to /localhost/...) and that command signing has
851 been set up (e.g. forwarder.setCommandSigningInfo()).</div>
852<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost <code>Face</code></dd><dd><code>prefix</code> - the <code>Name</code> prefix</dd>
853<dt><span class="strong">Throws:</span></dt>
854<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> - if the command fails</dd></dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700855</li>
856</ul>
857<a name="retrieveDataSet(net.named_data.jndn.Face, net.named_data.jndn.Name)">
858<!-- -->
859</a>
860<ul class="blockList">
861<li class="blockList">
862<h4>retrieveDataSet</h4>
863<pre>public static&nbsp;net.named_data.jndn.Data&nbsp;retrieveDataSet(net.named_data.jndn.Face&nbsp;forwarder,
864 net.named_data.jndn.Name&nbsp;datasetName)
865 throws <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>,
866 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
867<div class="block">Build an interest to retrieve a segmented data set from the NFD; for
868 details on the DataSet, see
Andrew Brown7969d392015-03-25 12:08:09 -0700869 <a href="http://redmine.named-data.net/projects/nfd/wiki/StatusDataset">http://redmine.named-data.net/projects/nfd/wiki/StatusDataset</a></div>
Andrew Brown3a3cd4e2015-04-13 09:44:12 -0700870<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>
871<dt><span class="strong">Returns:</span></dt><dd>the re-assembled <code>Data</code> packet</dd>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700872<dt><span class="strong">Throws:</span></dt>
Andrew Brown3a3cd4e2015-04-13 09:44:12 -0700873<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>
874<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>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700875</li>
876</ul>
877<a name="sendCommand(net.named_data.jndn.Face, net.named_data.jndn.Interest)">
878<!-- -->
879</a>
880<ul class="blockListLast">
881<li class="blockList">
882<h4>sendCommand</h4>
883<pre>public static&nbsp;<a href="../../../../com/intel/jndn/management/types/ControlResponse.html" title="class in com.intel.jndn.management.types">ControlResponse</a>&nbsp;sendCommand(net.named_data.jndn.Face&nbsp;forwarder,
884 net.named_data.jndn.Interest&nbsp;interest)
885 throws <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>,
886 net.named_data.jndn.encoding.EncodingException,
887 <a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
888<div class="block">Send an interest as a command to the forwarder; this method will convert
889 the interest to a command interest and block until a response is received
890 from the forwarder. Ensure the forwarding face is on the local machine
891 (management requests are to /localhost/...) and that command signing has
892 been set up (e.g. forwarder.setCommandSigningInfo()).</div>
Andrew Brown7969d392015-03-25 12:08:09 -0700893<dl><dt><span class="strong">Parameters:</span></dt><dd><code>forwarder</code> - only a localhost Face, command signing info must be set</dd><dd><code>interest</code> - As described at
894 <a href="http://redmine.named-data.net/projects/nfd/wiki/ControlCommand,">http://redmine.named-data.net/projects/nfd/wiki/ControlCommand,</a>
895 the requested interest must have encoded ControlParameters appended to the
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700896 interest name</dd>
Andrew Brown3a3cd4e2015-04-13 09:44:12 -0700897<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>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700898<dt><span class="strong">Throws:</span></dt>
899<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>
900<dd><code>net.named_data.jndn.encoding.EncodingException</code></dd>
901<dd><code><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code></dd></dl>
902</li>
903</ul>
904</li>
905</ul>
906</li>
907</ul>
908</div>
909</div>
910<!-- ========= END OF CLASS DATA ========= -->
911<!-- ======= START OF BOTTOM NAVBAR ====== -->
912<div class="bottomNav"><a name="navbar_bottom">
913<!-- -->
914</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
915<!-- -->
916</a>
917<ul class="navList" title="Navigation">
918<li><a href="../../../../overview-summary.html">Overview</a></li>
919<li><a href="package-summary.html">Package</a></li>
920<li class="navBarCell1Rev">Class</li>
921<li><a href="class-use/NFD.html">Use</a></li>
922<li><a href="package-tree.html">Tree</a></li>
923<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
924<li><a href="../../../../index-all.html">Index</a></li>
925<li><a href="../../../../help-doc.html">Help</a></li>
926</ul>
927</div>
928<div class="subNav">
929<ul class="navList">
930<li><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management"><span class="strong">Prev Class</span></a></li>
Andrew Brown6859f772015-05-11 14:26:53 -0700931<li><a href="../../../../com/intel/jndn/management/Strategies.html" title="class in com.intel.jndn.management"><span class="strong">Next Class</span></a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700932</ul>
933<ul class="navList">
934<li><a href="../../../../index.html?com/intel/jndn/management/NFD.html" target="_top">Frames</a></li>
935<li><a href="NFD.html" target="_top">No Frames</a></li>
936</ul>
937<ul class="navList" id="allclasses_navbar_bottom">
938<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
939</ul>
940<div>
941<script type="text/javascript"><!--
942 allClassesLink = document.getElementById("allclasses_navbar_bottom");
943 if(window==top) {
944 allClassesLink.style.display = "block";
945 }
946 else {
947 allClassesLink.style.display = "none";
948 }
949 //-->
950</script>
951</div>
952<div>
953<ul class="subNavList">
954<li>Summary:&nbsp;</li>
955<li>Nested&nbsp;|&nbsp;</li>
956<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
957<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
958<li><a href="#method_summary">Method</a></li>
959</ul>
960<ul class="subNavList">
961<li>Detail:&nbsp;</li>
962<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
963<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
964<li><a href="#method_detail">Method</a></li>
965</ul>
966</div>
967<a name="skip-navbar_bottom">
968<!-- -->
969</a></div>
970<!-- ======== END OF BOTTOM NAVBAR ======= -->
971<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
972</body>
973</html>