Package org.opendaylight.neutron.northbound.api

Class NeutronRoutersNorthbound

java.lang.Object

org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound<NeutronRouter,NeutronRouterRequest,INeutronRouterCRUD>

org.opendaylight.neutron.northbound.api.NeutronRoutersNorthbound

@Singleton
@Path("/routers")
public final class NeutronRoutersNorthbound
extends AbstractNeutronNorthbound<NeutronRouter,NeutronRouterRequest,INeutronRouterCRUD>

Neutron Northbound REST APIs for managing neutron routers.

Field Summary

Fields inherited from class org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound

HTTP_OK_BOTTOM, HTTP_OK_TOP

Constructor Summary

Constructors

Constructor	Description
NeutronRoutersNorthbound(INeutronRouterCRUD neutronCRUD)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addRouterInterface(String routerUUID, NeutronRouterInterface input)	Adds an interface to a router.
javax.ws.rs.core.Response	createRouters(NeutronRouterRequest input)	Creates new Routers.
javax.ws.rs.core.Response	deleteRouter(String routerUUID)	Deletes a Router.
protected String	getResourceName()
javax.ws.rs.core.Response	listRouters(List<String> fields, String queryID, String queryName, Boolean queryAdminStateUp, String queryStatus, String queryTenantID, String queryExternalGatewayInfo, String limit, String marker, String pageReverse)	Returns a list of all Routers.
javax.ws.rs.core.Response	removeRouterInterface(String routerUUID, NeutronRouterInterface input)
javax.ws.rs.core.Response	showRouter(String routerUUID, List<String> fields)	Returns a specific Router.
protected void	updateDelta(String uuid, NeutronRouter delta, NeutronRouter original)
javax.ws.rs.core.Response	updateRouter(String routerUUID, NeutronRouterRequest input)	Updates a Router.

Methods inherited from class org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound

create, delete, getNeutronCRUD, serviceUnavailable, show, update, uuidNoExist

Methods inherited from class java.lang.Object

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

Constructor Detail

NeutronRoutersNorthbound

@Inject
public NeutronRoutersNorthbound(INeutronRouterCRUD neutronCRUD)

Method Detail

getResourceName

protected String getResourceName()

Specified by:

getResourceName in class AbstractNeutronNorthbound<NeutronRouter,NeutronRouterRequest,INeutronRouterCRUD>

listRouters

@GET
@Produces("application/json")
public javax.ws.rs.core.Response listRouters(@QueryParam("fields")
                                             List<String> fields,
                                             @QueryParam("id")
                                             String queryID,
                                             @QueryParam("name")
                                             String queryName,
                                             @QueryParam("admin_state_up")
                                             Boolean queryAdminStateUp,
                                             @QueryParam("status")
                                             String queryStatus,
                                             @QueryParam("tenant_id")
                                             String queryTenantID,
                                             @QueryParam("external_gateway_info")
                                             String queryExternalGatewayInfo,
                                             @QueryParam("limit")
                                             String limit,
                                             @QueryParam("marker")
                                             String marker,
                                             @QueryParam("page_reverse")
                                             String pageReverse)

Returns a list of all Routers.

showRouter

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

Returns a specific Router.

createRouters

@POST
@Produces("application/json")
@Consumes("application/json")
public javax.ws.rs.core.Response createRouters(NeutronRouterRequest input)

Creates new Routers.

updateDelta

protected void updateDelta(String uuid,
                           NeutronRouter delta,
                           NeutronRouter original)

Overrides:

updateDelta in class AbstractNeutronNorthbound<NeutronRouter,NeutronRouterRequest,INeutronRouterCRUD>

updateRouter

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

Updates a Router.

deleteRouter

@Path("{routerUUID}")
@DELETE
public javax.ws.rs.core.Response deleteRouter(@PathParam("routerUUID")
                                              String routerUUID)

Deletes a Router.

addRouterInterface

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

Adds an interface to a router.

removeRouterInterface

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