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 | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 17 | package org.onosproject.store.consistent.impl; |
| 18 | |
| 19 | import java.util.Collection; |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 20 | import java.util.Map; |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 21 | import java.util.Map.Entry; |
| 22 | import java.util.Set; |
| 23 | |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 24 | import org.onosproject.store.service.Transaction; |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 25 | import org.onosproject.store.service.Versioned; |
| 26 | |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 27 | import net.kuujo.copycat.state.Command; |
| 28 | import net.kuujo.copycat.state.Initializer; |
| 29 | import net.kuujo.copycat.state.Query; |
| 30 | import net.kuujo.copycat.state.StateContext; |
| 31 | |
| 32 | /** |
| 33 | * Database state. |
| 34 | * |
| 35 | */ |
| 36 | public interface DatabaseState<K, V> { |
| 37 | |
| 38 | /** |
| 39 | * Initializes the database state. |
| 40 | * |
| 41 | * @param context The map state context. |
| 42 | */ |
| 43 | @Initializer |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame^] | 44 | void init(StateContext<DatabaseState<K, V>> context); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 45 | |
| 46 | @Query |
Madan Jampani | a89f8f9 | 2015-04-01 14:39:54 -0700 | [diff] [blame] | 47 | Set<String> tableNames(); |
| 48 | |
| 49 | @Query |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 50 | Map<String, Long> counters(); |
| 51 | |
| 52 | @Query |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 53 | int size(String tableName); |
| 54 | |
| 55 | @Query |
| 56 | boolean isEmpty(String tableName); |
| 57 | |
| 58 | @Query |
| 59 | boolean containsKey(String tableName, K key); |
| 60 | |
| 61 | @Query |
| 62 | boolean containsValue(String tableName, V value); |
| 63 | |
| 64 | @Query |
| 65 | Versioned<V> get(String tableName, K key); |
| 66 | |
| 67 | @Command |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 68 | Result<Versioned<V>> put(String tableName, K key, V value); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 69 | |
| 70 | @Command |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 71 | Result<Versioned<V>> remove(String tableName, K key); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 72 | |
| 73 | @Command |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 74 | Result<Void> clear(String tableName); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 75 | |
| 76 | @Query |
| 77 | Set<K> keySet(String tableName); |
| 78 | |
| 79 | @Query |
| 80 | Collection<Versioned<V>> values(String tableName); |
| 81 | |
| 82 | @Query |
| 83 | Set<Entry<K, Versioned<V>>> entrySet(String tableName); |
| 84 | |
| 85 | @Command |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 86 | Result<Versioned<V>> putIfAbsent(String tableName, K key, V value); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 87 | |
| 88 | @Command |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 89 | Result<Boolean> remove(String tableName, K key, V value); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 90 | |
| 91 | @Command |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 92 | Result<Boolean> remove(String tableName, K key, long version); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 93 | |
| 94 | @Command |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 95 | Result<Boolean> replace(String tableName, K key, V oldValue, V newValue); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 96 | |
| 97 | @Command |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 98 | Result<Boolean> replace(String tableName, K key, long oldVersion, V newValue); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 99 | |
| 100 | @Command |
Madan Jampani | 55ac134 | 2015-05-04 19:05:04 -0700 | [diff] [blame] | 101 | Long counterAddAndGet(String counterName, long delta); |
Madan Jampani | 04aeb45 | 2015-05-02 16:12:24 -0700 | [diff] [blame] | 102 | |
| 103 | @Command |
| 104 | Long counterGetAndAdd(String counterName, long delta); |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 105 | |
| 106 | @Query |
Madan Jampani | 04aeb45 | 2015-05-02 16:12:24 -0700 | [diff] [blame] | 107 | Long counterGet(String counterName); |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 108 | |
| 109 | @Command |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 110 | boolean prepareAndCommit(Transaction transaction); |
| 111 | |
| 112 | @Command |
| 113 | boolean prepare(Transaction transaction); |
| 114 | |
| 115 | @Command |
| 116 | boolean commit(Transaction transaction); |
| 117 | |
| 118 | @Command |
| 119 | boolean rollback(Transaction transaction); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 120 | } |