Package org.opendaylight.neutron.northbound.api

Class NeutronNetworksNorthbound

java.lang.Object

org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound<NeutronNetwork,NeutronNetworkRequest,INeutronNetworkCRUD>

org.opendaylight.neutron.northbound.api.NeutronNetworksNorthbound

@Singleton
@Path("/networks")
public final class NeutronNetworksNorthbound
extends AbstractNeutronNorthbound<NeutronNetwork,NeutronNetworkRequest,INeutronNetworkCRUD>

Neutron Northbound REST APIs for Network.

Field Summary

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

HTTP_OK_BOTTOM, HTTP_OK_TOP

Constructor Summary

Constructors

Constructor	Description
NeutronNetworksNorthbound(INeutronNetworkCRUD neutronNetworkCRUD)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createNetworks(NeutronNetworkRequest input)	Creates new Networks.
javax.ws.rs.core.Response	deleteNetwork(String netUUID)	Deletes a Network.
protected String	getResourceName()
javax.ws.rs.core.Response	listNetworks(List<String> fields, String queryID, String queryName, String queryAdminStateUp, String queryStatus, String queryShared, String queryTenantID, String queryRouterExternal, String queryProviderNetworkType, String queryProviderPhysicalNetwork, String queryProviderSegmentationID, String queryQosPolicyId, Integer limit, String marker, Boolean pageReverse)	Returns a list of all Networks.
javax.ws.rs.core.Response	showNetwork(String netUUID, List<String> fields)	Returns a specific Network.
protected void	updateDelta(String uuid, NeutronNetwork delta, NeutronNetwork original)
javax.ws.rs.core.Response	updateNetwork(String netUUID, NeutronNetworkRequest input)	Updates a Network.

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

NeutronNetworksNorthbound

@Inject
public NeutronNetworksNorthbound(INeutronNetworkCRUD neutronNetworkCRUD)

Method Detail

getResourceName

protected String getResourceName()

Specified by:

getResourceName in class AbstractNeutronNorthbound<NeutronNetwork,NeutronNetworkRequest,INeutronNetworkCRUD>

listNetworks

@GET
@Produces("application/json")
public javax.ws.rs.core.Response listNetworks(@QueryParam("fields")
                                              List<String> fields,
                                              @QueryParam("id")
                                              String queryID,
                                              @QueryParam("name")
                                              String queryName,
                                              @QueryParam("admin_state_up")
                                              String queryAdminStateUp,
                                              @QueryParam("status")
                                              String queryStatus,
                                              @QueryParam("shared")
                                              String queryShared,
                                              @QueryParam("tenant_id")
                                              String queryTenantID,
                                              @QueryParam("router_external")
                                              String queryRouterExternal,
                                              @QueryParam("provider_network_type")
                                              String queryProviderNetworkType,
                                              @QueryParam("provider_physical_network")
                                              String queryProviderPhysicalNetwork,
                                              @QueryParam("provider_segmentation_id")
                                              String queryProviderSegmentationID,
                                              @QueryParam("qos_policy_id")
                                              String queryQosPolicyId,
                                              @QueryParam("limit")
                                              Integer limit,
                                              @QueryParam("marker")
                                              String marker,
                                              @DefaultValue("false") @QueryParam("page_reverse")
                                              Boolean pageReverse)

Returns a list of all Networks.

showNetwork

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

Returns a specific Network.

createNetworks

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

Creates new Networks.

updateDelta

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

Overrides:

updateDelta in class AbstractNeutronNorthbound<NeutronNetwork,NeutronNetworkRequest,INeutronNetworkCRUD>

updateNetwork

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

Updates a Network.

deleteNetwork

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

Deletes a Network.