org.onosproject.rest.resources

Class DpisWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.DpisWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="dpis")
public class DpisWebResource
extends org.onosproject.rest.AbstractWebResource

Query the latest DPI statistics info.

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<org.onosproject.incubator.net.dpi.FlowStatInfo>	FLOW_STAT_INFO_COMPARATOR
static Comparator<org.onosproject.incubator.net.dpi.ProtocolStatInfo>	PROTOCOL_STAT_INFO_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
DpisWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addDpiStatistics(InputStream stream) Add new dpi statistics entry at the end of list.
javax.ws.rs.core.Response	getDetectedProtocols(int topn) Gets the latest detected protocol statistics only.
javax.ws.rs.core.Response	getDpisLatest(int topn) Gets the latest dpi statistics.
javax.ws.rs.core.Response	getKnownFlows(int topn) Gets the latest known flows statistics only.
javax.ws.rs.core.Response	getTrafficStatistics() Gets the latest traffic statistics only.
javax.ws.rs.core.Response	getUnknownFlows(int topn) Gets the latest unknown flows statistics only.

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

Field Detail

PROTOCOL_STAT_INFO_COMPARATOR

public static final Comparator<org.onosproject.incubator.net.dpi.ProtocolStatInfo> PROTOCOL_STAT_INFO_COMPARATOR

FLOW_STAT_INFO_COMPARATOR

public static final Comparator<org.onosproject.incubator.net.dpi.FlowStatInfo> FLOW_STAT_INFO_COMPARATOR

Constructor Detail

DpisWebResource

public DpisWebResource()

Method Detail

getDpisLatest

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getDpisLatest(@QueryParam(value="topn")
                                                                                         int topn)

Gets the latest dpi statistics.

Parameters:

topn - max size

Returns:

200 OK with a dpi statistics

onos model

DpiStatistics

getTrafficStatistics

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

Gets the latest traffic statistics only.

Returns:

200 OK with a traffic statistics

onos model

TrafficStatistics

getDetectedProtocols

@GET
 @Produces(value="application/json")
 @Path(value="protocols")
public javax.ws.rs.core.Response getDetectedProtocols(@QueryParam(value="topn")
                                                                                                                          int topn)

Gets the latest detected protocol statistics only.

Parameters:

topn - max size

Returns:

200 OK with a protocol statistics

onos model

ProtocolStatistics

getKnownFlows

@GET
 @Produces(value="application/json")
 @Path(value="knownFlows")
public javax.ws.rs.core.Response getKnownFlows(@QueryParam(value="topn")
                                                                                                                    int topn)

Gets the latest known flows statistics only.

Parameters:

topn - max size

Returns:

200 OK with a known flow statistics

onos model

KnownFlowStatistics

getUnknownFlows

@GET
 @Produces(value="application/json")
 @Path(value="unknownFlows")
public javax.ws.rs.core.Response getUnknownFlows(@QueryParam(value="topn")
                                                                                                                        int topn)

Gets the latest unknown flows statistics only.

Parameters:

topn - max size

Returns:

200 OK with an unknown flow statistics

onos model

UnknownFlowStatistics

addDpiStatistics

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response addDpiStatistics(InputStream stream)

Add new dpi statistics entry at the end of list.

Parameters:

stream - dpi statistics JSON

Returns:

status of the request - CREATED if the JSON is correct, BAD_REQUEST if the JSON is invalid

onos model

DpiStatisticsPost