Jian Li | 70c32de | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2021-present Open Networking Foundation |
| 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.kubevirtnetworking.api; |
| 17 | |
| 18 | import org.onosproject.event.ListenerService; |
| 19 | |
| 20 | import java.util.Set; |
| 21 | |
| 22 | /** |
| 23 | * Service for interacting with the inventory of kubevirt router. |
| 24 | */ |
| 25 | public interface KubevirtRouterService |
| 26 | extends ListenerService<KubevirtRouterEvent, KubevirtRouterListener> { |
| 27 | |
| 28 | /** |
| 29 | * Returns the kubevirt router with the supplied router name. |
| 30 | * |
| 31 | * @param name router name |
| 32 | * @return kubevirt router |
| 33 | */ |
| 34 | KubevirtRouter router(String name); |
| 35 | |
| 36 | /** |
| 37 | * Returns all kubevirt routers registered in the service. |
| 38 | * |
| 39 | * @return set of kubevirt routers |
| 40 | */ |
| 41 | Set<KubevirtRouter> routers(); |
Jian Li | e48a617 | 2021-02-28 03:50:15 +0900 | [diff] [blame] | 42 | |
| 43 | /** |
| 44 | * Returns the kubevirt floating IP with the supplied identifier. |
| 45 | * |
| 46 | * @param id floating IP identifier |
| 47 | * @return kubevirt floating IP |
| 48 | */ |
| 49 | KubevirtFloatingIp floatingIp(String id); |
| 50 | |
| 51 | /** |
| 52 | * Returns the kubevirt floating IP associated with the supplied POD. |
| 53 | * |
| 54 | * @param podName name of POD |
| 55 | * @return kubevirt floating IP |
| 56 | */ |
| 57 | KubevirtFloatingIp floatingIpByPodName(String podName); |
| 58 | |
| 59 | /** |
| 60 | * Returns the kubevirt floating IPs bound to the given router. |
| 61 | * |
| 62 | * @param routerName name of router |
| 63 | * @return set of kubevirt floating IPs |
| 64 | */ |
| 65 | Set<KubevirtFloatingIp> floatingIpsByRouter(String routerName); |
| 66 | |
| 67 | /** |
| 68 | * Returns all kubevirt floating IPs. |
| 69 | * |
| 70 | * @return set of kubevirt floating IPs |
| 71 | */ |
| 72 | Set<KubevirtFloatingIp> floatingIps(); |
Jian Li | 70c32de | 2021-02-26 18:15:20 +0900 | [diff] [blame] | 73 | } |