org.opendaylight.neutron.northbound.api

Class NeutronNetworksNorthbound

java.lang.Object

org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound<NeutronNetwork,NeutronNetworkRequest,INeutronNetworkCRUD>

org.opendaylight.neutron.northbound.api.NeutronNetworksNorthbound

@Path(value="/networks")
public class NeutronNetworksNorthbound
extends AbstractNeutronNorthbound<NeutronNetwork,NeutronNetworkRequest,INeutronNetworkCRUD>

Neutron Northbound REST APIs for Network.
This class provides REST APIs for managing neutron Networks

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

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createNetworks(NeutronNetworkRequest input) Creates new Networks
javax.ws.rs.core.Response	deleteNetwork(String netUUID) Deletes a Network
protected NeutronNetwork	extractFields(NeutronNetwork o, List<String> fields)
protected INeutronNetworkCRUD	getNeutronCRUD()
protected String	getResourceName()
javax.ws.rs.core.Response	listNetworks(List<String> fields, String queryID, String queryName, String queryAdminStateUp, String queryStatus, String queryShared, String queryTenantID, String queryRouterExternal, String queryProviderNetworkType, String queryProviderPhysicalNetwork, String queryProviderSegmentationID, String queryQosPolicyId, Integer limit, String marker, Boolean pageReverse) Returns a list of all Networks
protected NeutronNetworkRequest	newNeutronRequest(NeutronNetwork o)
javax.ws.rs.core.Response	showNetwork(String netUUID, List<String> fields) Returns a specific Network
protected void	updateDelta(String uuid, NeutronNetwork delta, NeutronNetwork original)
javax.ws.rs.core.Response	updateNetwork(String netUUID, NeutronNetworkRequest input) Updates a Network

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

create, delete, serviceUnavailable, show, update, uuidNoExist

Methods inherited from class java.lang.Object

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

Constructor Detail

NeutronNetworksNorthbound

public NeutronNetworksNorthbound()

Method Detail

getResourceName

protected String getResourceName()

Specified by:

getResourceName in class AbstractNeutronNorthbound<NeutronNetwork,NeutronNetworkRequest,INeutronNetworkCRUD>

extractFields

protected NeutronNetwork extractFields(NeutronNetwork o,
                                       List<String> fields)

Specified by:

extractFields in class AbstractNeutronNorthbound<NeutronNetwork,NeutronNetworkRequest,INeutronNetworkCRUD>

newNeutronRequest

protected NeutronNetworkRequest newNeutronRequest(NeutronNetwork o)

Specified by:

newNeutronRequest in class AbstractNeutronNorthbound<NeutronNetwork,NeutronNetworkRequest,INeutronNetworkCRUD>

getNeutronCRUD

protected INeutronNetworkCRUD getNeutronCRUD()

Specified by:

getNeutronCRUD in class AbstractNeutronNorthbound<NeutronNetwork,NeutronNetworkRequest,INeutronNetworkCRUD>

listNetworks

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response listNetworks(@QueryParam(value="fields")
                                                                                        List<String> fields,
                                                                                        @QueryParam(value="id")
                                                                                        String queryID,
                                                                                        @QueryParam(value="name")
                                                                                        String queryName,
                                                                                        @QueryParam(value="admin_state_up")
                                                                                        String queryAdminStateUp,
                                                                                        @QueryParam(value="status")
                                                                                        String queryStatus,
                                                                                        @QueryParam(value="shared")
                                                                                        String queryShared,
                                                                                        @QueryParam(value="tenant_id")
                                                                                        String queryTenantID,
                                                                                        @QueryParam(value="router_external")
                                                                                        String queryRouterExternal,
                                                                                        @QueryParam(value="provider_network_type")
                                                                                        String queryProviderNetworkType,
                                                                                        @QueryParam(value="provider_physical_network")
                                                                                        String queryProviderPhysicalNetwork,
                                                                                        @QueryParam(value="provider_segmentation_id")
                                                                                        String queryProviderSegmentationID,
                                                                                        @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 Networks

showNetwork

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

Returns a specific Network

createNetworks

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

Creates new Networks

updateDelta

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

Overrides:

updateDelta in class AbstractNeutronNorthbound<NeutronNetwork,NeutronNetworkRequest,INeutronNetworkCRUD>

updateNetwork

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

Updates a Network

deleteNetwork

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

Deletes a Network