org.onosproject.netconf

Interface NetconfSession

public interface NetconfSession

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

Method Summary

Modifier and Type	Method and Description
void	addDeviceOutputListener(NetconfDeviceOutputEventListener listener) Remove a listener from the underlying stream handler implementation.
default void	checkAndReestablish() Checks the state of the underlying SSH session and connection and if necessary it reestablishes it.
boolean	close() Closes the Netconf session with the device.
default boolean	copyConfig(DatastoreId destination, DatastoreId source) Copies the configuration between configuration datastores.
default boolean	copyConfig(DatastoreId netconfTargetConfig, String newConfiguration) Copies the new configuration, an Url or a complete configuration xml tree to the target configuration.
boolean	copyConfig(String netconfTargetConfig, String newConfiguration) Copies the new configuration, an Url or a complete configuration xml tree to the target configuration.
default boolean	copyConfig(TargetConfig netconfTargetConfig, String newConfiguration) Deprecated. - 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration enum parameter instead
default boolean	deleteConfig(DatastoreId netconfTargetConfig) Deletes part of the specified configuration based on the filterSchema.
default boolean	deleteConfig(String netconfTargetConfig) Deprecated. - 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration enum parameter instead
default boolean	deleteConfig(TargetConfig netconfTargetConfig) Deprecated. - 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration enum parameter instead
String	doWrappedRpc(String request) Executes an synchronous RPC to the server and wrap the request in RPC header.
default boolean	editConfig(DatastoreId netconfTargetConfig, String mode, String newConfiguration) Retrieves part of the specified configuration based on the filterSchema.
boolean	editConfig(String newConfiguration) Retrieves part of the specified configuration based on the filterSchema.
default boolean	editConfig(String netconfTargetConfig, String mode, String newConfiguration) Deprecated. - 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration enum parameter instead
default boolean	editConfig(TargetConfig netconfTargetConfig, String mode, String newConfiguration) Deprecated. - 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration enum parameter instead
void	endSubscription() Ends subscription to the device's notifications.
String	get(String request) Retrieves the requested configuration, different from get-config.
String	get(String filterSchema, String withDefaultsMode) Retrieves the requested data.
default String	getConfig(DatastoreId netconfTargetConfig) Retrieves the specified configuration.
default String	getConfig(DatastoreId netconfTargetConfig, String configurationFilterSchema) Retrieves part of the specified configuration based on the filterSchema.
default String	getConfig(String netconfTargetConfig) Deprecated. - 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration parameter instead
default String	getConfig(String netconfTargetConfig, String configurationFilterSchema) Deprecated. - 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfig enum parameter instead
default String	getConfig(TargetConfig netconfTargetConfig) Deprecated. - 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration parameter instead
default String	getConfig(TargetConfig netconfTargetConfig, String configurationFilterSchema) Deprecated. - 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfig enum parameter instead
default Set<String>	getDeviceCapabilitiesSet() Gets the capabilities of the remote Netconf device associated to this session.
String	getServerCapabilities() Deprecated. 1.10.0 use getDeviceCapabilitiesSet() instead
String	getSessionId() Gets the session ID of the Netconf session.
default boolean	lock() Locks the running configuration.
default boolean	lock(DatastoreId datastore) Locks the specified configuration.
default boolean	lock(String configType) Deprecated. - 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration parameter instead
void	removeDeviceOutputListener(NetconfDeviceOutputEventListener listener) Remove a listener from the underlying stream handler implementation.
CompletableFuture<String>	request(String request) Deprecated. - 1.10.0 do not remove needs reworking
String	requestSync(String request) Executes an synchronous RPC to the server.
void	setDeviceCapabilities(List<String> capabilities) Deprecated. 1.10.0 use setOnosCapabilities(Iterable) instead
default void	setOnosCapabilities(Iterable<String> capabilities) Sets the ONOS side capabilities.
void	startSubscription() Starts subscription to the device's notifications.
void	startSubscription(String filterSchema) Starts subscription to the device's notifications.
default boolean	unlock() Unlocks the running configuration.
default boolean	unlock(DatastoreId datastore) Unlocks the specified configuration.
default boolean	unlock(String configType) Deprecated. - 1.10.0 Kingfisher use method overload that accepts org.onosproject.netconf.TargetConfiguration parameter instead

Method Detail

request

@Deprecated
CompletableFuture<String> request(String request)
                                       throws NetconfException

Deprecated. - 1.10.0 do not remove needs reworking

Executes an asynchronous RPC to the server and obtains a future to be completed. The caller must ensure that the message-id in any request is unique for the session

Parameters:

request - the XML containing the RPC for the server.

Returns:

Server response or ERROR

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

get

String get(String request)
    throws NetconfException

Retrieves the requested configuration, different from get-config.

Parameters:

request - the XML containing the request to the server.

Returns:

device running configuration

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

get

String get(String filterSchema,
           String withDefaultsMode)
    throws NetconfException

