Package org.opendaylight.neutron.northbound.api

Class NeutronLoadBalancerPoolNorthbound

java.lang.Object

org.opendaylight.neutron.northbound.api.AbstractNeutronNorthbound<NeutronLoadBalancerPool,NeutronLoadBalancerPoolRequest,INeutronLoadBalancerPoolCRUD>

org.opendaylight.neutron.northbound.api.NeutronLoadBalancerPoolNorthbound

@Singleton
@Path("/lbaas/pools")
public final class NeutronLoadBalancerPoolNorthbound
extends AbstractNeutronNorthbound<NeutronLoadBalancerPool,NeutronLoadBalancerPoolRequest,INeutronLoadBalancerPoolCRUD>

Neutron Northbound REST APIs for LoadBalancerPool Policies.

For now, the LB pool member data is maintained with the INeutronLoadBalancerPoolCRUD, and not duplicated within the INeutronLoadBalancerPoolMemberCRUD's cache.

Field Summary

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

HTTP_OK_BOTTOM, HTTP_OK_TOP

Constructor Summary

Constructors

Constructor	Description
NeutronLoadBalancerPoolNorthbound(INeutronLoadBalancerPoolCRUD neutronCRUD, org.opendaylight.mdsal.binding.api.DataBroker dataBroker)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createLoadBalancerPoolMember(String loadBalancerPoolUUID, NeutronLoadBalancerPoolMemberRequest input)	Adds a Member to an LBaaS Pool member.
javax.ws.rs.core.Response	createLoadBalancerPools(NeutronLoadBalancerPoolRequest input)	Creates new LoadBalancerPool.
javax.ws.rs.core.Response	deleteLoadBalancerPool(String loadBalancerPoolUUID)	Deletes a LoadBalancerPool.
javax.ws.rs.core.Response	deleteLoadBalancerPoolMember(String loadBalancerPoolUUID, String loadBalancerPoolMemberUUID)	Deletes a LoadBalancerPoolMember.
protected String	getResourceName()
javax.ws.rs.core.Response	listGroups(List<String> fields, String queryLoadBalancerPoolID, String queryLoadBalancerPoolTenantID, String queryLoadBalancerPoolName, String queryLoadBalancerProtocol, String queryLoadBalancerPoolLbAlgorithm, String queryLoadBalancerPoolHealthMonitorID, Boolean queryLoadBalancerIsAdminStateUp, List<NeutronLoadBalancerPoolMember> queryLoadBalancerPoolMembers, String limit, String marker, String pageReverse)	Returns a list of all LoadBalancerPool.
javax.ws.rs.core.Response	listMembers(String loadBalancerPoolUUID, List<String> fields, String queryLoadBalancerPoolMemberID, String queryLoadBalancerPoolMemberTenantID, String queryLoadBalancerPoolMemberAddress, String queryLoadBalancerPoolMemberProtoPort, Boolean queryLoadBalancerPoolMemberAdminStateUp, Integer queryLoadBalancerPoolMemberWeight, String queryLoadBalancerPoolMemberSubnetID, String limit, String marker, String pageReverse)	Returns a list of all LoadBalancerPoolMembers in specified pool.
javax.ws.rs.core.Response	showLoadBalancerPool(String loadBalancerPoolID, List<String> fields)	Returns a specific LoadBalancerPool.
javax.ws.rs.core.Response	showLoadBalancerPoolMember(String loadBalancerPoolUUID, String loadBalancerPoolMemberUUID, List<String> fields)	Returns a specific LoadBalancerPoolMember.
javax.ws.rs.core.Response	updateLoadBalancerPool(String loadBalancerPoolID, NeutronLoadBalancerPoolRequest input)	Updates a LoadBalancerPool Policy.
javax.ws.rs.core.Response	updateLoadBalancerPoolMember(String loadBalancerPoolUUID, String loadBalancerPoolMemberUUID, NeutronLoadBalancerPoolMemberRequest input)	Updates a LB member pool.

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

NeutronLoadBalancerPoolNorthbound

@Inject
public NeutronLoadBalancerPoolNorthbound(INeutronLoadBalancerPoolCRUD neutronCRUD,
                                         org.opendaylight.mdsal.binding.api.DataBroker dataBroker)

Method Detail

getResourceName

protected String getResourceName()

Specified by:

getResourceName in class AbstractNeutronNorthbound<NeutronLoadBalancerPool,NeutronLoadBalancerPoolRequest,INeutronLoadBalancerPoolCRUD>

