Add IOFSwitch.getInetAddress and comments to other interfaces

src/main/java/net/floodlightcontroller/core/IOFSwitch.java

@@ -18,6 +18,7 @@
 package net.floodlightcontroller.core;
 
 import java.io.IOException;
+import java.net.SocketAddress;
 import java.util.Collection;
 import java.util.Date;
 import java.util.List;
@@ -53,7 +54,31 @@ public interface IOFSwitch {
     public static final String PROP_SUPPORTS_OFPP_TABLE = "supportsOfppTable";
     public static final String PROP_SUPPORTS_OFPP_FLOOD = "supportsOfppFlood";
     public static final String PROP_SUPPORTS_NETMASK_TBL = "supportsNetmaskTbl";
-    
+
+    /**
+     * Set IFloodlightProviderService for this switch instance
+     * Called immediately after instantiation
+     * 
+     * @param controller
+     */
+    public void setFloodlightProvider(Controller controller);
+
+    /**
+     * Set IThreadPoolService for this switch instance
+     * Called immediately after instantiation
+     * 
+     * @param threadPool
+     */
+    public void setThreadPoolService(IThreadPoolService threadPool);
+
+    /**
+     * Set the netty Channel this switch instance is associated with
+     * Called immediately after instantiation
+     * 
+     * @param channel
+     */
+    public void setChannel(Channel channel);
+
     /**
      * Writes to the OFMessage to the output stream.
      * The message will be handed to the floodlightProvider for possible filtering
@@ -403,14 +428,28 @@ public interface IOFSwitch {
      */
     public void setHARole(Role role, boolean haRoleReplyReceived);
 
-    public void setChannel(Channel channel);
-
-    public void setFloodlightProvider(Controller controller);
-
-    public void setThreadPoolService(IThreadPoolService threadPool);
-
+    /**
+     * Return a read lock that must be held while calling the listeners for
+     * messages from the switch. Holding the read lock prevents the active
+     * switch list from being modified out from under the listeners.
+     * @return 
+     */
     public Lock getListenerReadLock();
 
+    /**
+     * Return a write lock that must be held when the controllers modifies the
+     * list of active switches. This is to ensure that the active switch list
+     * doesn't change out from under the listeners as they are handling a
+     * message from the switch.
+     * @return
+     */
     public Lock getListenerWriteLock();
 
+    /**
+     * Get the IP Address for the switch
+     * @return the inet address
+     */
+    public SocketAddress getInetAddress();
+
+
 }

src/main/java/net/floodlightcontroller/core/internal/OFSwitchImpl.java

@@ -633,6 +633,8 @@ public class OFSwitchImpl implements IOFSwitch {
         return xid;
     }
     
+    @JsonIgnore
+    @Override
     public void setHARole(Role role, boolean replyReceived) {
         /* null role implies disconnect the switch */
         if (role == null) {

src/test/java/net/floodlightcontroller/util/OFMessageDamperMockSwitch.java

@@ -2,6 +2,7 @@ package net.floodlightcontroller.util;
 
 import static org.junit.Assert.*;
 import java.io.IOException;
+import java.net.SocketAddress;
 
 import java.util.Collection;
 import java.util.Date;
@@ -391,4 +392,10 @@ public class OFMessageDamperMockSwitch implements IOFSwitch {
         
     }
 
+    @Override
+    public SocketAddress getInetAddress() {
+        // TODO Auto-generated method stub
+        return null;
+    }
+
 }
\ No newline at end of file