alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [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 | */ |
alshabib | 10c810b | 2015-08-18 16:59:04 -0700 | [diff] [blame] | 16 | package org.onosproject.net.meter; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 17 | |
Daniele Moro | 43ac289 | 2021-07-15 17:02:59 +0200 | [diff] [blame] | 18 | import org.onosproject.core.ApplicationId; |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 19 | import org.onosproject.net.DeviceId; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 20 | import org.onosproject.store.Store; |
| 21 | |
| 22 | import java.util.Collection; |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 23 | import java.util.concurrent.CompletableFuture; |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 24 | |
| 25 | /** |
| 26 | * Entity that stores and distributed meter objects. |
| 27 | */ |
| 28 | public interface MeterStore extends Store<MeterEvent, MeterStoreDelegate> { |
| 29 | |
| 30 | /** |
Wailok Shum | 6a24935 | 2021-07-29 00:02:56 +0800 | [diff] [blame] | 31 | * Adds a meter to the store or updates a meter in the store. |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 32 | * |
| 33 | * @param meter a meter |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 34 | * @return a future indicating the result of the store operation |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 35 | */ |
Wailok Shum | 6a24935 | 2021-07-29 00:02:56 +0800 | [diff] [blame] | 36 | CompletableFuture<MeterStoreResult> addOrUpdateMeter(Meter meter); |
| 37 | |
| 38 | /** |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 39 | * Deletes a meter from the store. |
| 40 | * |
| 41 | * @param meter a meter |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 42 | * @return a future indicating the result of the store operation |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 43 | */ |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 44 | CompletableFuture<MeterStoreResult> deleteMeter(Meter meter); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 45 | |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 46 | /** |
| 47 | * Adds the meter features to the store. |
| 48 | * |
| 49 | * @param meterfeatures the meter features |
| 50 | * @return the result of the store operation |
| 51 | */ |
| 52 | MeterStoreResult storeMeterFeatures(MeterFeatures meterfeatures); |
| 53 | |
| 54 | /** |
Wailok Shum | 6a24935 | 2021-07-29 00:02:56 +0800 | [diff] [blame] | 55 | * Adds a collection of meter features to the store. |
| 56 | * |
| 57 | * @param meterfeatures the collection of meter features |
| 58 | * @return the result of the store operation |
| 59 | */ |
| 60 | MeterStoreResult storeMeterFeatures(Collection<MeterFeatures> meterfeatures); |
| 61 | |
| 62 | /** |
Jordi Ortiz | aa8de49 | 2016-12-01 00:21:36 +0100 | [diff] [blame] | 63 | * Deletes the meter features from the store. |
| 64 | * |
| 65 | * @param deviceId the device id |
| 66 | * @return a future indicating the result of the store operation |
| 67 | */ |
| 68 | MeterStoreResult deleteMeterFeatures(DeviceId deviceId); |
| 69 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 70 | /** |
Wailok Shum | 6a24935 | 2021-07-29 00:02:56 +0800 | [diff] [blame] | 71 | * Deletes a collection of meter features from the store. |
| 72 | * |
| 73 | * @param meterfeatures a collection of meter features |
| 74 | * @return a future indicating the result of the store operation |
| 75 | */ |
| 76 | MeterStoreResult deleteMeterFeatures(Collection<MeterFeatures> meterfeatures); |
| 77 | |
| 78 | /** |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 79 | * Updates a given meter's state with the provided state. |
alshabib | eadfc8e | 2015-08-18 15:40:46 -0700 | [diff] [blame] | 80 | * |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 81 | * @param meter a meter |
pierventre | 4422005 | 2020-09-22 12:51:06 +0200 | [diff] [blame] | 82 | * @return the updated meter |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 83 | */ |
pierventre | 4422005 | 2020-09-22 12:51:06 +0200 | [diff] [blame] | 84 | Meter updateMeterState(Meter meter); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 85 | |
| 86 | /** |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 87 | * Obtains a meter matching the given meter key. |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 88 | * |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 89 | * @param key a meter key |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 90 | * @return a meter |
| 91 | */ |
alshabib | 70aaa1b | 2015-09-25 14:30:59 -0700 | [diff] [blame] | 92 | Meter getMeter(MeterKey key); |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 93 | |
| 94 | /** |
| 95 | * Returns all meters stored in the store. |
| 96 | * |
pierventre | 4422005 | 2020-09-22 12:51:06 +0200 | [diff] [blame] | 97 | * @return an immutable copy of all meters |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 98 | */ |
| 99 | Collection<Meter> getAllMeters(); |
| 100 | |
| 101 | /** |
Jordi Ortiz | 9287b63 | 2017-06-22 11:01:37 +0200 | [diff] [blame] | 102 | * Returns all meters stored in the store for a |
| 103 | * precise device. |
| 104 | * |
| 105 | * @param deviceId the device to get the meter list from |
pierventre | 4422005 | 2020-09-22 12:51:06 +0200 | [diff] [blame] | 106 | * @return an immutable copy of the meters stored for a given device |
Jordi Ortiz | 9287b63 | 2017-06-22 11:01:37 +0200 | [diff] [blame] | 107 | */ |
| 108 | Collection<Meter> getAllMeters(DeviceId deviceId); |
| 109 | |
| 110 | /** |
pierventre | c0914ec | 2021-08-27 15:25:02 +0200 | [diff] [blame] | 111 | * Returns all meters stored in the store for a |
| 112 | * precise device and scope. |
| 113 | * |
| 114 | * @param deviceId a device id |
| 115 | * @param scope meters scope |
| 116 | * @return an immutable copy of the meters stored for a given device |
| 117 | * withing a given scope |
| 118 | */ |
| 119 | Collection<Meter> getAllMeters(DeviceId deviceId, MeterScope scope); |
| 120 | |
| 121 | /** |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 122 | * Update the store by deleting the failed meter. |
| 123 | * Notifies the delegate that the meter failed to allow it |
| 124 | * to nofity the app. |
| 125 | * |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 126 | * @param op a failed meter operation |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 127 | * @param reason a failure reason |
| 128 | */ |
| 129 | void failedMeter(MeterOperation op, MeterFailReason reason); |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 130 | |
| 131 | /** |
| 132 | * Delete this meter immediately. |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 133 | * |
alshabib | 5eb7939 | 2015-08-19 18:09:55 -0700 | [diff] [blame] | 134 | * @param m a meter |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 135 | */ |
| 136 | void purgeMeter(Meter m); |
| 137 | |
| 138 | /** |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 139 | * Allocates the first available MeterId. |
| 140 | * |
| 141 | * @param deviceId the device id |
| 142 | * @param meterScope the meter scope |
| 143 | * @return the meter Id or null if it was not possible |
| 144 | * to allocate a meter id |
| 145 | */ |
| 146 | MeterCellId allocateMeterId(DeviceId deviceId, MeterScope meterScope); |
| 147 | |
| 148 | /** |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 149 | * Frees the given meter id. |
| 150 | * |
| 151 | * @param deviceId the device id |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 152 | * @param meterId the id to be freed |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 153 | * @deprecated in onos-2.5, freeing an ID is closely related to removal of a meter |
| 154 | * so, this function is no longer exposed on interface |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 155 | */ |
Wailok Shum | f013a78 | 2021-07-26 16:51:01 +0800 | [diff] [blame] | 156 | @Deprecated |
Pier Luigi | f094c61 | 2017-10-14 12:15:02 +0200 | [diff] [blame] | 157 | void freeMeterId(DeviceId deviceId, MeterId meterId); |
Jordi Ortiz | 6c84776 | 2017-01-30 17:13:05 +0100 | [diff] [blame] | 158 | |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 159 | /** |
| 160 | * Removes all meters of given device from store. |
Daniele Moro | 43ac289 | 2021-07-15 17:02:59 +0200 | [diff] [blame] | 161 | * This API is typically used when the device is offline. |
Gamze Abaka | f57ef60 | 2019-03-11 06:52:48 +0000 | [diff] [blame] | 162 | * |
| 163 | * @param deviceId the device id |
pierventre | 3b39bd8 | 2021-08-18 09:40:14 +0200 | [diff] [blame] | 164 | */ |
| 165 | void purgeMeters(DeviceId deviceId); |
| 166 | |
| 167 | /** |
Daniele Moro | 43ac289 | 2021-07-15 17:02:59 +0200 | [diff] [blame] | 168 | * Removes all meters of given device and for the given application from store. |
| 169 | * This API is typically used when the device is offline. |
| 170 | * |
| 171 | * @param deviceId the device id |
| 172 | * @param appId the application id |
| 173 | */ |
| 174 | void purgeMeters(DeviceId deviceId, ApplicationId appId); |
| 175 | |
pierventre | 3b39bd8 | 2021-08-18 09:40:14 +0200 | [diff] [blame] | 176 | /** |
| 177 | * Enables/disables user defined index mode for the store. In this mode users |
| 178 | * can provide an index for the meter. Store may reject switching mode requests |
| 179 | * at run time if meters were already allocated. |
| 180 | * |
| 181 | * @param enable to enable/disable the user defined index mode. |
| 182 | * @return true if user defined index mode is enabled. False otherwise. |
| 183 | */ |
| 184 | boolean userDefinedIndexMode(boolean enable); |
| 185 | |
alshabib | 7bb0501 | 2015-08-05 10:15:09 -0700 | [diff] [blame] | 186 | } |