org.onosproject.ovsdb.controller

Interface OvsdbClientService

All Superinterfaces:

OvsdbRpc

All Known Implementing Classes:

DefaultOvsdbClient

public interface OvsdbClientService
extends OvsdbRpc

Represents to provider facing side of a node.

Method Summary

Modifier and Type	Method and Description
void	applyQos(org.onosproject.net.PortNumber portNumber, java.lang.String qosName) apply qos to port.
void	bindQueues(org.onosproject.net.behaviour.QosId qosId, java.util.Map<java.lang.Long,org.onosproject.net.behaviour.QueueDescription> queues) Bind Queue to QoS.
boolean	createBridge(OvsdbBridge ovsdbBridge) Creates a bridge with a given bridge description.
boolean	createInterface(java.lang.String bridgeName, OvsdbInterface ovsdbIface) Creates an interface with a given OVSDB interface description.
boolean	createMirror(java.lang.String bridgeName, OvsdbMirror mirror) Creates a mirror port.
void	createPort(java.lang.String bridgeName, java.lang.String portName) Creates a port.
boolean	createQos(OvsdbQos ovsdbQos) Creates a qos.
boolean	createQueue(OvsdbQueue queue) Creates queues.
void	disconnect() Disconnects the OVSDB server.
void	dropBridge(java.lang.String bridgeName) Drops a bridge.
boolean	dropInterface(java.lang.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(java.lang.String bridgeName, java.lang.String portName) Drops a port.
void	dropQos(org.onosproject.net.behaviour.QosId qosId) Drops the configuration for qos.
void	dropQueue(org.onosproject.net.behaviour.QueueId queueId) Drops the configuration for queue.
java.util.Set<OvsdbBridge>	getBridges() Gets bridges of node.
java.lang.String	getBridgeUuid(java.lang.String bridgeName) Gets the Bridge uuid.
java.util.Set<org.onosproject.net.behaviour.ControllerInfo>	getControllers(org.onosproject.net.DeviceId openflowDeviceId) Gets controllers of node.
DatabaseSchema	getDatabaseSchema(java.lang.String dbName) Gets the OVSDB database schema from local.
java.util.Set<OvsdbPort>	getLocalPorts(java.lang.Iterable<java.lang.String> ifaceids) Gets OVSDB local ports.
java.util.Set<org.onosproject.net.behaviour.MirroringStatistics>	getMirroringStatistics(org.onosproject.net.DeviceId deviceId) Gets mirroring statistics of the device.
java.lang.String	getMirrorUuid(java.lang.String mirrorName) Gets the Mirror uuid.
com.google.common.util.concurrent.ListenableFuture<DatabaseSchema>	getOvsdbSchema(java.lang.String dbName) Gets the OVSDB database schema.
boolean	getPortError(java.util.List<OvsdbPortName> portNames, org.onosproject.net.DeviceId bridgeId) Gets error status for the given portNames.
java.util.Set<OvsdbPort>	getPorts() Gets ports of bridge.
java.util.List<OvsdbPortName>	getPorts(java.util.List<java.lang.String> portNames, org.onosproject.net.DeviceId bridgeId) Gets created ports for the particular bridgeId.
java.lang.String	getPortUuid(java.lang.String portName, java.lang.String bridgeUuid) Gets the Port uuid.
OvsdbQos	getQos(org.onosproject.net.behaviour.QosId qosId) Gets a qos of node.
java.util.Set<OvsdbQos>	getQoses() Gets qoses of node.
OvsdbQueue	getQueue(org.onosproject.net.behaviour.QueueId queueId) Gets a queue of node.
java.util.Set<OvsdbQueue>	getQueues() Gets queues of node.
Row	getRow(java.lang.String dbName, java.lang.String tableName, java.lang.String uuid) Gets the OVSDB row from local OVSDB store.
boolean	isConnected() Checks if the node is still connected.
org.onosproject.net.behaviour.ControllerInfo	localController() Returns local controller information.
com.google.common.util.concurrent.ListenableFuture<TableUpdates>	monitorTables(java.lang.String dbName, java.lang.String id) Gets the OVSDB table updates.
OvsdbNodeId	nodeId() Gets the node identifier.
void	removeQos(org.onosproject.net.PortNumber portNumber) Creates a qos port.
void	removeRow(java.lang.String dbName, java.lang.String tableName, java.lang.String uuid) Removes the OVSDB row from local OVSDB store.
void	setControllersWithDeviceId(org.onosproject.net.DeviceId deviceId, java.util.List<org.onosproject.net.behaviour.ControllerInfo> controllers) Sets the Controllers for the specified device.
void	unbindQueues(org.onosproject.net.behaviour.QosId qosId, java.util.List<java.lang.Long> queueKeys) Unbind Queue from QoS.
void	updateOvsdbStore(java.lang.String dbName, java.lang.String tableName, java.lang.String uuid, Row row) Updates the local OVSDB store.

Methods inherited from interface org.onosproject.ovsdb.rfc.jsonrpc.OvsdbRpc

echo, getSchema, listDbs, monitor, transact

Method Detail

nodeId

OvsdbNodeId nodeId()

Gets the node identifier.

Returns:

node identifier

createMirror

boolean createMirror(java.lang.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.

Parameters:

bridgeName - the name of the bridge

mirror - the OVSDB mirror description

Returns:

true if mirror creation is successful, false otherwise

getMirrorUuid

java.lang.String getMirrorUuid(java.lang.String mirrorName)

Gets the Mirror uuid.

Parameters:

mirrorName - mirror name

Returns:

mirror uuid, empty if no uuid is found

getMirroringStatistics

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

Gets mirroring statistics of the device.

Parameters:

deviceId - target device id

Returns:

set of mirroring statistics; empty if no mirror is found

dropMirror

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

Drops the configuration for mirror.

Parameters:

mirroringName - name of mirror to drop

applyQos

void applyQos(org.onosproject.net.PortNumber portNumber,
              java.lang.String qosName)

apply qos to port.

Parameters:

portNumber - port identifier

qosName - the qos name

removeQos

void removeQos(org.onosproject.net.PortNumber portNumber)

Creates a qos port.

Parameters:

portNumber - port identifier

createQos

boolean createQos(OvsdbQos ovsdbQos)

Creates a qos. associates with queue to provide the ability of limit the rate of different flows depend on itself priority.

Parameters:

ovsdbQos - the OVSDB Qos

Returns:

true if qos creation is successful, false otherwise

dropQos

void dropQos(org.onosproject.net.behaviour.QosId qosId)

Drops the configuration for qos.

Parameters:

qosId - qos identifier

getQos

OvsdbQos getQos(org.onosproject.net.behaviour.QosId qosId)

Gets a qos of node.

Parameters:

qosId - qos identifier

Returns:

null if no qos is find

getQoses

java.util.Set<OvsdbQos> getQoses()

Gets qoses of node.

Returns:

set of qoses; empty if no qos is find

bindQueues

void bindQueues(org.onosproject.net.behaviour.QosId qosId,
                java.util.Map<java.lang.Long,org.onosproject.net.behaviour.QueueDescription> queues)

Bind Queue to QoS.

Parameters:

qosId - qos identifier

queues - the Queue key and Queue description

unbindQueues

void unbindQueues(org.onosproject.net.behaviour.QosId qosId,
                  java.util.List<java.lang.Long> queueKeys)

Unbind Queue from QoS.

Parameters:

qosId - qos identifier

queueKeys - queue key

createQueue

boolean createQueue(OvsdbQueue queue)

Creates queues. limits the rate of each flow depend on itself priority.

Parameters:

queue - the OVSDB queue description

Returns:

true if queue creation is successful, false otherwise

dropQueue

void dropQueue(org.onosproject.net.behaviour.QueueId queueId)

Drops the configuration for queue.

Parameters:

queueId - queue identifier

getQueue

OvsdbQueue getQueue(org.onosproject.net.behaviour.QueueId queueId)

Gets a queue of node.

Parameters:

queueId - the queue identifier

Returns:

null if no queue is find

getQueues

java.util.Set<OvsdbQueue> getQueues()

Gets queues of node.

Returns:

set of queues; empty if no queue is find

createInterface

boolean createInterface(java.lang.String bridgeName,
                        OvsdbInterface ovsdbIface)

Creates an interface with a given OVSDB interface description.

Parameters:

bridgeName - bridge name

ovsdbIface - ovsdb interface description

Returns:

true if interface creation is successful, false otherwise

dropInterface

boolean dropInterface(java.lang.String ifaceName)

Removes an interface with the supplied interface name.

Parameters:

ifaceName - interface name

Returns:

true if interface creation is successful, false otherwise

createBridge

boolean createBridge(OvsdbBridge ovsdbBridge)

Creates a bridge with a given bridge description.

Parameters:

ovsdbBridge - ovsdb bridge description

Returns:

true if bridge creation is successful, otherwise false

dropBridge

void dropBridge(java.lang.String bridgeName)

Drops a bridge.

Parameters:

bridgeName - bridge name

getBridges

java.util.Set<OvsdbBridge> getBridges()

Gets bridges of node.

Returns:

set of bridges; empty if no bridge is find

getControllers

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

Gets controllers of node.

Parameters:

openflowDeviceId - target device id

Returns:

set of controllers; empty if no controller is find

localController

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

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

Returns:

local controller

setControllersWithDeviceId

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

Sets the Controllers for the specified device.

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

Parameters:

deviceId - device id (likely Openflow device)

controllers - list of controllers

createPort

void createPort(java.lang.String bridgeName,
                java.lang.String portName)

Creates a port.

Parameters:

bridgeName - bridge name

portName - port name

dropPort

void dropPort(java.lang.String bridgeName,
              java.lang.String portName)

Drops a port.

Parameters:

bridgeName - bridge name

portName - port name

getPorts

java.util.Set<OvsdbPort> getPorts()

Gets ports of bridge.

Returns:

set of ports; empty if no ports is find

isConnected

boolean isConnected()

Checks if the node is still connected.

Returns:

true if the node is still connected

getBridgeUuid

java.lang.String getBridgeUuid(java.lang.String bridgeName)

Gets the Bridge uuid.

Parameters:

bridgeName - bridge name

Returns:

bridge uuid, empty if no uuid is find

getPortUuid

java.lang.String getPortUuid(java.lang.String portName,
                             java.lang.String bridgeUuid)

Gets the Port uuid.

Parameters:

portName - port name

bridgeUuid - bridge uuid

Returns:

port uuid, empty if no uuid is find

getOvsdbSchema

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

Gets the OVSDB database schema.

Parameters:

dbName - database name

Returns:

database schema

monitorTables

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

Gets the OVSDB table updates.

Parameters:

dbName - database name

id - random uuid

Returns:

table updates

getDatabaseSchema

DatabaseSchema getDatabaseSchema(java.lang.String dbName)

Gets the OVSDB database schema from local.

Parameters:

dbName - database name

Returns:

database schema

getRow

Row getRow(java.lang.String dbName,
           java.lang.String tableName,
           java.lang.String uuid)

Gets the OVSDB row from local OVSDB store.

Parameters:

dbName - database name

tableName - table name

uuid - row uuid

Returns:

row OVSDB row

removeRow

void removeRow(java.lang.String dbName,
               java.lang.String tableName,
               java.lang.String uuid)

Removes the OVSDB row from local OVSDB store.

Parameters:

dbName - database name

tableName - table name

uuid - row uuid

updateOvsdbStore

void updateOvsdbStore(java.lang.String dbName,
                      java.lang.String tableName,
                      java.lang.String uuid,
                      Row row)

Updates the local OVSDB store.

Parameters:

dbName - database name

tableName - table name

uuid - row uuid

row - OVSDB row

getLocalPorts

java.util.Set<OvsdbPort> getLocalPorts(java.lang.Iterable<java.lang.String> ifaceids)

Gets OVSDB local ports.

Parameters:

ifaceids - the ifaceid that needed

Returns:

OVSDB ports

disconnect

void disconnect()

Disconnects the OVSDB server.

getPorts

java.util.List<OvsdbPortName> getPorts(java.util.List<java.lang.String> portNames,
                                       org.onosproject.net.DeviceId bridgeId)

Gets created ports for the particular bridgeId.

Parameters:

portNames - the portNames which needs to checked for create

bridgeId - bridgeIdentifier

Returns:

OvsdbPortNames the created ports from port table for the bridgeId by considering input port list. Considered port as created if port's interface table also gets created,irrespective of ofport value(has errors or not)

getPortError

boolean getPortError(java.util.List<OvsdbPortName> portNames,
                     org.onosproject.net.DeviceId bridgeId)

Gets error status for the given portNames.

Parameters:

portNames - the portNames which need to be checked for errors

bridgeId - bridgeIdentifier

Returns:

errorstatus true if input port list contains error, false otherwise