Package org.opendaylight.neutron.northbound.api

Class NeutronL2gatewayNorthbound

java.lang.Object

org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound<NeutronL2gateway,NeutronL2gatewayRequest,INeutronL2gatewayCRUD>

org.opendaylight.neutron.northbound.api.NeutronL2gatewayNorthbound

@Singleton
@Path("/l2-gateways")
public final class NeutronL2gatewayNorthbound
extends AbstractNeutronNorthbound<NeutronL2gateway,NeutronL2gatewayRequest,INeutronL2gatewayCRUD>

Neutron Northbound REST APIs for L2 gateway.

Field Summary

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

HTTP_OK_BOTTOM, HTTP_OK_TOP

Constructor Summary

Constructors

Constructor	Description
NeutronL2gatewayNorthbound(INeutronL2gatewayCRUD neutronCRUD)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createL2gateway(NeutronL2gatewayRequest input)	Creates L2gateway.
javax.ws.rs.core.Response	deleteL2gateway(String l2gatewayID)	Deletes a L2gateway.
protected String	getResourceName()
javax.ws.rs.core.Response	listL2gateways(List<String> fields, String queryID, String queryName, String queryTenantID, String queryNeutronL2gatewayDevice, String limit, String marker, String pageReverse)	Returns a list of all L2gateways.
javax.ws.rs.core.Response	showL2gateway(String l2gatewayID, List<String> fields)	Returns a specific L2gateway.
javax.ws.rs.core.Response	updateL2gateway(String l2gatewayID, NeutronL2gatewayRequest input)	Updates a L2gateway.

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

NeutronL2gatewayNorthbound

@Inject
public NeutronL2gatewayNorthbound(INeutronL2gatewayCRUD neutronCRUD)

Method Detail

getResourceName

protected String getResourceName()

Specified by:

getResourceName in class AbstractNeutronNorthbound<NeutronL2gateway,NeutronL2gatewayRequest,INeutronL2gatewayCRUD>

createL2gateway

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

Creates L2gateway.

Parameters:

input - l2gateway attributes

Returns:

success or error code

listL2gateways

@GET
@Produces("application/json")
public javax.ws.rs.core.Response listL2gateways(@QueryParam("fields")
                                                List<String> fields,
                                                @QueryParam("id")
                                                String queryID,
                                                @QueryParam("name")
                                                String queryName,
                                                @QueryParam("tenant_id")
                                                String queryTenantID,
                                                @QueryParam("devices")
                                                String queryNeutronL2gatewayDevice,
                                                @QueryParam("limit")
                                                String limit,
                                                @QueryParam("marker")
                                                String marker,
                                                @QueryParam("page_reverse")
                                                String pageReverse)

Returns a list of all L2gateways.

showL2gateway

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

Returns a specific L2gateway.

Parameters:

l2gatewayID - requested l2gateway uuid

fields - l2gateway attributes

Returns:

l2gateway details or error.

deleteL2gateway

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

Deletes a L2gateway.

Parameters:

l2gatewayID - l2gateway uuid which should be deleted

Returns:

success or error code

updateL2gateway

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

Updates a L2gateway.

Parameters:

l2gatewayID - gateway ID that needs to be modified

input - gateway attributes

Returns:

status