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

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

Neutron Northbound REST APIs.
This class provides REST APIs for managing Neutron Floating IPs

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
NeutronFloatingIpsNorthbound()

Method Summary

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

public NeutronFloatingIpsNorthbound()

Method Detail

getResourceName

protected String getResourceName()

Specified by:

getResourceName in class AbstractNeutronNorthbound<NeutronFloatingIp,NeutronFloatingIpRequest,INeutronFloatingIpCRUD>

listFloatingIps

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

Returns a list of all FloatingIps.

showFloatingIp

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

Returns a specific FloatingIp.

createFloatingIps

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

Creates new FloatingIps.

updateFloatingIp

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

Updates a FloatingIp.

deleteFloatingIp

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

Deletes a FloatingIp.