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.
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 configurationFilterSchema) 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.

Method Detail

request

CompletableFuture<String> request(String request)
                           throws NetconfException

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

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

Retrives 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

Retrives 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

String getConfig(String targetConfiguration)
          throws NetconfException

Retrives the specified configuration.

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

String getConfig(String targetConfiguration,
                 String configurationFilterSchema)
          throws NetconfException

Retrives part of the specivied configuration based on the filterSchema.

Parameters:

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

Retrives 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

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

Retrives part of the specified configuration based on the filterSchema.

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

boolean copyConfig(String targetConfiguration,
                   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:

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

boolean deleteConfig(String targetConfiguration)
              throws NetconfException

Deletes part of the specified configuration based on the filterSchema.

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

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

boolean lock(String configType)
      throws NetconfException

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

boolean unlock(String configType)
        throws NetconfException

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

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

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.

getServerCapabilities

String getServerCapabilities()

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

Returns:

Network capabilities as a string.

setDeviceCapabilities

void setDeviceCapabilities(List<String> capabilities)

Sets the ONOS side capabilities.

Parameters:

capabilities - list of capabilities the device has.

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.