org.onosproject.netconf.ctl

Class DefaultNetconfDevice

java.lang.Object

org.onosproject.netconf.ctl.DefaultNetconfDevice

All Implemented Interfaces:

NetconfDevice

public class DefaultNetconfDevice
extends Object
implements NetconfDevice

Default implementation of a NETCONF device.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DefaultNetconfDevice.SshNetconfSessionFactory

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	log
protected NetconfSessionFactory	sessionFactory

Constructor Summary

Constructors

Constructor and Description
DefaultNetconfDevice(NetconfDeviceInfo deviceInfo) Creates a new default NETCONF device with the information provided.

Method Summary

Modifier and Type	Method and Description
void	disconnect() Ensures that all sessions are closed.
NetconfDeviceInfo	getDeviceInfo() return all the info associated with this device.
NetconfSession	getSession() Returns a NETCONF session context for this device.
boolean	isActive() Returns whether a device is a NETCONF device with a capabilities list and is accessible.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

public static final org.slf4j.Logger log

sessionFactory

protected NetconfSessionFactory sessionFactory

Constructor Detail

DefaultNetconfDevice

public DefaultNetconfDevice(NetconfDeviceInfo deviceInfo)
                     throws NetconfException

Creates a new default NETCONF device with the information provided. The device gets created only if no exception is thrwn while connecting to it and establishing the NETCONF session.

Parameters:

deviceInfo - information about the device to be created.

Throws:

NetconfException - if there are problems in creating or establishing the underlying NETCONF connection and session.

Method Detail

isActive

public boolean isActive()

Description copied from interface: NetconfDevice

Returns whether a device is a NETCONF device with a capabilities list and is accessible.

Specified by:

isActive in interface NetconfDevice

Returns:

true if device is accessible, false otherwise

getSession

public NetconfSession getSession()

Description copied from interface: NetconfDevice

Returns a NETCONF session context for this device.

Specified by:

getSession in interface NetconfDevice

Returns:

netconf session

disconnect

public void disconnect()

Description copied from interface: NetconfDevice

Ensures that all sessions are closed. A device cannot be used after disconnect is called.

Specified by:

disconnect in interface NetconfDevice

getDeviceInfo

public NetconfDeviceInfo getDeviceInfo()

Description copied from interface: NetconfDevice

return all the info associated with this device.

Specified by:

getDeviceInfo in interface NetconfDevice

Returns:

NetconfDeviceInfo