Yuta HIGUCHI | b5df76d | 2014-09-27 20:54:00 -0700 | [diff] [blame] | 1 | package org.onlab.onos.store.common; |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 2 | |
| 3 | import com.google.common.base.Optional; |
| 4 | import com.google.common.cache.LoadingCache; |
| 5 | import com.hazelcast.core.EntryAdapter; |
| 6 | import com.hazelcast.core.EntryEvent; |
| 7 | import com.hazelcast.core.HazelcastInstance; |
| 8 | import com.hazelcast.core.MapEvent; |
Yuta HIGUCHI | fec9e19 | 2014-09-28 14:58:02 -0700 | [diff] [blame] | 9 | import com.hazelcast.core.Member; |
Yuta HIGUCHI | b5df76d | 2014-09-27 20:54:00 -0700 | [diff] [blame] | 10 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 11 | import org.apache.felix.scr.annotations.Activate; |
| 12 | import org.apache.felix.scr.annotations.Component; |
| 13 | import org.apache.felix.scr.annotations.Reference; |
| 14 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
tom | 0755a36 | 2014-09-24 11:54:43 -0700 | [diff] [blame] | 15 | import org.onlab.onos.event.Event; |
| 16 | import org.onlab.onos.store.AbstractStore; |
| 17 | import org.onlab.onos.store.StoreDelegate; |
Yuta HIGUCHI | 672488d | 2014-10-07 09:23:43 -0700 | [diff] [blame] | 18 | import org.onlab.onos.store.serializers.KryoSerializer; |
Yuta HIGUCHI | 971addc | 2014-10-07 23:23:17 -0700 | [diff] [blame] | 19 | import org.onlab.onos.store.serializers.StoreSerializer; |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 20 | import org.slf4j.Logger; |
| 21 | |
| 22 | import static com.google.common.base.Preconditions.checkNotNull; |
| 23 | import static org.slf4j.LoggerFactory.getLogger; |
| 24 | |
| 25 | /** |
| 26 | * Abstraction of a distributed store based on Hazelcast. |
| 27 | */ |
Yuta HIGUCHI | 672488d | 2014-10-07 09:23:43 -0700 | [diff] [blame] | 28 | @Component |
Yuta HIGUCHI | 2e96389 | 2014-09-27 13:00:39 -0700 | [diff] [blame] | 29 | public abstract class AbstractHazelcastStore<E extends Event, D extends StoreDelegate<E>> |
tom | ca55e64 | 2014-09-24 18:28:38 -0700 | [diff] [blame] | 30 | extends AbstractStore<E, D> { |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 31 | |
| 32 | protected final Logger log = getLogger(getClass()); |
| 33 | |
| 34 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 35 | protected StoreService storeService; |
| 36 | |
Yuta HIGUCHI | 971addc | 2014-10-07 23:23:17 -0700 | [diff] [blame] | 37 | protected StoreSerializer serializer; |
Yuta HIGUCHI | ad4c218 | 2014-09-29 11:16:23 -0700 | [diff] [blame] | 38 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 39 | protected HazelcastInstance theInstance; |
| 40 | |
| 41 | @Activate |
| 42 | public void activate() { |
Yuta HIGUCHI | 672488d | 2014-10-07 09:23:43 -0700 | [diff] [blame] | 43 | serializer = new KryoSerializer(); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 44 | theInstance = storeService.getHazelcastInstance(); |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * Serializes the specified object using the backing store service. |
| 49 | * |
| 50 | * @param obj object to be serialized |
| 51 | * @return serialized object |
| 52 | */ |
| 53 | protected byte[] serialize(Object obj) { |
Yuta HIGUCHI | 672488d | 2014-10-07 09:23:43 -0700 | [diff] [blame] | 54 | return serializer.encode(obj); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 55 | } |
| 56 | |
| 57 | /** |
| 58 | * Deserializes the specified object using the backing store service. |
| 59 | * |
| 60 | * @param bytes bytes to be deserialized |
| 61 | * @param <T> type of object |
| 62 | * @return deserialized object |
| 63 | */ |
| 64 | protected <T> T deserialize(byte[] bytes) { |
Yuta HIGUCHI | 672488d | 2014-10-07 09:23:43 -0700 | [diff] [blame] | 65 | return serializer.decode(bytes); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 66 | } |
| 67 | |
| 68 | |
| 69 | /** |
| 70 | * An IMap entry listener, which reflects each remote event to the cache. |
| 71 | * |
| 72 | * @param <K> IMap key type after deserialization |
| 73 | * @param <V> IMap value type after deserialization |
| 74 | */ |
Yuta HIGUCHI | fec9e19 | 2014-09-28 14:58:02 -0700 | [diff] [blame] | 75 | public class RemoteCacheEventHandler<K, V> extends EntryAdapter<byte[], byte[]> { |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 76 | |
Yuta HIGUCHI | fec9e19 | 2014-09-28 14:58:02 -0700 | [diff] [blame] | 77 | private final Member localMember; |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 78 | private LoadingCache<K, Optional<V>> cache; |
| 79 | |
| 80 | /** |
| 81 | * Constructor. |
| 82 | * |
| 83 | * @param cache cache to update |
| 84 | */ |
Yuta HIGUCHI | fec9e19 | 2014-09-28 14:58:02 -0700 | [diff] [blame] | 85 | public RemoteCacheEventHandler(LoadingCache<K, Optional<V>> cache) { |
| 86 | this.localMember = theInstance.getCluster().getLocalMember(); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 87 | this.cache = checkNotNull(cache); |
| 88 | } |
| 89 | |
| 90 | @Override |
| 91 | public void mapCleared(MapEvent event) { |
Yuta HIGUCHI | fec9e19 | 2014-09-28 14:58:02 -0700 | [diff] [blame] | 92 | if (localMember.equals(event.getMember())) { |
| 93 | // ignore locally triggered event |
| 94 | return; |
| 95 | } |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 96 | cache.invalidateAll(); |
| 97 | } |
| 98 | |
| 99 | @Override |
tom | ca55e64 | 2014-09-24 18:28:38 -0700 | [diff] [blame] | 100 | public void entryAdded(EntryEvent<byte[], byte[]> event) { |
Yuta HIGUCHI | fec9e19 | 2014-09-28 14:58:02 -0700 | [diff] [blame] | 101 | if (localMember.equals(event.getMember())) { |
| 102 | // ignore locally triggered event |
| 103 | return; |
| 104 | } |
tom | ca55e64 | 2014-09-24 18:28:38 -0700 | [diff] [blame] | 105 | K key = deserialize(event.getKey()); |
| 106 | V newVal = deserialize(event.getValue()); |
| 107 | Optional<V> newValue = Optional.of(newVal); |
| 108 | cache.asMap().putIfAbsent(key, newValue); |
| 109 | onAdd(key, newVal); |
| 110 | } |
| 111 | |
| 112 | @Override |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 113 | public void entryUpdated(EntryEvent<byte[], byte[]> event) { |
Yuta HIGUCHI | fec9e19 | 2014-09-28 14:58:02 -0700 | [diff] [blame] | 114 | if (localMember.equals(event.getMember())) { |
| 115 | // ignore locally triggered event |
| 116 | return; |
| 117 | } |
tom | ca55e64 | 2014-09-24 18:28:38 -0700 | [diff] [blame] | 118 | K key = deserialize(event.getKey()); |
| 119 | V oldVal = deserialize(event.getOldValue()); |
Yuta HIGUCHI | bb1fc72 | 2014-09-24 00:00:13 -0700 | [diff] [blame] | 120 | Optional<V> oldValue = Optional.fromNullable(oldVal); |
tom | ca55e64 | 2014-09-24 18:28:38 -0700 | [diff] [blame] | 121 | V newVal = deserialize(event.getValue()); |
Yuta HIGUCHI | bb1fc72 | 2014-09-24 00:00:13 -0700 | [diff] [blame] | 122 | Optional<V> newValue = Optional.of(newVal); |
| 123 | cache.asMap().replace(key, oldValue, newValue); |
Yuta HIGUCHI | a8a53eb | 2014-09-25 17:47:55 -0700 | [diff] [blame] | 124 | onUpdate(key, oldVal, newVal); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 125 | } |
| 126 | |
| 127 | @Override |
| 128 | public void entryRemoved(EntryEvent<byte[], byte[]> event) { |
Yuta HIGUCHI | fec9e19 | 2014-09-28 14:58:02 -0700 | [diff] [blame] | 129 | if (localMember.equals(event.getMember())) { |
| 130 | // ignore locally triggered event |
| 131 | return; |
| 132 | } |
tom | ca55e64 | 2014-09-24 18:28:38 -0700 | [diff] [blame] | 133 | K key = deserialize(event.getKey()); |
Yuta HIGUCHI | f547970 | 2014-09-25 00:09:24 -0700 | [diff] [blame] | 134 | V val = deserialize(event.getOldValue()); |
tom | ca55e64 | 2014-09-24 18:28:38 -0700 | [diff] [blame] | 135 | cache.invalidate(key); |
| 136 | onRemove(key, val); |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 137 | } |
| 138 | |
tom | ca55e64 | 2014-09-24 18:28:38 -0700 | [diff] [blame] | 139 | /** |
| 140 | * Cache entry addition hook. |
| 141 | * |
| 142 | * @param key new key |
| 143 | * @param newVal new value |
| 144 | */ |
| 145 | protected void onAdd(K key, V newVal) { |
| 146 | } |
| 147 | |
| 148 | /** |
| 149 | * Cache entry update hook. |
| 150 | * |
| 151 | * @param key new key |
Yuta HIGUCHI | a8a53eb | 2014-09-25 17:47:55 -0700 | [diff] [blame] | 152 | * @param oldValue old value |
tom | ca55e64 | 2014-09-24 18:28:38 -0700 | [diff] [blame] | 153 | * @param newVal new value |
| 154 | */ |
Yuta HIGUCHI | a8a53eb | 2014-09-25 17:47:55 -0700 | [diff] [blame] | 155 | protected void onUpdate(K key, V oldValue, V newVal) { |
tom | ca55e64 | 2014-09-24 18:28:38 -0700 | [diff] [blame] | 156 | } |
| 157 | |
| 158 | /** |
| 159 | * Cache entry remove hook. |
| 160 | * |
| 161 | * @param key new key |
| 162 | * @param val old value |
| 163 | */ |
| 164 | protected void onRemove(K key, V val) { |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 165 | } |
| 166 | } |
| 167 | |
Yuta HIGUCHI | fec9e19 | 2014-09-28 14:58:02 -0700 | [diff] [blame] | 168 | /** |
| 169 | * Distributed object remote event entry listener. |
| 170 | * |
| 171 | * @param <K> Entry key type after deserialization |
| 172 | * @param <V> Entry value type after deserialization |
| 173 | */ |
| 174 | public class RemoteEventHandler<K, V> extends EntryAdapter<byte[], byte[]> { |
| 175 | |
| 176 | private final Member localMember; |
| 177 | |
| 178 | public RemoteEventHandler() { |
| 179 | this.localMember = theInstance.getCluster().getLocalMember(); |
| 180 | } |
| 181 | @Override |
| 182 | public void entryAdded(EntryEvent<byte[], byte[]> event) { |
| 183 | if (localMember.equals(event.getMember())) { |
| 184 | // ignore locally triggered event |
| 185 | return; |
| 186 | } |
| 187 | K key = deserialize(event.getKey()); |
| 188 | V newVal = deserialize(event.getValue()); |
| 189 | onAdd(key, newVal); |
| 190 | } |
| 191 | |
| 192 | @Override |
| 193 | public void entryRemoved(EntryEvent<byte[], byte[]> event) { |
| 194 | if (localMember.equals(event.getMember())) { |
| 195 | // ignore locally triggered event |
| 196 | return; |
| 197 | } |
| 198 | K key = deserialize(event.getKey()); |
| 199 | V val = deserialize(event.getValue()); |
| 200 | onRemove(key, val); |
| 201 | } |
| 202 | |
| 203 | @Override |
| 204 | public void entryUpdated(EntryEvent<byte[], byte[]> event) { |
| 205 | if (localMember.equals(event.getMember())) { |
| 206 | // ignore locally triggered event |
| 207 | return; |
| 208 | } |
| 209 | K key = deserialize(event.getKey()); |
| 210 | V oldVal = deserialize(event.getOldValue()); |
| 211 | V newVal = deserialize(event.getValue()); |
| 212 | onUpdate(key, oldVal, newVal); |
| 213 | } |
| 214 | |
| 215 | /** |
| 216 | * Remote entry addition hook. |
| 217 | * |
| 218 | * @param key new key |
| 219 | * @param newVal new value |
| 220 | */ |
| 221 | protected void onAdd(K key, V newVal) { |
| 222 | } |
| 223 | |
| 224 | /** |
| 225 | * Remote entry update hook. |
| 226 | * |
| 227 | * @param key new key |
| 228 | * @param oldValue old value |
| 229 | * @param newVal new value |
| 230 | */ |
| 231 | protected void onUpdate(K key, V oldValue, V newVal) { |
| 232 | } |
| 233 | |
| 234 | /** |
| 235 | * Remote entry remove hook. |
| 236 | * |
| 237 | * @param key new key |
| 238 | * @param val old value |
| 239 | */ |
| 240 | protected void onRemove(K key, V val) { |
| 241 | } |
| 242 | } |
| 243 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 244 | } |