org.onosproject.ovsdb.controller.driver

Class DefaultOvsdbClient

java.lang.Object

org.onosproject.ovsdb.controller.driver.DefaultOvsdbClient

All Implemented Interfaces:

OvsdbProviderService, OvsdbClientService, OvsdbRpc

public class DefaultOvsdbClient
extends Object
implements OvsdbProviderService, OvsdbClientService

An representation of an ovsdb client.

Constructor Summary

Constructors

Constructor and Description
DefaultOvsdbClient(OvsdbNodeId nodeId) Creates an OvsdbClient.

Method Summary

Modifier and Type	Method and Description
boolean	createBridge(OvsdbBridge ovsdbBridge) Creates a bridge with a given bridge description.
void	createBridge(String bridgeName) Deprecated.
boolean	createBridge(String bridgeName, String dpid, List<org.onosproject.net.behaviour.ControllerInfo> controllers) Deprecated.
void	createBridge(String bridgeName, String dpid, String exPortName) Deprecated.
boolean	createInterface(String bridgeName, OvsdbInterface ovsdbIface) Creates an interface with a given OVSDB interface description.
boolean	createMirror(String bridgeName, OvsdbMirror mirror) Creates a mirror port.
void	createPort(String bridgeName, String portName) Creates a port.
boolean	createTunnel(String bridgeName, String ifaceName, String tunnelType, Map<String,String> options) Deprecated.
void	disconnect() Disconnects the OVSDB server.
void	dropBridge(String bridgeName) Drops a bridge.
boolean	dropInterface(String ifaceName) Removes an interface with the supplied interface name.
void	dropMirror(org.onosproject.net.behaviour.MirroringName mirroringName) Drops the configuration for mirror.
void	dropPort(String bridgeName, String portName) Drops a port.
void	dropTunnel(org.onlab.packet.IpAddress srcIp, org.onlab.packet.IpAddress dstIp) Deprecated.
com.google.common.util.concurrent.ListenableFuture<List<String>>	echo() The "echo" method can be used by both clients and servers to verify the liveness of a database connection.
Set<OvsdbBridge>	getBridges() Gets bridges of node.
String	getBridgeUuid(String bridgeName) Gets the Bridge uuid.
Set<org.onosproject.net.behaviour.ControllerInfo>	getControllers(org.onosproject.net.DeviceId openflowDeviceId) Gets controllers of node.
DatabaseSchema	getDatabaseSchema(String dbName) Gets the OVSDB database schema from local.
Set<OvsdbPort>	getLocalPorts(Iterable<String> ifaceids) Gets OVSDB local ports.
Set<org.onosproject.net.behaviour.MirroringStatistics>	getMirroringStatistics(org.onosproject.net.DeviceId deviceId) Gets mirrors of the device.
String	getMirrorUuid(String mirrorName) Gets the Mirror uuid.
com.google.common.util.concurrent.ListenableFuture<DatabaseSchema>	getOvsdbSchema(String dbName) Gets the OVSDB database schema.
Set<OvsdbPort>	getPorts() Gets ports of bridge.
String	getPortUuid(String portName, String bridgeUuid) Gets the Port uuid.
Row	getRow(String dbName, String tableName, String uuid) Gets the ovsdb row.
com.google.common.util.concurrent.ListenableFuture<com.fasterxml.jackson.databind.JsonNode>	getSchema(List<String> dbnames) This operation retrieves a database-schema that describes hosted database db-name.
boolean	isConnected() Checks if the node is still connected.
com.google.common.util.concurrent.ListenableFuture<List<String>>	listDbs() This operation retrieves an array whose elements are the names of the databases that can be accessed over this management protocol connection.
org.onosproject.net.behaviour.ControllerInfo	localController() Returns local controller information.
com.google.common.util.concurrent.ListenableFuture<com.fasterxml.jackson.databind.JsonNode>	monitor(DatabaseSchema dbSchema, String monitorId) The "monitor" request enables a client to replicate tables or subsets of tables within an OVSDB database by requesting notifications of changes to those tables and by receiving the complete initial state of a table or a subset of a table.
com.google.common.util.concurrent.ListenableFuture<TableUpdates>	monitorTables(String dbName, String id) Gets the OVSDB table updates.
void	nodeAdded() Announces to the ovsdb agent that this node has added.
OvsdbNodeId	nodeId() Gets the node identifier.
void	nodeRemoved() Announces to the ovsdb agent that this node has removed.
void	processRequest(com.fasterxml.jackson.databind.JsonNode requestJson) processes request from ovsdb.
void	processResult(com.fasterxml.jackson.databind.JsonNode response) Processes result from ovsdb.
void	removeRow(String dbName, String tableName, String uuid) Removes the OVSDB row from local OVSDB store.
void	setAgent(OvsdbAgent agent) Sets the ovsdb agent to be used.
void	setCallback(Callback monitorCallback) Sets call back.
void	setChannel(io.netty.channel.Channel channel) Sets the associated Netty channel for this node.
void	setConnection(boolean connected) Sets whether the node is connected.
void	setControllersWithDeviceId(org.onosproject.net.DeviceId deviceId, List<org.onosproject.net.behaviour.ControllerInfo> controllers) Sets the Controllers for the specified device.
com.google.common.util.concurrent.ListenableFuture<List<com.fasterxml.jackson.databind.JsonNode>>	transact(DatabaseSchema dbSchema, List<Operation> operations) This RPC method causes the database server to execute a series of operations in the specified order on a given database.
void	updateOvsdbStore(String dbName, String tableName, String uuid, Row row) Updates the local OVSDB store.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOvsdbClient

