[ONOS-3535] Accumulate control message stats using monitor service
- Augment the control message class to have device id
- Initial implementation of accumulating control message stats
- Add more adpator for unit test
- Change Collection<ControlMessage> to Set<ControlMessage>
- Fix the arithmatic exception
- Fix some javadoc warnings
Change-Id: I2abaf0d91edca5419b26f1c5a69246bcdb9201bf
diff --git a/apps/cpman/api/src/main/java/org/onosproject/cpman/ControlMessage.java b/apps/cpman/api/src/main/java/org/onosproject/cpman/ControlMessage.java
index 8b6112e..eb0dcab 100644
--- a/apps/cpman/api/src/main/java/org/onosproject/cpman/ControlMessage.java
+++ b/apps/cpman/api/src/main/java/org/onosproject/cpman/ControlMessage.java
@@ -15,6 +15,8 @@
*/
package org.onosproject.cpman;
+import org.onosproject.net.DeviceId;
+
/**
* Abstraction of control message.
*/
@@ -33,6 +35,13 @@
Type type();
/**
+ * Returns the device identification.
+ *
+ * @return device identification
+ */
+ DeviceId deviceId();
+
+ /**
* Returns the latest control message load.
*
* @return control message load
@@ -56,7 +65,7 @@
/**
* Returns the time that this control message stats collected.
*
- * @return
+ * @return time stamp.
*/
- long timeStamp();
+ long timestamp();
}
diff --git a/apps/cpman/api/src/main/java/org/onosproject/cpman/ControlPlaneMonitorService.java b/apps/cpman/api/src/main/java/org/onosproject/cpman/ControlPlaneMonitorService.java
index f34e82b..051d1c7 100644
--- a/apps/cpman/api/src/main/java/org/onosproject/cpman/ControlPlaneMonitorService.java
+++ b/apps/cpman/api/src/main/java/org/onosproject/cpman/ControlPlaneMonitorService.java
@@ -78,6 +78,7 @@
/**
* Obtains a list of names of available resources.
*
+ * @param resourceType resource type
* @return a collection of names of available resources
*/
Set<String> availableResources(Type resourceType);
diff --git a/apps/cpman/api/src/main/java/org/onosproject/cpman/DefaultControlMessage.java b/apps/cpman/api/src/main/java/org/onosproject/cpman/DefaultControlMessage.java
index e63c0ee..a859cd5 100644
--- a/apps/cpman/api/src/main/java/org/onosproject/cpman/DefaultControlMessage.java
+++ b/apps/cpman/api/src/main/java/org/onosproject/cpman/DefaultControlMessage.java
@@ -15,34 +15,43 @@
*/
package org.onosproject.cpman;
+import org.onosproject.net.DeviceId;
+
+import java.util.Objects;
+
+import static com.google.common.base.MoreObjects.toStringHelper;
+
/**
* Default control message implementation.
*/
public class DefaultControlMessage implements ControlMessage {
private final Type type;
+ private final DeviceId deviceId;
private final long load;
private final long rate;
private final long count;
- private final long timeStamp;
+ private final long timestamp;
/**
* Generates a control message instance using given type and statistic
* information.
*
* @param type control message type
+ * @param deviceId device identification
* @param load control message load
* @param rate control message rate
* @param count control message count
- * @param timeStamp time stamp of the control message stats
+ * @param timestamp time stamp of the control message stats
*/
- public DefaultControlMessage(Type type, long load, long rate,
- long count, long timeStamp) {
+ public DefaultControlMessage(Type type, DeviceId deviceId, long load,
+ long rate, long count, long timestamp) {
this.type = type;
+ this.deviceId = deviceId;
this.load = load;
this.rate = rate;
this.count = count;
- this.timeStamp = timeStamp;
+ this.timestamp = timestamp;
}
@Override
@@ -51,6 +60,11 @@
}
@Override
+ public DeviceId deviceId() {
+ return deviceId;
+ }
+
+ @Override
public long load() {
return load;
}
@@ -66,7 +80,41 @@
}
@Override
- public long timeStamp() {
- return timeStamp;
+ public long timestamp() {
+ return timestamp;
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(type, deviceId.toString(), load, rate, count, timestamp);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj instanceof DefaultControlMessage) {
+ final DefaultControlMessage other = (DefaultControlMessage) obj;
+ return Objects.equals(this.type, other.type) &&
+ Objects.equals(this.deviceId, other.deviceId) &&
+ Objects.equals(this.load, other.load) &&
+ Objects.equals(this.rate, other.rate) &&
+ Objects.equals(this.count, other.count) &&
+ Objects.equals(this.timestamp, other.timestamp);
+ }
+ return false;
+ }
+
+ @Override
+ public String toString() {
+ return toStringHelper(this)
+ .add("type", type)
+ .add("deviceId", deviceId.toString())
+ .add("load", load)
+ .add("rate", rate)
+ .add("count", count)
+ .add("timestamp", timestamp)
+ .toString();
}
}
diff --git a/apps/cpman/api/src/main/java/org/onosproject/cpman/MetricsDatabase.java b/apps/cpman/api/src/main/java/org/onosproject/cpman/MetricsDatabase.java
index 9d4ce08..54167b8 100644
--- a/apps/cpman/api/src/main/java/org/onosproject/cpman/MetricsDatabase.java
+++ b/apps/cpman/api/src/main/java/org/onosproject/cpman/MetricsDatabase.java
@@ -141,6 +141,7 @@
* Add a new metric to be monitored.
*
* @param metricType control metric type
+ * @return builder object
*/
Builder addMetricType(String metricType);
diff --git a/apps/cpman/api/src/main/java/org/onosproject/cpman/message/ControlMessageEvent.java b/apps/cpman/api/src/main/java/org/onosproject/cpman/message/ControlMessageEvent.java
index 83858be..40c3529 100644
--- a/apps/cpman/api/src/main/java/org/onosproject/cpman/message/ControlMessageEvent.java
+++ b/apps/cpman/api/src/main/java/org/onosproject/cpman/message/ControlMessageEvent.java
@@ -15,10 +15,10 @@
*/
package org.onosproject.cpman.message;
-import org.onosproject.event.AbstractEvent;
import org.onosproject.cpman.ControlMessage;
+import org.onosproject.event.AbstractEvent;
-import java.util.Collection;
+import java.util.Set;
import static com.google.common.base.MoreObjects.toStringHelper;
@@ -26,7 +26,7 @@
* Describes control message event.
*/
public class ControlMessageEvent
- extends AbstractEvent<ControlMessageEvent.Type, Collection<ControlMessage>> {
+ extends AbstractEvent<ControlMessageEvent.Type, Set<ControlMessage>> {
/**
* Type of control message events.
@@ -44,7 +44,7 @@
* @param type control message event type
* @param controlMessages event control message subject
*/
- public ControlMessageEvent(Type type, Collection<ControlMessage> controlMessages) {
+ public ControlMessageEvent(Type type, Set<ControlMessage> controlMessages) {
super(type, controlMessages);
}
diff --git a/apps/cpman/api/src/main/java/org/onosproject/cpman/message/ControlMessageProviderService.java b/apps/cpman/api/src/main/java/org/onosproject/cpman/message/ControlMessageProviderService.java
index 7a702c2..0472a2f 100644
--- a/apps/cpman/api/src/main/java/org/onosproject/cpman/message/ControlMessageProviderService.java
+++ b/apps/cpman/api/src/main/java/org/onosproject/cpman/message/ControlMessageProviderService.java
@@ -19,7 +19,7 @@
import org.onosproject.net.DeviceId;
import org.onosproject.net.provider.ProviderService;
-import java.util.Collection;
+import java.util.Set;
/**
* Service through which control message providers can inject control message
@@ -34,5 +34,5 @@
* @param deviceId device identifier
* @param controlMessages a collection of control message stats
*/
- void updateStatsInfo(DeviceId deviceId, Collection<ControlMessage> controlMessages);
+ void updateStatsInfo(DeviceId deviceId, Set<ControlMessage> controlMessages);
}
\ No newline at end of file
diff --git a/apps/cpman/api/src/main/java/org/onosproject/cpman/message/ControlMessageStore.java b/apps/cpman/api/src/main/java/org/onosproject/cpman/message/ControlMessageStore.java
index 8c6667a..32083b6 100644
--- a/apps/cpman/api/src/main/java/org/onosproject/cpman/message/ControlMessageStore.java
+++ b/apps/cpman/api/src/main/java/org/onosproject/cpman/message/ControlMessageStore.java
@@ -20,7 +20,7 @@
import org.onosproject.net.provider.ProviderId;
import org.onosproject.store.Store;
-import java.util.Collection;
+import java.util.Set;
/**
* Manages inventory of control message.
@@ -37,6 +37,6 @@
* @return ready to send event describing what occurred
*/
ControlMessageEvent updateStatsInfo(ProviderId providerId, DeviceId deviceId,
- Collection<ControlMessage> controlMessages);
+ Set<ControlMessage> controlMessages);
}