A C D E F G H I L N O P R S T U V

A

addDeviceListener(NetconfDeviceListener) - Method in interface org.onosproject.netconf.NetconfController

Adds Device Event Listener.

addDeviceOutputListener(NetconfDeviceOutputEventListener) - Method in interface org.onosproject.netconf.NetconfSession

Remove a listener from the underlying stream handler implementation.

asXml() - Method in class org.onosproject.netconf.DatastoreId

Returns datastore name as XML tag.

C

CANDIDATE - Static variable in class org.onosproject.netconf.DatastoreId

A configuration datastore that can be manipulated without impacting the device's current configuration and that can be committed to the running configuration datastore.

checkAndReestablish() - Method in interface org.onosproject.netconf.NetconfSession

Checks the state of the underlying SSH session and connection and if necessary it reestablishes it.

close() - Method in interface org.onosproject.netconf.NetconfSession

Closes the Netconf session with the device.

connectDevice(DeviceId) - Method in interface org.onosproject.netconf.NetconfController

Tries to connect to a specific NETCONF device, if the connection is succesful it creates and adds the device to the ONOS core as a NetconfDevice.

copyConfig(DatastoreId, DatastoreId) - Method in interface org.onosproject.netconf.NetconfSession

Copies the configuration between configuration datastores.

copyConfig(DatastoreId, String) - Method in interface org.onosproject.netconf.NetconfSession

Copies the new configuration, an Url or a complete configuration xml tree to the target configuration.

copyConfig(String, String) - Method in interface org.onosproject.netconf.NetconfSession

Copies the new configuration, an Url or a complete configuration xml tree to the target configuration.

copyConfig(TargetConfig, String) - Method in interface org.onosproject.netconf.NetconfSession

Deprecated.

- 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration enum parameter instead

createNetconfDevice(NetconfDeviceInfo) - Method in interface org.onosproject.netconf.NetconfDeviceFactory

Creates a new NETCONF device based on the supplied information.

createNetconfSession(NetconfDeviceInfo) - Method in interface org.onosproject.netconf.NetconfSessionFactory

Creates a new NETCONF session for the specified device.

D

datastore(String) - Static method in class org.onosproject.netconf.DatastoreId

Returns datastore identifier object.

DatastoreId - Class in org.onosproject.netconf

Identifier object to specify datastore.

deleteConfig(DatastoreId) - Method in interface org.onosproject.netconf.NetconfSession

Deletes part of the specified configuration based on the filterSchema.

deleteConfig(String) - Method in interface org.onosproject.netconf.NetconfSession

Deprecated.

- 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration enum parameter instead

deleteConfig(TargetConfig) - Method in interface org.onosproject.netconf.NetconfSession

Deprecated.

- 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration enum parameter instead

deviceAdded(DeviceId) - Method in interface org.onosproject.netconf.NetconfDeviceListener

Notifies that the device was added.

deviceRemoved(DeviceId) - Method in interface org.onosproject.netconf.NetconfDeviceListener

Notifies that the device was removed.

disconnect() - Method in interface org.onosproject.netconf.NetconfDevice

Ensures that all sessions are closed.

disconnectDevice(DeviceId, boolean) - Method in interface org.onosproject.netconf.NetconfController

Disconnects a Netconf device and removes it from the core.

doWrappedRpc(String) - Method in interface org.onosproject.netconf.NetconfSession

Executes an synchronous RPC to the server and wrap the request in RPC header.

E

editConfig(String) - Method in interface org.onosproject.netconf.NetconfSession

Retrieves part of the specified configuration based on the filterSchema.

editConfig(DatastoreId, String, String) - Method in interface org.onosproject.netconf.NetconfSession

Retrieves part of the specified configuration based on the filterSchema.

editConfig(String, String, String) - Method in interface org.onosproject.netconf.NetconfSession

Deprecated.

- 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration enum parameter instead

editConfig(TargetConfig, String, String) - Method in interface org.onosproject.netconf.NetconfSession

Deprecated.

- 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration enum parameter instead

endSubscription() - Method in interface org.onosproject.netconf.NetconfSession

Ends subscription to the device's notifications.

equals(Object) - Method in class org.onosproject.netconf.NetconfDeviceInfo

event(NetconfDeviceOutputEvent) - Method in class org.onosproject.netconf.FilteringNetconfDeviceOutputEventListener

F

FilteringNetconfDeviceOutputEventListener - Class in org.onosproject.netconf

Listener to listen for event about specific Device.

FilteringNetconfDeviceOutputEventListener(NetconfDeviceInfo) - Constructor for class org.onosproject.netconf.FilteringNetconfDeviceOutputEventListener

G

get(String) - Method in interface org.onosproject.netconf.NetconfSession

Retrieves the requested configuration, different from get-config.