public DefaultOvsdbClient(OvsdbNodeId nodeId)

Creates an OvsdbClient.

Parameters:

nodeId - ovsdb node id

Method Detail

nodeId

public OvsdbNodeId nodeId()

Description copied from interface: OvsdbClientService

Gets the node identifier.

Specified by:

nodeId in interface OvsdbClientService

Returns:

node identifier

setAgent

public void setAgent(OvsdbAgent agent)

Description copied from interface: OvsdbProviderService

Sets the ovsdb agent to be used. This method can only be called once.

Specified by:

setAgent in interface OvsdbProviderService

Parameters:

agent - the agent to set.

setChannel

public void setChannel(io.netty.channel.Channel channel)

Description copied from interface: OvsdbProviderService

Sets the associated Netty channel for this node.

Specified by:

setChannel in interface OvsdbProviderService

Parameters:

channel - the Netty channel

setConnection

public void setConnection(boolean connected)

Description copied from interface: OvsdbProviderService

Sets whether the node is connected.

Specified by:

setConnection in interface OvsdbProviderService

Parameters:

connected - whether the node is connected

isConnected

public boolean isConnected()

Description copied from interface: OvsdbClientService

Checks if the node is still connected.

Specified by:

isConnected in interface OvsdbClientService

Returns:

true if the node is still connected

nodeAdded

public void nodeAdded()

Description copied from interface: OvsdbProviderService

Announces to the ovsdb agent that this node has added.

Specified by:

nodeAdded in interface OvsdbProviderService

nodeRemoved

public void nodeRemoved()

Description copied from interface: OvsdbProviderService

Announces to the ovsdb agent that this node has removed.

Specified by:

nodeRemoved in interface OvsdbProviderService

getRow

public Row getRow(String dbName,
                  String tableName,
                  String uuid)

Gets the ovsdb row.

Specified by:

getRow in interface OvsdbClientService

Parameters:

dbName - the ovsdb database name

tableName - the ovsdb table name

uuid - the key of the row

Returns:

row, empty if row is find

removeRow

public void removeRow(String dbName,
                      String tableName,
                      String uuid)

Description copied from interface: OvsdbClientService

Removes the OVSDB row from local OVSDB store.

Specified by:

removeRow in interface OvsdbClientService

Parameters:

dbName - database name

tableName - table name

uuid - row uuid

updateOvsdbStore

