org.onosproject.rest.resources

Class TopologyWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.TopologyWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="topology")
public class TopologyWebResource
extends org.onosproject.rest.AbstractWebResource

Query network topology graph and its components.

Constructor Summary

Constructors

Constructor and Description
TopologyWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getCluster(int clusterId) Gets details of a specific SCC.
javax.ws.rs.core.Response	getClusterDevices(int clusterId) Gets devices in a specific SCC.
javax.ws.rs.core.Response	getClusterLinks(int clusterId) Gets links in specific SCC.
javax.ws.rs.core.Response	getClusters() Gets overview of topology SCCs.
javax.ws.rs.core.Response	getConnectPointBroadcast(String connectPointString) Tests if a connect point is in broadcast set.
javax.ws.rs.core.Response	getConnectPointInfrastructure(String connectPointString) Tests if a connect point is infrastructure or edge.
javax.ws.rs.core.Response	getTopology() Gets overview of current topology.

Methods inherited from class org.onosproject.rest.AbstractWebResource

codec, encodeArray, getService, mapper, newArray, newObject

Methods inherited from class org.onlab.rest.BaseResource

get, ok

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.onosproject.codec.CodecContext

decode, encode

Constructor Detail

TopologyWebResource

public TopologyWebResource()

Method Detail

getTopology

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getTopology()

Gets overview of current topology.

Returns:

200 OK with topology overview

onos model

Topology

getClusters

@GET
 @Produces(value="application/json")
 @Path(value="clusters")
public javax.ws.rs.core.Response getClusters()

Gets overview of topology SCCs.

Returns:

200 OK with topology clusters overview

onos model

TopologyClusters

getCluster

@GET
 @Produces(value="application/json")
 @Path(value="clusters/{id}")
public javax.ws.rs.core.Response getCluster(@PathParam(value="id")
                                                                                                                    int clusterId)

Gets details of a specific SCC.

Parameters:

clusterId - id of the cluster to query

Returns:

200 OK with topology cluster details

onos model

TopologyCluster

getClusterDevices

@GET
 @Produces(value="application/json")
 @Path(value="clusters/{id}/devices")
public javax.ws.rs.core.Response getClusterDevices(@PathParam(value="id")
                                                                                                                                   int clusterId)

Gets devices in a specific SCC.

Parameters:

clusterId - id of the cluster to query

Returns:

200 OK with topology cluster devices

onos model

TopologyClustersDevices

getClusterLinks

@GET
 @Produces(value="application/json")
 @Path(value="clusters/{id}/links")
public javax.ws.rs.core.Response getClusterLinks(@PathParam(value="id")
                                                                                                                               int clusterId)

Gets links in specific SCC.

Parameters:

clusterId - id of the cluster to query

Returns:

200 OK with topology cluster links

onos model

LinksGet

getConnectPointBroadcast

@GET
 @Produces(value="application/json")
 @Path(value="broadcast/{connectPoint}")
public javax.ws.rs.core.Response getConnectPointBroadcast(@PathParam(value="connectPoint")
                                                                                                                                             String connectPointString)

Tests if a connect point is in broadcast set.

Parameters:

connectPointString - deviceid:portnumber

Returns:

200 OK with JSON representation of true if the connect point is broadcast, false otherwise

onos model

TopologyBroadcast

getConnectPointInfrastructure

@GET
 @Produces(value="application/json")
 @Path(value="infrastructure/{connectPoint}")
public javax.ws.rs.core.Response getConnectPointInfrastructure(@PathParam(value="connectPoint")
                                                                                                                                                       String connectPointString)

Tests if a connect point is infrastructure or edge.

Parameters:

connectPointString - deviceid:portnumber

Returns:

200 OK with JSON representation of true if the connect point is broadcast, false otherwise

onos model

TopologyInfrastructure