get(String, String) - Method in interface org.onosproject.netconf.NetconfSession

Retrieves the requested data.

getConfig(DatastoreId) - Method in interface org.onosproject.netconf.NetconfSession

Retrieves the specified configuration.

getConfig(TargetConfig) - Method in interface org.onosproject.netconf.NetconfSession

Deprecated.

- 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration parameter instead

getConfig(String) - Method in interface org.onosproject.netconf.NetconfSession

Deprecated.

- 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration parameter instead

getConfig(DatastoreId, String) - Method in interface org.onosproject.netconf.NetconfSession

Retrieves part of the specified configuration based on the filterSchema.

getConfig(String, String) - Method in interface org.onosproject.netconf.NetconfSession

Deprecated.

- 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfig enum parameter instead

getConfig(TargetConfig, String) - Method in interface org.onosproject.netconf.NetconfSession

Deprecated.

- 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfig enum parameter instead

getDeviceCapabilitiesSet() - Method in interface org.onosproject.netconf.NetconfSession

Gets the capabilities of the remote Netconf device associated to this session.

getDeviceId() - Method in class org.onosproject.netconf.NetconfDeviceInfo

Return the DeviceId about the device containing the URI.

getDeviceInfo() - Method in interface org.onosproject.netconf.NetconfDevice

return all the info associated with this device.

getDeviceInfo() - Method in class org.onosproject.netconf.NetconfDeviceOutputEvent

Event-related device information.

getDevicesMap() - Method in interface org.onosproject.netconf.NetconfController

Gets all the nodes information.

getKey() - Method in class org.onosproject.netconf.NetconfDeviceInfo

Exposes the key of the controller.

getKeyFile() - Method in class org.onosproject.netconf.NetconfDeviceInfo

Deprecated.

1.9.0

getMessageID() - Method in class org.onosproject.netconf.NetconfDeviceOutputEvent

Reply messageId.

getMessagePayload() - Method in class org.onosproject.netconf.NetconfDeviceOutputEvent

return the message payload of the reply form the device.

getNetconfDevice(DeviceId) - Method in interface org.onosproject.netconf.NetconfController

Gets a Netconf Device by node identifier.

getNetconfDevice(IpAddress, int) - Method in interface org.onosproject.netconf.NetconfController

Gets a Netconf Device by node identifier.

getNetconfDevices() - Method in interface org.onosproject.netconf.NetconfController

Gets all Netconf Devices.

getServerCapabilities() - Method in interface org.onosproject.netconf.NetconfSession

Deprecated.

1.10.0 use NetconfSession.getDeviceCapabilitiesSet() instead

getSession() - Method in interface org.onosproject.netconf.NetconfDevice

Returns a NETCONF session context for this device.

getSessionId() - Method in interface org.onosproject.netconf.NetconfSession

Gets the session ID of the Netconf session.

H

hashCode() - Method in class org.onosproject.netconf.NetconfDeviceInfo

I

ip() - Method in class org.onosproject.netconf.NetconfDeviceInfo

Exposes the ip address of the controller.

isActive() - Method in interface org.onosproject.netconf.NetconfDevice

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

isRelevant(NetconfDeviceOutputEvent) - Method in class org.onosproject.netconf.FilteringNetconfDeviceOutputEventListener

L

lock(DatastoreId) - Method in interface org.onosproject.netconf.NetconfSession

Locks the specified configuration.

lock(String) - Method in interface org.onosproject.netconf.NetconfSession

Deprecated.

- 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration parameter instead

lock() - Method in interface org.onosproject.netconf.NetconfSession

Locks the running configuration.

log - Static variable in class org.onosproject.netconf.NetconfDeviceInfo

N

name() - Method in class org.onosproject.netconf.NetconfDeviceInfo

Exposes the name of the controller.

NetconfController - Interface in org.onosproject.netconf

Abstraction of an NETCONF controller.

NetconfDevice - Interface in org.onosproject.netconf

Interface representing a NETCONF device.

NetconfDeviceFactory - Interface in org.onosproject.netconf

Abstract interface for the creation of a NETCONF device.

NetconfDeviceInfo - Class in org.onosproject.netconf

Represents a Netconf device information.

NetconfDeviceInfo(String, String, IpAddress, int) - Constructor for class org.onosproject.netconf.NetconfDeviceInfo

Information for contacting the controller.

NetconfDeviceInfo(String, String, IpAddress, int, String) - Constructor for class org.onosproject.netconf.NetconfDeviceInfo

Information for contacting the controller.

NetconfDeviceListener - Interface in org.onosproject.netconf

Allows for providers interested in node events to be notified.

NetconfDeviceOutputEvent - Class in org.onosproject.netconf

Describes a NETCONF device related event.