public void updateOvsdbStore(String dbName,
                             String tableName,
                             String uuid,
                             Row row)

Description copied from interface: OvsdbClientService

Updates the local OVSDB store.

Specified by:

updateOvsdbStore in interface OvsdbClientService

Parameters:

dbName - database name

tableName - table name

uuid - row uuid

row - OVSDB row

getMirrorUuid

public String getMirrorUuid(String mirrorName)

Gets the Mirror uuid.

Specified by:

getMirrorUuid in interface OvsdbClientService

Parameters:

mirrorName - mirror name

Returns:

mirror uuid, empty if no uuid is found

getMirroringStatistics

public Set<org.onosproject.net.behaviour.MirroringStatistics> getMirroringStatistics(org.onosproject.net.DeviceId deviceId)

Gets mirrors of the device.

Specified by:

getMirroringStatistics in interface OvsdbClientService

Parameters:

deviceId - target device id

Returns:

set of mirroring; empty if no mirror is found

getPortUuid

public String getPortUuid(String portName,
                          String bridgeUuid)

Description copied from interface: OvsdbClientService

Gets the Port uuid.

Specified by:

getPortUuid in interface OvsdbClientService

Parameters:

portName - port name

bridgeUuid - bridge uuid

Returns:

port uuid, empty if no uuid is find

getBridgeUuid

public String getBridgeUuid(String bridgeName)

Description copied from interface: OvsdbClientService

Gets the Bridge uuid.

Specified by:

getBridgeUuid in interface OvsdbClientService

Parameters:

bridgeName - bridge name

Returns:

bridge uuid, empty if no uuid is find

createPort

public void createPort(String bridgeName,
                       String portName)

Description copied from interface: OvsdbClientService

Creates a port.

Specified by:

createPort in interface OvsdbClientService

Parameters:

bridgeName - bridge name

portName - port name

dropPort

public void dropPort(String bridgeName,
                     String portName)

Description copied from interface: OvsdbClientService

Drops a port.

Specified by:

dropPort in interface OvsdbClientService

Parameters:

bridgeName - bridge name

portName - port name

createBridge

@Deprecated
public void createBridge(String bridgeName)

Deprecated.

Description copied from interface: OvsdbClientService

Creates a bridge.

Specified by:

createBridge in interface OvsdbClientService

Parameters:

bridgeName - bridge name

createBridge

@Deprecated
public void createBridge(String bridgeName,
                                     String dpid,
                                     String exPortName)

Deprecated.

Description copied from interface: OvsdbClientService

Creates a bridge.

Specified by:

createBridge in interface OvsdbClientService

Parameters:

bridgeName - bridge name

dpid - data path id

exPortName - external port name

createBridge

@Deprecated
public boolean createBridge(String bridgeName,
                                        String dpid,
                                        List<org.onosproject.net.behaviour.ControllerInfo> controllers)

Deprecated.

Description copied from interface: OvsdbClientService

Creates a bridge with given name and dpid. Sets the bridge's controller with given controllers.

Specified by:

createBridge in interface OvsdbClientService

Parameters:

bridgeName - bridge name

dpid - data path id

controllers - controllers

Returns:

true if bridge creation is successful, false otherwise

createBridge

public boolean createBridge(OvsdbBridge ovsdbBridge)

Description copied from interface: OvsdbClientService

Creates a bridge with a given bridge description.

Specified by:

createBridge in interface OvsdbClientService

Parameters:

ovsdbBridge - ovsdb bridge description

Returns:

true if bridge creation is successful, otherwise false

localController

public org.onosproject.net.behaviour.ControllerInfo localController()

Description copied from interface: OvsdbClientService

Returns local controller information. The connection is a TCP connection to the local ONOS instance's IP and the default OpenFlow port.

Specified by:

localController in interface OvsdbClientService

Returns:

local controller

setControllersWithDeviceId

public void setControllersWithDeviceId(org.onosproject.net.DeviceId deviceId,
                                       List<org.onosproject.net.behaviour.ControllerInfo> controllers)

