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 | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 24 | import org.onosproject.cluster.NodeId; |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 25 | import org.onosproject.store.service.Transaction; |
Madan Jampani | 393e0f0 | 2015-02-12 07:35:39 +0530 | [diff] [blame] | 26 | import org.onosproject.store.service.Versioned; |
| 27 | |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 28 | import net.kuujo.copycat.state.Command; |
| 29 | import net.kuujo.copycat.state.Initializer; |
| 30 | import net.kuujo.copycat.state.Query; |
| 31 | import net.kuujo.copycat.state.StateContext; |
| 32 | |
| 33 | /** |
| 34 | * Database state. |
| 35 | * |
| 36 | */ |
| 37 | public interface DatabaseState<K, V> { |
| 38 | |
| 39 | /** |
| 40 | * Initializes the database state. |
| 41 | * |
| 42 | * @param context The map state context. |
| 43 | */ |
| 44 | @Initializer |
Sho SHIMIZU | 3310a34 | 2015-05-13 12:14:05 -0700 | [diff] [blame] | 45 | void init(StateContext<DatabaseState<K, V>> context); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 46 | |
| 47 | @Query |
Madan Jampani | 7804c99 | 2015-07-20 13:20:19 -0700 | [diff] [blame] | 48 | Set<String> maps(); |
Madan Jampani | a89f8f9 | 2015-04-01 14:39:54 -0700 | [diff] [blame] | 49 | |
| 50 | @Query |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 51 | Map<String, Long> counters(); |
| 52 | |
| 53 | @Query |
Madan Jampani | 3ca9cb6 | 2015-07-21 11:35:44 -0700 | [diff] [blame] | 54 | int mapSize(String mapName); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 55 | |
| 56 | @Query |
Madan Jampani | 7804c99 | 2015-07-20 13:20:19 -0700 | [diff] [blame] | 57 | boolean mapIsEmpty(String mapName); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 58 | |
| 59 | @Query |
Madan Jampani | 7804c99 | 2015-07-20 13:20:19 -0700 | [diff] [blame] | 60 | boolean mapContainsKey(String mapName, K key); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 61 | |
| 62 | @Query |
Madan Jampani | 7804c99 | 2015-07-20 13:20:19 -0700 | [diff] [blame] | 63 | boolean mapContainsValue(String mapName, V value); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 64 | |
| 65 | @Query |
Madan Jampani | 7804c99 | 2015-07-20 13:20:19 -0700 | [diff] [blame] | 66 | Versioned<V> mapGet(String mapName, K key); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 67 | |
| 68 | @Command |
Madan Jampani | 7804c99 | 2015-07-20 13:20:19 -0700 | [diff] [blame] | 69 | Result<UpdateResult<K, V>> mapUpdate(String mapName, K key, Match<V> valueMatch, Match<Long> versionMatch, V value); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 70 | |
| 71 | @Command |
Madan Jampani | 7804c99 | 2015-07-20 13:20:19 -0700 | [diff] [blame] | 72 | Result<Void> mapClear(String mapName); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 73 | |
| 74 | @Query |
Madan Jampani | 7804c99 | 2015-07-20 13:20:19 -0700 | [diff] [blame] | 75 | Set<K> mapKeySet(String mapName); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 76 | |
| 77 | @Query |
Madan Jampani | 7804c99 | 2015-07-20 13:20:19 -0700 | [diff] [blame] | 78 | Collection<Versioned<V>> mapValues(String mapName); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 79 | |
| 80 | @Query |
Madan Jampani | 7804c99 | 2015-07-20 13:20:19 -0700 | [diff] [blame] | 81 | Set<Entry<K, Versioned<V>>> mapEntrySet(String mapName); |
Madan Jampani | 346d4f5 | 2015-05-04 11:09:39 -0700 | [diff] [blame] | 82 | |
| 83 | @Command |
Madan Jampani | 55ac134 | 2015-05-04 19:05:04 -0700 | [diff] [blame] | 84 | Long counterAddAndGet(String counterName, long delta); |
Madan Jampani | 04aeb45 | 2015-05-02 16:12:24 -0700 | [diff] [blame] | 85 | |
| 86 | @Command |
| 87 | Long counterGetAndAdd(String counterName, long delta); |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 88 | |
| 89 | @Query |
Madan Jampani | 63c659f | 2015-06-11 00:52:58 -0700 | [diff] [blame] | 90 | Long queueSize(String queueName); |
| 91 | |
| 92 | @Query |
| 93 | byte[] queuePeek(String queueName); |
| 94 | |
| 95 | @Command |
| 96 | byte[] queuePop(String queueName, NodeId requestor); |
| 97 | |
| 98 | @Command |
| 99 | Set<NodeId> queuePush(String queueName, byte[] entry); |
| 100 | |
| 101 | @Query |
Madan Jampani | 04aeb45 | 2015-05-02 16:12:24 -0700 | [diff] [blame] | 102 | Long counterGet(String counterName); |
Madan Jampani | b5d72d5 | 2015-04-03 16:53:50 -0700 | [diff] [blame] | 103 | |
| 104 | @Command |
Madan Jampani | bff6d8f | 2015-03-31 16:53:47 -0700 | [diff] [blame] | 105 | boolean prepareAndCommit(Transaction transaction); |
| 106 | |
| 107 | @Command |
| 108 | boolean prepare(Transaction transaction); |
| 109 | |
| 110 | @Command |
| 111 | boolean commit(Transaction transaction); |
| 112 | |
| 113 | @Command |
| 114 | boolean rollback(Transaction transaction); |
Madan Jampani | 94c2353 | 2015-02-05 17:40:01 -0800 | [diff] [blame] | 115 | } |