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