Description copied from interface: OvsdbClientService

Sets the Controllers for the specified device.

This method will replace the existing controller list with the new controller list.

Specified by:

setControllersWithDeviceId in interface OvsdbClientService

Parameters:

deviceId - device id (likely Openflow device)

controllers - list of controllers

dropBridge

public void dropBridge(String bridgeName)

Description copied from interface: OvsdbClientService

Drops a bridge.

Specified by:

dropBridge in interface OvsdbClientService

Parameters:

bridgeName - bridge name

createMirror

public boolean createMirror(String bridgeName,
                            OvsdbMirror mirror)

Creates a mirror port. Mirrors the traffic that goes to selectDstPort or comes from selectSrcPort or packets containing selectVlan to mirrorPort or to all ports that trunk mirrorVlan.

Specified by:

createMirror in interface OvsdbClientService

Parameters:

mirror - the OVSDB mirror description

bridgeName - the name of the bridge

Returns:

true if mirror creation is successful, false otherwise

dropMirror

public void dropMirror(org.onosproject.net.behaviour.MirroringName mirroringName)

Drops the configuration for mirror.

Specified by:

dropMirror in interface OvsdbClientService

Parameters:

mirroringName - name of mirror to drop

createTunnel

@Deprecated
public boolean createTunnel(String bridgeName,
                                        String ifaceName,
                                        String tunnelType,
                                        Map<String,String> options)

Deprecated.

Description copied from interface: OvsdbClientService

Creates a tunnel port with given options.

Specified by:

createTunnel in interface OvsdbClientService

Parameters:

bridgeName - bridge name

ifaceName - port name

tunnelType - tunnel type

options - tunnel options

Returns:

true if tunnel creation is successful, false otherwise

dropTunnel

@Deprecated
public void dropTunnel(org.onlab.packet.IpAddress srcIp,
                                   org.onlab.packet.IpAddress dstIp)

Deprecated.

Description copied from interface: OvsdbClientService

Drops the configuration for tunnel.

Specified by:

dropTunnel in interface OvsdbClientService

Parameters:

srcIp - source IP address

dstIp - destination IP address

createInterface

public boolean createInterface(String bridgeName,
                               OvsdbInterface ovsdbIface)

Description copied from interface: OvsdbClientService

Creates an interface with a given OVSDB interface description.

Specified by:

createInterface in interface OvsdbClientService

Parameters:

bridgeName - bridge name

ovsdbIface - ovsdb interface description

Returns:

true if interface creation is successful, false otherwise

dropInterface

public boolean dropInterface(String ifaceName)

Description copied from interface: OvsdbClientService

Removes an interface with the supplied interface name.

Specified by:

dropInterface in interface OvsdbClientService

Parameters:

ifaceName - interface name

Returns:

true if interface creation is successful, false otherwise

getOvsdbSchema

public com.google.common.util.concurrent.ListenableFuture<DatabaseSchema> getOvsdbSchema(String dbName)

Description copied from interface: OvsdbClientService

Gets the OVSDB database schema.

Specified by:

getOvsdbSchema in interface OvsdbClientService

Parameters:

dbName - database name

Returns:

database schema

monitorTables

public com.google.common.util.concurrent.ListenableFuture<TableUpdates> monitorTables(String dbName,
                                                                                      String id)

Description copied from interface: OvsdbClientService

Gets the OVSDB table updates.

Specified by:

monitorTables in interface OvsdbClientService

Parameters:

dbName - database name

id - random uuid

Returns:

table updates

getSchema

public com.google.common.util.concurrent.ListenableFuture<com.fasterxml.jackson.databind.JsonNode> getSchema(List<String> dbnames)

Description copied from interface: OvsdbRpc

This operation retrieves a database-schema that describes hosted database db-name.

Specified by:

getSchema in interface OvsdbRpc

Parameters:

dbnames - database name

Returns:

ListenableFuture of JsonNode

echo

public com.google.common.util.concurrent.ListenableFuture<List<String>> echo()

