added default host constructs to API
Change-Id: I3ef3e08559c7c4d73d8e4aee693589ee0830ed85
diff --git a/core/api/src/main/java/org/onlab/onos/net/host/HostDescription.java b/core/api/src/main/java/org/onlab/onos/net/host/HostDescription.java
index e3c67b9..62a4c9a 100644
--- a/core/api/src/main/java/org/onlab/onos/net/host/HostDescription.java
+++ b/core/api/src/main/java/org/onlab/onos/net/host/HostDescription.java
@@ -1,11 +1,43 @@
package org.onlab.onos.net.host;
+import java.util.Set;
+
+import org.onlab.onos.net.Description;
+import org.onlab.onos.net.HostLocation;
+import org.onlab.packet.IPv4;
+import org.onlab.packet.MACAddress;
+
/**
* Information describing host and its location.
*/
-public interface HostDescription {
+public interface HostDescription extends Description {
- // IP, MAC, VLAN-ID, HostLocation -> (ConnectionPoint + timestamp)
+ /**
+ * Returns the MAC address associated with this host (NIC).
+ *
+ * @return the MAC address of this host
+ */
+ MACAddress hwAddress();
+
+ /**
+ * Returns the VLAN associated with this host.
+ *
+ * @return the VLAN ID value
+ */
+ short vlan();
+
+ /**
+ * Returns the location of the host on the network edge.
+ *
+ * @return the network location
+ */
+ HostLocation location();
+
+ /**
+ * Returns zero or more IP address(es) associated with this host's MAC.
+ *
+ * @return a set of IP addresses.
+ */
+ Set<IPv4> ipAddresses();
}
-