Madan Jampani | 837a363 | 2016-01-21 16:47:26 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Madan Jampani | 837a363 | 2016-01-21 16:47:26 -0800 | [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 | package org.onosproject.store.primitives; |
| 17 | |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 18 | import java.util.Set; |
Jordan Halterman | 7b7644f | 2017-10-16 12:57:55 -0700 | [diff] [blame] | 19 | import java.util.concurrent.TimeUnit; |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 20 | |
Madan Jampani | 837a363 | 2016-01-21 16:47:26 -0800 | [diff] [blame] | 21 | import org.onosproject.store.service.AsyncAtomicCounter; |
Jordan Halterman | c955df7 | 2017-02-04 20:43:28 -0800 | [diff] [blame] | 22 | import org.onosproject.store.service.AsyncAtomicCounterMap; |
Jordan Halterman | 5a1053e | 2017-05-19 18:03:47 -0700 | [diff] [blame] | 23 | import org.onosproject.store.service.AsyncAtomicIdGenerator; |
Madan Jampani | 837a363 | 2016-01-21 16:47:26 -0800 | [diff] [blame] | 24 | import org.onosproject.store.service.AsyncAtomicValue; |
| 25 | import org.onosproject.store.service.AsyncConsistentMap; |
Aaron Kruglikov | 61582a0 | 2016-09-06 13:18:58 -0700 | [diff] [blame] | 26 | import org.onosproject.store.service.AsyncConsistentMultimap; |
Aaron Kruglikov | ed88ff6 | 2016-08-01 16:02:09 -0700 | [diff] [blame] | 27 | import org.onosproject.store.service.AsyncConsistentTreeMap; |
Madan Jampani | 837a363 | 2016-01-21 16:47:26 -0800 | [diff] [blame] | 28 | import org.onosproject.store.service.AsyncDistributedSet; |
Madan Jampani | 2914e4e | 2016-09-13 17:48:56 -0700 | [diff] [blame] | 29 | import org.onosproject.store.service.AsyncDocumentTree; |
Madan Jampani | 47b80ba | 2016-01-31 23:05:55 -0800 | [diff] [blame] | 30 | import org.onosproject.store.service.AsyncLeaderElector; |
Jordan Halterman | d0d8035 | 2017-08-10 15:08:27 -0700 | [diff] [blame] | 31 | import org.onosproject.store.service.Ordering; |
Madan Jampani | 837a363 | 2016-01-21 16:47:26 -0800 | [diff] [blame] | 32 | import org.onosproject.store.service.Serializer; |
Madan Jampani | 2914e4e | 2016-09-13 17:48:56 -0700 | [diff] [blame] | 33 | import org.onosproject.store.service.WorkQueue; |
Madan Jampani | 837a363 | 2016-01-21 16:47:26 -0800 | [diff] [blame] | 34 | |
Jordan Halterman | 7b7644f | 2017-10-16 12:57:55 -0700 | [diff] [blame] | 35 | import static org.onosproject.store.service.DistributedPrimitive.DEFAULT_OPERATION_TIMEOUT_MILLIS; |
| 36 | |
Madan Jampani | 837a363 | 2016-01-21 16:47:26 -0800 | [diff] [blame] | 37 | /** |
| 38 | * Interface for entity that can create instances of different distributed primitives. |
| 39 | */ |
| 40 | public interface DistributedPrimitiveCreator { |
| 41 | |
| 42 | /** |
| 43 | * Creates a new {@code AsyncConsistentMap}. |
| 44 | * |
| 45 | * @param name map name |
| 46 | * @param serializer serializer to use for serializing/deserializing map entries |
| 47 | * @param <K> key type |
| 48 | * @param <V> value type |
| 49 | * @return map |
| 50 | */ |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 51 | <K, V> AsyncConsistentMap<K, V> newAsyncConsistentMap(String name, Serializer serializer); |
Madan Jampani | 837a363 | 2016-01-21 16:47:26 -0800 | [diff] [blame] | 52 | |
| 53 | /** |
Aaron Kruglikov | ed88ff6 | 2016-08-01 16:02:09 -0700 | [diff] [blame] | 54 | * Creates a new {@code AsyncConsistentTreeMap}. |
| 55 | * |
| 56 | * @param name tree name |
| 57 | * @param serializer serializer to use for serializing/deserializing map entries |
| 58 | * @param <V> value type |
| 59 | * @return distributedTreeMap |
| 60 | */ |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 61 | <V> AsyncConsistentTreeMap<V> newAsyncConsistentTreeMap(String name, Serializer serializer); |
Aaron Kruglikov | 61582a0 | 2016-09-06 13:18:58 -0700 | [diff] [blame] | 62 | |
| 63 | /** |
| 64 | * Creates a new set backed {@code AsyncConsistentMultimap}. |
| 65 | * |
| 66 | * @param name multimap name |
| 67 | * @param serializer serializer to use for serializing/deserializing |
| 68 | * @param <K> key type |
| 69 | * @param <V> value type |
| 70 | * @return set backed distributedMultimap |
| 71 | */ |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 72 | <K, V> AsyncConsistentMultimap<K, V> newAsyncConsistentSetMultimap(String name, Serializer serializer); |
Aaron Kruglikov | ed88ff6 | 2016-08-01 16:02:09 -0700 | [diff] [blame] | 73 | |
| 74 | /** |
Jordan Halterman | c955df7 | 2017-02-04 20:43:28 -0800 | [diff] [blame] | 75 | * Creates a new {@code AsyncAtomicCounterMap}. |
| 76 | * |
| 77 | * @param name counter map name |
| 78 | * @param serializer serializer to use for serializing/deserializing keys |
| 79 | * @param <K> key type |
| 80 | * @return atomic counter map |
| 81 | */ |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 82 | <K> AsyncAtomicCounterMap<K> newAsyncAtomicCounterMap(String name, Serializer serializer); |
Jordan Halterman | c955df7 | 2017-02-04 20:43:28 -0800 | [diff] [blame] | 83 | |
| 84 | /** |
Madan Jampani | 837a363 | 2016-01-21 16:47:26 -0800 | [diff] [blame] | 85 | * Creates a new {@code AsyncAtomicCounter}. |
| 86 | * |
| 87 | * @param name counter name |
| 88 | * @return counter |
| 89 | */ |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 90 | AsyncAtomicCounter newAsyncCounter(String name); |
Madan Jampani | 837a363 | 2016-01-21 16:47:26 -0800 | [diff] [blame] | 91 | |
| 92 | /** |
Jordan Halterman | 5a1053e | 2017-05-19 18:03:47 -0700 | [diff] [blame] | 93 | * Creates a new {@code AsyncAtomixIdGenerator}. |
| 94 | * |
| 95 | * @param name ID generator name |
| 96 | * @return ID generator |
| 97 | */ |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 98 | AsyncAtomicIdGenerator newAsyncIdGenerator(String name); |
Jordan Halterman | 5a1053e | 2017-05-19 18:03:47 -0700 | [diff] [blame] | 99 | |
| 100 | /** |
Madan Jampani | 837a363 | 2016-01-21 16:47:26 -0800 | [diff] [blame] | 101 | * Creates a new {@code AsyncAtomicValue}. |
| 102 | * |
| 103 | * @param name value name |
| 104 | * @param serializer serializer to use for serializing/deserializing value type |
| 105 | * @param <V> value type |
| 106 | * @return value |
| 107 | */ |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 108 | <V> AsyncAtomicValue<V> newAsyncAtomicValue(String name, Serializer serializer); |
Madan Jampani | 837a363 | 2016-01-21 16:47:26 -0800 | [diff] [blame] | 109 | |
| 110 | /** |
Madan Jampani | 837a363 | 2016-01-21 16:47:26 -0800 | [diff] [blame] | 111 | * Creates a new {@code AsyncDistributedSet}. |
| 112 | * |
| 113 | * @param name set name |
| 114 | * @param serializer serializer to use for serializing/deserializing set entries |
| 115 | * @param <E> set entry type |
| 116 | * @return set |
| 117 | */ |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 118 | <E> AsyncDistributedSet<E> newAsyncDistributedSet(String name, Serializer serializer); |
Madan Jampani | 47b80ba | 2016-01-31 23:05:55 -0800 | [diff] [blame] | 119 | |
| 120 | /** |
| 121 | * Creates a new {@code AsyncLeaderElector}. |
| 122 | * |
| 123 | * @param name leader elector name |
| 124 | * @return leader elector |
| 125 | */ |
Jordan Halterman | 7b7644f | 2017-10-16 12:57:55 -0700 | [diff] [blame] | 126 | default AsyncLeaderElector newAsyncLeaderElector(String name) { |
| 127 | return newAsyncLeaderElector(name, DEFAULT_OPERATION_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS); |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * Creates a new {@code AsyncLeaderElector}. |
| 132 | * |
| 133 | * @param name leader elector name |
| 134 | * @param electionTimeout leader election timeout |
| 135 | * @param timeUnit leader election timeout time unit |
| 136 | * @return leader elector |
| 137 | */ |
| 138 | AsyncLeaderElector newAsyncLeaderElector(String name, long electionTimeout, TimeUnit timeUnit); |
Madan Jampani | e14a09c | 2016-02-11 10:43:21 -0800 | [diff] [blame] | 139 | |
| 140 | /** |
Madan Jampani | 35708a9 | 2016-07-06 10:48:19 -0700 | [diff] [blame] | 141 | * Creates a new {@code WorkQueue}. |
| 142 | * |
Ray Milkey | bb23e0b | 2016-08-02 17:00:21 -0700 | [diff] [blame] | 143 | * @param <E> work element type |
Madan Jampani | 35708a9 | 2016-07-06 10:48:19 -0700 | [diff] [blame] | 144 | * @param name work queue name |
| 145 | * @param serializer serializer |
| 146 | * @return work queue |
| 147 | */ |
Jordan Halterman | 2bf177c | 2017-06-29 01:49:08 -0700 | [diff] [blame] | 148 | <E> WorkQueue<E> newWorkQueue(String name, Serializer serializer); |
Madan Jampani | 35708a9 | 2016-07-06 10:48:19 -0700 | [diff] [blame] | 149 | |
| 150 | /** |
Madan Jampani | 2914e4e | 2016-09-13 17:48:56 -0700 | [diff] [blame] | 151 | * Creates a new {@code AsyncDocumentTree}. |
| 152 | * |
| 153 | * @param <V> document tree node value type |
| 154 | * @param name tree name |
| 155 | * @param serializer serializer |
| 156 | * @return document tree |
| 157 | */ |
Jordan Halterman | d0d8035 | 2017-08-10 15:08:27 -0700 | [diff] [blame] | 158 | default <V> AsyncDocumentTree<V> newAsyncDocumentTree(String name, Serializer serializer) { |
| 159 | return newAsyncDocumentTree(name, serializer, Ordering.NATURAL); |
| 160 | } |
| 161 | |
| 162 | /** |
| 163 | * Creates a new {@code AsyncDocumentTree}. |
| 164 | * |
| 165 | * @param <V> document tree node value type |
| 166 | * @param name tree name |
| 167 | * @param serializer serializer |
| 168 | * @param ordering tree node ordering |
| 169 | * @return document tree |
| 170 | */ |
| 171 | <V> AsyncDocumentTree<V> newAsyncDocumentTree(String name, Serializer serializer, Ordering ordering); |
Madan Jampani | 2914e4e | 2016-09-13 17:48:56 -0700 | [diff] [blame] | 172 | |
| 173 | /** |
Madan Jampani | e14a09c | 2016-02-11 10:43:21 -0800 | [diff] [blame] | 174 | * Returns the names of all created {@code AsyncConsistentMap} instances. |
| 175 | * @return set of {@code AsyncConsistentMap} names |
| 176 | */ |
| 177 | Set<String> getAsyncConsistentMapNames(); |
| 178 | |
| 179 | /** |
| 180 | * Returns the names of all created {@code AsyncAtomicCounter} instances. |
| 181 | * @return set of {@code AsyncAtomicCounter} names |
| 182 | */ |
| 183 | Set<String> getAsyncAtomicCounterNames(); |
Madan Jampani | 35708a9 | 2016-07-06 10:48:19 -0700 | [diff] [blame] | 184 | |
| 185 | /** |
| 186 | * Returns the names of all created {@code WorkQueue} instances. |
| 187 | * @return set of {@code WorkQueue} names |
| 188 | */ |
| 189 | Set<String> getWorkQueueNames(); |
Ray Milkey | bb23e0b | 2016-08-02 17:00:21 -0700 | [diff] [blame] | 190 | } |