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 | |
| 18 | import java.util.List; |
| 19 | |
| 20 | /** |
| 21 | * Service for provisioning overlay virtual networks on compute nodes. |
| 22 | */ |
| 23 | public interface CordVtnService { |
Hyunsun Moon | 9661d64 | 2015-09-23 13:24:35 -0700 | [diff] [blame] | 24 | |
| 25 | String CORDVTN_APP_ID = "org.onosproject.cordvtn"; |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 26 | /** |
Hyunsun Moon | e9d7599 | 2015-09-15 22:39:16 -0700 | [diff] [blame] | 27 | * Adds a new node to the service. |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 28 | * |
Hyunsun Moon | 4edb017 | 2015-11-07 22:08:43 -0800 | [diff] [blame] | 29 | * @param node cordvtn node |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 30 | */ |
Hyunsun Moon | 4edb017 | 2015-11-07 22:08:43 -0800 | [diff] [blame] | 31 | void addNode(CordVtnNode node); |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 32 | |
| 33 | /** |
Hyunsun Moon | 9661d64 | 2015-09-23 13:24:35 -0700 | [diff] [blame] | 34 | * Deletes a node from the service. |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 35 | * |
Hyunsun Moon | 4edb017 | 2015-11-07 22:08:43 -0800 | [diff] [blame] | 36 | * @param node cordvtn node |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 37 | */ |
Hyunsun Moon | 4edb017 | 2015-11-07 22:08:43 -0800 | [diff] [blame] | 38 | void deleteNode(CordVtnNode node); |
Hyunsun Moon | 9661d64 | 2015-09-23 13:24:35 -0700 | [diff] [blame] | 39 | |
| 40 | /** |
Hyunsun Moon | 4edb017 | 2015-11-07 22:08:43 -0800 | [diff] [blame] | 41 | * Initiates node to serve virtual tenant network. |
Hyunsun Moon | 9661d64 | 2015-09-23 13:24:35 -0700 | [diff] [blame] | 42 | * |
Hyunsun Moon | 4edb017 | 2015-11-07 22:08:43 -0800 | [diff] [blame] | 43 | * @param node cordvtn node |
Hyunsun Moon | 9661d64 | 2015-09-23 13:24:35 -0700 | [diff] [blame] | 44 | */ |
Hyunsun Moon | 4edb017 | 2015-11-07 22:08:43 -0800 | [diff] [blame] | 45 | void initNode(CordVtnNode node); |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 46 | |
| 47 | /** |
| 48 | * Returns the number of the nodes known to the service. |
| 49 | * |
| 50 | * @return number of nodes |
| 51 | */ |
| 52 | int getNodeCount(); |
| 53 | |
| 54 | /** |
Hyunsun Moon | 4edb017 | 2015-11-07 22:08:43 -0800 | [diff] [blame] | 55 | * Returns node initialization state. |
Hyunsun Moon | 9661d64 | 2015-09-23 13:24:35 -0700 | [diff] [blame] | 56 | * |
Hyunsun Moon | 4edb017 | 2015-11-07 22:08:43 -0800 | [diff] [blame] | 57 | * @param node cordvtn node |
| 58 | * @return true if initial node setup is completed, otherwise false |
Hyunsun Moon | 9661d64 | 2015-09-23 13:24:35 -0700 | [diff] [blame] | 59 | */ |
Hyunsun Moon | 4edb017 | 2015-11-07 22:08:43 -0800 | [diff] [blame] | 60 | boolean getNodeInitState(CordVtnNode node); |
Hyunsun Moon | 7dca9b3 | 2015-10-08 22:25:30 -0700 | [diff] [blame] | 61 | |
| 62 | /** |
Hyunsun Moon | de37257 | 2016-01-14 03:42:47 -0800 | [diff] [blame] | 63 | * Returns detailed node initialization state. |
| 64 | * Return string includes the following information. |
| 65 | * |
| 66 | * Integration bridge created/connected: OK or NO |
| 67 | * VXLAN interface created: OK or NO |
| 68 | * Physical interface added: OK or NO |
| 69 | * |
| 70 | * @param node cordvtn node |
| 71 | * @return string including detailed node init state |
| 72 | */ |
| 73 | String checkNodeInitState(CordVtnNode node); |
| 74 | |
| 75 | /** |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 76 | * Returns all nodes known to the service. |
| 77 | * |
| 78 | * @return list of nodes |
| 79 | */ |
Hyunsun Moon | 4edb017 | 2015-11-07 22:08:43 -0800 | [diff] [blame] | 80 | List<CordVtnNode> getNodes(); |
Hyunsun Moon | 9274aaf | 2015-12-04 11:35:25 -0800 | [diff] [blame] | 81 | |
| 82 | /** |
Hyunsun Moon | 97eaf50 | 2015-12-07 14:06:28 -0800 | [diff] [blame] | 83 | * Creates dependencies for a given tenant service. |
Hyunsun Moon | 9274aaf | 2015-12-04 11:35:25 -0800 | [diff] [blame] | 84 | * |
Hyunsun Moon | ba29007 | 2015-12-16 20:53:23 -0800 | [diff] [blame] | 85 | * @param tServiceId id of the service which has a dependency |
| 86 | * @param pServiceId id of the service which provide dependency |
Hyunsun Moon | 9274aaf | 2015-12-04 11:35:25 -0800 | [diff] [blame] | 87 | */ |
Hyunsun Moon | ba29007 | 2015-12-16 20:53:23 -0800 | [diff] [blame] | 88 | void createServiceDependency(CordServiceId tServiceId, CordServiceId pServiceId); |
Hyunsun Moon | 9274aaf | 2015-12-04 11:35:25 -0800 | [diff] [blame] | 89 | |
| 90 | /** |
Hyunsun Moon | 97eaf50 | 2015-12-07 14:06:28 -0800 | [diff] [blame] | 91 | * Removes all dependencies from a given tenant service. |
Hyunsun Moon | 9274aaf | 2015-12-04 11:35:25 -0800 | [diff] [blame] | 92 | * |
Hyunsun Moon | ba29007 | 2015-12-16 20:53:23 -0800 | [diff] [blame] | 93 | * @param tServiceId id of the service which has a dependency |
| 94 | * @param pServiceId id of the service which provide dependency |
Hyunsun Moon | 9274aaf | 2015-12-04 11:35:25 -0800 | [diff] [blame] | 95 | */ |
Hyunsun Moon | ba29007 | 2015-12-16 20:53:23 -0800 | [diff] [blame] | 96 | void removeServiceDependency(CordServiceId tServiceId, CordServiceId pServiceId); |
Hyunsun Moon | 950f639 | 2015-09-10 17:54:10 -0700 | [diff] [blame] | 97 | } |