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