Greatly enhance the information returned by the controller switch REST API

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

@@ -18,8 +18,10 @@
 package net.floodlightcontroller.core.internal;
 
 import java.io.IOException;
+import java.net.SocketAddress;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.LinkedList;
@@ -37,11 +39,14 @@ import net.floodlightcontroller.core.IFloodlightProviderService;
 import net.floodlightcontroller.core.IOFMessageListener;
 import net.floodlightcontroller.core.IFloodlightProviderService.Role;
 import net.floodlightcontroller.core.IOFSwitch;
-import net.floodlightcontroller.core.types.MacVlanPair;
+import net.floodlightcontroller.core.web.serializers.DPIDSerializer;
 import net.floodlightcontroller.threadpool.IThreadPoolService;
 import net.floodlightcontroller.util.TimedCache;
 
 import org.codehaus.jackson.annotate.JsonIgnore;
+import org.codehaus.jackson.annotate.JsonProperty;
+import org.codehaus.jackson.map.annotate.JsonSerialize;
+import org.codehaus.jackson.map.ser.ToStringSerializer;
 import org.jboss.netty.channel.Channel;
 import org.openflow.protocol.OFFeaturesReply;
 import org.openflow.protocol.OFFlowMod;
@@ -82,8 +87,6 @@ public class OFSwitchImpl implements IOFSwitch {
     protected Channel channel;
     protected AtomicInteger transactionIdSource;
     protected Map<Short, OFPhysicalPort> ports;
-    protected Long switchClusterId;
-    protected Map<MacVlanPair,Short> macVlanToPortMap;
     protected Map<Integer,OFStatisticsFuture> statsFutureMap;
     protected Map<Integer, IOFMessageListener> iofMsgListenersMap;
     protected boolean connected;
@@ -132,7 +135,6 @@ public class OFSwitchImpl implements IOFSwitch {
         this.connectedSince = new Date();
         this.transactionIdSource = new AtomicInteger();
         this.ports = new ConcurrentHashMap<Short, OFPhysicalPort>();
-        this.switchClusterId = null;
         this.connected = true;
         this.statsFutureMap = new ConcurrentHashMap<Integer,OFStatisticsFuture>();
         this.iofMsgListenersMap = new ConcurrentHashMap<Integer,IOFMessageListener>();
@@ -241,27 +243,20 @@ public class OFSwitchImpl implements IOFSwitch {
         channel.close();
     }
 
+    @JsonIgnore
     public OFFeaturesReply getFeaturesReply() {
         return this.featuresReply;
     }
     
-    public void setSwitchClusterId(Long id) {
-        this.switchClusterId = id;
-    }
-    
-    public Long getSwitchClusterId() {
-        return switchClusterId;
-    }
-
     public synchronized void setFeaturesReply(OFFeaturesReply featuresReply) {
         this.featuresReply = featuresReply;
         for (OFPhysicalPort port : featuresReply.getPorts()) {
             ports.put(port.getPortNumber(), port);
         }
-        this.switchClusterId = featuresReply.getDatapathId();
         this.stringId = HexString.toHexString(featuresReply.getDatapathId());
     }
 
+    @JsonIgnore
     public synchronized List<OFPhysicalPort> getEnabledPorts() {
         List<OFPhysicalPort> result = new ArrayList<OFPhysicalPort>();
         for (OFPhysicalPort port : ports.values()) {
@@ -280,9 +275,15 @@ public class OFSwitchImpl implements IOFSwitch {
         ports.put(port.getPortNumber(), port);
     }
     
+    @JsonIgnore
     public Map<Short, OFPhysicalPort> getPorts() {
         return ports;
     }
+    
+    @JsonProperty("ports")
+    public Collection<OFPhysicalPort> getPortCollection() {
+        return ports.values();
+    }
 
     public synchronized void deletePort(short portNumber) {
         ports.remove(portNumber);
@@ -306,12 +307,15 @@ public class OFSwitchImpl implements IOFSwitch {
     }
     
     @Override
+    @JsonSerialize(using=DPIDSerializer.class)
+    @JsonProperty("dpid")
     public long getId() {
         if (this.featuresReply == null)
             throw new RuntimeException("Features reply has not yet been set");
         return this.featuresReply.getDatapathId();
     }
 
+    @JsonIgnore
     @Override
     public String getStringId() {
         return stringId;
@@ -335,6 +339,7 @@ public class OFSwitchImpl implements IOFSwitch {
         return connectedSince;
     }
 
+    @JsonIgnore
     @Override
     public int getNextTransactionId() {
         return this.transactionIdSource.incrementAndGet();
@@ -409,6 +414,7 @@ public class OFSwitchImpl implements IOFSwitch {
         this.threadPool = tp;
     }
 
+    @JsonIgnore
     @Override
     public synchronized boolean isConnected() {
         return connected;
@@ -424,6 +430,7 @@ public class OFSwitchImpl implements IOFSwitch {
         return role;
     }
     
+    @JsonIgnore
     @Override
     public boolean isActive() {
         return (role != Role.SLAVE);
@@ -469,6 +476,7 @@ public class OFSwitchImpl implements IOFSwitch {
     }
 
     @Override
+    @JsonIgnore
     public Map<Short, Long> getPortBroadcastHits() {
     	return this.portBroadcastCacheHitMap;
     }
@@ -517,6 +525,15 @@ public class OFSwitchImpl implements IOFSwitch {
     public Lock getListenerWriteLock() {
         return listenerLock.writeLock();
     }
+
+    /**
+     * Get the IP Address for the switch
+     * @return the inet address
+     */
+    @JsonSerialize(using=ToStringSerializer.class)
+    public SocketAddress getInetAddress() {
+        return channel.getRemoteAddress();
+    }
     
     /**
      * Send NX role request message to the switch requesting the specified role.

src/main/java/net/floodlightcontroller/core/web/ControllerSwitchesResource.java

@@ -17,10 +17,7 @@
 
 package net.floodlightcontroller.core.web;
 
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.util.Collection;
 
 import net.floodlightcontroller.core.IFloodlightProviderService;
 import net.floodlightcontroller.core.IOFSwitch;
@@ -34,18 +31,10 @@ import org.restlet.resource.ServerResource;
  */
 public class ControllerSwitchesResource extends ServerResource {
     @Get("json")
-    public List<Map<String, String>> retrieve() {
-        List<Map<String, String>> switchIds = new ArrayList<Map<String, String>>();
+    public Collection<IOFSwitch> retrieve() {
         IFloodlightProviderService floodlightProvider = 
                 (IFloodlightProviderService)getContext().getAttributes().
                     get(IFloodlightProviderService.class.getCanonicalName());
-        Map<Long, IOFSwitch> switches = floodlightProvider.getSwitches();
-
-        for (IOFSwitch s: switches.values()) {
-            Map<String, String> m = new HashMap<String, String>();
-            m.put("dpid", s.getStringId());
-            switchIds.add(m);
-        }
-        return switchIds;
+        return floodlightProvider.getSwitches().values();
     }
 }

src/main/java/org/openflow/protocol/serializers/OFPhysicalPortJSONSerializer.java → src/main/java/net/floodlightcontroller/core/web/serializers/ByteArrayMACSerializer.java

 /**
-*    Copyright 2011, Big Switch Networks, Inc. 
+*    Copyright 2011,2012 Big Switch Networks, Inc. 
 *    Originally created by David Erickson, Stanford University
 * 
 *    Licensed under the Apache License, Version 2.0 (the "License"); you may
@@ -15,7 +15,7 @@
 *    under the License.
 **/
 
-package org.openflow.protocol.serializers;
+package net.floodlightcontroller.core.web.serializers;
 
 import java.io.IOException;
 
@@ -23,35 +23,18 @@ import org.codehaus.jackson.JsonGenerator;
 import org.codehaus.jackson.JsonProcessingException;
 import org.codehaus.jackson.map.JsonSerializer;
 import org.codehaus.jackson.map.SerializerProvider;
-import org.openflow.protocol.OFPhysicalPort;
 import org.openflow.util.HexString;
 
-public class OFPhysicalPortJSONSerializer extends JsonSerializer<OFPhysicalPort> {
-
-    /**
-     * Performs the serialization of a OFPhysicalPort object
-     */
-    @Override
-    public void serialize(OFPhysicalPort port, JsonGenerator jGen, SerializerProvider serializer) throws IOException, JsonProcessingException {
-        jGen.writeStartObject();
-        jGen.writeNumberField("advertisedFeatures", port.getAdvertisedFeatures());
-        jGen.writeNumberField("config", port.getConfig());
-        jGen.writeNumberField("currentFeatures", port.getCurrentFeatures());
-        jGen.writeStringField("hardwareAddress", HexString.toHexString(port.getHardwareAddress()));
-        jGen.writeStringField("name", port.getName());
-        jGen.writeNumberField("peerFeatures", port.getPeerFeatures());
-        jGen.writeNumberField("portNumber", port.getPortNumber());
-        jGen.writeNumberField("state", port.getState());
-        jGen.writeNumberField("supportedFeatures", port.getSupportedFeatures());
-        jGen.writeEndObject();
-    }
+/**
+ * Serialize a MAC as colon-separated hexadecimal
+ */
+public class ByteArrayMACSerializer extends JsonSerializer<byte[]> {
 
-    /**
-     * Tells SimpleModule that we are the serializer for OFPhysicalPort
-     */
     @Override
-    public Class<OFPhysicalPort> handledType() {
-        return OFPhysicalPort.class;
+    public void serialize(byte[] mac, JsonGenerator jGen,
+                          SerializerProvider serializer)
+                                  throws IOException, JsonProcessingException {
+        jGen.writeString(HexString.toHexString(mac));
     }
 
 }

src/main/java/net/floodlightcontroller/core/web/serializers/UShortSerializer.java

+/**
+*    Copyright 2011,2012 Big Switch Networks, Inc. 
+*    Originally created by David Erickson, Stanford University
+* 
+*    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 net.floodlightcontroller.core.web.serializers;
+
+import java.io.IOException;
+
+import org.codehaus.jackson.JsonGenerator;
+import org.codehaus.jackson.JsonProcessingException;
+import org.codehaus.jackson.map.JsonSerializer;
+import org.codehaus.jackson.map.SerializerProvider;
+
+/**
+ * Serialize a short value as an unsigned short
+ */
+public class UShortSerializer extends JsonSerializer<Short> {
+
+    @Override
+    public void serialize(Short s, JsonGenerator jGen,
+                          SerializerProvider serializer) throws IOException,
+                                                  JsonProcessingException {
+        if (s == null) jGen.writeNull();
+        else jGen.writeNumber(s.shortValue() & 0xffff);
+    }
+
+}

src/main/java/org/openflow/protocol/OFPhysicalPort.java

@@ -21,16 +21,16 @@ import java.io.UnsupportedEncodingException;
 import java.nio.charset.Charset;
 import java.util.Arrays;
 
+import net.floodlightcontroller.core.web.serializers.ByteArrayMACSerializer;
+import net.floodlightcontroller.core.web.serializers.UShortSerializer;
 
 import org.codehaus.jackson.map.annotate.JsonSerialize;
 import org.jboss.netty.buffer.ChannelBuffer;
-import org.openflow.protocol.serializers.OFPhysicalPortJSONSerializer;
 
 /**
  * Represents ofp_phy_port
  * @author David Erickson (daviderickson@cs.stanford.edu) - Mar 25, 2010
  */
-@JsonSerialize(using=OFPhysicalPortJSONSerializer.class)
 public class OFPhysicalPort {
     public static int MINIMUM_LENGTH = 48;
     public static int OFP_ETH_ALEN = 6;
@@ -221,6 +221,7 @@ public class OFPhysicalPort {
     /**
      * @return the portNumber
      */
+    @JsonSerialize(using=UShortSerializer.class)
     public short getPortNumber() {
         return portNumber;
     }
@@ -235,6 +236,7 @@ public class OFPhysicalPort {
     /**
      * @return the hardwareAddress
      */
+    @JsonSerialize(using=ByteArrayMACSerializer.class)
     public byte[] getHardwareAddress() {
         return hardwareAddress;
     }