org.onosproject.calendar

Class BandwidthCalendarResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.calendar.BandwidthCalendarResource

public class BandwidthCalendarResource
extends org.onlab.rest.BaseResource

Web resource for triggering calendared intents.

Constructor Summary

Constructors

Constructor and Description
BandwidthCalendarResource()

Method Summary

Modifier and Type	Method and Description
protected org.onosproject.core.ApplicationId	appId()
javax.ws.rs.core.Response	modifyBandwidth(String intentKey, String src, String dst, String srcPort, String dstPort, String bandwidth) Modify a bi-directional path's bandwidth.
javax.ws.rs.core.Response	removePath(String intentKey) Remove a bi-directional path with created intent key.
javax.ws.rs.core.Response	setupPath(String src, String dst, String srcPort, String dstPort, String bandwidth, String latency) Setup a bi-directional path with constraints between switch to switch.

Methods inherited from class org.onlab.rest.BaseResource

get, ok, setServiceDirectory

Methods inherited from class java.lang.Object

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

Constructor Detail

BandwidthCalendarResource

public BandwidthCalendarResource()

Method Detail

setupPath

public javax.ws.rs.core.Response setupPath(String src,
                                           String dst,
                                           String srcPort,
                                           String dstPort,
                                           String bandwidth,
                                           String latency)

Setup a bi-directional path with constraints between switch to switch. Switch is identified by DPID.

Parameters:

src - the path source (DPID or hostID)

dst - the path destination (DPID or hostID)

srcPort - the source port (-1 if src/dest is a host)

dstPort - the destination port (-1 if src/dest is a host)

bandwidth - the bandwidth (mbps) requirement for the path

latency - the latency (micro sec) requirement for the path

Returns:

intent key if successful, server error message or "FAILED" if failed to create or submit intent

modifyBandwidth

public javax.ws.rs.core.Response modifyBandwidth(String intentKey,
                                                 String src,
                                                 String dst,
                                                 String srcPort,
                                                 String dstPort,
                                                 String bandwidth)

Modify a bi-directional path's bandwidth.

Parameters:

intentKey - the path intent key

src - the path source (DPID or hostID)

dst - the path destination (DPID or hostID)

srcPort - the source port (-1 if src/dest is a host)

dstPort - the destination port (-1 if src/dest is a host)

bandwidth - the bandwidth (mbps) requirement for the path

Returns:

Intent state, "INSTALLED", if successful, server error message or "FAILED" if failed to modify any direction intent

removePath

public javax.ws.rs.core.Response removePath(String intentKey)

Remove a bi-directional path with created intent key.

Parameters:

intentKey - the string key for the intent to remove

Returns:

Intent state, "WITHDRAWN", if successful, server error message or FAILED" if any direction intent remove failed

appId

protected org.onosproject.core.ApplicationId appId()