org.onosproject.netconf.ctl

Class NetconfSessionImpl

java.lang.Object

org.onosproject.netconf.ctl.NetconfSessionImpl

All Implemented Interfaces:

NetconfSession

public class NetconfSessionImpl
extends Object
implements NetconfSession

Implementation of a NETCONF session to talk to a device.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NetconfSessionImpl.NetconfSessionDelegateImpl

Constructor Summary

Constructors

Constructor and Description
NetconfSessionImpl(NetconfDeviceInfo deviceInfo)

Method Summary

Modifier and Type	Method and Description
void	addDeviceOutputListener(NetconfDeviceOutputEventListener listener) Remove a listener from the underlying stream handler implementation.
boolean	close() Closes the Netconf session with the device.
boolean	copyConfig(String targetConfiguration, String newConfiguration) Copies the new configuration, an Url or a complete configuration xml tree to the target configuration.
boolean	deleteConfig(String targetConfiguration) Deletes part of the specified configuration based on the filterSchema.
String	doWrappedRpc(String request) Executes an synchronous RPC to the server and wrap the request in RPC header.
boolean	editConfig(String newConfiguration) Retrives part of the specified configuration based on the filterSchema.
boolean	editConfig(String targetConfiguration, String mode, String newConfiguration) Retrives part of the specified configuration based on the filterSchema.
void	endSubscription() Ends subscription to the device's notifications.
String	get(String request) Retrives the requested configuration, different from get-config.
String	get(String filterSchema, String withDefaultsMode) Retrives the requested data.
String	getConfig(String targetConfiguration) Retrives the specified configuration.
String	getConfig(String targetConfiguration, String configurationSchema) Retrives part of the specivied configuration based on the filterSchema.
String	getServerCapabilities() Gets the capabilities of the Netconf server associated to this session.
String	getSessionId() Gets the session ID of the Netconf session.
boolean	lock() Locks the running configuration.
boolean	lock(String configType) Locks the specified configuration.
void	removeDeviceOutputListener(NetconfDeviceOutputEventListener listener) Remove a listener from the underlying stream handler implementation.
CompletableFuture<String>	request(String request) Executes an asynchronous RPC to the server and obtains a future to be completed.
String	requestSync(String request) Executes an synchronous RPC to the server.
void	setDeviceCapabilities(List<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.
boolean	unlock() Unlocks the running configuration.
boolean	unlock(String configType) Unlocks the specified configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetconfSessionImpl

public NetconfSessionImpl(NetconfDeviceInfo deviceInfo)
                   throws NetconfException

Throws:

NetconfException

Method Detail

startSubscription

public void startSubscription()
                       throws NetconfException

Description copied from interface: NetconfSession

Starts subscription to the device's notifications.

Specified by:

startSubscription in interface NetconfSession

Throws:

NetconfException - when there is a problem starting the subscription

startSubscription

@Beta
public void startSubscription(String filterSchema)
                             throws NetconfException

Description copied from interface: NetconfSession

Starts subscription to the device's notifications.

Specified by:

startSubscription in interface NetconfSession

Parameters:

filterSchema - XML subtrees to indicate specific notification

Throws:

NetconfException - when there is a problem starting the subscription

endSubscription

public void endSubscription()
                     throws NetconfException

Description copied from interface: NetconfSession

Ends subscription to the device's notifications.

Specified by:

endSubscription in interface NetconfSession

Throws:

NetconfException - when there is a problem ending the subscription

requestSync

public String requestSync(String request)
                   throws NetconfException

Description copied from interface: NetconfSession

Executes an synchronous RPC to the server.

Specified by:

requestSync in interface NetconfSession

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

request

public CompletableFuture<String> request(String request)

Description copied from interface: NetconfSession

Executes an asynchronous RPC to the server and obtains a future to be completed.

Specified by:

request in interface NetconfSession

Parameters:

request - the XML containing the RPC for the server.

Returns:

Server response or ERROR

doWrappedRpc

public String doWrappedRpc(String request)
                    throws NetconfException

Description copied from interface: NetconfSession

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

Specified by:

doWrappedRpc in interface NetconfSession

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

get

public String get(String request)
           throws NetconfException

Description copied from interface: NetconfSession

Retrives the requested configuration, different from get-config.

Specified by:

get in interface NetconfSession

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

public String get(String filterSchema,
                  String withDefaultsMode)
           throws NetconfException

Description copied from interface: NetconfSession

Retrives the requested data.

Specified by:

get in interface NetconfSession

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

getConfig

public String getConfig(String targetConfiguration)
                 throws NetconfException

Description copied from interface: NetconfSession

Retrives the specified configuration.

Specified by:

getConfig in interface NetconfSession

Parameters:

targetConfiguration - 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

public String getConfig(String targetConfiguration,
                        String configurationSchema)
                 throws NetconfException

Description copied from interface: NetconfSession

Retrives part of the specivied configuration based on the filterSchema.

Specified by:

getConfig in interface NetconfSession

Parameters:

targetConfiguration - the type of configuration to retrieve.

configurationSchema - 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

public boolean editConfig(String newConfiguration)
                   throws NetconfException

Description copied from interface: NetconfSession

Retrives part of the specified configuration based on the filterSchema.

Specified by:

editConfig in interface NetconfSession

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

public boolean editConfig(String targetConfiguration,
                          String mode,
                          String newConfiguration)
                   throws NetconfException

Description copied from interface: NetconfSession

Retrives part of the specified configuration based on the filterSchema.

Specified by:

editConfig in interface NetconfSession

Parameters:

targetConfiguration - 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

public boolean copyConfig(String targetConfiguration,
                          String newConfiguration)
                   throws NetconfException

Description copied from interface: NetconfSession

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

Specified by:

copyConfig in interface NetconfSession

Parameters:

targetConfiguration - 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

public boolean deleteConfig(String targetConfiguration)
                     throws NetconfException

Description copied from interface: NetconfSession

Deletes part of the specified configuration based on the filterSchema.

Specified by:

deleteConfig in interface NetconfSession

Parameters:

targetConfiguration - 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

lock

public boolean lock(String configType)
             throws NetconfException

Description copied from interface: NetconfSession

Locks the specified configuration.

Specified by:

lock in interface NetconfSession

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

public boolean unlock(String configType)
               throws NetconfException

Description copied from interface: NetconfSession

Unlocks the specified configuration.

Specified by:

unlock in interface NetconfSession

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

public boolean lock()
             throws NetconfException

Description copied from interface: NetconfSession

Locks the running configuration.

Specified by:

lock in interface NetconfSession

Returns:

true if successful.

Throws:

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

unlock

public boolean unlock()
               throws NetconfException

Description copied from interface: NetconfSession

Unlocks the running configuration.

Specified by:

unlock in interface NetconfSession

Returns:

true if successful.

Throws:

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

close

public boolean close()
              throws NetconfException

Description copied from interface: NetconfSession

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

Specified by:

close in interface NetconfSession

Returns:

true if closed

Throws:

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

getSessionId

public String getSessionId()

Description copied from interface: NetconfSession

Gets the session ID of the Netconf session.

Specified by:

getSessionId in interface NetconfSession

Returns:

Session ID as a string.

getServerCapabilities

public String getServerCapabilities()

Description copied from interface: NetconfSession

Gets the capabilities of the Netconf server associated to this session.

Specified by:

getServerCapabilities in interface NetconfSession

Returns:

Network capabilities as a string.

setDeviceCapabilities

public void setDeviceCapabilities(List<String> capabilities)

Description copied from interface: NetconfSession

Sets the ONOS side capabilities.

Specified by:

setDeviceCapabilities in interface NetconfSession

Parameters:

capabilities - list of capabilities the device has.

addDeviceOutputListener

public void addDeviceOutputListener(NetconfDeviceOutputEventListener listener)

Description copied from interface: NetconfSession

Remove a listener from the underlying stream handler implementation.

Specified by:

addDeviceOutputListener in interface NetconfSession

Parameters:

listener - event listener.

removeDeviceOutputListener

public void removeDeviceOutputListener(NetconfDeviceOutputEventListener listener)

Description copied from interface: NetconfSession

Remove a listener from the underlying stream handler implementation.

Specified by:

removeDeviceOutputListener in interface NetconfSession

Parameters:

listener - event listener.