/* * Copyright (C) 2014 SDN Hub, LLC. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html * * Authors : Srini Seetharaman */ package org.opendaylight.neutron.northbound.api; import java.net.HttpURLConnection; import java.util.ArrayList; import java.util.HashMap; import java.util.Iterator; import java.util.List; import java.util.Map; import javax.ws.rs.Consumes; import javax.ws.rs.DELETE; import javax.ws.rs.GET; import javax.ws.rs.POST; import javax.ws.rs.PUT; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.Produces; import javax.ws.rs.QueryParam; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; import org.codehaus.enunciate.jaxrs.ResponseCode; import org.codehaus.enunciate.jaxrs.StatusCodes; import org.opendaylight.neutron.spi.INeutronLoadBalancerPoolAware; import org.opendaylight.neutron.spi.INeutronLoadBalancerPoolCRUD; import org.opendaylight.neutron.spi.NeutronCRUDInterfaces; import org.opendaylight.neutron.spi.NeutronLoadBalancerPool; import org.opendaylight.neutron.spi.NeutronLoadBalancerPoolMember; /** * Neutron Northbound REST APIs for LoadBalancerPool Policies.
* This class provides REST APIs for managing neutron LoadBalancerPool Policies * *
*
* 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 * */ /** * For now, the LB pool member data is maintained with the INeutronLoadBalancerPoolCRUD, * and not duplicated within the INeutronLoadBalancerPoolMemberCRUD's cache. */ @Path("/lbaas/pools") public class NeutronLoadBalancerPoolNorthbound { private static final int HTTP_OK_BOTTOM = 200; private static final int HTTP_OK_TOP = 299; private static final String INTERFACE_NAME = "LoadBalancerPool CRUD Interface"; private static final String UUID_NO_EXIST = "LoadBalancerPool UUID does not exist."; private static final String NO_PROVIDERS = "No providers registered. Please try again later"; private static final String NO_PROVIDER_LIST = "Couldn't get providers list. Please try again later"; private NeutronLoadBalancerPool extractFields(NeutronLoadBalancerPool o, List fields) { return o.extractFields(fields); } private NeutronCRUDInterfaces getNeutronInterfaces() { NeutronCRUDInterfaces answer = new NeutronCRUDInterfaces().fetchINeutronLoadBalancerPoolCRUD(this); if (answer.getLoadBalancerPoolInterface() == null) { throw new ServiceUnavailableException(INTERFACE_NAME + RestMessages.SERVICEUNAVAILABLE.toString()); } return answer; } /** * Returns a list of all LoadBalancerPool * */ @GET @Produces({ MediaType.APPLICATION_JSON }) @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"), @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"), @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"), @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") }) public Response listGroups( // return fields @QueryParam("fields") List fields, // OpenStack LoadBalancerPool attributes @QueryParam("id") String queryLoadBalancerPoolID, @QueryParam("tenant_id") String queryLoadBalancerPoolTenantID, @QueryParam("name") String queryLoadBalancerPoolName, @QueryParam("description") String queryLoadBalancerDescription, @QueryParam("protocol") String queryLoadBalancerProtocol, @QueryParam("lb_algorithm") String queryLoadBalancerPoolLbAlgorithm, @QueryParam("healthmonitor_id") String queryLoadBalancerPoolHealthMonitorID, @QueryParam("admin_state_up") String queryLoadBalancerIsAdminStateUp, @QueryParam("members") List queryLoadBalancerPoolMembers, // pagination @QueryParam("limit") String limit, @QueryParam("marker") String marker, @QueryParam("page_reverse") String pageReverse // sorting not supported ) { INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = getNeutronInterfaces().getLoadBalancerPoolInterface(); List allLoadBalancerPools = loadBalancerPoolInterface.getAllNeutronLoadBalancerPools(); List ans = new ArrayList(); Iterator i = allLoadBalancerPools.iterator(); while (i.hasNext()) { NeutronLoadBalancerPool nsg = i.next(); if ((queryLoadBalancerPoolID == null || queryLoadBalancerPoolID.equals(nsg.getLoadBalancerPoolID())) && (queryLoadBalancerPoolTenantID == null || queryLoadBalancerPoolTenantID.equals(nsg.getLoadBalancerPoolTenantID())) && (queryLoadBalancerPoolName == null || queryLoadBalancerPoolName.equals(nsg.getLoadBalancerPoolName())) && (queryLoadBalancerDescription == null || queryLoadBalancerDescription.equals(nsg.getLoadBalancerPoolDescription())) && (queryLoadBalancerPoolLbAlgorithm == null || queryLoadBalancerPoolLbAlgorithm.equals(nsg.getLoadBalancerPoolLbAlgorithm())) && (queryLoadBalancerPoolHealthMonitorID == null || queryLoadBalancerPoolHealthMonitorID.equals(nsg.getNeutronLoadBalancerPoolHealthMonitorID())) && (queryLoadBalancerIsAdminStateUp == null || queryLoadBalancerIsAdminStateUp.equals(nsg.getLoadBalancerPoolAdminIsStateIsUp())) && (queryLoadBalancerPoolMembers.size() == 0 || queryLoadBalancerPoolMembers.equals(nsg.getLoadBalancerPoolMembers()))) { if (fields.size() > 0) { ans.add(extractFields(nsg,fields)); } else { ans.add(nsg); } } } return Response.status(HttpURLConnection.HTTP_OK).entity( new NeutronLoadBalancerPoolRequest(ans)).build(); } /** * Returns a specific LoadBalancerPool */ @Path("{loadBalancerPoolID}") @GET @Produces({ MediaType.APPLICATION_JSON }) @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"), @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"), @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"), @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"), @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") }) public Response showLoadBalancerPool(@PathParam("loadBalancerPoolID") String loadBalancerPoolID, // return fields @QueryParam("fields") List fields) { INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = getNeutronInterfaces().getLoadBalancerPoolInterface(); if (!loadBalancerPoolInterface.neutronLoadBalancerPoolExists(loadBalancerPoolID)) { throw new ResourceNotFoundException(UUID_NO_EXIST); } if (fields.size() > 0) { NeutronLoadBalancerPool ans = loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID); return Response.status(HttpURLConnection.HTTP_OK).entity( new NeutronLoadBalancerPoolRequest(extractFields(ans, fields))).build(); } else { return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronLoadBalancerPoolRequest(loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID))).build(); } } /** * Creates new LoadBalancerPool */ @POST @Produces({ MediaType.APPLICATION_JSON }) @Consumes({ MediaType.APPLICATION_JSON }) @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_CREATED, condition = "Created"), @ResponseCode(code = HttpURLConnection.HTTP_BAD_REQUEST, condition = "Bad Request"), @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"), @ResponseCode(code = HttpURLConnection.HTTP_FORBIDDEN, condition = "Forbidden"), @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"), @ResponseCode(code = HttpURLConnection.HTTP_CONFLICT, condition = "Conflict"), @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"), @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") }) public Response createLoadBalancerPools(final NeutronLoadBalancerPoolRequest input) { INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = getNeutronInterfaces().getLoadBalancerPoolInterface(); if (input.isSingleton()) { NeutronLoadBalancerPool singleton = input.getSingleton(); /* * Verify that the LoadBalancerPool doesn't already exist. */ if (loadBalancerPoolInterface.neutronLoadBalancerPoolExists(singleton.getLoadBalancerPoolID())) { throw new BadRequestException("LoadBalancerPool UUID already exists"); } Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerPoolAware.class, this); if (instances != null) { if (instances.length > 0) { for (Object instance : instances) { INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance; int status = service.canCreateNeutronLoadBalancerPool(singleton); if (status < HttpURLConnection.HTTP_OK || status > HTTP_OK_TOP) { return Response.status(status).build(); } } } else { throw new ServiceUnavailableException(NO_PROVIDERS); } } else { throw new ServiceUnavailableException(NO_PROVIDER_LIST); } loadBalancerPoolInterface.addNeutronLoadBalancerPool(singleton); if (instances != null) { for (Object instance : instances) { INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance; service.neutronLoadBalancerPoolCreated(singleton); } } } else { List bulk = input.getBulk(); Iterator i = bulk.iterator(); Map testMap = new HashMap(); Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerPoolAware.class, this); while (i.hasNext()) { NeutronLoadBalancerPool test = i.next(); /* * Verify that the loadBalancerPool doesn't already exist */ if (loadBalancerPoolInterface.neutronLoadBalancerPoolExists(test.getLoadBalancerPoolID())) { throw new BadRequestException("Load Balancer Pool UUID already is already created"); } if (testMap.containsKey(test.getLoadBalancerPoolID())) { throw new BadRequestException("Load Balancer Pool UUID already exists"); } if (instances != null) { if (instances.length > 0) { for (Object instance : instances) { INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance; int status = service.canCreateNeutronLoadBalancerPool(test); if (status < HTTP_OK_BOTTOM || status > HTTP_OK_TOP) { return Response.status(status).build(); } } } else { throw new ServiceUnavailableException(NO_PROVIDERS); } } else { throw new ServiceUnavailableException(NO_PROVIDER_LIST); } } /* * now, each element of the bulk request can be added to the cache */ i = bulk.iterator(); while (i.hasNext()) { NeutronLoadBalancerPool test = i.next(); loadBalancerPoolInterface.addNeutronLoadBalancerPool(test); if (instances != null) { for (Object instance : instances) { INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance; service.neutronLoadBalancerPoolCreated(test); } } } } return Response.status(HttpURLConnection.HTTP_CREATED).entity(input).build(); } /** * Updates a LoadBalancerPool Policy */ @Path("{loadBalancerPoolID}") @PUT @Produces({ MediaType.APPLICATION_JSON }) @Consumes({ MediaType.APPLICATION_JSON }) @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_OK, condition = "Operation successful"), @ResponseCode(code = HttpURLConnection.HTTP_BAD_REQUEST, condition = "Bad Request"), @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"), @ResponseCode(code = HttpURLConnection.HTTP_FORBIDDEN, condition = "Forbidden"), @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"), @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"), @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") }) public Response updateLoadBalancerPool( @PathParam("loadBalancerPoolID") String loadBalancerPoolID, final NeutronLoadBalancerPoolRequest input) { INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = getNeutronInterfaces().getLoadBalancerPoolInterface(); /* * verify the LoadBalancerPool exists and there is only one delta provided */ if (!loadBalancerPoolInterface.neutronLoadBalancerPoolExists(loadBalancerPoolID)) { throw new ResourceNotFoundException(UUID_NO_EXIST); } if (!input.isSingleton()) { throw new BadRequestException("Only singleton edit supported"); } NeutronLoadBalancerPool delta = input.getSingleton(); NeutronLoadBalancerPool original = loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID); /* * updates restricted by Neutron */ if (delta.getLoadBalancerPoolID() != null || delta.getLoadBalancerPoolTenantID() != null || delta.getLoadBalancerPoolName() != null || delta.getLoadBalancerPoolDescription() != null || delta.getLoadBalancerPoolProtocol() != null || delta.getLoadBalancerPoolLbAlgorithm() != null || delta.getNeutronLoadBalancerPoolHealthMonitorID() != null || delta.getLoadBalancerPoolAdminIsStateIsUp() != null || delta.getLoadBalancerPoolMembers() != null) { throw new BadRequestException("Attribute edit blocked by Neutron"); } Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerPoolAware.class, this); if (instances != null) { if (instances.length > 0) { for (Object instance : instances) { INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance; int status = service.canUpdateNeutronLoadBalancerPool(delta, original); if (status < HTTP_OK_BOTTOM || status > HTTP_OK_TOP) { return Response.status(status).build(); } } } else { throw new ServiceUnavailableException(NO_PROVIDERS); } } else { throw new ServiceUnavailableException(NO_PROVIDER_LIST); } /* * update the object and return it */ loadBalancerPoolInterface.updateNeutronLoadBalancerPool(loadBalancerPoolID, delta); NeutronLoadBalancerPool updatedLoadBalancerPool = loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID); if (instances != null) { for (Object instance : instances) { INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance; service.neutronLoadBalancerPoolUpdated(updatedLoadBalancerPool); } } return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronLoadBalancerPoolRequest(loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolID))).build(); } /** * Deletes a LoadBalancerPool */ @Path("{loadBalancerPoolUUID}") @DELETE @StatusCodes({ @ResponseCode(code = HttpURLConnection.HTTP_NO_CONTENT, condition = "No Content"), @ResponseCode(code = HttpURLConnection.HTTP_UNAUTHORIZED, condition = "Unauthorized"), @ResponseCode(code = HttpURLConnection.HTTP_NOT_FOUND, condition = "Not Found"), @ResponseCode(code = HttpURLConnection.HTTP_CONFLICT, condition = "Conflict"), @ResponseCode(code = HttpURLConnection.HTTP_NOT_IMPLEMENTED, condition = "Not Implemented"), @ResponseCode(code = HttpURLConnection.HTTP_UNAVAILABLE, condition = "No providers available") }) public Response deleteLoadBalancerPool( @PathParam("loadBalancerPoolUUID") String loadBalancerPoolUUID) { INeutronLoadBalancerPoolCRUD loadBalancerPoolInterface = getNeutronInterfaces().getLoadBalancerPoolInterface(); /* * verify the LoadBalancerPool exists and it isn't currently in use */ if (!loadBalancerPoolInterface.neutronLoadBalancerPoolExists(loadBalancerPoolUUID)) { throw new ResourceNotFoundException(UUID_NO_EXIST); } if (loadBalancerPoolInterface.neutronLoadBalancerPoolInUse(loadBalancerPoolUUID)) { return Response.status(HttpURLConnection.HTTP_CONFLICT).build(); } NeutronLoadBalancerPool singleton = loadBalancerPoolInterface.getNeutronLoadBalancerPool(loadBalancerPoolUUID); Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerPoolAware.class, this); if (instances != null) { if (instances.length > 0) { for (Object instance : instances) { INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance; int status = service.canDeleteNeutronLoadBalancerPool(singleton); if (status < HTTP_OK_BOTTOM || status > HTTP_OK_TOP) { return Response.status(status).build(); } } } else { throw new ServiceUnavailableException(NO_PROVIDERS); } } else { throw new ServiceUnavailableException(NO_PROVIDER_LIST); } /* * remove it and return 204 status */ loadBalancerPoolInterface.removeNeutronLoadBalancerPool(loadBalancerPoolUUID); if (instances != null) { for (Object instance : instances) { INeutronLoadBalancerPoolAware service = (INeutronLoadBalancerPoolAware) instance; service.neutronLoadBalancerPoolDeleted(singleton); } } return Response.status(HttpURLConnection.HTTP_NO_CONTENT).build(); } }