Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2019-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.k8snetworking.api; |
| 17 | |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 18 | import org.onosproject.store.Store; |
| 19 | |
| 20 | import java.util.Set; |
| 21 | |
| 22 | /** |
| 23 | * Manages inventory of instance IPAM; not intended for direct use. |
| 24 | */ |
| 25 | public interface K8sIpamStore extends Store<K8sIpamEvent, K8sIpamStoreDelegate> { |
| 26 | |
| 27 | /** |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 28 | * Creates a new allocated IP address. |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 29 | * |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 30 | * @param ipam IPAM instance |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 31 | */ |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 32 | void createAllocatedIp(K8sIpam ipam); |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 33 | |
| 34 | /** |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 35 | * Updates the existing allocated IP address. |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 36 | * |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 37 | * @param ipam IPAM instance |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 38 | */ |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 39 | void updateAllocatedIp(K8sIpam ipam); |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 40 | |
| 41 | /** |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 42 | * Removes the existing allocated IP address. |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 43 | * |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 44 | * @param ipamId IPAM identifier |
| 45 | * @return removed IPAM instance; null if failed |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 46 | */ |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 47 | K8sIpam removeAllocatedIp(String ipamId); |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 48 | |
| 49 | /** |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 50 | * Returns the IPAM with the given IPAM identifier. |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 51 | * |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 52 | * @param ipamId IPAM identifier |
| 53 | * @return IPAM; null it not found |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 54 | */ |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 55 | K8sIpam allocatedIp(String ipamId); |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 56 | |
| 57 | /** |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 58 | * Returns all allocated IPAM instances. |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 59 | * |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 60 | * @return set of IPAM instances |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 61 | */ |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 62 | Set<K8sIpam> allocatedIps(); |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 63 | |
| 64 | /** |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 65 | * Creates a new available IP address. |
| 66 | * |
| 67 | * @param ipam IPAM instance |
| 68 | */ |
| 69 | void createAvailableIp(K8sIpam ipam); |
| 70 | |
| 71 | /** |
| 72 | * Updates the existing available IP address. |
| 73 | * |
| 74 | * @param ipam IPAM instance |
| 75 | */ |
| 76 | void updateAvailableIp(K8sIpam ipam); |
| 77 | |
| 78 | /** |
| 79 | * Removes the existing available IP address. |
| 80 | * |
| 81 | * @param ipamId IPAM identifier |
| 82 | * @return remved IPAM instance; null if failed |
| 83 | */ |
| 84 | K8sIpam removeAvailableIp(String ipamId); |
| 85 | |
| 86 | /** |
| 87 | * Returns the IPAM with the given IPAM identifier. |
| 88 | * |
| 89 | * @param ipamId IPAM identifier |
| 90 | * @return IPAM; null it not found |
| 91 | */ |
| 92 | K8sIpam availableIp(String ipamId); |
| 93 | |
| 94 | /** |
| 95 | * Returns all available IPAM instances. |
| 96 | * |
| 97 | * @return set of IPAM instances |
| 98 | */ |
| 99 | Set<K8sIpam> availableIps(); |
| 100 | |
| 101 | /** |
| 102 | * Clears all allocated and available IP addresses. |
| 103 | */ |
| 104 | void clear(); |
| 105 | |
| 106 | /** |
| 107 | * Clears allocated and available IP addresses associated with the given network. |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 108 | * |
| 109 | * @param networkId network identifier |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 110 | */ |
Jian Li | 9b19916 | 2019-02-10 18:00:35 +0900 | [diff] [blame^] | 111 | void clear(String networkId); |
Jian Li | fc55e42 | 2019-01-21 14:39:34 +0900 | [diff] [blame] | 112 | } |