NetconfDeviceOutputEvent(NetconfDeviceOutputEvent.Type, Object, String, Optional<Integer>, NetconfDeviceInfo) - Constructor for class org.onosproject.netconf.NetconfDeviceOutputEvent

Creates an event of a given type and for the specified subject and the current time.

NetconfDeviceOutputEvent(NetconfDeviceOutputEvent.Type, Object, String, Optional<Integer>, NetconfDeviceInfo, long) - Constructor for class org.onosproject.netconf.NetconfDeviceOutputEvent

Creates an event of a given type and for the specified subject and time.

NetconfDeviceOutputEvent.Type - Enum in org.onosproject.netconf

Type of device related events.

NetconfDeviceOutputEventListener - Interface in org.onosproject.netconf

Interface for Netconf device output Listeners.

NetconfException - Exception in org.onosproject.netconf

Represents class of errors related to NETCONF SB protocol.

NetconfException(String) - Constructor for exception org.onosproject.netconf.NetconfException

Constructs an exception with the specified message.

NetconfException(String, Throwable) - Constructor for exception org.onosproject.netconf.NetconfException

Constructs an exception with the specified message and the underlying cause.

NetconfSession - Interface in org.onosproject.netconf

NETCONF session object that allows NETCONF operations on top with the physical device on top of an SSH connection.

NetconfSessionFactory - Interface in org.onosproject.netconf

Abstract interface for the creation of a NETCONF session.

O

org.onosproject.netconf - package org.onosproject.netconf

NETCONF controller API.

P

password() - Method in class org.onosproject.netconf.NetconfDeviceInfo

Exposes the password of the controller.

port() - Method in class org.onosproject.netconf.NetconfDeviceInfo

Exposes the port of the controller.

R

removeDevice(DeviceId) - Method in interface org.onosproject.netconf.NetconfController

Removes a Netconf device from the core.

removeDeviceListener(NetconfDeviceListener) - Method in interface org.onosproject.netconf.NetconfController

Removes Device Listener.

removeDeviceOutputListener(NetconfDeviceOutputEventListener) - Method in interface org.onosproject.netconf.NetconfSession

Remove a listener from the underlying stream handler implementation.

request(String) - Method in interface org.onosproject.netconf.NetconfSession

Deprecated.

- 1.10.0 do not remove needs reworking

requestSync(String) - Method in interface org.onosproject.netconf.NetconfSession

Executes an synchronous RPC to the server.

RUNNING - Static variable in class org.onosproject.netconf.DatastoreId

A configuration datastore holding the complete configuration currently active on the device.

S

setDeviceCapabilities(List<String>) - Method in interface org.onosproject.netconf.NetconfSession

Deprecated.

1.10.0 use NetconfSession.setOnosCapabilities(Iterable) instead

setOnosCapabilities(Iterable<String>) - Method in interface org.onosproject.netconf.NetconfSession

Sets the ONOS side capabilities.

startSubscription() - Method in interface org.onosproject.netconf.NetconfSession

Starts subscription to the device's notifications.

startSubscription(String) - Method in interface org.onosproject.netconf.NetconfSession

Starts subscription to the device's notifications.

STARTUP - Static variable in class org.onosproject.netconf.DatastoreId

The configuration datastore holding the configuration loaded by the device when it boots.

T

TargetConfig - Enum in org.onosproject.netconf

Deprecated.

in 1.10.0 use TargetConfiguration instead According to NETCONF RFC, various additional configuration datastores may be defined by capabilities.

toDatastoreId(String) - Static method in enum org.onosproject.netconf.TargetConfig

Deprecated.

toDatastoreId(TargetConfig) - Static method in enum org.onosproject.netconf.TargetConfig

Deprecated.

toString() - Method in class org.onosproject.netconf.DatastoreId

toString() - Method in class org.onosproject.netconf.NetconfDeviceInfo

Return the info about the device in a string.

toString() - Method in class org.onosproject.netconf.NetconfDeviceOutputEvent

toString() - Method in enum org.onosproject.netconf.TargetConfig

Deprecated.

toTargetConfig(String) - Static method in enum org.onosproject.netconf.TargetConfig

Deprecated.

U

unlock(DatastoreId) - Method in interface org.onosproject.netconf.NetconfSession

Unlocks the specified configuration.

unlock(String) - Method in interface org.onosproject.netconf.NetconfSession

Deprecated.

- 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration parameter instead

unlock() - Method in interface org.onosproject.netconf.NetconfSession

Unlocks the running configuration.

V

valueOf(String) - Static method in enum org.onosproject.netconf.NetconfDeviceOutputEvent.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.onosproject.netconf.TargetConfig

Deprecated.

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.onosproject.netconf.NetconfDeviceOutputEvent.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.onosproject.netconf.TargetConfig

Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G H I L N O P R S T U V