Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -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 | */ |
| 16 | |
| 17 | package org.onosproject.store.primitives; |
| 18 | |
| 19 | import com.google.common.base.Throwables; |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 20 | import org.onosproject.store.service.AsyncConsistentTreeMap; |
Jordan Halterman | dae1160 | 2018-07-03 00:00:47 -0700 | [diff] [blame] | 21 | import org.onosproject.store.service.AsyncIterator; |
Ray Milkey | 6a51cb9 | 2018-03-06 09:03:03 -0800 | [diff] [blame] | 22 | import org.onosproject.store.service.ConsistentMapException; |
| 23 | import org.onosproject.store.service.ConsistentTreeMap; |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 24 | import org.onosproject.store.service.MapEventListener; |
| 25 | import org.onosproject.store.service.Synchronous; |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 26 | import org.onosproject.store.service.Versioned; |
| 27 | |
| 28 | import java.util.Collection; |
Jordan Halterman | dae1160 | 2018-07-03 00:00:47 -0700 | [diff] [blame] | 29 | import java.util.Iterator; |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 30 | import java.util.Map; |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 31 | import java.util.NavigableMap; |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 32 | import java.util.NavigableSet; |
| 33 | import java.util.Set; |
| 34 | import java.util.concurrent.CompletableFuture; |
| 35 | import java.util.concurrent.ExecutionException; |
Madan Jampani | 0463cf9 | 2016-05-04 14:46:08 -0700 | [diff] [blame] | 36 | import java.util.concurrent.Executor; |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 37 | import java.util.concurrent.TimeUnit; |
| 38 | import java.util.concurrent.TimeoutException; |
| 39 | import java.util.function.BiFunction; |
| 40 | import java.util.function.Function; |
| 41 | import java.util.function.Predicate; |
| 42 | |
| 43 | /** |
| 44 | * Implementation of the {@link ConsistentTreeMap} interface. |
| 45 | */ |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 46 | public class DefaultConsistentTreeMap<V> |
| 47 | extends Synchronous<AsyncConsistentTreeMap<V>> |
| 48 | implements ConsistentTreeMap<V> { |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 49 | private final AsyncConsistentTreeMap<V> treeMap; |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 50 | private final long operationTimeoutMillis; |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 51 | private Map<String, V> javaMap; |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 52 | |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 53 | public DefaultConsistentTreeMap(AsyncConsistentTreeMap<V> treeMap, |
| 54 | long operationTimeoutMillis) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 55 | super(treeMap); |
| 56 | this.treeMap = treeMap; |
| 57 | this.operationTimeoutMillis = operationTimeoutMillis; |
| 58 | } |
| 59 | |
| 60 | private <T> T complete(CompletableFuture<T> future) { |
| 61 | try { |
| 62 | return future.get(operationTimeoutMillis, TimeUnit.MILLISECONDS); |
| 63 | } catch (InterruptedException e) { |
| 64 | Thread.currentThread().interrupt(); |
| 65 | throw new ConsistentMapException.Interrupted(); |
| 66 | } catch (ExecutionException e) { |
Ray Milkey | 6a51cb9 | 2018-03-06 09:03:03 -0800 | [diff] [blame] | 67 | Throwables.throwIfUnchecked(e.getCause()); |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 68 | throw new ConsistentMapException(e.getCause()); |
Yuta HIGUCHI | f13b3df | 2016-07-25 12:13:22 -0700 | [diff] [blame] | 69 | } catch (TimeoutException e) { |
| 70 | throw new ConsistentMapException.Timeout(); |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 71 | } |
| 72 | } |
| 73 | |
| 74 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 75 | public String firstKey() { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 76 | return complete(treeMap.firstKey()); |
| 77 | } |
| 78 | |
| 79 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 80 | public String lastKey() { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 81 | return complete(treeMap.lastKey()); |
| 82 | } |
| 83 | |
| 84 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 85 | public Map.Entry<String, Versioned<V>> ceilingEntry(String key) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 86 | return complete(treeMap.ceilingEntry(key)); |
| 87 | } |
| 88 | |
| 89 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 90 | public Map.Entry<String, Versioned<V>> floorEntry(String key) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 91 | return complete(treeMap.floorEntry(key)); |
| 92 | } |
| 93 | |
| 94 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 95 | public Map.Entry<String, Versioned<V>> higherEntry(String key) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 96 | return complete(treeMap.higherEntry(key)); |
| 97 | } |
| 98 | |
| 99 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 100 | public Map.Entry<String, Versioned<V>> lowerEntry(String key) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 101 | return complete(treeMap.lowerEntry(key)); |
| 102 | } |
| 103 | |
| 104 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 105 | public Map.Entry<String, Versioned<V>> firstEntry() { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 106 | return complete(treeMap.firstEntry()); |
| 107 | } |
| 108 | |
| 109 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 110 | public Map.Entry<String, Versioned<V>> lastEntry() { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 111 | return complete(treeMap.lastEntry()); |
| 112 | } |
| 113 | |
| 114 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 115 | public Map.Entry<String, Versioned<V>> pollFirstEntry() { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 116 | return complete(treeMap.pollFirstEntry()); |
| 117 | } |
| 118 | |
| 119 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 120 | public Map.Entry<String, Versioned<V>> pollLastEntry() { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 121 | return complete(treeMap.pollLastEntry()); |
| 122 | } |
| 123 | |
| 124 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 125 | public String lowerKey(String key) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 126 | return complete(treeMap.lowerKey(key)); |
| 127 | } |
| 128 | |
| 129 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 130 | public String floorKey(String key) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 131 | return complete(treeMap.floorKey(key)); |
| 132 | } |
| 133 | |
| 134 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 135 | public String ceilingKey(String key) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 136 | return complete(treeMap.ceilingKey(key)); |
| 137 | } |
| 138 | |
| 139 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 140 | public String higherKey(String key) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 141 | return complete(treeMap.higherKey(key)); |
| 142 | } |
| 143 | |
| 144 | |
| 145 | @Override |
| 146 | /** |
| 147 | * {@inheritDoc} |
| 148 | * <p>This may be a long operation with greater risk of timeout.</p> |
| 149 | */ |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 150 | public NavigableSet<String> navigableKeySet() { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 151 | return complete(treeMap.navigableKeySet()); |
| 152 | } |
| 153 | |
| 154 | @Override |
| 155 | public int size() { |
| 156 | return complete(treeMap.size()); |
| 157 | } |
| 158 | |
| 159 | @Override |
| 160 | public boolean isEmpty() { |
| 161 | return complete(treeMap.isEmpty()); |
| 162 | } |
| 163 | |
| 164 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 165 | public boolean containsKey(String key) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 166 | return complete(treeMap.containsKey(key)); |
| 167 | } |
| 168 | |
| 169 | @Override |
| 170 | public boolean containsValue(V value) { |
| 171 | return complete(treeMap.containsValue(value)); |
| 172 | } |
| 173 | |
| 174 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 175 | public Versioned<V> get(String key) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 176 | return complete(treeMap.get(key)); |
| 177 | } |
| 178 | |
| 179 | @Override |
Jordan Halterman | f627244 | 2017-04-20 02:18:08 -0700 | [diff] [blame] | 180 | public Versioned<V> getOrDefault(String key, V defaultValue) { |
| 181 | return complete(treeMap.getOrDefault(key, defaultValue)); |
| 182 | } |
| 183 | |
| 184 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 185 | public Versioned<V> computeIfAbsent(String key, |
| 186 | Function<? super String, |
| 187 | ? extends V> mappingFunction) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 188 | return complete(treeMap.computeIfAbsent(key, mappingFunction)); |
| 189 | } |
| 190 | |
| 191 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 192 | public Versioned<V> compute(String key, |
| 193 | BiFunction<? super String, |
| 194 | ? super V, |
| 195 | ? extends V> remappingFunction) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 196 | return complete(treeMap.compute(key, remappingFunction)); |
| 197 | } |
| 198 | |
| 199 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 200 | public Versioned<V> computeIfPresent( |
| 201 | String key, |
| 202 | BiFunction<? super String, |
| 203 | ? super V, |
| 204 | ? extends V> remappingFunction) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 205 | return complete(treeMap.computeIfPresent(key, remappingFunction)); |
| 206 | } |
| 207 | |
| 208 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 209 | public Versioned<V> computeIf(String key, Predicate<? super V> condition, |
| 210 | BiFunction<? super String, |
| 211 | ? super V, |
| 212 | ? extends V> remappingFunction) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 213 | return complete(treeMap.computeIf(key, condition, remappingFunction)); |
| 214 | } |
| 215 | |
| 216 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 217 | public Versioned<V> put(String key, V value) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 218 | return complete(treeMap.put(key, value)); |
| 219 | } |
| 220 | |
| 221 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 222 | public Versioned<V> putAndGet(String key, V value) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 223 | return complete(treeMap.putAndGet(key, value)); |
| 224 | } |
| 225 | |
| 226 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 227 | public Versioned<V> remove(String key) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 228 | return complete(treeMap.remove(key)); |
| 229 | } |
| 230 | |
| 231 | @Override |
| 232 | public void clear() { |
| 233 | complete(treeMap.clear()); |
| 234 | } |
| 235 | |
| 236 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 237 | public Set<String> keySet() { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 238 | return complete(treeMap.keySet()); |
| 239 | } |
| 240 | |
| 241 | @Override |
| 242 | public Collection<Versioned<V>> values() { |
| 243 | return complete(treeMap.values()); |
| 244 | } |
| 245 | |
| 246 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 247 | public Set<Map.Entry<String, Versioned<V>>> entrySet() { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 248 | return complete(treeMap.entrySet()); |
| 249 | } |
| 250 | |
| 251 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 252 | public Versioned<V> putIfAbsent(String key, V value) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 253 | return complete(treeMap.putIfAbsent(key, value)); |
| 254 | } |
| 255 | |
| 256 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 257 | public boolean remove(String key, V value) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 258 | return complete(treeMap.remove(key, value)); |
| 259 | } |
| 260 | |
| 261 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 262 | public boolean remove(String key, long version) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 263 | return complete(treeMap.remove(key, version)); |
| 264 | } |
| 265 | |
| 266 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 267 | public Versioned<V> replace(String key, V value) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 268 | return complete(treeMap.replace(key, value)); |
| 269 | } |
| 270 | |
| 271 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 272 | public boolean replace(String key, V oldValue, V newValue) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 273 | return complete(treeMap.replace(key, oldValue, newValue)); |
| 274 | } |
| 275 | |
| 276 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 277 | public boolean replace(String key, long oldVersion, V newValue) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 278 | return complete(treeMap.replace(key, oldVersion, newValue)); |
| 279 | } |
| 280 | |
| 281 | @Override |
Jordan Halterman | dae1160 | 2018-07-03 00:00:47 -0700 | [diff] [blame] | 282 | public Iterator<Map.Entry<String, Versioned<V>>> iterator() { |
| 283 | return new DefaultIterator<>(complete(treeMap.iterator())); |
| 284 | } |
| 285 | |
| 286 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 287 | public void addListener(MapEventListener<String, V> listener, |
| 288 | Executor executor) { |
Madan Jampani | 0463cf9 | 2016-05-04 14:46:08 -0700 | [diff] [blame] | 289 | complete(treeMap.addListener(listener, executor)); |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 290 | } |
| 291 | |
| 292 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 293 | public void removeListener(MapEventListener<String, V> listener) { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 294 | complete(treeMap.removeListener(listener)); |
| 295 | } |
| 296 | |
Jordan Halterman | dae1160 | 2018-07-03 00:00:47 -0700 | [diff] [blame] | 297 | private class DefaultIterator<K, V> implements Iterator<Map.Entry<K, Versioned<V>>> { |
| 298 | private final AsyncIterator<Map.Entry<K, Versioned<V>>> iterator; |
| 299 | |
| 300 | public DefaultIterator(AsyncIterator<Map.Entry<K, Versioned<V>>> iterator) { |
| 301 | this.iterator = iterator; |
| 302 | } |
| 303 | |
| 304 | @Override |
| 305 | public boolean hasNext() { |
| 306 | return complete(iterator.hasNext()); |
| 307 | } |
| 308 | |
| 309 | @Override |
| 310 | public Map.Entry<K, Versioned<V>> next() { |
| 311 | return complete(iterator.next()); |
| 312 | } |
| 313 | } |
| 314 | |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 315 | @Override |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 316 | public Map<String, V> asJavaMap() { |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 317 | synchronized (this) { |
| 318 | if (javaMap == null) { |
| 319 | javaMap = new ConsistentMapBackedJavaMap<>(this); |
| 320 | } |
| 321 | } |
| 322 | return javaMap; |
| 323 | } |
Aaron Kruglikov | 6a16435 | 2016-07-25 11:46:17 -0700 | [diff] [blame] | 324 | |
| 325 | @Override |
| 326 | public NavigableMap<String, V> subMap(String upperKey, |
| 327 | String lowerKey, |
| 328 | boolean inclusiveUpper, |
| 329 | boolean inclusiveLower) { |
| 330 | return complete(treeMap.subMap(upperKey, lowerKey, |
| 331 | inclusiveUpper, inclusiveLower)); |
| 332 | } |
Aaron Kruglikov | 47047b2 | 2016-03-31 16:52:48 -0700 | [diff] [blame] | 333 | } |