listGroups

@GET
@Produces("application/json")
public javax.ws.rs.core.Response listGroups(@QueryParam("fields")
                                            List<String> fields,
                                            @QueryParam("id")
                                            String queryLoadBalancerPoolID,
                                            @QueryParam("tenant_id")
                                            String queryLoadBalancerPoolTenantID,
                                            @QueryParam("name")
                                            String queryLoadBalancerPoolName,
                                            @QueryParam("protocol")
                                            String queryLoadBalancerProtocol,
                                            @QueryParam("lb_algorithm")
                                            String queryLoadBalancerPoolLbAlgorithm,
                                            @QueryParam("healthmonitor_id")
                                            String queryLoadBalancerPoolHealthMonitorID,
                                            @QueryParam("admin_state_up")
                                            Boolean queryLoadBalancerIsAdminStateUp,
                                            @QueryParam("members")
                                            List<NeutronLoadBalancerPoolMember> queryLoadBalancerPoolMembers,
                                            @QueryParam("limit")
                                            String limit,
                                            @QueryParam("marker")
                                            String marker,
                                            @QueryParam("page_reverse")
                                            String pageReverse)

Returns a list of all LoadBalancerPool.

showLoadBalancerPool

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

Returns a specific LoadBalancerPool.

createLoadBalancerPools

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

Creates new LoadBalancerPool.

updateLoadBalancerPool

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

Updates a LoadBalancerPool Policy.

deleteLoadBalancerPool

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

Deletes a LoadBalancerPool.

listMembers

@Path("{loadBalancerPoolUUID}/members")
@GET
@Produces("application/json")
public javax.ws.rs.core.Response listMembers(@PathParam("loadBalancerPoolUUID")
                                             String loadBalancerPoolUUID,
                                             @QueryParam("fields")
                                             List<String> fields,
                                             @QueryParam("id")
                                             String queryLoadBalancerPoolMemberID,
                                             @QueryParam("tenant_id")
                                             String queryLoadBalancerPoolMemberTenantID,
                                             @QueryParam("address")
                                             String queryLoadBalancerPoolMemberAddress,
                                             @QueryParam("protocol_port")
                                             String queryLoadBalancerPoolMemberProtoPort,
                                             @QueryParam("admin_state_up")
                                             Boolean queryLoadBalancerPoolMemberAdminStateUp,
                                             @QueryParam("weight")
                                             Integer queryLoadBalancerPoolMemberWeight,
                                             @QueryParam("subnet_id")
                                             String queryLoadBalancerPoolMemberSubnetID,
                                             @QueryParam("limit")
                                             String limit,
                                             @QueryParam("marker")
                                             String marker,
                                             @QueryParam("page_reverse")
                                             String pageReverse)

Returns a list of all LoadBalancerPoolMembers in specified pool.

showLoadBalancerPoolMember

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

Returns a specific LoadBalancerPoolMember.

createLoadBalancerPoolMember

@Path("{loadBalancerPoolUUID}/members")
@POST
@Produces("application/json")
@Consumes("application/json")
public javax.ws.rs.core.Response createLoadBalancerPoolMember(@PathParam("loadBalancerPoolUUID")
                                                              String loadBalancerPoolUUID,
                                                              NeutronLoadBalancerPoolMemberRequest input)

Adds a Member to an LBaaS Pool member.

updateLoadBalancerPoolMember

@Path("{loadBalancerPoolUUID}/members/{loadBalancerPoolMemberUUID}")
@PUT
@Produces("application/json")
@Consumes("application/json")
public javax.ws.rs.core.Response updateLoadBalancerPoolMember(@PathParam("loadBalancerPoolUUID")
                                                              String loadBalancerPoolUUID,
                                                              @PathParam("loadBalancerPoolMemberUUID")
                                                              String loadBalancerPoolMemberUUID,
                                                              NeutronLoadBalancerPoolMemberRequest input)

Updates a LB member pool.

deleteLoadBalancerPoolMember

@Path("{loadBalancerPoolUUID}/members/{loadBalancerPoolMemberUUID}")
@DELETE
public javax.ws.rs.core.Response deleteLoadBalancerPoolMember(@PathParam("loadBalancerPoolUUID")
                                                              String loadBalancerPoolUUID,
                                                              @PathParam("loadBalancerPoolMemberUUID")
                                                              String loadBalancerPoolMemberUUID)

Deletes a LoadBalancerPoolMember.