Madan Jampani | 619453b | 2015-07-22 23:47:09 -0700 | [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 | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 16 | package org.onosproject.store.consistent.impl; |
| 17 | |
Madan Jampani | e8af1cc | 2015-06-23 14:23:31 -0700 | [diff] [blame] | 18 | import org.onosproject.core.ApplicationId; |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 19 | import org.onosproject.store.service.AsyncConsistentMap; |
| 20 | import org.onosproject.store.service.ConsistentMap; |
| 21 | import org.onosproject.store.service.ConsistentMapBuilder; |
| 22 | import org.onosproject.store.service.Serializer; |
| 23 | |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 24 | import static com.google.common.base.Preconditions.checkArgument; |
| 25 | import static com.google.common.base.Preconditions.checkState; |
| 26 | |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 27 | /** |
| 28 | * Default Consistent Map builder. |
| 29 | * |
| 30 | * @param <K> type for map key |
| 31 | * @param <V> type for map value |
| 32 | */ |
| 33 | public class DefaultConsistentMapBuilder<K, V> implements ConsistentMapBuilder<K, V> { |
| 34 | |
| 35 | private Serializer serializer; |
| 36 | private String name; |
Madan Jampani | e8af1cc | 2015-06-23 14:23:31 -0700 | [diff] [blame] | 37 | private ApplicationId applicationId; |
| 38 | private boolean purgeOnUninstall = false; |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 39 | private boolean partitionsEnabled = true; |
Madan Jampani | 02b7fb8 | 2015-05-01 13:01:20 -0700 | [diff] [blame] | 40 | private boolean readOnly = false; |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 41 | private boolean metering = true; |
Madan Jampani | 3d6a2f6 | 2015-08-12 07:19:07 -0700 | [diff] [blame] | 42 | private boolean relaxedReadConsistency = false; |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 43 | private final DatabaseManager manager; |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 44 | |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 45 | public DefaultConsistentMapBuilder(DatabaseManager manager) { |
| 46 | this.manager = manager; |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 47 | } |
| 48 | |
| 49 | @Override |
| 50 | public ConsistentMapBuilder<K, V> withName(String name) { |
| 51 | checkArgument(name != null && !name.isEmpty()); |
| 52 | this.name = name; |
| 53 | return this; |
| 54 | } |
| 55 | |
| 56 | @Override |
Madan Jampani | e8af1cc | 2015-06-23 14:23:31 -0700 | [diff] [blame] | 57 | public ConsistentMapBuilder<K, V> withApplicationId(ApplicationId id) { |
| 58 | checkArgument(id != null); |
| 59 | this.applicationId = id; |
| 60 | return this; |
| 61 | } |
| 62 | |
| 63 | @Override |
| 64 | public ConsistentMapBuilder<K, V> withPurgeOnUninstall() { |
| 65 | purgeOnUninstall = true; |
| 66 | return this; |
| 67 | } |
| 68 | |
| 69 | @Override |
Flavio Castro | 41b1f3a | 2015-07-31 13:51:32 -0700 | [diff] [blame] | 70 | public ConsistentMapBuilder<K, V> withMeteringDisabled() { |
| 71 | metering = false; |
| 72 | return this; |
| 73 | } |
| 74 | |
| 75 | @Override |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 76 | public ConsistentMapBuilder<K, V> withSerializer(Serializer serializer) { |
| 77 | checkArgument(serializer != null); |
| 78 | this.serializer = serializer; |
| 79 | return this; |
| 80 | } |
| 81 | |
| 82 | @Override |
| 83 | public ConsistentMapBuilder<K, V> withPartitionsDisabled() { |
| 84 | partitionsEnabled = false; |
| 85 | return this; |
| 86 | } |
| 87 | |
Madan Jampani | 02b7fb8 | 2015-05-01 13:01:20 -0700 | [diff] [blame] | 88 | @Override |
| 89 | public ConsistentMapBuilder<K, V> withUpdatesDisabled() { |
| 90 | readOnly = true; |
| 91 | return this; |
| 92 | } |
| 93 | |
Madan Jampani | 3d6a2f6 | 2015-08-12 07:19:07 -0700 | [diff] [blame] | 94 | @Override |
| 95 | public ConsistentMapBuilder<K, V> withRelaxedReadConsistency() { |
| 96 | relaxedReadConsistency = true; |
| 97 | return this; |
| 98 | } |
| 99 | |
Madan Jampani | e8af1cc | 2015-06-23 14:23:31 -0700 | [diff] [blame] | 100 | private void validateInputs() { |
| 101 | checkState(name != null, "name must be specified"); |
| 102 | checkState(serializer != null, "serializer must be specified"); |
| 103 | if (purgeOnUninstall) { |
| 104 | checkState(applicationId != null, "ApplicationId must be specified when purgeOnUninstall is enabled"); |
| 105 | } |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 106 | } |
| 107 | |
| 108 | @Override |
| 109 | public ConsistentMap<K, V> build() { |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 110 | return new DefaultConsistentMap<>(buildAndRegisterMap()); |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | @Override |
| 114 | public AsyncConsistentMap<K, V> buildAsyncMap() { |
Madan Jampani | 50589ac | 2015-06-08 11:38:46 -0700 | [diff] [blame] | 115 | return buildAndRegisterMap(); |
| 116 | } |
| 117 | |
| 118 | private DefaultAsyncConsistentMap<K, V> buildAndRegisterMap() { |
Madan Jampani | e8af1cc | 2015-06-23 14:23:31 -0700 | [diff] [blame] | 119 | validateInputs(); |
Madan Jampani | 3d6a2f6 | 2015-08-12 07:19:07 -0700 | [diff] [blame] | 120 | Database database = partitionsEnabled ? manager.partitionedDatabase : manager.inMemoryDatabase; |
| 121 | if (relaxedReadConsistency) { |
| 122 | return manager.registerMap( |
| 123 | new AsyncCachingConsistentMap<>(name, |
| 124 | applicationId, |
| 125 | database, |
| 126 | serializer, |
| 127 | readOnly, |
| 128 | purgeOnUninstall, |
| 129 | metering)); |
| 130 | } else { |
| 131 | return manager.registerMap( |
| 132 | new DefaultAsyncConsistentMap<>(name, |
| 133 | applicationId, |
| 134 | database, |
| 135 | serializer, |
| 136 | readOnly, |
| 137 | purgeOnUninstall, |
| 138 | metering)); |
| 139 | } |
Madan Jampani | f1b8e17 | 2015-03-23 11:42:02 -0700 | [diff] [blame] | 140 | } |
| 141 | } |