Madan Jampani | 2546111 | 2015-02-17 14:17:29 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 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 | /** |
Madan Jampani | cab114c | 2015-07-23 00:14:19 -0700 | [diff] [blame] | 47 | * Creates a new DistributedSetBuilder. |
Madan Jampani | 08706ce | 2015-04-01 14:49:28 -0700 | [diff] [blame] | 48 | * |
| 49 | * @param <E> set element type |
| 50 | * @return builder for an distributed set |
| 51 | */ |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 52 | <E> DistributedSetBuilder<E> setBuilder(); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 53 | |
| 54 | /** |
Madan Jampani | cab114c | 2015-07-23 00:14:19 -0700 | [diff] [blame] | 55 | * Creates a new DistributedQueueBuilder. |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 56 | * |
| 57 | * @param <E> queue entry type |
| 58 | * @return builder for an distributed queue |
| 59 | */ |
| 60 | <E> DistributedQueueBuilder<E> queueBuilder(); |
| 61 | |
| 62 | /** |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 63 | * Creates a new AtomicCounterBuilder. |
| 64 | * |
| 65 | * @return atomic counter builder |
| 66 | */ |
| 67 | AtomicCounterBuilder atomicCounterBuilder(); |
| 68 | |
| 69 | /** |
Madan Jampani | 762246d | 2015-07-21 15:40:59 -0700 | [diff] [blame] | 70 | * Creates a new AtomicValueBuilder. |
| 71 | * |
| 72 | * @param <V> atomic value type |
| 73 | * @return atomic value builder |
| 74 | */ |
| 75 | <V> AtomicValueBuilder<V> atomicValueBuilder(); |
| 76 | |
| 77 | /** |
Madan Jampani | 39fff10 | 2016-02-14 13:17:28 -0800 | [diff] [blame] | 78 | * Creates a new LeaderElectorBuilder. |
| 79 | * |
| 80 | * @return leader elector builder |
| 81 | */ |
| 82 | LeaderElectorBuilder leaderElectorBuilder(); |
| 83 | |
| 84 | /** |
Ayaka Koshibe | 3a32156 | 2015-04-29 13:24:07 -0700 | [diff] [blame] | 85 | * Creates a new transaction context builder. |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 86 | * |
Ayaka Koshibe | 3a32156 | 2015-04-29 13:24:07 -0700 | [diff] [blame] | 87 | * @return a builder for a transaction context. |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 88 | */ |
Ayaka Koshibe | 3a32156 | 2015-04-29 13:24:07 -0700 | [diff] [blame] | 89 | TransactionContextBuilder transactionContextBuilder(); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 90 | } |