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

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

Neutron Northbound REST APIs.
This class provides REST APIs for managing neutron routers

Authentication scheme : HTTP Basic
Authentication realm : opendaylight
Transport : HTTP and HTTPS

HTTPS Authentication is disabled by default. Administrator can enable it in tomcat-server.xml after adding a proper keystore / SSL certificate from a trusted authority.
More info : http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration

Field Summary

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

HTTP_OK_BOTTOM, HTTP_OK_TOP

Constructor Summary

Constructors

Constructor and Description
NeutronRoutersNorthbound()

Method Summary

Modifier and Type	Method and 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

public NeutronRoutersNorthbound()

Method Detail

getResourceName

protected String getResourceName()

Specified by:

getResourceName in class AbstractNeutronNorthbound<NeutronRouter,NeutronRouterRequest,INeutronRouterCRUD>

listRouters

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

Returns a list of all Routers.

showRouter

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

Returns a specific Router.

createRouters

@POST
 @Produces(value="application/json")
 @Consumes(value="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(value="{routerUUID}")
 @PUT
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response updateRouter(@PathParam(value="routerUUID")
                                                                                                                                                          String routerUUID,
                                                                                                                                                          NeutronRouterRequest input)

Updates a Router.

deleteRouter

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

Deletes a Router.

addRouterInterface

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

Adds an interface to a router.

removeRouterInterface

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