Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014-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.cordvtn; |
| 17 | |
Hyunsun Moon | 9661d64 | 2015-09-23 13:24:35 -0700 | [diff] [blame] | 18 | import org.onosproject.net.DeviceId; |
Hyunsun Moon | e9d7599 | 2015-09-15 22:39:16 -0700 | [diff] [blame] | 19 | |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 20 | import java.util.List; |
| 21 | |
| 22 | /** |
| 23 | * Service for provisioning overlay virtual networks on compute nodes. |
| 24 | */ |
| 25 | public interface CordVtnService { |
Hyunsun Moon | 9661d64 | 2015-09-23 13:24:35 -0700 | [diff] [blame] | 26 | |
| 27 | String CORDVTN_APP_ID = "org.onosproject.cordvtn"; |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 28 | /** |
Hyunsun Moon | e9d7599 | 2015-09-15 22:39:16 -0700 | [diff] [blame] | 29 | * Adds a new node to the service. |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 30 | * |
Hyunsun Moon | 7dca9b3 | 2015-10-08 22:25:30 -0700 | [diff] [blame] | 31 | * @param ovsdb ovsdb node |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 32 | */ |
Hyunsun Moon | 7dca9b3 | 2015-10-08 22:25:30 -0700 | [diff] [blame] | 33 | void addNode(OvsdbNode ovsdb); |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 34 | |
| 35 | /** |
Hyunsun Moon | 9661d64 | 2015-09-23 13:24:35 -0700 | [diff] [blame] | 36 | * Deletes a node from the service. |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 37 | * |
Hyunsun Moon | 7dca9b3 | 2015-10-08 22:25:30 -0700 | [diff] [blame] | 38 | * @param ovsdb ovsdb node |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 39 | */ |
Hyunsun Moon | 7dca9b3 | 2015-10-08 22:25:30 -0700 | [diff] [blame] | 40 | void deleteNode(OvsdbNode ovsdb); |
Hyunsun Moon | 9661d64 | 2015-09-23 13:24:35 -0700 | [diff] [blame] | 41 | |
| 42 | /** |
Hyunsun Moon | 7dca9b3 | 2015-10-08 22:25:30 -0700 | [diff] [blame] | 43 | * Connect to a node. |
Hyunsun Moon | 9661d64 | 2015-09-23 13:24:35 -0700 | [diff] [blame] | 44 | * |
Hyunsun Moon | 7dca9b3 | 2015-10-08 22:25:30 -0700 | [diff] [blame] | 45 | * @param ovsdb ovsdb node |
Hyunsun Moon | 9661d64 | 2015-09-23 13:24:35 -0700 | [diff] [blame] | 46 | */ |
Hyunsun Moon | 7dca9b3 | 2015-10-08 22:25:30 -0700 | [diff] [blame] | 47 | void connect(OvsdbNode ovsdb); |
| 48 | |
| 49 | /** |
| 50 | * Disconnect a node. |
| 51 | * |
| 52 | * @param ovsdb ovsdb node |
| 53 | */ |
| 54 | void disconnect(OvsdbNode ovsdb); |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 55 | |
| 56 | /** |
| 57 | * Returns the number of the nodes known to the service. |
| 58 | * |
| 59 | * @return number of nodes |
| 60 | */ |
| 61 | int getNodeCount(); |
| 62 | |
| 63 | /** |
Hyunsun Moon | 9661d64 | 2015-09-23 13:24:35 -0700 | [diff] [blame] | 64 | * Returns OvsdbNode with given device id. |
| 65 | * |
| 66 | * @param deviceId device id |
| 67 | * @return ovsdb node |
| 68 | */ |
| 69 | OvsdbNode getNode(DeviceId deviceId); |
| 70 | |
| 71 | /** |
Hyunsun Moon | 7dca9b3 | 2015-10-08 22:25:30 -0700 | [diff] [blame] | 72 | * Returns connection state of the node. |
| 73 | * |
| 74 | * @param ovsdb ovsdb node |
| 75 | * @return true if the node is connected, false otherwise |
| 76 | */ |
| 77 | boolean isNodeConnected(OvsdbNode ovsdb); |
| 78 | |
| 79 | /** |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 80 | * Returns all nodes known to the service. |
| 81 | * |
| 82 | * @return list of nodes |
| 83 | */ |
| 84 | List<OvsdbNode> getNodes(); |
| 85 | } |