| Package | Description | 
|---|---|
| com.tailf.ned | 
 Network Equipment Drivers package 
 | 
| Modifier and Type | Method and Description | 
|---|---|
abstract void | 
NedGenericBase.abort(NedWorker w,
     NedEditOp[] ops)
Is invoked by NCS to abort the current transaction and
 bring the configuration back to the state before the
 previous  
prepare()
 invocation. | 
abstract void | 
NedCliBase.abort(NedWorker w,
     String data)
Is invoked by NCS to abort the configuration to the state before the
 previous prepare() invocation. 
 | 
void | 
NedCliBaseTemplate.abort(NedWorker worker,
     String data)  | 
void | 
NedCliBaseTemplate.applyConfig(NedWorker worker,
           int cmd,
           String data)  | 
void | 
NedCliBaseTemplate.close(NedWorker worker)  | 
abstract void | 
NedConnectionBase.close(NedWorker w)
This method is invoked when the connection is terminated. 
 | 
void | 
NedCliBaseTemplate.command(NedWorker worker,
       String cmdname,
       ConfXMLParam[] p)  | 
abstract void | 
NedConnectionBase.command(NedWorker w,
       String cmdName,
       ConfXMLParam[] params)
This is for any optional commands on the device that are
 not part of the yang files config data, but is modeled as
 tailf:actions or rpcs in the device yang files. 
 | 
void | 
NedCliBaseTemplate.commit(NedWorker worker,
      int timeout)  | 
abstract void | 
NedConnectionBase.commit(NedWorker w,
      int timeout)
This indicates that the current set of operations should be
 committed to the running configuration. 
 | 
static SSHClient | 
SSHClient.createClient(NedWorker worker,
            NedConnectionBase ned)
SSHClient default factory method. 
 | 
void | 
NedConnectionBase.createSubscription(NedWorker w,
                  String stream,
                  String startTime,
                  String filter,
                  int filterType)
This method is invoked to create a notification subscription. 
 | 
default NedExpectResult | 
SSHClient.CliSession.expect(Pattern[] p,
      boolean include,
      int timeout,
      boolean full,
      NedWorker worker)  | 
NedExpectResult | 
SSHSession.expect(Pattern[] p,
      boolean include,
      int timeout,
      boolean full,
      NedWorker worker)  | 
NedExpectResult | 
TelnetSession.expect(Pattern[] p,
      boolean include,
      int timeout,
      boolean full,
      NedWorker worker)  | 
NedExpectResult | 
CliSession.expect(Pattern[] p,
      boolean Include,
      int timeout,
      NedWorker worker)  | 
default NedExpectResult | 
SSHClient.CliSession.expect(Pattern[] p,
      boolean include,
      int timeout,
      NedWorker worker)  | 
NedExpectResult | 
SSHSession.expect(Pattern[] p,
      boolean include,
      int timeout,
      NedWorker worker)  | 
NedExpectResult | 
TelnetSession.expect(Pattern[] p,
      boolean include,
      int timeout,
      NedWorker worker)  | 
NedExpectResult | 
CliSession.expect(Pattern[] p,
      NedWorker worker)  | 
default NedExpectResult | 
SSHClient.CliSession.expect(Pattern[] p,
      NedWorker worker)  | 
NedExpectResult | 
SSHSession.expect(Pattern[] p,
      NedWorker worker)  | 
NedExpectResult | 
TelnetSession.expect(Pattern[] p,
      NedWorker worker)  | 
default String | 
SSHClient.CliSession.expect(Pattern p,
      boolean include,
      int timeout,
      NedWorker worker)  | 
String | 
SSHSession.expect(Pattern p,
      boolean include,
      int timeout,
      NedWorker worker)  | 
String | 
TelnetSession.expect(Pattern p,
      boolean include,
      int timeout,
      NedWorker worker)  | 
String | 
CliSession.expect(Pattern p,
      NedWorker worker)  | 
default String | 
SSHClient.CliSession.expect(Pattern p,
      NedWorker worker)  | 
String | 
SSHSession.expect(Pattern p,
      NedWorker worker)  | 
String | 
TelnetSession.expect(Pattern p,
      NedWorker worker)  | 
NedExpectResult | 
CliSession.expect(String[] Str,
      boolean Include,
      int timeout,
      NedWorker worker)  | 
default NedExpectResult | 
SSHClient.CliSession.expect(String[] str,
      boolean include,
      int timeout,
      NedWorker worker)  | 
NedExpectResult | 
SSHSession.expect(String[] Str,
      boolean include,
      int timeout,
      NedWorker worker)  | 
NedExpectResult | 
TelnetSession.expect(String[] Str,
      boolean include,
      int timeout,
      NedWorker worker)  | 
NedExpectResult | 
CliSession.expect(String[] Str,
      NedWorker worker)  | 
default NedExpectResult | 
SSHClient.CliSession.expect(String[] str,
      NedWorker worker)  | 
NedExpectResult | 
SSHSession.expect(String[] Str,
      NedWorker worker)  | 