Description copied from interface: OvsdbRpc

The "echo" method can be used by both clients and servers to verify the liveness of a database connection.

Specified by:

echo in interface OvsdbRpc

Returns:

return info

monitor

public com.google.common.util.concurrent.ListenableFuture<com.fasterxml.jackson.databind.JsonNode> monitor(DatabaseSchema dbSchema,
                                                                                                           String monitorId)

Description copied from interface: OvsdbRpc

The "monitor" request enables a client to replicate tables or subsets of tables within an OVSDB database by requesting notifications of changes to those tables and by receiving the complete initial state of a table or a subset of a table.

Specified by:

monitor in interface OvsdbRpc

Parameters:

dbSchema - databse schema

monitorId - a id for monitor

Returns:

ListenableFuture of JsonNode

listDbs

public com.google.common.util.concurrent.ListenableFuture<List<String>> listDbs()

Description copied from interface: OvsdbRpc

This operation retrieves an array whose elements are the names of the databases that can be accessed over this management protocol connection.

Specified by:

listDbs in interface OvsdbRpc

Returns:

database names

transact

public com.google.common.util.concurrent.ListenableFuture<List<com.fasterxml.jackson.databind.JsonNode>> transact(DatabaseSchema dbSchema,
                                                                                                                  List<Operation> operations)

Description copied from interface: OvsdbRpc

This RPC method causes the database server to execute a series of operations in the specified order on a given database.

Specified by:

transact in interface OvsdbRpc

Parameters:

dbSchema - database schema

operations - the operations to execute

Returns:

result the transact result

processResult

public void processResult(com.fasterxml.jackson.databind.JsonNode response)

Description copied from interface: OvsdbProviderService

Processes result from ovsdb.

Specified by:

processResult in interface OvsdbProviderService

Parameters:

response - JsonNode response from ovsdb

processRequest

public void processRequest(com.fasterxml.jackson.databind.JsonNode requestJson)

Description copied from interface: OvsdbProviderService

processes request from ovsdb.

Specified by:

processRequest in interface OvsdbProviderService

Parameters:

requestJson - JsonNode request from ovsdb

setCallback

public void setCallback(Callback monitorCallback)

Description copied from interface: OvsdbProviderService

Sets call back.

Specified by:

setCallback in interface OvsdbProviderService

Parameters:

monitorCallback - the callback to set

getBridges

public Set<OvsdbBridge> getBridges()

Description copied from interface: OvsdbClientService

Gets bridges of node.

Specified by:

getBridges in interface OvsdbClientService

Returns:

set of bridges; empty if no bridge is find

getControllers

public Set<org.onosproject.net.behaviour.ControllerInfo> getControllers(org.onosproject.net.DeviceId openflowDeviceId)

Description copied from interface: OvsdbClientService

Gets controllers of node.

Specified by:

getControllers in interface OvsdbClientService

Parameters:

openflowDeviceId - target device id

Returns:

set of controllers; empty if no controller is find

getPorts

public Set<OvsdbPort> getPorts()

Description copied from interface: OvsdbClientService

Gets ports of bridge.

Specified by:

getPorts in interface OvsdbClientService

Returns:

set of ports; empty if no ports is find

getDatabaseSchema

public DatabaseSchema getDatabaseSchema(String dbName)

Description copied from interface: OvsdbClientService

Gets the OVSDB database schema from local.

Specified by:

getDatabaseSchema in interface OvsdbClientService

Parameters:

dbName - database name

Returns:

database schema

getLocalPorts

public Set<OvsdbPort> getLocalPorts(Iterable<String> ifaceids)

Description copied from interface: OvsdbClientService

Gets OVSDB local ports.

Specified by:

getLocalPorts in interface OvsdbClientService

Parameters:

ifaceids - the ifaceid that needed

Returns:

OVSDB ports

disconnect

public void disconnect()

Description copied from interface: OvsdbClientService

Disconnects the OVSDB server.

Specified by:

disconnect in interface OvsdbClientService