Retrieves the requested data.

Parameters:

filterSchema - XML subtrees to include in the reply

withDefaultsMode - with-defaults mode

Returns:

Server response

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

doWrappedRpc

String doWrappedRpc(String request)
             throws NetconfException

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

Parameters:

request - the XML containing the request to the server.

Returns:

Server response or ERROR

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

requestSync

String requestSync(String request)
            throws NetconfException

Executes an synchronous RPC to the server.

Parameters:

request - the XML containing the RPC for the server.

Returns:

Server response or ERROR

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

getConfig

default String getConfig(DatastoreId netconfTargetConfig)
                  throws NetconfException

Retrieves the specified configuration.

Parameters:

netconfTargetConfig - the type of configuration to retrieve.

Returns:

specified configuration.

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

getConfig

@Deprecated
default String getConfig(TargetConfig netconfTargetConfig)
                              throws NetconfException

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

Retrieves the specified configuration.

Parameters:

netconfTargetConfig - the type of configuration to retrieve.

Returns:

specified configuration.

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

getConfig

@Deprecated
default String getConfig(String netconfTargetConfig)
                              throws NetconfException

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

Retrieves the specified configuration.

Parameters:

netconfTargetConfig - the type of configuration to retrieve.

Returns:

specified configuration.

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

getConfig

default String getConfig(DatastoreId netconfTargetConfig,
                         String configurationFilterSchema)
                  throws NetconfException

Retrieves part of the specified configuration based on the filterSchema.

Parameters:

netconfTargetConfig - the type of configuration to retrieve.

configurationFilterSchema - XML schema to filter the configuration elements we are interested in

Returns:

device running configuration.

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

getConfig

@Deprecated
default String getConfig(String netconfTargetConfig,
                                     String configurationFilterSchema)
                              throws NetconfException

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

Retrieves part of the specified configuration based on the filterSchema.

Parameters:

netconfTargetConfig - the type of configuration to retrieve.

configurationFilterSchema - XML schema to filter the configuration elements we are interested in

Returns:

device running configuration.

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

getConfig

@Deprecated
default String getConfig(TargetConfig netconfTargetConfig,
                                     String configurationFilterSchema)
                              throws NetconfException

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

Retrieves part of the specified configuration based on the filterSchema.

Parameters:

netconfTargetConfig - the type of configuration to retrieve.

configurationFilterSchema - XML schema to filter the configuration elements we are interested in

Returns:

device running configuration.

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

editConfig

boolean editConfig(String newConfiguration)
            throws NetconfException

Retrieves part of the specified configuration based on the filterSchema.

Parameters:

newConfiguration - configuration to set

Returns:

true if the configuration was edited correctly

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

editConfig

default boolean editConfig(DatastoreId netconfTargetConfig,
                           String mode,
                           String newConfiguration)
                    throws NetconfException

Retrieves part of the specified configuration based on the filterSchema.

Parameters:

netconfTargetConfig - the targetConfiguration to change

mode - selected mode to change the configuration

newConfiguration - configuration to set

Returns:

true if the configuration was edited correctly

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

editConfig

@Deprecated
default boolean editConfig(String netconfTargetConfig,
                                       String mode,
                                       String newConfiguration)
                                throws NetconfException

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

Retrieves part of the specified configuration based on the filterSchema.

Parameters:

netconfTargetConfig - the targetConfiguration to change

mode - selected mode to change the configuration

newConfiguration - configuration to set

Returns:

true if the configuration was edited correctly

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

editConfig

@Deprecated
default boolean editConfig(TargetConfig netconfTargetConfig,
                                       String mode,
                                       String newConfiguration)
                                throws NetconfException

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

Retrieves part of the specified configuration based on the filterSchema.

Parameters:

netconfTargetConfig - the targetConfiguration to change

mode - selected mode to change the configuration

newConfiguration - configuration to set

Returns:

true if the configuration was edited correctly

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

copyConfig

default boolean copyConfig(DatastoreId destination,
                           DatastoreId source)
                    throws NetconfException

Copies the configuration between configuration datastores.

The target configuration can't be the running one

Parameters:

destination - configuration datastore

source - configuration datastore

Returns:

true if the configuration was copied correctly

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

copyConfig

default boolean copyConfig(DatastoreId netconfTargetConfig,
                           String newConfiguration)
                    throws NetconfException

Copies the new configuration, an Url or a complete configuration xml tree to the target configuration. The target configuration can't be the running one

Parameters:

netconfTargetConfig - the type of configuration to retrieve.

newConfiguration - configuration XML to set or URL tag to the configuration

Returns:

true if the configuration was copied correctly

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

copyConfig

boolean copyConfig(String netconfTargetConfig,
                   String newConfiguration)
            throws NetconfException

Copies the new configuration, an Url or a complete configuration xml tree to the target configuration. The target configuration can't be the running one

Parameters:

netconfTargetConfig - the type of configuration to retrieve.

newConfiguration - configuration to set