NedExpectResult | 
TelnetSession.expect(String[] Str,
      NedWorker worker)  | 
String | 
CliSession.expect(String Str,
      boolean Include,
      boolean Full,
      int timeout,
      NedWorker worker)  | 
default String | 
SSHClient.CliSession.expect(String str,
      boolean include,
      boolean full,
      int timeout,
      NedWorker worker)  | 
String | 
SSHSession.expect(String str,
      boolean include,
      boolean full,
      int timeout,
      NedWorker worker)  | 
String | 
TelnetSession.expect(String str,
      boolean include,
      boolean full,
      int timeout,
      NedWorker worker)  | 
default String | 
SSHClient.CliSession.expect(String str,
      boolean include,
      int timeout,
      NedWorker worker)  | 
String | 
SSHSession.expect(String Str,
      boolean Include,
      int timeout,
      NedWorker worker)  | 
String | 
TelnetSession.expect(String Str,
      boolean Include,
      int timeout,
      NedWorker worker)  | 
String | 
CliSession.expect(String Str,
      int timeout,
      NedWorker worker)  | 
default String | 
SSHClient.CliSession.expect(String str,
      int timeout,
      NedWorker worker)  | 
String | 
SSHSession.expect(String Str,
      int timeout,
      NedWorker worker)  | 
String | 
TelnetSession.expect(String Str,
      int timeout,
      NedWorker worker)  | 
String | 
CliSession.expect(String Str,
      NedWorker worker)  | 
default String | 
SSHClient.CliSession.expect(String str,
      NedWorker worker)  | 
String | 
SSHSession.expect(String Str,
      NedWorker worker)  | 
String | 
TelnetSession.expect(String Str,
      NedWorker worker)  | 
void | 
NedCliBaseTemplate.getTransId(NedWorker worker)  | 
abstract void | 
NedConnectionBase.getTransId(NedWorker w)
When this method is invoked the NED should produce a transaction
 id that must be changed if any changes has been made to the
 configuration since the last time the transaction id was requested. 
 | 
void | 
NedCliBaseTemplate.handshake(NedWorker worker)  | 
void | 
NedConnectionBase.initialize(NedWorker w)
Used for initializing an transaction. 
 | 
NedCliBase | 
NedCliBase.initNoConnect(String device_id,
             NedMux mux,
             NedWorker worker)
Make a new instance of Ned object without establishing a connection
 towards the device. 
 | 
NedGenericBase | 
NedGenericBase.initNoConnect(String deviceId,
             NedMux mux,
             NedWorker w)
Make a new instance of Ned object without establishing a connection
 towards the device. 
 | 
boolean | 
NedConnectionBase.isAlive(NedWorker w)
This method is invoked to check if a connection is still
 alive. 
 | 
boolean | 
NedConnectionBase.keepAlive(NedWorker w)
This method is invoked periodically to keep an connection
 alive. 
 | 
abstract NedGenericBase | 
NedGenericBase.newConnection(String deviceId,
             InetAddress ip,
             int port,
             String luser,
             boolean trace,
             int connectTimeout,
             int readTimeout,
             int writeTimeout,
             NedMux mux,
             NedWorker worker)
Establish a new connection to a device and send response to
 NCS with information about the device using the method
 setConnectionData()
 A new instance representing the new connection should
 be returned. 
 | 
abstract NedCliBase | 
NedCliBase.newConnection(String deviceId,
             InetAddress ip,
             int port,
             String proto,
             String ruser,
             String pass,
             String secpass,
             String publicKeyDir,
             boolean trace,
             int connectTimeout,
             int readTimeout,
             int writeTimeout,
             NedMux mux,
             NedWorker w)
Establish a new connection to a device and send response to
 NCS with information about the device. 
 | 
NedCliBase | 
NedCliBaseTemplate.newConnection(String device_id,
             InetAddress ip,
             int port,
             String proto,
             String ruser,
             String pass,
             String secpass,
             String publicKeyDir,
             boolean trace,
             int connectTimeout,
             int readTimeout,
             int writeTimeout,
             NedMux mux,
             NedWorker worker)  | 
void | 
NedCliBaseTemplate.persist(NedWorker worker)  | 
abstract void | 
NedConnectionBase.persist(NedWorker w)
This method is invoked when the currently committed change set
 should be made permanent. 
 | 
abstract void | 
NedGenericBase.prepare(NedWorker w,
       NedEditOp[] ops)
Is invoked by NCS to take the configuration to a new state. 
 | 
abstract void | 
NedCliBase.prepare(NedWorker w,
       String data)
Is invoked by NCS to take the configuration to a new state. 
 | 
void | 
NedCliBaseTemplate.prepare(NedWorker worker,
       String data)  | 
void | 
NedGenericBase.prepareDry(NedWorker w,
          NedEditOp[] ops)
Is invoked by NCS to ask the NED what actions it would take towards
 the device if it would do a prepare. 
 | 
