org.onosproject.ovsdb.rfc.jsonrpc

Interface OvsdbRpc

All Known Subinterfaces:

OvsdbClientService

All Known Implementing Classes:

DefaultOvsdbClient

public interface OvsdbRpc

The following interface describe the RPC7047's methods that are supported.

Method Summary

Modifier and Type	Method and Description
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.
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.
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.
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<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.

Method Detail

getSchema

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.

Parameters:

dbnames - database name

Returns:

ListenableFuture of JsonNode

echo

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.

Returns:

return info

monitor

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.

Parameters:

dbSchema - databse schema

monitorId - a id for monitor

Returns:

ListenableFuture of JsonNode

listDbs

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.

Returns:

database names

transact

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.

Parameters:

dbSchema - database schema

operations - the operations to execute

Returns:

result the transact result