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