OpenDaylight Controller functional modules.

[controller.git] / opendaylight / northbound / topology / src / main / java / org / opendaylight / controller / topology / northbound / TopologyNorthboundJAXRS.java

diff --git a/opendaylight/northbound/topology/src/main/java/org/opendaylight/controller/topology/northbound/TopologyNorthboundJAXRS.java b/opendaylight/northbound/topology/src/main/java/org/opendaylight/controller/topology/northbound/TopologyNorthboundJAXRS.java
new file mode 100644 (file)
index 0000000..00b27b0
--- /dev/null
+++ b/opendaylight/northbound/topology/src/main/java/org/opendaylight/controller/topology/northbound/TopologyNorthboundJAXRS.java
@@ -0,0 +1,88 @@
+
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.opendaylight.controller.topology.northbound;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+
+import org.codehaus.enunciate.jaxrs.ResponseCode;
+import org.codehaus.enunciate.jaxrs.StatusCodes;
+import org.codehaus.enunciate.jaxrs.TypeHint;
+import org.opendaylight.controller.northbound.commons.RestMessages;
+import org.opendaylight.controller.northbound.commons.exception.ResourceNotFoundException;
+import org.opendaylight.controller.sal.core.Edge;
+import org.opendaylight.controller.sal.core.Property;
+import org.opendaylight.controller.sal.utils.ServiceHelper;
+import org.opendaylight.controller.topologymanager.ITopologyManager;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Topology Northbound REST API
+ * 
+ * <br><br>
+ * Authentication scheme : <b>HTTP Basic</b><br>
+ * Authentication realm : <b>opendaylight</b><br>
+ * Transport : <b>HTTP and HTTPS</b><br>
+ * <br>
+ * HTTPS Authentication is disabled by default. Administrator can enable it in tomcat-server.xml after adding 
+ * a proper keystore / SSL certificate from a trusted authority.<br>
+ * More info : http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
+ */
+
+@Path("/")
+public class TopologyNorthboundJAXRS {
+    private static Logger logger = LoggerFactory
+            .getLogger(TopologyNorthboundJAXRS.class);
+
+    /**
+     *
+     * Retrieve the Topology for the
+     *
+     * @param containerName The container for which we want to retrieve the topology
+     *
+     * @return A List of EdgeProps each EdgeProp represent an Edge of
+     * the grap with the corresponding properties attached to it.
+     */
+    @Path("/{containerName}")
+    @GET
+    @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
+    @TypeHint(Topology.class)
+    @StatusCodes( { @ResponseCode(code = 404, condition = "The containerName passed was not found") })
+    public Topology getTopology(
+            @PathParam("containerName") String containerName) {
+        ITopologyManager topologyManager = (ITopologyManager) ServiceHelper
+                .getInstance(ITopologyManager.class, containerName, this);
+        if (topologyManager == null) {
+            throw new ResourceNotFoundException(RestMessages.NOCONTAINER
+                    .toString());
+        }
+
+        Map<Edge, Set<Property>> topo = topologyManager.getEdges();
+        if (topo != null) {
+            List<EdgeProperties> res = new ArrayList<EdgeProperties>();
+            for (Map.Entry<Edge, Set<Property>> entry : topo.entrySet()) {
+                EdgeProperties el = new EdgeProperties(entry.getKey(), entry.getValue());
+                res.add(el);
+            }
+            return new Topology(res);
+        }
+
+        return null;
+    }
+}