Returns:

true if the configuration was copied correctly

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

copyConfig

@Deprecated
default boolean copyConfig(TargetConfig netconfTargetConfig,
                                       String newConfiguration)
                                throws NetconfException

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

Copies the new configuration, an Url or a complete configuration xml tree to the target configuration. The target configuration can't be the running one

Parameters:

netconfTargetConfig - the type of configuration to retrieve.

newConfiguration - configuration to set

Returns:

true if the configuration was copied correctly

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

deleteConfig

default boolean deleteConfig(DatastoreId netconfTargetConfig)
                      throws NetconfException

Deletes part of the specified configuration based on the filterSchema.

Parameters:

netconfTargetConfig - the name of the configuration to delete

Returns:

true if the configuration was copied correctly

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

deleteConfig

@Deprecated
default boolean deleteConfig(String netconfTargetConfig)
                                  throws NetconfException

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

Deletes part of the specified configuration based on the filterSchema.

Parameters:

netconfTargetConfig - the name of the configuration to delete

Returns:

true if the configuration was deleted correctly

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

deleteConfig

@Deprecated
default boolean deleteConfig(TargetConfig netconfTargetConfig)
                                  throws NetconfException

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

Deletes part of the specified configuration based on the filterSchema.

Parameters:

netconfTargetConfig - the name of the configuration to delete

Returns:

true if the configuration was copied correctly

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

startSubscription

void startSubscription()
                throws NetconfException

Starts subscription to the device's notifications.

Throws:

NetconfException - when there is a problem starting the subscription

startSubscription

@Beta
void startSubscription(String filterSchema)
                      throws NetconfException

Starts subscription to the device's notifications.

Parameters:

filterSchema - XML subtrees to indicate specific notification

Throws:

NetconfException - when there is a problem starting the subscription

endSubscription

void endSubscription()
              throws NetconfException

Ends subscription to the device's notifications.

Throws:

NetconfException - when there is a problem ending the subscription

lock

default boolean lock(DatastoreId datastore)
              throws NetconfException

Locks the specified configuration.

Parameters:

datastore - configuration datastore to be locked

Returns:

true if successful.

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

lock

@Deprecated
default boolean lock(String configType)
                          throws NetconfException

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

Locks the specified configuration.

Parameters:

configType - type of configuration to be locked

Returns:

true if successful.

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

unlock

default boolean unlock(DatastoreId datastore)
                throws NetconfException

Unlocks the specified configuration.

Parameters:

datastore - configuration datastore to be unlocked

Returns:

true if successful.

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

unlock

@Deprecated
default boolean unlock(String configType)
                            throws NetconfException

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

Unlocks the specified configuration.

Parameters:

configType - type of configuration to be locked

Returns:

true if successful.

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

lock

default boolean lock()
              throws NetconfException

Locks the running configuration.

Returns:

true if successful.

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

unlock

default boolean unlock()
                throws NetconfException

Unlocks the running configuration.

Returns:

true if successful.

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

close

boolean close()
       throws NetconfException

Closes the Netconf session with the device. the first time it tries gracefully, then kills it forcefully

Returns:

true if closed

Throws:

NetconfException - when there is a problem in the communication process on the underlying connection

getSessionId

String getSessionId()

Gets the session ID of the Netconf session.

Returns:

Session ID as a string.

getDeviceCapabilitiesSet

default Set<String> getDeviceCapabilitiesSet()

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

Returns:

Network capabilities as strings in a Set.

Since:

1.10.0 Note: default implementation provided with the interface will be removed when getServerCapabilities() reaches deprecation grace period.

getServerCapabilities

@Deprecated
String getServerCapabilities()

Deprecated. 1.10.0 use getDeviceCapabilitiesSet() instead

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

Returns:

Network capabilities as a string.

setDeviceCapabilities

@Deprecated
void setDeviceCapabilities(List<String> capabilities)

Deprecated. 1.10.0 use setOnosCapabilities(Iterable) instead

Sets the ONOS side capabilities.

Parameters:

capabilities - list of capabilities the device has.

checkAndReestablish

default void checkAndReestablish()
                          throws NetconfException

Checks the state of the underlying SSH session and connection and if necessary it reestablishes it. Should be implemented, providing a default here for retrocompatibility.

Throws:

NetconfException - when there is a problem in reestablishing the connection or the session to the device.

setOnosCapabilities

default void setOnosCapabilities(Iterable<String> capabilities)

Sets the ONOS side capabilities.

Parameters:

capabilities - list of capabilities ONOS has.

Since:

1.10.0

addDeviceOutputListener

void addDeviceOutputListener(NetconfDeviceOutputEventListener listener)

Remove a listener from the underlying stream handler implementation.

Parameters:

listener - event listener.

removeDeviceOutputListener

void removeDeviceOutputListener(NetconfDeviceOutputEventListener listener)

Remove a listener from the underlying stream handler implementation.

Parameters:

listener - event listener.