NETCONF4J

A simple, from scratch implementation of the Netconf protocol. We are currently using this library at OpenNaaS and quite happy with its feature set. See roadmap for more details and things to come.

Contributors are welcomed!

Features

Low, atomic dependencies (commons-logging, commons-configuration, commons-io, junit, ganymed-ssh2).
OSGi ready.
Test coverage.
Support for both sync and async calls.
Maven based, easy to build & contribute.
Efficient (SAX based) parsing.
Transport abstraction (currently, SSH and Virtual).
This is an RPC only implementation. Configuration data passed to user untouched.

Roadmap

Fully support base Netconf (RFC4741) with all its capabilities.
Support for events (RFC5277) and SOAP transport (RFC4743).
Add vendor (i.e. Juniper) specific capabilities utils project.

Usage

Check out the code using normal github procedure.

Build as usual. Both maven2 and maven3 should work:

cd netconf-read-only/
mvn install

Alternatively, if any test fail but you want to build anyway, try:

cd netconf-read-only/
mvn install -DskipTests

The produced jar can now be found in the target directory and at your .m2 local repo.

For importing the produced jar in your maven project use:

<dependency>
		<groupId>net.i2cat.netconf</groupId>
		<artifactId>netconf4j</artifactId>
		<version>0.0.2</version>
</dependency>

From java, you can open a netconf session with:

sessionContext = new SessionContext();
sessionContext.setURI(new URI(System.getProperty("net.i2cat.netconf.test.transportUri", "mock://foo:bar@foo:22/okServer")));
session = new NetconfSession(sessionContext);
session.connect();

For the library interface check:

INetconfSession here.
SessionContext here.
The RPC objects here.

Some usage examples can be found at:

The JUnit tests inside the library here.
The OpenNaaS protocol bundle here.

Origin

This project is a spin-off of the Manticore 2 and Mantychore FP7 projects. See http://www.mantychore.eu/about/ for further details.

Mantychore FP7 project is funded by the European Commission.

Contact