Package org.opendaylight.neutron.northbound.api

Class NeutronFloatingIpsNorthbound

java.lang.Object

org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound<NeutronFloatingIp,NeutronFloatingIpRequest,INeutronFloatingIpCRUD>

org.opendaylight.neutron.northbound.api.NeutronFloatingIpsNorthbound

@Singleton
@Path("/floatingips")
public final class NeutronFloatingIpsNorthbound
extends AbstractNeutronNorthbound<NeutronFloatingIp,NeutronFloatingIpRequest,INeutronFloatingIpCRUD>

Neutron Northbound REST APIs for managing Neutron Floating IPs.

Field Summary

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

HTTP_OK_BOTTOM, HTTP_OK_TOP

Constructor Summary

Constructors

Constructor	Description
NeutronFloatingIpsNorthbound(INeutronFloatingIpCRUD neutronCRUD)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createFloatingIps(NeutronFloatingIpRequest input)	Creates new FloatingIps.
javax.ws.rs.core.Response	deleteFloatingIp(String floatingipUUID)	Deletes a FloatingIp.
protected String	getResourceName()
javax.ws.rs.core.Response	listFloatingIps(List<String> fields, String queryID, String queryFloatingNetworkId, String queryPortId, String queryFixedIpAddress, String queryFloatingIpAddress, String queryTenantID, String queryRouterID, String queryStatus, String limit, String marker, String pageReverse)	Returns a list of all FloatingIps.
javax.ws.rs.core.Response	showFloatingIp(String floatingipUUID, List<String> fields)	Returns a specific FloatingIp.
javax.ws.rs.core.Response	updateFloatingIp(String floatingipUUID, NeutronFloatingIpRequest input)	Updates a FloatingIp.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NeutronFloatingIpsNorthbound

@Inject
public NeutronFloatingIpsNorthbound(INeutronFloatingIpCRUD neutronCRUD)

Method Detail

getResourceName

protected String getResourceName()

Specified by:

getResourceName in class AbstractNeutronNorthbound<NeutronFloatingIp,NeutronFloatingIpRequest,INeutronFloatingIpCRUD>

listFloatingIps

@GET
@Produces("application/json")
public javax.ws.rs.core.Response listFloatingIps(@QueryParam("fields")
                                                 List<String> fields,
                                                 @QueryParam("id")
                                                 String queryID,
                                                 @QueryParam("floating_network_id")
                                                 String queryFloatingNetworkId,
                                                 @QueryParam("port_id")
                                                 String queryPortId,
                                                 @QueryParam("fixed_ip_address")
                                                 String queryFixedIpAddress,
                                                 @QueryParam("floating_ip_address")
                                                 String queryFloatingIpAddress,
                                                 @QueryParam("tenant_id")
                                                 String queryTenantID,
                                                 @QueryParam("router_id")
                                                 String queryRouterID,
                                                 @QueryParam("status")
                                                 String queryStatus,
                                                 @QueryParam("limit")
                                                 String limit,
                                                 @QueryParam("marker")
                                                 String marker,
                                                 @QueryParam("page_reverse")
                                                 String pageReverse)

Returns a list of all FloatingIps.

showFloatingIp

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

Returns a specific FloatingIp.

createFloatingIps

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

Creates new FloatingIps.

updateFloatingIp

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

Updates a FloatingIp.

deleteFloatingIp

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

Deletes a FloatingIp.