Implement listeners for ConsistentMultimap.
Change-Id: Ica07d444c18af8ba7a9bbb120623512def572a48
diff --git a/core/api/src/main/java/org/onosproject/store/primitives/DefaultConsistentMultimap.java b/core/api/src/main/java/org/onosproject/store/primitives/DefaultConsistentMultimap.java
index e8142a4..c7c9f5d 100644
--- a/core/api/src/main/java/org/onosproject/store/primitives/DefaultConsistentMultimap.java
+++ b/core/api/src/main/java/org/onosproject/store/primitives/DefaultConsistentMultimap.java
@@ -21,6 +21,7 @@
import org.onosproject.store.service.AsyncConsistentMultimap;
import org.onosproject.store.service.ConsistentMapException;
import org.onosproject.store.service.ConsistentMultimap;
+import org.onosproject.store.service.MultimapEventListener;
import org.onosproject.store.service.Synchronous;
import org.onosproject.store.service.Versioned;
@@ -29,6 +30,7 @@
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Executor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
@@ -144,6 +146,16 @@
//FIXME implement this when a new version of ConsistentMapBackedJavaMap is made for multimaps
}
+ @Override
+ public void addListener(MultimapEventListener<K, V> listener, Executor executor) {
+ complete(asyncMultimap.addListener(listener, executor));
+ }
+
+ @Override
+ public void removeListener(MultimapEventListener<K, V> listener) {
+ complete(asyncMultimap.removeListener(listener));
+ }
+
private <T> T complete(CompletableFuture<T> future) {
try {
return future.get(operationTimeoutMillis, TimeUnit.MILLISECONDS);
diff --git a/core/api/src/main/java/org/onosproject/store/service/AsyncConsistentMultimap.java b/core/api/src/main/java/org/onosproject/store/service/AsyncConsistentMultimap.java
index 36d6d25..6a44e06 100644
--- a/core/api/src/main/java/org/onosproject/store/service/AsyncConsistentMultimap.java
+++ b/core/api/src/main/java/org/onosproject/store/service/AsyncConsistentMultimap.java
@@ -17,12 +17,14 @@
package org.onosproject.store.service;
import com.google.common.collect.Multiset;
+import com.google.common.util.concurrent.MoreExecutors;
import org.onosproject.store.primitives.DefaultConsistentMultimap;
import java.util.Collection;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.Executor;
/**
* Interface for a distributed multimap.
@@ -222,6 +224,34 @@
CompletableFuture<Collection<Map.Entry<K, V>>> entries();
/**
+ * Registers the specified listener to be notified whenever the map is updated.
+ *
+ * @param listener listener to notify about map events
+ * @return future that will be completed when the operation finishes
+ */
+ default CompletableFuture<Void> addListener(MultimapEventListener<K, V> listener) {
+ return addListener(listener, MoreExecutors.directExecutor());
+ }
+
+ /**
+ * Registers the specified listener to be notified whenever the map is updated.
+ *
+ * @param listener listener to notify about map events
+ * @param executor executor to use for handling incoming map events
+ * @return future that will be completed when the operation finishes
+ */
+ CompletableFuture<Void> addListener(MultimapEventListener<K, V> listener, Executor executor);
+
+ /**
+ * Unregisters the specified listener such that it will no longer
+ * receive map change notifications.
+ *
+ * @param listener listener to unregister
+ * @return future that will be completed when the operation finishes
+ */
+ CompletableFuture<Void> removeListener(MultimapEventListener<K, V> listener);
+
+ /**
* Returns a map of keys to collections of values that reflect the set of
* key-value pairs contained in the multimap, where the key value pairs
* would be the key paired with each of the values in the collection.
diff --git a/core/api/src/main/java/org/onosproject/store/service/ConsistentMultimap.java b/core/api/src/main/java/org/onosproject/store/service/ConsistentMultimap.java
index 8858369..bba38bb 100644
--- a/core/api/src/main/java/org/onosproject/store/service/ConsistentMultimap.java
+++ b/core/api/src/main/java/org/onosproject/store/service/ConsistentMultimap.java
@@ -17,10 +17,12 @@
package org.onosproject.store.service;
import com.google.common.collect.Multiset;
+import com.google.common.util.concurrent.MoreExecutors;
import java.util.Collection;
import java.util.Map;
import java.util.Set;
+import java.util.concurrent.Executor;
/**
* This provides a synchronous version of the functionality provided by
@@ -203,4 +205,29 @@
* empty.
*/
Map<K, Collection<V>> asMap();
+
+ /**
+ * Registers the specified listener to be notified whenever the map is updated.
+ *
+ * @param listener listener to notify about map events
+ */
+ default void addListener(MultimapEventListener<K, V> listener) {
+ addListener(listener, MoreExecutors.directExecutor());
+ }
+
+ /**
+ * Registers the specified listener to be notified whenever the map is updated.
+ *
+ * @param listener listener to notify about map events
+ * @param executor executor to use for handling incoming map events
+ */
+ void addListener(MultimapEventListener<K, V> listener, Executor executor);
+
+ /**
+ * Unregisters the specified listener such that it will no longer
+ * receive map change notifications.
+ *
+ * @param listener listener to unregister
+ */
+ void removeListener(MultimapEventListener<K, V> listener);
}
diff --git a/core/api/src/main/java/org/onosproject/store/service/MultimapEvent.java b/core/api/src/main/java/org/onosproject/store/service/MultimapEvent.java
new file mode 100644
index 0000000..ed56974
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/store/service/MultimapEvent.java
@@ -0,0 +1,145 @@
+/*
+ * Copyright 2017-present Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.store.service;
+
+import com.google.common.base.MoreObjects;
+
+import java.util.Objects;
+
+/**
+ * Representation of a ConsistentMultimap update notification.
+ *
+ * @param <K> key type
+ * @param <V> value type
+ */
+public class MultimapEvent<K, V> {
+
+ /**
+ * MultimapEvent type.
+ */
+ public enum Type {
+ /**
+ * Entry inserted into the map.
+ */
+ INSERT,
+
+ /**
+ * Entry removed from map.
+ */
+ REMOVE
+ }
+
+ private final String name;
+ private final Type type;
+ private final K key;
+ private final V newValue;
+ private final V oldValue;
+
+ /**
+ * Creates a new event object.
+ *
+ * @param name map name
+ * @param key key the event concerns
+ * @param newValue new value key is mapped to
+ * @param oldValue previous value that was mapped to the key
+ */
+ public MultimapEvent(String name, K key, V newValue, V oldValue) {
+ this.name = name;
+ this.key = key;
+ this.newValue = newValue;
+ this.oldValue = oldValue;
+ this.type = newValue != null ? Type.INSERT : Type.REMOVE;
+ }
+
+ /**
+ * Returns the map name.
+ *
+ * @return name of map
+ */
+ public String name() {
+ return name;
+ }
+
+ /**
+ * Returns the type of the event.
+ *
+ * @return the type of event
+ */
+ public Type type() {
+ return type;
+ }
+
+ /**
+ * Returns the key this event concerns.
+ *
+ * @return the key
+ */
+ public K key() {
+ return key;
+ }
+
+ /**
+ * Returns the new value in the map associated with the key.
+ * If {@link #type()} returns {@code REMOVE},
+ * this method will return {@code null}.
+ *
+ * @return the new value for key
+ */
+ public V newValue() {
+ return newValue;
+ }
+
+ /**
+ * Returns the old value that was associated with the key.
+ * If {@link #type()} returns {@code INSERT}, this method will return
+ * {@code null}.
+ *
+ * @return the old value that was mapped to the key
+ */
+ public V oldValue() {
+ return oldValue;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (!(o instanceof MultimapEvent)) {
+ return false;
+ }
+
+ MultimapEvent<K, V> that = (MultimapEvent) o;
+ return Objects.equals(this.name, that.name) &&
+ Objects.equals(this.type, that.type) &&
+ Objects.equals(this.key, that.key) &&
+ Objects.equals(this.newValue, that.newValue) &&
+ Objects.equals(this.oldValue, that.oldValue);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(name, type, key, newValue, oldValue);
+ }
+
+ @Override
+ public String toString() {
+ return MoreObjects.toStringHelper(getClass())
+ .add("name", name)
+ .add("type", type)
+ .add("key", key)
+ .add("newValue", newValue)
+ .add("oldValue", oldValue)
+ .toString();
+ }
+}
diff --git a/core/api/src/main/java/org/onosproject/store/service/MultimapEventListener.java b/core/api/src/main/java/org/onosproject/store/service/MultimapEventListener.java
new file mode 100644
index 0000000..2445af9
--- /dev/null
+++ b/core/api/src/main/java/org/onosproject/store/service/MultimapEventListener.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright 2017-present Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.store.service;
+
+/**
+ * Listener to be notified about updates to a ConsistentMultimap.
+ */
+public interface MultimapEventListener<K, V> {
+
+ /**
+ * Reacts to the specified event.
+ *
+ * @param event the event
+ */
+ void event(MultimapEvent<K, V> event);
+}
diff --git a/core/api/src/test/java/org/onosproject/store/service/TestConsistentMultimap.java b/core/api/src/test/java/org/onosproject/store/service/TestConsistentMultimap.java
index 6bf6602..2e46d92 100644
--- a/core/api/src/test/java/org/onosproject/store/service/TestConsistentMultimap.java
+++ b/core/api/src/test/java/org/onosproject/store/service/TestConsistentMultimap.java
@@ -21,6 +21,7 @@
import java.util.Collection;
import java.util.Map;
import java.util.Set;
+import java.util.concurrent.Executor;
import java.util.concurrent.atomic.AtomicLong;
/**
@@ -134,6 +135,14 @@
}
@Override
+ public void addListener(MultimapEventListener<K, V> listener, Executor executor) {
+ }
+
+ @Override
+ public void removeListener(MultimapEventListener<K, V> listener) {
+ }
+
+ @Override
public String name() {
return this.name;
}