abstract void | 
NedCliBase.prepareDry(NedWorker w,
          String data)
Is invoked by NCS to tell the NED what actions it should take towards
 the device if it should do a prepare. 
 | 
void | 
NedCliBaseTemplate.prepareDry(NedWorker worker,
          String data)  | 
void | 
NedCliBaseTemplate.reconnect(NedWorker worker)  | 
abstract void | 
NedConnectionBase.reconnect(NedWorker w)
Used for resuming a connection found in the connection pool. 
 | 
abstract void | 
NedGenericBase.revert(NedWorker w,
      NedEditOp[] ops)
Is invoked by NCS to undo the changes introduced in the last commit
 operation (communicated to the NED in the prepare method invocation). 
 | 
abstract void | 
NedCliBase.revert(NedWorker w,
      String data)
Is invoked by NCS to undo the changes introduced in the last commit
 operation (communicated to the NED in the prepare method invocation). 
 | 
void | 
NedCliBaseTemplate.revert(NedWorker worker,
      String data)  | 
void | 
NedCliBaseTemplate.setupSSH(NedWorker worker)  | 
void | 
NedCliBaseTemplate.setupTelnet(NedWorker worker)  | 
abstract void | 
NedGenericBase.show(NedWorker w,
    int th)
Read parts of the configuration and applies it to the transaction
 provided in
 the method invocation. 
 | 
abstract void | 
NedCliBase.show(NedWorker w,
    String toptag)
Extract parts of the configuration and send it to NCS. 
 | 
void | 
NedCliBaseTemplate.show(NedWorker worker,
    String toptag)  | 
void | 
NedGenericBase.showOffline(NedWorker w,
           int th,
           String data)
Read parts of the configuration and applies it to the
 transaction, both provided in the method invocation. 
 | 
void | 
NedCliBase.showOffline(NedWorker w,
           String toptag,
           String data)
Extract parts of the configuration and send it to NCS. 
 | 
void | 
NedCliBase.showPartial(NedWorker w,
           ConfPath[] paths)
Extract parts of the configuration and send it to NCS. 
 | 
void | 
NedCliBase.showPartial(NedWorker w,
           ConfPath[] paths,
           String[] cmdpaths)
Extract parts of the configuration and send it to NCS. 
 | 
void | 
NedGenericBase.showPartial(NedWorker w,
           int th,
           ConfPath[] paths)
Read parts of the configuration and applies it to the transaction
 provided in
 the method invocation. 
 | 
void | 
NedCliBase.showPartial(NedWorker w,
           String[] cmdpaths)
Deprecated. 
 
Use the method
  
NedCliBase.showPartial(NedWorker,ConfPath[],String[])
 instead.
 Extract parts of the configuration and send it to NCS. The response
 is sent by invoking the w.showCliResponse() method in the provided
 NedWorker. | 
void | 
NedCliBaseTemplate.showStats(NedWorker worker,
         int th,
         ConfPath path)  | 
void | 
NedConnectionBase.showStats(NedWorker w,
         int th,
         ConfPath path)
Deprecated.  
 | 
void | 
NedCliBaseTemplate.showStatsList(NedWorker worker,
             int th,
             ConfPath path)  | 
void | 
NedConnectionBase.showStatsList(NedWorker w,
             int th,
             ConfPath path)
Deprecated.  
 | 
void | 
NedConnectionBase.showStatsPath(NedWorker w,
             int th,
             ConfPath path)
When this method is invoked depending on the node type the NED should:
  * if the path points to the list node or leaf-list node without
    specifying the key, then the NED should populate the list keys. 
 | 
void | 
NedCliBaseTemplate.trace(NedWorker worker,
     String msg,
     String direction)  | 
void | 
NedConnectionBase.uninitialize(NedWorker w)
If the transaction is not completed and the NED has done initialize
 this method is called to undo the transaction preparations. 
 | 
| Constructor and Description | 
|---|
NedCliBaseTemplate(String device_id,
                  InetAddress ip,
                  int port,
                  String proto,
                  String ruser,
                  String pass,
                  String secpass,
                  boolean trace,
                  int connectTimeout,
                  int readTimeout,
                  int writeTimeout,
                  NedMux mux,
                  NedWorker worker)  | 
SSHConnection(NedWorker worker)
Deprecated.  
Constructor that uses the current NedWorker to retrieve configuration
 parameters like host, port
 and also southbound-source-address (if set) 
 | 
TelnetSession(NedWorker worker)
Constructor for Telnet session object. 
 | 
TelnetSession(NedWorker worker,
             int readTimeout,
             NedTracer tracer,
             NedConnectionBase conn)
Constructor with an extra argument for a readTimeout timer. 
 | 
TelnetSession(NedWorker worker,
             NedTracer tracer,
             NedConnectionBase conn)
Constructor for Telnet session object. 
 | 
TelnetSession(NedWorker worker,
             String username,
             int readTimeout,
             NedTracer tracer,
             NedConnectionBase conn)
Constructor with extra user name argument. 
 |