org.opendaylight.neutron.northbound.api

Class NeutronPortsNorthbound

java.lang.Object

org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound<NeutronPort,NeutronPortRequest,INeutronPortCRUD>

org.opendaylight.neutron.northbound.api.NeutronPortsNorthbound

@Singleton
 @Path(value="/ports")
public final class NeutronPortsNorthbound
extends AbstractNeutronNorthbound<NeutronPort,NeutronPortRequest,INeutronPortCRUD>

Neutron Northbound REST APIs for managing neutron port objects.

Field Summary

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

HTTP_OK_BOTTOM, HTTP_OK_TOP

Constructor Summary

Constructors

Constructor and Description
NeutronPortsNorthbound(INeutronPortCRUD neutronCRUD)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createPorts(NeutronPortRequest input) Creates new Ports.
javax.ws.rs.core.Response	deletePort(String portUUID) Deletes a Port.
protected String	getResourceName()
javax.ws.rs.core.Response	listPorts(List<String> fields, String queryID, String queryNetworkID, String queryName, Boolean queryAdminStateUp, String queryStatus, String queryMACAddress, String queryDeviceID, String queryDeviceOwner, String queryTenantID, Boolean queryPortSecurityEnabled, String queryQosPolicyId, Integer limit, String marker, Boolean pageReverse) Returns a list of all Ports.
javax.ws.rs.core.Response	showPort(String portUUID, List<String> fields) Returns a specific Port.
protected void	updateDelta(String uuid, NeutronPort delta, NeutronPort original)
javax.ws.rs.core.Response	updatePort(String portUUID, NeutronPortRequest input) Updates a Port.

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

NeutronPortsNorthbound

@Inject
public NeutronPortsNorthbound(INeutronPortCRUD neutronCRUD)

Method Detail

getResourceName

protected String getResourceName()

Specified by:

getResourceName in class AbstractNeutronNorthbound<NeutronPort,NeutronPortRequest,INeutronPortCRUD>

listPorts

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response listPorts(@QueryParam(value="fields")
                                                                                     List<String> fields,
                                                                                     @QueryParam(value="id")
                                                                                     String queryID,
                                                                                     @QueryParam(value="network_id")
                                                                                     String queryNetworkID,
                                                                                     @QueryParam(value="name")
                                                                                     String queryName,
                                                                                     @QueryParam(value="admin_state_up")
                                                                                     Boolean queryAdminStateUp,
                                                                                     @QueryParam(value="status")
                                                                                     String queryStatus,
                                                                                     @QueryParam(value="mac_address")
                                                                                     String queryMACAddress,
                                                                                     @QueryParam(value="device_id")
                                                                                     String queryDeviceID,
                                                                                     @QueryParam(value="device_owner")
                                                                                     String queryDeviceOwner,
                                                                                     @QueryParam(value="tenant_id")
                                                                                     String queryTenantID,
                                                                                     @QueryParam(value="port_security_enabled")
                                                                                     Boolean queryPortSecurityEnabled,
                                                                                     @QueryParam(value="qos_policy_id")
                                                                                     String queryQosPolicyId,
                                                                                     @QueryParam(value="limit")
                                                                                     Integer limit,
                                                                                     @QueryParam(value="marker")
                                                                                     String marker,
                                                                                     @DefaultValue(value="false") @QueryParam(value="page_reverse")
                                                                                     Boolean pageReverse)

Returns a list of all Ports.

showPort

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

Returns a specific Port.

createPorts

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

Creates new Ports.

updateDelta

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

Overrides:

updateDelta in class AbstractNeutronNorthbound<NeutronPort,NeutronPortRequest,INeutronPortCRUD>

updatePort

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

Updates a Port.

deletePort

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

Deletes a Port.