Package org.opendaylight.neutron.northbound.api

Class NeutronSubnetsNorthbound

java.lang.Object

org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound<NeutronSubnet,NeutronSubnetRequest,INeutronSubnetCRUD>

org.opendaylight.neutron.northbound.api.NeutronSubnetsNorthbound

@Singleton
@Path("/subnets")
public final class NeutronSubnetsNorthbound
extends AbstractNeutronNorthbound<NeutronSubnet,NeutronSubnetRequest,INeutronSubnetCRUD>

Neutron Northbound REST APIs for Subnets.

Field Summary

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

HTTP_OK_BOTTOM, HTTP_OK_TOP

Constructor Summary

Constructors

Constructor	Description
NeutronSubnetsNorthbound(INeutronSubnetCRUD neutronCRUD)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createSubnets(NeutronSubnetRequest input)	Creates new Subnets.
javax.ws.rs.core.Response	deleteSubnet(String subnetUUID)	Deletes a Subnet.
protected String	getResourceName()
javax.ws.rs.core.Response	listSubnets(List<String> fields, String queryID, String queryNetworkID, String queryName, Integer queryIPVersion, String queryCIDR, String queryGatewayIp, Boolean queryEnableDHCP, String queryTenantID, String queryIpV6AddressMode, String queryIpV6RaMode, Integer limit, String marker, Boolean pageReverse)	Returns a list of all Subnets.
javax.ws.rs.core.Response	showSubnet(String subnetUUID, List<String> fields)	Returns a specific Subnet.
protected void	updateDelta(String uuid, NeutronSubnet delta, NeutronSubnet original)
javax.ws.rs.core.Response	updateSubnet(String subnetUUID, NeutronSubnetRequest input)	Updates a Subnet.

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

NeutronSubnetsNorthbound

@Inject
public NeutronSubnetsNorthbound(INeutronSubnetCRUD neutronCRUD)

Method Detail

getResourceName

protected String getResourceName()

Specified by:

getResourceName in class AbstractNeutronNorthbound<NeutronSubnet,NeutronSubnetRequest,INeutronSubnetCRUD>

listSubnets

@GET
@Produces("application/json")
public javax.ws.rs.core.Response listSubnets(@QueryParam("fields")
                                             List<String> fields,
                                             @QueryParam("id")
                                             String queryID,
                                             @QueryParam("network_id")
                                             String queryNetworkID,
                                             @QueryParam("name")
                                             String queryName,
                                             @QueryParam("ip_version")
                                             Integer queryIPVersion,
                                             @QueryParam("cidr")
                                             String queryCIDR,
                                             @QueryParam("gateway_ip")
                                             String queryGatewayIp,
                                             @QueryParam("enable_dhcp")
                                             Boolean queryEnableDHCP,
                                             @QueryParam("tenant_id")
                                             String queryTenantID,
                                             @QueryParam("ipv6_address_mode")
                                             String queryIpV6AddressMode,
                                             @QueryParam("ipv6_ra_mode")
                                             String queryIpV6RaMode,
                                             @QueryParam("limit")
                                             Integer limit,
                                             @QueryParam("marker")
                                             String marker,
                                             @DefaultValue("false") @QueryParam("page_reverse")
                                             Boolean pageReverse)

Returns a list of all Subnets.

showSubnet

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

Returns a specific Subnet.

createSubnets

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

Creates new Subnets.

updateDelta

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

Overrides:

updateDelta in class AbstractNeutronNorthbound<NeutronSubnet,NeutronSubnetRequest,INeutronSubnetCRUD>

updateSubnet

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

Updates a Subnet.

deleteSubnet

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

Deletes a Subnet.