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 | */ |
| 16 | |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 17 | package org.onosproject.store.service; |
| 18 | |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 19 | |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 20 | /** |
| 21 | * Storage service. |
| 22 | * <p> |
| 23 | * This service provides operations for creating key-value stores. |
| 24 | * One can chose to create key-value stores with varying properties such |
| 25 | * as strongly consistent vs eventually consistent, durable vs volatile. |
| 26 | * <p> |
| 27 | * Various store implementations should leverage the data structures provided |
| 28 | * by this service |
| 29 | */ |
| 30 | public interface StorageService { |
| 31 | |
| 32 | /** |
Jonathan Hart | 6ec029a | 2015-03-24 17:12:35 -0700 | [diff] [blame] | 33 | * Creates a new EventuallyConsistentMapBuilder. |
| 34 | * |
| 35 | * @param <K> key type |
| 36 | * @param <V> value type |
| 37 | * @return builder for an eventually consistent map |
| 38 | */ |
| 39 | <K, V> EventuallyConsistentMapBuilder<K, V> eventuallyConsistentMapBuilder(); |
| 40 | |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 41 | /** |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 42 | * Creates a new ConsistentMapBuilder. |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 43 | * |
| 44 | * @param <K> key type |
| 45 | * @param <V> value type |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 46 | * @return builder for a consistent map |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 47 | */ |
| 48 | <K, V> ConsistentMapBuilder<K, V> consistentMapBuilder(); |
Madan Jampani | 08706ce | 2015-04-01 14:49:28 -0700 | [diff] [blame] | 49 | |
| 50 | /** |
| 51 | * Creates a new distributed set builder. |
| 52 | * |
| 53 | * @param <E> set element type |
| 54 | * @return builder for an distributed set |
| 55 | */ |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 56 | <E> DistributedSetBuilder<E> setBuilder(); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 57 | |
| 58 | /** |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 59 | * Creates a new distributed queue builder. |
| 60 | * |
| 61 | * @param <E> queue entry type |
| 62 | * @return builder for an distributed queue |
| 63 | */ |
| 64 | <E> DistributedQueueBuilder<E> queueBuilder(); |
| 65 | |
| 66 | /** |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 67 | * Creates a new AtomicCounterBuilder. |
| 68 | * |
| 69 | * @return atomic counter builder |
| 70 | */ |
| 71 | AtomicCounterBuilder atomicCounterBuilder(); |
| 72 | |
| 73 | /** |
Ayaka Koshibe | 3a32156 | 2015-04-29 13:24:07 -0700 | [diff] [blame] | 74 | * Creates a new transaction context builder. |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 75 | * |
Ayaka Koshibe | 3a32156 | 2015-04-29 13:24:07 -0700 | [diff] [blame] | 76 | * @return a builder for a transaction context. |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 77 | */ |
Ayaka Koshibe | 3a32156 | 2015-04-29 13:24:07 -0700 | [diff] [blame] | 78 | TransactionContextBuilder transactionContextBuilder(); |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 79 | } |