Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 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.openstacknode; |
| 17 | |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 18 | import org.onlab.packet.IpAddress; |
Hyunsun Moon | 05d9b26 | 2016-07-03 18:38:44 -0700 | [diff] [blame] | 19 | import org.onosproject.event.ListenerService; |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 20 | import org.onosproject.net.DeviceId; |
| 21 | import org.onosproject.net.PortNumber; |
| 22 | |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 23 | import java.util.List; |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 24 | import java.util.Optional; |
| 25 | import java.util.Set; |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 26 | |
| 27 | /** |
| 28 | * Handles the bootstrap request for compute/gateway node. |
| 29 | */ |
Hyunsun Moon | 05d9b26 | 2016-07-03 18:38:44 -0700 | [diff] [blame] | 30 | public interface OpenstackNodeService |
| 31 | extends ListenerService<OpenstackNodeEvent, OpenstackNodeListener> { |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 32 | |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 33 | enum NodeType { |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 34 | /** |
| 35 | * Compute or Gateway Node. |
| 36 | */ |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 37 | COMPUTE, |
| 38 | GATEWAY |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 39 | } |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 40 | |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 41 | /** |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 42 | * Adds or updates a new node to the service. |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 43 | * |
| 44 | * @param node openstack node |
| 45 | */ |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 46 | void addOrUpdateNode(OpenstackNode node); |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 47 | |
| 48 | /** |
Hyunsun Moon | 05d9b26 | 2016-07-03 18:38:44 -0700 | [diff] [blame] | 49 | * Bootstraps node with INIT state. |
| 50 | * |
| 51 | * @param node openstack node |
| 52 | */ |
| 53 | void processInitState(OpenstackNode node); |
| 54 | |
| 55 | /** |
| 56 | * Bootstraps node with DEVICE_CREATED state. |
| 57 | * |
| 58 | * @param node openstack node |
| 59 | */ |
| 60 | void processDeviceCreatedState(OpenstackNode node); |
| 61 | |
| 62 | /** |
| 63 | * Bootstraps node with COMPLETE state. |
| 64 | * |
| 65 | * @param node openstack node |
| 66 | */ |
| 67 | void processCompleteState(OpenstackNode node); |
| 68 | |
| 69 | /** |
| 70 | * Bootstraps node with INCOMPLETE state. |
| 71 | * |
| 72 | * @param node openstack node |
| 73 | */ |
| 74 | void processIncompleteState(OpenstackNode node); |
| 75 | |
| 76 | /** |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 77 | * Deletes a node from the service. |
| 78 | * |
| 79 | * @param node openstack node |
| 80 | */ |
| 81 | void deleteNode(OpenstackNode node); |
| 82 | |
| 83 | /** |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 84 | * Returns all nodes known to the service. |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 85 | * |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 86 | * @return list of nodes |
| 87 | */ |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 88 | List<OpenstackNode> nodes(); |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 89 | |
| 90 | /** |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 91 | * Returns all nodes in complete state. |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 92 | * |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 93 | * @return set of nodes |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 94 | */ |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 95 | Set<OpenstackNode> completeNodes(); |
| 96 | |
| 97 | /** |
Hyunsun Moon | 34bbe17 | 2016-06-28 19:18:40 -0700 | [diff] [blame] | 98 | * Returns data network IP address of a given integration bridge device. |
| 99 | * |
| 100 | * @param intBridgeId integration bridge device id |
| 101 | * @return ip address; empty value otherwise |
| 102 | */ |
| 103 | Optional<IpAddress> dataIp(DeviceId intBridgeId); |
| 104 | |
| 105 | /** |
| 106 | * Returns tunnel port number of a given integration bridge device. |
| 107 | * |
| 108 | * @param intBridgeId integration bridge device id |
| 109 | * @return port number; or empty value |
| 110 | */ |
| 111 | Optional<PortNumber> tunnelPort(DeviceId intBridgeId); |
| 112 | |
| 113 | /** |
| 114 | * Returns router bridge device ID connected to a given integration bridge. |
| 115 | * It returns valid value only if the node type is GATEWAY. |
| 116 | * |
| 117 | * @param intBridgeId device id of the integration bridge |
| 118 | * @return device id of a router bridge; or empty value |
| 119 | */ |
| 120 | Optional<DeviceId> routerBridge(DeviceId intBridgeId); |
| 121 | |
| 122 | /** |
| 123 | * Returns port number connected to the router bridge. |
| 124 | * It returns valid value only if the node type is GATEWAY. |
| 125 | * |
| 126 | * @param intBridgeId integration bridge device id |
| 127 | * @return port number; or empty value |
| 128 | */ |
| 129 | Optional<PortNumber> externalPort(DeviceId intBridgeId); |
Daniel Park | a7d6e9f | 2016-01-18 17:54:14 +0900 | [diff] [blame] | 130 | } |