Package org.opendaylight.neutron.northbound.api

Class NeutronVpnServicesNorthbound

java.lang.Object

org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound<NeutronVpnService,NeutronVpnServiceRequest,INeutronVpnServiceCRUD>

org.opendaylight.neutron.northbound.api.NeutronVpnServicesNorthbound

@Singleton
@Path("/vpn/vpnservices")
public final class NeutronVpnServicesNorthbound
extends AbstractNeutronNorthbound<NeutronVpnService,NeutronVpnServiceRequest,INeutronVpnServiceCRUD>

Neutron Northbound REST APIs for VPN Service.

Field Summary

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

HTTP_OK_BOTTOM, HTTP_OK_TOP

Constructor Summary

Constructors

Constructor	Description
NeutronVpnServicesNorthbound(INeutronVpnServiceCRUD neutronCRUD)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createVPNService(NeutronVpnServiceRequest input)	Creates new VPN Service.
javax.ws.rs.core.Response	deleteVPNService(String serviceID)	Deletes a VPN Service.
protected String	getResourceName()
javax.ws.rs.core.Response	listVPNServices(List<String> fields, String queryID, String queryTenantID, String queryName, Boolean queryAdminStateUp, String queryRouterID, String queryStatus, String querySubnetID, String limit, String marker, String pageReverse)	Returns a list of all VPN Services.
javax.ws.rs.core.Response	showVPNService(String serviceID, List<String> fields)	Returns a specific VPN Service.
javax.ws.rs.core.Response	updateVPNService(String serviceID, NeutronVpnServiceRequest input)	Updates a VPN Service.

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

NeutronVpnServicesNorthbound

@Inject
public NeutronVpnServicesNorthbound(INeutronVpnServiceCRUD neutronCRUD)

Method Detail

getResourceName

protected String getResourceName()

Specified by:

getResourceName in class AbstractNeutronNorthbound<NeutronVpnService,NeutronVpnServiceRequest,INeutronVpnServiceCRUD>

listVPNServices

@GET
@Produces("application/json")
public javax.ws.rs.core.Response listVPNServices(@QueryParam("fields")
                                                 List<String> fields,
                                                 @QueryParam("id")
                                                 String queryID,
                                                 @QueryParam("tenant_id")
                                                 String queryTenantID,
                                                 @QueryParam("name")
                                                 String queryName,
                                                 @QueryParam("admin_state_up")
                                                 Boolean queryAdminStateUp,
                                                 @QueryParam("router_id")
                                                 String queryRouterID,
                                                 @QueryParam("status")
                                                 String queryStatus,
                                                 @QueryParam("subnet_id")
                                                 String querySubnetID,
                                                 @QueryParam("limit")
                                                 String limit,
                                                 @QueryParam("marker")
                                                 String marker,
                                                 @QueryParam("page_reverse")
                                                 String pageReverse)

Returns a list of all VPN Services.

showVPNService

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

Returns a specific VPN Service.

createVPNService

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

Creates new VPN Service.

updateVPNService

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

Updates a VPN Service.

deleteVPNService

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

Deletes a VPN Service.