CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.ovsdb.controller; |
| 17 | |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 18 | import com.google.common.util.concurrent.ListenableFuture; |
lishuai | 6c56f5e | 2015-11-17 16:38:19 +0800 | [diff] [blame] | 19 | |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 20 | import org.onlab.packet.IpAddress; |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 21 | import org.onosproject.net.DeviceId; |
| 22 | import org.onosproject.net.behaviour.ControllerInfo; |
Jonathan Hart | 51539b8 | 2015-10-29 09:53:04 -0700 | [diff] [blame] | 23 | import org.onosproject.ovsdb.rfc.jsonrpc.OvsdbRpc; |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 24 | import org.onosproject.ovsdb.rfc.message.OperationResult; |
| 25 | import org.onosproject.ovsdb.rfc.message.TableUpdates; |
| 26 | import org.onosproject.ovsdb.rfc.notation.Row; |
Jonathan Hart | 51539b8 | 2015-10-29 09:53:04 -0700 | [diff] [blame] | 27 | import org.onosproject.ovsdb.rfc.notation.Uuid; |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 28 | import org.onosproject.ovsdb.rfc.operations.Operation; |
| 29 | import org.onosproject.ovsdb.rfc.schema.DatabaseSchema; |
| 30 | |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 31 | import java.util.List; |
Hyunsun Moon | 646d8c4 | 2015-10-08 20:32:44 -0700 | [diff] [blame] | 32 | import java.util.Map; |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 33 | import java.util.Set; |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 34 | |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 35 | /** |
| 36 | * Represents to provider facing side of a node. |
| 37 | */ |
Jonathan Hart | 51539b8 | 2015-10-29 09:53:04 -0700 | [diff] [blame] | 38 | public interface OvsdbClientService extends OvsdbRpc { |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 39 | /** |
| 40 | * Gets the node identifier. |
| 41 | * |
| 42 | * @return node identifier |
| 43 | */ |
| 44 | OvsdbNodeId nodeId(); |
| 45 | |
| 46 | /** |
BitOhenry | 264f35a | 2015-11-03 20:58:39 +0800 | [diff] [blame] | 47 | * Creates the configuration for tunnel. |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 48 | * |
| 49 | * @param srcIp source IP address |
| 50 | * @param dstIp destination IP address |
Ray Milkey | ea12532 | 2016-02-16 13:35:09 -0800 | [diff] [blame] | 51 | * @deprecated 1.4.0 Emu release |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 52 | */ |
jiangrui | e276682 | 2015-11-27 10:17:10 +0800 | [diff] [blame] | 53 | @Deprecated |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 54 | void createTunnel(IpAddress srcIp, IpAddress dstIp); |
| 55 | |
| 56 | /** |
Hyunsun Moon | 646d8c4 | 2015-10-08 20:32:44 -0700 | [diff] [blame] | 57 | * Creates a tunnel port with given options. |
| 58 | * |
| 59 | * @param bridgeName bridge name |
| 60 | * @param portName port name |
| 61 | * @param tunnelType tunnel type |
| 62 | * @param options tunnel options |
| 63 | * @return true if tunnel creation is successful, false otherwise |
| 64 | */ |
| 65 | boolean createTunnel(String bridgeName, String portName, String tunnelType, Map<String, String> options); |
| 66 | |
| 67 | /** |
BitOhenry | 264f35a | 2015-11-03 20:58:39 +0800 | [diff] [blame] | 68 | * Drops the configuration for tunnel. |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 69 | * |
| 70 | * @param srcIp source IP address |
| 71 | * @param dstIp destination IP address |
| 72 | */ |
| 73 | void dropTunnel(IpAddress srcIp, IpAddress dstIp); |
| 74 | |
| 75 | /** |
BitOhenry | 264f35a | 2015-11-03 20:58:39 +0800 | [diff] [blame] | 76 | * Gets tunnels of node. |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 77 | * |
| 78 | * @return set of tunnels; empty if no tunnel is find |
| 79 | */ |
| 80 | Set<OvsdbTunnel> getTunnels(); |
| 81 | |
| 82 | /** |
| 83 | * Creates a bridge. |
| 84 | * |
| 85 | * @param bridgeName bridge name |
| 86 | */ |
| 87 | void createBridge(String bridgeName); |
| 88 | |
| 89 | /** |
lishuai | 6c56f5e | 2015-11-17 16:38:19 +0800 | [diff] [blame] | 90 | * Creates a bridge. |
| 91 | * |
| 92 | * @param bridgeName bridge name |
| 93 | * @param dpid data path id |
| 94 | * @param exPortName external port name |
| 95 | */ |
| 96 | void createBridge(String bridgeName, String dpid, String exPortName); |
| 97 | |
| 98 | /** |
Hyunsun Moon | 646d8c4 | 2015-10-08 20:32:44 -0700 | [diff] [blame] | 99 | * Creates a bridge with given name and dpid. |
| 100 | * Sets the bridge's controller with given controllers. |
| 101 | * |
| 102 | * @param bridgeName bridge name |
| 103 | * @param dpid data path id |
| 104 | * @param controllers controllers |
| 105 | * @return true if bridge creation is successful, false otherwise |
| 106 | */ |
| 107 | boolean createBridge(String bridgeName, String dpid, List<ControllerInfo> controllers); |
| 108 | |
| 109 | /** |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 110 | * Drops a bridge. |
| 111 | * |
| 112 | * @param bridgeName bridge name |
| 113 | */ |
| 114 | void dropBridge(String bridgeName); |
| 115 | |
| 116 | /** |
BitOhenry | 264f35a | 2015-11-03 20:58:39 +0800 | [diff] [blame] | 117 | * Gets bridges of node. |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 118 | * |
| 119 | * @return set of bridges; empty if no bridge is find |
| 120 | */ |
| 121 | Set<OvsdbBridge> getBridges(); |
| 122 | |
| 123 | /** |
BitOhenry | 264f35a | 2015-11-03 20:58:39 +0800 | [diff] [blame] | 124 | * Gets controllers of node. |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 125 | * |
Brian O'Connor | 5251562 | 2015-10-09 17:03:44 -0700 | [diff] [blame] | 126 | * @param openflowDeviceId target device id |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 127 | * @return set of controllers; empty if no controller is find |
| 128 | */ |
| 129 | Set<ControllerInfo> getControllers(DeviceId openflowDeviceId); |
| 130 | |
| 131 | /** |
Brian O'Connor | 6ee8aa3 | 2015-10-09 16:07:42 -0700 | [diff] [blame] | 132 | * Sets the Controllers for the specified bridge. |
Brian O'Connor | 5251562 | 2015-10-09 17:03:44 -0700 | [diff] [blame] | 133 | * <p> |
Brian O'Connor | 6ee8aa3 | 2015-10-09 16:07:42 -0700 | [diff] [blame] | 134 | * This method will replace the existing controller list with the new controller |
| 135 | * list. |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 136 | * |
Brian O'Connor | 6ee8aa3 | 2015-10-09 16:07:42 -0700 | [diff] [blame] | 137 | * @param bridgeUuid bridge uuid |
| 138 | * @param controllers list of controllers |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 139 | */ |
Jonathan Hart | 51539b8 | 2015-10-29 09:53:04 -0700 | [diff] [blame] | 140 | void setControllersWithUuid(Uuid bridgeUuid, List<ControllerInfo> controllers); |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 141 | |
| 142 | /** |
Brian O'Connor | 6ee8aa3 | 2015-10-09 16:07:42 -0700 | [diff] [blame] | 143 | * Sets the Controllers for the specified device. |
Brian O'Connor | 5251562 | 2015-10-09 17:03:44 -0700 | [diff] [blame] | 144 | * <p> |
Brian O'Connor | 6ee8aa3 | 2015-10-09 16:07:42 -0700 | [diff] [blame] | 145 | * This method will replace the existing controller list with the new controller |
| 146 | * list. |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 147 | * |
Brian O'Connor | 6ee8aa3 | 2015-10-09 16:07:42 -0700 | [diff] [blame] | 148 | * @param deviceId device id (likely Openflow device) |
| 149 | * @param controllers list of controllers |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 150 | */ |
| 151 | void setControllersWithDeviceId(DeviceId deviceId, List<ControllerInfo> controllers); |
| 152 | |
| 153 | /** |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 154 | * Creates a port. |
| 155 | * |
| 156 | * @param bridgeName bridge name |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 157 | * @param portName port name |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 158 | */ |
| 159 | void createPort(String bridgeName, String portName); |
| 160 | |
| 161 | /** |
| 162 | * Drops a port. |
| 163 | * |
| 164 | * @param bridgeName bridge name |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 165 | * @param portName port name |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 166 | */ |
| 167 | void dropPort(String bridgeName, String portName); |
| 168 | |
| 169 | /** |
BitOhenry | 264f35a | 2015-11-03 20:58:39 +0800 | [diff] [blame] | 170 | * Gets ports of bridge. |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 171 | * |
| 172 | * @return set of ports; empty if no ports is find |
| 173 | */ |
| 174 | Set<OvsdbPort> getPorts(); |
| 175 | |
| 176 | /** |
| 177 | * Checks if the node is still connected. |
| 178 | * |
| 179 | * @return true if the node is still connected |
| 180 | */ |
| 181 | boolean isConnected(); |
| 182 | |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 183 | /** |
| 184 | * Gets the Bridge uuid. |
| 185 | * |
| 186 | * @param bridgeName bridge name |
| 187 | * @return bridge uuid, empty if no uuid is find |
| 188 | */ |
| 189 | String getBridgeUuid(String bridgeName); |
| 190 | |
| 191 | /** |
| 192 | * Gets the Port uuid. |
| 193 | * |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 194 | * @param portName port name |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 195 | * @param bridgeUuid bridge uuid |
| 196 | * @return port uuid, empty if no uuid is find |
| 197 | */ |
| 198 | String getPortUuid(String portName, String bridgeUuid); |
| 199 | |
| 200 | /** |
| 201 | * Gets the Interface uuid. |
| 202 | * |
| 203 | * @param portUuid port uuid |
| 204 | * @param portName port name |
| 205 | * @return interface uuid, empty if no uuid is find |
| 206 | */ |
| 207 | String getInterfaceUuid(String portUuid, String portName); |
| 208 | |
| 209 | /** |
| 210 | * Gets the Controller uuid. |
| 211 | * |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 212 | * @param controllerName controller name |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 213 | * @param controllerTarget controller target |
| 214 | * @return controller uuid, empty if no uuid is find |
| 215 | */ |
| 216 | String getControllerUuid(String controllerName, String controllerTarget); |
| 217 | |
| 218 | /** |
BitOhenry | 3f28c68 | 2015-11-07 10:40:03 +0800 | [diff] [blame] | 219 | * Gets the OVS uuid. |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 220 | * |
| 221 | * @param dbName database name |
| 222 | * @return ovs uuid, empty if no uuid is find |
| 223 | */ |
| 224 | String getOvsUuid(String dbName); |
| 225 | |
| 226 | /** |
BitOhenry | 3f28c68 | 2015-11-07 10:40:03 +0800 | [diff] [blame] | 227 | * Gets the OVSDB database schema. |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 228 | * |
| 229 | * @param dbName database name |
| 230 | * @return database schema |
| 231 | */ |
| 232 | ListenableFuture<DatabaseSchema> getOvsdbSchema(String dbName); |
| 233 | |
| 234 | /** |
BitOhenry | 3f28c68 | 2015-11-07 10:40:03 +0800 | [diff] [blame] | 235 | * Gets the OVSDB table updates. |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 236 | * |
| 237 | * @param dbName database name |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 238 | * @param id random uuid |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 239 | * @return table updates |
| 240 | */ |
| 241 | ListenableFuture<TableUpdates> monitorTables(String dbName, String id); |
| 242 | |
| 243 | /** |
BitOhenry | 3f28c68 | 2015-11-07 10:40:03 +0800 | [diff] [blame] | 244 | * Gets the OVSDB config operation result. |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 245 | * |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 246 | * @param dbName database name |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 247 | * @param operations the list of operations |
| 248 | * @return operation results |
| 249 | */ |
| 250 | ListenableFuture<List<OperationResult>> transactConfig(String dbName, |
| 251 | List<Operation> operations); |
| 252 | |
| 253 | /** |
BitOhenry | 3f28c68 | 2015-11-07 10:40:03 +0800 | [diff] [blame] | 254 | * Gets the OVSDB database schema from local. |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 255 | * |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 256 | * @param dbName database name |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 257 | * @return database schema |
| 258 | */ |
| 259 | DatabaseSchema getDatabaseSchema(String dbName); |
| 260 | |
| 261 | /** |
BitOhenry | 3f28c68 | 2015-11-07 10:40:03 +0800 | [diff] [blame] | 262 | * Gets the OVSDB row from local OVSDB store. |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 263 | * |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 264 | * @param dbName database name |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 265 | * @param tableName table name |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 266 | * @param uuid row uuid |
BitOhenry | 3f28c68 | 2015-11-07 10:40:03 +0800 | [diff] [blame] | 267 | * @return row OVSDB row |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 268 | */ |
| 269 | Row getRow(String dbName, String tableName, String uuid); |
| 270 | |
| 271 | /** |
BitOhenry | 3f28c68 | 2015-11-07 10:40:03 +0800 | [diff] [blame] | 272 | * Removes the OVSDB row from local OVSDB store. |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 273 | * |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 274 | * @param dbName database name |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 275 | * @param tableName table name |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 276 | * @param uuid row uuid |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 277 | */ |
| 278 | void removeRow(String dbName, String tableName, String uuid); |
| 279 | |
| 280 | /** |
BitOhenry | 3f28c68 | 2015-11-07 10:40:03 +0800 | [diff] [blame] | 281 | * Updates the local OVSDB store. |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 282 | * |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 283 | * @param dbName database name |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 284 | * @param tableName table name |
andrea | ed976a4 | 2015-10-05 14:38:25 -0700 | [diff] [blame] | 285 | * @param uuid row uuid |
BitOhenry | 3f28c68 | 2015-11-07 10:40:03 +0800 | [diff] [blame] | 286 | * @param row OVSDB row |
YuanyouZhang | d06bb6b | 2015-08-05 16:59:07 +0800 | [diff] [blame] | 287 | */ |
| 288 | void updateOvsdbStore(String dbName, String tableName, String uuid, Row row); |
| 289 | |
CNlucius | a66c397 | 2015-09-06 20:31:29 +0800 | [diff] [blame] | 290 | /** |
BitOhenry | 3f28c68 | 2015-11-07 10:40:03 +0800 | [diff] [blame] | 291 | * Gets OVSDB local ports. |
CNlucius | a66c397 | 2015-09-06 20:31:29 +0800 | [diff] [blame] | 292 | * |
| 293 | * @param ifaceids the ifaceid that needed |
BitOhenry | 3f28c68 | 2015-11-07 10:40:03 +0800 | [diff] [blame] | 294 | * @return OVSDB ports |
CNlucius | a66c397 | 2015-09-06 20:31:29 +0800 | [diff] [blame] | 295 | */ |
| 296 | Set<OvsdbPort> getLocalPorts(Iterable<String> ifaceids); |
Hyunsun Moon | 5fb20a5 | 2015-09-25 17:02:33 -0700 | [diff] [blame] | 297 | |
| 298 | /** |
BitOhenry | 3f28c68 | 2015-11-07 10:40:03 +0800 | [diff] [blame] | 299 | * Disconnects the OVSDB server. |
Hyunsun Moon | 5fb20a5 | 2015-09-25 17:02:33 -0700 | [diff] [blame] | 300 | */ |
| 301 | void disconnect(); |
CNlucius | 74fd494 | 2015-07-20 14:28:04 +0800 | [diff] [blame] | 302 | } |