org.onosproject.vtnweb.resources

Class RouterWebResource

java.lang.Object

org.onlab.rest.BaseResource

org.onosproject.rest.AbstractWebResource

org.onosproject.vtnweb.resources.RouterWebResource

All Implemented Interfaces:

org.onosproject.codec.CodecContext

@Path(value="routers")
public class RouterWebResource
extends org.onosproject.rest.AbstractWebResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATE_FAIL
static String	DELETE_SUCCESS
static String	GET_FAIL
static String	INTFACR_ADD_SUCCESS
static String	INTFACR_DEL_SUCCESS
static String	JSON_NOT_NULL
static String	NOT_EXIST
static String	UPDATE_FAIL

Constructor Summary

Constructors

Constructor and Description
RouterWebResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addRouterInterface(String id, InputStream input)
Collection<Router>	changeJsonToSub(com.fasterxml.jackson.databind.JsonNode routerNode) Returns a collection of floatingIps from floatingIpNodes.
Collection<Router>	changeUpdateJsonToSub(com.fasterxml.jackson.databind.JsonNode subnode, String routerId) Returns a collection of floatingIps from floatingIpNodes.
javax.ws.rs.core.Response	createRouter(InputStream input)
javax.ws.rs.core.Response	deleteSingleRouter(String id)
javax.ws.rs.core.Response	getRouter(String id, List<String> fields)
javax.ws.rs.core.Response	listRouters()
protected <T> T	nullIsNotFound(T item, String message) Returns the specified item if that items is null; otherwise throws not found exception.
javax.ws.rs.core.Response	removeRouterInterface(String id, InputStream input)
javax.ws.rs.core.Response	updateRouter(String id, InputStream input)

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

Methods inherited from interface org.onosproject.codec.CodecContext

decode, encode

Field Detail

CREATE_FAIL

public static final String CREATE_FAIL

See Also:

Constant Field Values

UPDATE_FAIL

public static final String UPDATE_FAIL

See Also:

Constant Field Values

GET_FAIL

public static final String GET_FAIL

See Also:

Constant Field Values

NOT_EXIST

public static final String NOT_EXIST

See Also:

Constant Field Values

DELETE_SUCCESS

public static final String DELETE_SUCCESS

See Also:

Constant Field Values

JSON_NOT_NULL

public static final String JSON_NOT_NULL

See Also:

Constant Field Values

INTFACR_ADD_SUCCESS

public static final String INTFACR_ADD_SUCCESS

See Also:

Constant Field Values

INTFACR_DEL_SUCCESS

public static final String INTFACR_DEL_SUCCESS

See Also:

Constant Field Values

Constructor Detail

RouterWebResource

public RouterWebResource()

Method Detail

listRouters

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

getRouter

@GET
 @Path(value="{routerUUID}")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response getRouter(@PathParam(value="routerUUID")
                                                                                                                                                       String id,
                                                                                                                                                       @QueryParam(value="fields")
                                                                                                                                                       List<String> fields)

createRouter

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

updateRouter

@PUT
 @Path(value="{routerUUID}")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response updateRouter(@PathParam(value="routerUUID")
                                                                                                                                                          String id,
                                                                                                                                                          InputStream input)

deleteSingleRouter

@DELETE
 @Path(value="{routerUUID}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response deleteSingleRouter(@PathParam(value="routerUUID")
                                                                                                                                                                   String id)
                                                                                                                                                            throws IOException

Throws:

IOException

addRouterInterface

@PUT
 @Path(value="{routerUUID}/add_router_interface")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response addRouterInterface(@PathParam(value="routerUUID")
                                                                                                                                                                                     String id,
                                                                                                                                                                                     InputStream input)

removeRouterInterface

@PUT
 @Path(value="{routerUUID}/remove_router_interface")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response removeRouterInterface(@PathParam(value="routerUUID")
                                                                                                                                                                                           String id,
                                                                                                                                                                                           InputStream input)

changeJsonToSub

public Collection<Router> changeJsonToSub(com.fasterxml.jackson.databind.JsonNode routerNode)
                                   throws Exception

Returns a collection of floatingIps from floatingIpNodes.

Parameters:

routerNode - the router json node

Returns:

routers a collection of router

Throws:

Exception - when any argument is illegal

changeUpdateJsonToSub

public Collection<Router> changeUpdateJsonToSub(com.fasterxml.jackson.databind.JsonNode subnode,
                                                String routerId)
                                         throws Exception

Returns a collection of floatingIps from floatingIpNodes.

Parameters:

subnode - the router json node

routerId - the router identify

Returns:

routers a collection of router

Throws:

Exception - when any argument is illegal

nullIsNotFound

protected <T> T nullIsNotFound(T item,
                               String message)

Returns the specified item if that items is null; otherwise throws not found exception.

Type Parameters:

T - item type

Parameters:

item - item to check

message - not found message

Returns:

item if not null

Throws:

org.onlab.util.ItemNotFoundException - if item is null