Package 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("/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	Description
NeutronPortsNorthbound(INeutronPortCRUD neutronCRUD)

Method Summary

Modifier and Type	Method	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("application/json")
public javax.ws.rs.core.Response listPorts(@QueryParam("fields")
                                           List<String> fields,
                                           @QueryParam("id")
                                           String queryID,
                                           @QueryParam("network_id")
                                           String queryNetworkID,
                                           @QueryParam("name")
                                           String queryName,
                                           @QueryParam("admin_state_up")
                                           Boolean queryAdminStateUp,
                                           @QueryParam("status")
                                           String queryStatus,
                                           @QueryParam("mac_address")
                                           String queryMACAddress,
                                           @QueryParam("device_id")
                                           String queryDeviceID,
                                           @QueryParam("device_owner")
                                           String queryDeviceOwner,
                                           @QueryParam("tenant_id")
                                           String queryTenantID,
                                           @QueryParam("port_security_enabled")
                                           Boolean queryPortSecurityEnabled,
                                           @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 Ports.

showPort

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

Returns a specific Port.

createPorts

@POST
@Produces("application/json")
@Consumes("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("{portUUID}")
@PUT
@Produces("application/json")
@Consumes("application/json")
public javax.ws.rs.core.Response updatePort(@PathParam("portUUID")
                                            String portUUID,
                                            NeutronPortRequest input)

Updates a Port.

deletePort

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

Deletes a Port.