org.onosproject.rest.resources

Class MulticastRouteWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.rest.resources.MulticastRouteWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Beta
 @Path(value="mcast")
public class MulticastRouteWebResource
extends org.onosproject.rest.AbstractWebResource

Manage the multicast routing information.

Constructor Summary

Constructors

Constructor and Description
MulticastRouteWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addSinks(String group, String source, InputStream stream) Create a sink for a multicast route.
javax.ws.rs.core.Response	createRoute(InputStream stream) Create new multicast route.
javax.ws.rs.core.Response	deleteRoute(InputStream stream) Remove a multicast route.
javax.ws.rs.core.Response	getRoutes() Get all multicast routes.

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

MulticastRouteWebResource

public MulticastRouteWebResource()

Method Detail

getRoutes

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

Get all multicast routes. Returns array of all known multicast routes.

Returns:

200 OK with array of all known multicast routes

onos model

McastRoutesGet

createRoute

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

Create new multicast route. Creates a new route in the multicast RIB.

Parameters:

stream - multicast route JSON

Returns:

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

onos model

McastRoutePost

deleteRoute

@DELETE
 @Consumes(value="application/json")
public javax.ws.rs.core.Response deleteRoute(InputStream stream)

Remove a multicast route. Removes a route from the multicast RIB.

Parameters:

stream - multicast route JSON

Returns:

204 NO CONTENT

onos model

McastRoutePost

addSinks

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Path(value="sinks/{group}/{source}")
public javax.ws.rs.core.Response addSinks(@PathParam(value="group")
                                                                                                                                                                 String group,
                                                                                                                                                                 @PathParam(value="source")
                                                                                                                                                                 String source,
                                                                                                                                                                 InputStream stream)

Create a sink for a multicast route. Creates a new sink for an existing multicast route.

Parameters:

group - group IP address

source - source IP address

stream - sink JSON

Returns:

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

onos model

McastSinkPost