Madan Jampani | 2546111 | 2015-02-17 14:17:29 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Madan Jampani | 2546111 | 2015-02-17 14:17:29 -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 | */ |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 16 | package org.onosproject.store.service; |
| 17 | |
| 18 | /** |
| 19 | * Storage service. |
| 20 | * <p> |
Madan Jampani | cab114c | 2015-07-23 00:14:19 -0700 | [diff] [blame] | 21 | * This service provides builders for various distributed primitives. |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 22 | * <p> |
Madan Jampani | cab114c | 2015-07-23 00:14:19 -0700 | [diff] [blame] | 23 | * It is expected that services and applications will leverage the primitives indirectly provided by |
| 24 | * this service for their distributed state management and coordination. |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 25 | */ |
| 26 | public interface StorageService { |
| 27 | |
| 28 | /** |
Jonathan Hart | 6ec029a | 2015-03-24 17:12:35 -0700 | [diff] [blame] | 29 | * Creates a new EventuallyConsistentMapBuilder. |
| 30 | * |
| 31 | * @param <K> key type |
| 32 | * @param <V> value type |
| 33 | * @return builder for an eventually consistent map |
| 34 | */ |
| 35 | <K, V> EventuallyConsistentMapBuilder<K, V> eventuallyConsistentMapBuilder(); |
| 36 | |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 37 | /** |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 38 | * Creates a new ConsistentMapBuilder. |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 39 | * |
| 40 | * @param <K> key type |
| 41 | * @param <V> value type |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 42 | * @return builder for a consistent map |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 43 | */ |
| 44 | <K, V> ConsistentMapBuilder<K, V> consistentMapBuilder(); |
Madan Jampani | 08706ce | 2015-04-01 14:49:28 -0700 | [diff] [blame] | 45 | |
| 46 | /** |
Sithara Punnassery | 112ed82 | 2016-10-24 14:55:19 -0700 | [diff] [blame] | 47 | * Creates a new ConsistentMapBuilder. |
| 48 | * |
| 49 | * @param <V> value type |
| 50 | * @return builder for a consistent map |
| 51 | */ |
| 52 | <V> DocumentTreeBuilder<V> documentTreeBuilder(); |
| 53 | |
| 54 | /** |
Aaron Kruglikov | ed88ff6 | 2016-08-01 16:02:09 -0700 | [diff] [blame] | 55 | * Creates a new {@code AsyncConsistentTreeMapBuilder}. |
| 56 | * |
| 57 | * @param <V> value type |
| 58 | * @return builder for a async consistent tree map |
| 59 | */ |
| 60 | <V> ConsistentTreeMapBuilder<V> consistentTreeMapBuilder(); |
| 61 | |
| 62 | /** |
Aaron Kruglikov | 61582a0 | 2016-09-06 13:18:58 -0700 | [diff] [blame] | 63 | * Creates a new {@code AsyncConsistentSetMultimapBuilder}. |
| 64 | * |
| 65 | * @param <K> key type |
| 66 | * @param <V> value type |
| 67 | * @return builder for a set based async consistent multimap |
| 68 | */ |
| 69 | <K, V> ConsistentMultimapBuilder<K, V> consistentMultimapBuilder(); |
| 70 | |
| 71 | /** |
Jordan Halterman | c955df7 | 2017-02-04 20:43:28 -0800 | [diff] [blame] | 72 | * Creates a new {@code AtomicCounterMapBuilder}. |
| 73 | * |
| 74 | * @param <K> key type |
| 75 | * @return builder for an atomic counter map |
| 76 | */ |
| 77 | <K> AtomicCounterMapBuilder<K> atomicCounterMapBuilder(); |
| 78 | |
| 79 | /** |
Madan Jampani | cab114c | 2015-07-23 00:14:19 -0700 | [diff] [blame] | 80 | * Creates a new DistributedSetBuilder. |
Madan Jampani | 08706ce | 2015-04-01 14:49:28 -0700 | [diff] [blame] | 81 | * |
| 82 | * @param <E> set element type |
| 83 | * @return builder for an distributed set |
| 84 | */ |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 85 | <E> DistributedSetBuilder<E> setBuilder(); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 86 | |
| 87 | /** |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 88 | * Creates a new AtomicCounterBuilder. |
| 89 | * |
| 90 | * @return atomic counter builder |
| 91 | */ |
| 92 | AtomicCounterBuilder atomicCounterBuilder(); |
| 93 | |
| 94 | /** |
Jordan Halterman | 5a1053e | 2017-05-19 18:03:47 -0700 | [diff] [blame] | 95 | * Creates a new AtomicIdGeneratorBuilder. |
| 96 | * |
| 97 | * @return atomic ID generator builder |
| 98 | */ |
| 99 | AtomicIdGeneratorBuilder atomicIdGeneratorBuilder(); |
| 100 | |
| 101 | /** |
Madan Jampani | 762246d | 2015-07-21 15:40:59 -0700 | [diff] [blame] | 102 | * Creates a new AtomicValueBuilder. |
| 103 | * |
| 104 | * @param <V> atomic value type |
| 105 | * @return atomic value builder |
| 106 | */ |
| 107 | <V> AtomicValueBuilder<V> atomicValueBuilder(); |
| 108 | |
| 109 | /** |
Madan Jampani | 39fff10 | 2016-02-14 13:17:28 -0800 | [diff] [blame] | 110 | * Creates a new LeaderElectorBuilder. |
| 111 | * |
| 112 | * @return leader elector builder |
| 113 | */ |
| 114 | LeaderElectorBuilder leaderElectorBuilder(); |
| 115 | |
| 116 | /** |
Ayaka Koshibe | 3a32156 | 2015-04-29 13:24:07 -0700 | [diff] [blame] | 117 | * Creates a new transaction context builder. |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 118 | * |
Ayaka Koshibe | 3a32156 | 2015-04-29 13:24:07 -0700 | [diff] [blame] | 119 | * @return a builder for a transaction context. |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 120 | */ |
Ayaka Koshibe | 3a32156 | 2015-04-29 13:24:07 -0700 | [diff] [blame] | 121 | TransactionContextBuilder transactionContextBuilder(); |
Madan Jampani | d5714e0 | 2016-04-19 14:15:20 -0700 | [diff] [blame] | 122 | |
| 123 | /** |
| 124 | * Returns an instance of {@code AsyncAtomicCounter} with specified name. |
| 125 | * @param name counter name |
| 126 | * |
| 127 | * @return AsyncAtomicCounter instance |
| 128 | */ |
| 129 | default AsyncAtomicCounter getAsyncAtomicCounter(String name) { |
| 130 | return atomicCounterBuilder().withName(name).build(); |
| 131 | } |
| 132 | |
| 133 | /** |
Jordan Halterman | 5a1053e | 2017-05-19 18:03:47 -0700 | [diff] [blame] | 134 | * Returns an instance of {@code AsyncAtomicIdGenerator} with specified name. |
| 135 | * |
| 136 | * @param name ID generator name |
| 137 | * @return AsyncAtomicIdGenerator instance |
| 138 | */ |
| 139 | default AsyncAtomicIdGenerator getAsyncAtomicIdGenerator(String name) { |
| 140 | return atomicIdGeneratorBuilder().withName(name).build(); |
| 141 | } |
| 142 | |
| 143 | /** |
Madan Jampani | d5714e0 | 2016-04-19 14:15:20 -0700 | [diff] [blame] | 144 | * Returns an instance of {@code AtomicCounter} with specified name. |
| 145 | * @param name counter name |
| 146 | * |
| 147 | * @return AtomicCounter instance |
| 148 | */ |
| 149 | default AtomicCounter getAtomicCounter(String name) { |
| 150 | return getAsyncAtomicCounter(name).asAtomicCounter(); |
| 151 | } |
Madan Jampani | 35708a9 | 2016-07-06 10:48:19 -0700 | [diff] [blame] | 152 | |
| 153 | /** |
Jordan Halterman | 5a1053e | 2017-05-19 18:03:47 -0700 | [diff] [blame] | 154 | * Returns an instance of {@code AtomicIdGenerator} with specified name. |
| 155 | * |
| 156 | * @param name ID generator name |
| 157 | * @return AtomicIdGenerator instance |
| 158 | */ |
| 159 | default AtomicIdGenerator getAtomicIdGenerator(String name) { |
| 160 | return getAsyncAtomicIdGenerator(name).asAtomicIdGenerator(); |
| 161 | } |
| 162 | |
| 163 | /** |
Madan Jampani | 35708a9 | 2016-07-06 10:48:19 -0700 | [diff] [blame] | 164 | * Returns an instance of {@code WorkQueue} with specified name. |
Ray Milkey | bb23e0b | 2016-08-02 17:00:21 -0700 | [diff] [blame] | 165 | * |
| 166 | * @param <E> work element type |
Madan Jampani | 35708a9 | 2016-07-06 10:48:19 -0700 | [diff] [blame] | 167 | * @param name work queue name |
| 168 | * @param serializer serializer |
Madan Jampani | 35708a9 | 2016-07-06 10:48:19 -0700 | [diff] [blame] | 169 | * @return WorkQueue instance |
| 170 | */ |
| 171 | <E> WorkQueue<E> getWorkQueue(String name, Serializer serializer); |
Madan Jampani | 13f6515 | 2016-08-17 13:14:53 -0700 | [diff] [blame] | 172 | |
| 173 | /** |
Madan Jampani | 2914e4e | 2016-09-13 17:48:56 -0700 | [diff] [blame] | 174 | * Returns an instance of {@code AsyncDocumentTree} with specified name. |
| 175 | * |
| 176 | * @param <V> tree node value type |
| 177 | * @param name document tree name |
| 178 | * @param serializer serializer |
| 179 | * @return AsyncDocumentTree instance |
| 180 | */ |
| 181 | <V> AsyncDocumentTree<V> getDocumentTree(String name, Serializer serializer); |
| 182 | |
Aaron Kruglikov | 61582a0 | 2016-09-06 13:18:58 -0700 | [diff] [blame] | 183 | /** Returns a set backed instance of {@code AsyncConsistentMultimap} with |
| 184 | * the specified name. |
| 185 | * |
| 186 | * @param name the multimap name |
| 187 | * @param serializer serializer |
| 188 | * @param <K> key type |
| 189 | * @param <V> value type |
| 190 | * @return set backed {@code AsyncConsistentMultimap} instance |
| 191 | */ |
| 192 | <K, V> AsyncConsistentMultimap<K, V> getAsyncSetMultimap(String name, |
| 193 | Serializer serializer); |
| 194 | |
| 195 | /** |
| 196 | * Returns an instance of {@code AsyncConsistentTreeMap} with the specified |
| 197 | * name. |
| 198 | * |
| 199 | * @param name the treemap name |
| 200 | * @param serializer serializer |
| 201 | * @param <V> value type |
| 202 | * @return set backed {@code AsyncConsistentTreeMap} instance |
| 203 | */ |
| 204 | <V> AsyncConsistentTreeMap<V> getAsyncTreeMap(String name, |
| 205 | Serializer serializer); |
| 206 | |
Madan Jampani | 2914e4e | 2016-09-13 17:48:56 -0700 | [diff] [blame] | 207 | /** |
Madan Jampani | 13f6515 | 2016-08-17 13:14:53 -0700 | [diff] [blame] | 208 | * Returns an instance of {@code Topic} with specified name. |
| 209 | * |
Yuta HIGUCHI | 7c298f3 | 2016-08-18 14:32:32 -0700 | [diff] [blame] | 210 | * @param <T> topic message type |
Madan Jampani | 13f6515 | 2016-08-17 13:14:53 -0700 | [diff] [blame] | 211 | * @param name topic name |
| 212 | * @param serializer serializer |
| 213 | * |
| 214 | * @return Topic instance |
| 215 | */ |
| 216 | <T> Topic<T> getTopic(String name, Serializer serializer); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 217 | } |