| Andrew Brown | 352e019 | 2015-02-20 17:41:45 -0800 | [diff] [blame] | 1 | # jndn-management |
| 2 | |
| Andrew Brown | 113d5f9 | 2015-02-20 17:46:28 -0800 | [diff] [blame] | 3 | This project consists of tools for managing an NDN forwarding daemon (NFD). It relies on the [NDN Protocol](https://named-data.net) and its associated [client library](https://github.com/named-data/jndn). It implements the NFD management specification outlined at http://redmine.named-data.net/projects/nfd/wiki/Management. Please note that this library does not yet implement all of the commands in the management specification. |
| Andrew Brown | 352e019 | 2015-02-20 17:41:45 -0800 | [diff] [blame] | 4 | |
| 5 | ## Install |
| 6 | With Maven, add the following to your POM: |
| 7 | ``` |
| 8 | <dependency> |
| 9 | <groupId>com.intel.jndn.management</groupId> |
| andrewsbrown | 7217285 | 2015-02-23 10:36:07 -0800 | [diff] [blame] | 10 | <artifactId>jndn-management</artifactId> |
| 11 | <version>RELEASE</version> <!-- or a specific version --> |
| Andrew Brown | 352e019 | 2015-02-20 17:41:45 -0800 | [diff] [blame] | 12 | </dependency> |
| 13 | ``` |
| 14 | |
| 15 | ## Use |
| 16 | With a Face that has command signing information set, call any of the following static methods: |
| 17 | - __NFD.pingLocal(Face forwarder)__: ping a local NFD with /localhost/nfd to verify if it exists. |
| andrewsbrown | ff02da3 | 2015-03-25 10:52:12 -0700 | [diff] [blame] | 18 | - __NFD.getForwarderStatus(Face forwarder)__: retrieve the forwarder status information. |
| Andrew Brown | 352e019 | 2015-02-20 17:41:45 -0800 | [diff] [blame] | 19 | - __NFD.getFaceList(Face forwarder)__: retrieve all connected faces. |
| 20 | - __NFD.getFibList(Face forwarder)__: retrieve all forwarding entries in the Forwarding Information Base (FIB). |
| 21 | - __NFD.getRibList(Face forwarder)__: retrieve all routing entries in the Routing Information Base (RIB). |
| 22 | - __NFD.createFace(Face forwarder, String uri)__: create a new face on the NFD opened to the given URI. |
| Andrew Brown | d5f6f69 | 2015-02-20 17:43:05 -0800 | [diff] [blame] | 23 | - __NFD.register(Face forwarder, ...)__: includes several similar methods for registering a new route on the NFD. |
| 24 | - __NFD.unregister(Face forwarder, Name route)__: unregister a route by name. |
| Andrew Brown | 6e7471e | 2015-02-20 17:44:36 -0800 | [diff] [blame] | 25 | - __NFD.setStrategy(Face forwarder, Name prefix, Name strategy)__: set the forwarding strategy for the given prefix. |
| Andrew Brown | d5f6f69 | 2015-02-20 17:43:05 -0800 | [diff] [blame] | 26 | |
| andrewsbrown | 6b342ce | 2015-03-24 09:46:47 -0700 | [diff] [blame] | 27 | See [full Javadoc documentation](http://01org.github.io/jndn-management/index.html) |
| 28 | |
| Andrew Brown | d5f6f69 | 2015-02-20 17:43:05 -0800 | [diff] [blame] | 29 | ## License |
| andrewsbrown | 7e6b9e8 | 2015-03-03 16:11:11 -0800 | [diff] [blame] | 30 | Copyright © 2015, Intel Corporation. |
| 31 | |
| 32 | This program is free software; you can redistribute it and/or modify it under the terms and conditions of the GNU Lesser General Public License, version 3, as published by the Free Software Foundation. |
| 33 | |
| 34 | This program is distributed in the hope it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU Lesser General Public License](https://github.com/01org/jndn-management/blob/master/LICENSE) for more details. |