org.onosproject.mfwd.rest

Class McastResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.mfwd.rest.McastResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

public class McastResource
extends org.onosproject.rest.AbstractWebResource

Rest API for Multicast Forwarding.

Constructor Summary

Constructors

Constructor and Description
McastResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	join(String sAddr, String gAddr, String ports) Static join a multicast flow.
javax.ws.rs.core.Response	removeMcastFlow(String src, String grp) Delete multicast state.
javax.ws.rs.core.Response	showAll() Retrieve the multicast route table.

Methods inherited from class org.onosproject.rest.AbstractWebResource

codec, encodeArray, getService, mapper, newArray, newObject

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

McastResource

public McastResource()

Method Detail

showAll

public javax.ws.rs.core.Response showAll()
                                  throws IOException

Retrieve the multicast route table.

Returns:

the multicast route table.

Throws:

IOException - if an error occurs

join

public javax.ws.rs.core.Response join(String sAddr,
                                      String gAddr,
                                      String ports)
                               throws IOException

Static join a multicast flow.

Parameters:

sAddr - source address to join

gAddr - group address to join

ports - ingress and egress ConnectPoints to join

Returns:

the Result of the join

Throws:

IOException - if something failed with the join command

removeMcastFlow

public javax.ws.rs.core.Response removeMcastFlow(String src,
                                                 String grp)

Delete multicast state.

Parameters:

src - address to be deleted

grp - address to be deleted

Returns:

status of delete if successful