Package com.tailf.ned

Class NedCapability

Object

com.tailf.ned.NedCapability

public class NedCapability
extends Object

NedCapability is used to communicate the capabilities (supported namespace, revision, features and deviations) of a NedConnection (NedGeneric or NedCli).

Constructor Summary

Constructors

Constructor	Description
NedCapability(String uri, String module)
NedCapability(String str, String uri, String module, List<String> features, String revision, List<String> deviations)	This class mimics a capability as returned by a NETCONF agent over the NETCONF protocol.
NedCapability(String uri, String module, List<String> features, String revision, List<String> deviations)

Method Summary

Modifier and Type	Method	Description
ConfEObject	encode()
List<String>	getDeviations()
List<String>	getFeatures()
String	getModule()
String	getName()
String	getRevision()
String	getURI()
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

NedCapability

public NedCapability(String uri,
 String module)

NedCapability

public NedCapability(String str,
 String uri,
 String module,
 List<String> features,
 String revision,
 List<String> deviations)

This class mimics a capability as returned by a NETCONF agent over the NETCONF protocol. A NED needs to return an array of these after it has connected to its managed device. This returned list of Capabilities make NCS handle a NED connection in a manner similar to a NETCONF connection. The list of capabilities returned by the NED connect code needs to precisely identify the actual capabilities of the device i.e which YANG modules NCS shall use when communication with the device.

Parameters:

str - The full capability string similar to how a NETCONF agent returns. This optional parameter can be set to ""

uri - The actual capability uri. This parameter is required.

module - The name of the YANG module that implements this capability Required parameter.

features - If the modules is using the features 'feature' of YANG, which features are enabled by this device.

revision - If there exists multiple revisions of the yang module that implements this capability, which revision does this particular device run.

deviations - If the YANG feature 'deviations' are used, which deviations does this device have.

NedCapability

public NedCapability(String uri,
 String module,
 List<String> features,
 String revision,
 List<String> deviations)

Method Details

encode

public ConfEObject encode()

getName

public String getName()

getURI

public String getURI()

getModule

public String getModule()

getFeatures

public List<String> getFeatures()

getRevision

public String getRevision()

getDeviations

public List<String> getDeviations()

toString

public String toString()

Overrides:

toString in class Object