/* * Copyright (C) 2014 Red Hat, Inc. * * 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 */ 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 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.INeutronLoadBalancerListenerAware; import org.opendaylight.neutron.spi.INeutronLoadBalancerListenerCRUD; import org.opendaylight.neutron.spi.NeutronCRUDInterfaces; import org.opendaylight.neutron.spi.NeutronLoadBalancerListener; /** * Neutron Northbound REST APIs for LoadBalancerListener Policies.
* This class provides REST APIs for managing neutron LoadBalancerListener 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 * */ @Path("/lbaas/listeners") public class NeutronLoadBalancerListenerNorthbound { private static final int HTTP_OK_BOTTOM = 200; private static final int HTTP_OK_TOP = 299; private static final String INTERFACE_NAME = "LoadBalancerListener CRUD Interface"; private static final String UUID_NO_EXIST = "LoadBalancerListener 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 NeutronLoadBalancerListener extractFields(NeutronLoadBalancerListener o, List fields) { return o.extractFields(fields); } private NeutronCRUDInterfaces getNeutronInterfaces() { NeutronCRUDInterfaces answer = new NeutronCRUDInterfaces().fetchINeutronLoadBalancerListenerCRUD(this); if (answer.getLoadBalancerListenerInterface() == null) { throw new ServiceUnavailableException(INTERFACE_NAME + RestMessages.SERVICEUNAVAILABLE.toString()); } return answer; } /** * Returns a list of all LoadBalancerListener */ @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 LoadBalancerListener attributes @QueryParam("id") String queryLoadBalancerListenerID, @QueryParam("default_pool_id") String queryLoadBalancerListenerDefaultPoolID, @QueryParam("tenant_id") String queryLoadBalancerListenerTenantID, @QueryParam("name") String queryLoadBalancerListenerName, @QueryParam("description") String queryLoadBalancerListenerDescription, @QueryParam("protocol") String queryLoadBalancerListenerProtocol, @QueryParam("protocol_port") String queryLoadBalancerListenerProtocolPort, @QueryParam("admin_state_up") String queryLoadBalancerListenerAdminIsUp, // pagination @QueryParam("limit") String limit, @QueryParam("marker") String marker, @QueryParam("page_reverse") String pageReverse // sorting not supported ) { INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = getNeutronInterfaces().getLoadBalancerListenerInterface(); List allLoadBalancerListeners = loadBalancerListenerInterface.getAllNeutronLoadBalancerListeners(); List ans = new ArrayList(); Iterator i = allLoadBalancerListeners.iterator(); while (i.hasNext()) { NeutronLoadBalancerListener nsg = i.next(); if ((queryLoadBalancerListenerID == null || queryLoadBalancerListenerID.equals(nsg.getLoadBalancerListenerID())) && (queryLoadBalancerListenerDefaultPoolID == null || queryLoadBalancerListenerDefaultPoolID.equals(nsg.getNeutronLoadBalancerListenerDefaultPoolID())) && (queryLoadBalancerListenerTenantID == null || queryLoadBalancerListenerTenantID.equals(nsg.getLoadBalancerListenerTenantID())) && (queryLoadBalancerListenerName == null || queryLoadBalancerListenerName.equals(nsg.getLoadBalancerListenerName())) && (queryLoadBalancerListenerDescription == null || queryLoadBalancerListenerDescription.equals(nsg.getLoadBalancerListenerDescription())) && (queryLoadBalancerListenerProtocol == null || queryLoadBalancerListenerProtocol.equals(nsg.getNeutronLoadBalancerListenerProtocol())) && (queryLoadBalancerListenerProtocolPort == null || queryLoadBalancerListenerProtocolPort.equals(nsg.getNeutronLoadBalancerListenerProtocolPort())) && (queryLoadBalancerListenerAdminIsUp == null || queryLoadBalancerListenerAdminIsUp.equals(nsg.getLoadBalancerListenerAdminStateIsUp()))) { if (fields.size() > 0) { ans.add(extractFields(nsg,fields)); } else { ans.add(nsg); } } } return Response.status(HttpURLConnection.HTTP_OK).entity( new NeutronLoadBalancerListenerRequest(ans)).build(); } /** * Returns a specific LoadBalancerListener */ @Path("{loadBalancerListenerID}") @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 showLoadBalancerListener(@PathParam("loadBalancerListenerID") String loadBalancerListenerID, // return fields @QueryParam("fields") List fields) { INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = getNeutronInterfaces().getLoadBalancerListenerInterface(); if (!loadBalancerListenerInterface.neutronLoadBalancerListenerExists(loadBalancerListenerID)) { throw new ResourceNotFoundException(UUID_NO_EXIST); } if (fields.size() > 0) { NeutronLoadBalancerListener ans = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID); return Response.status(HttpURLConnection.HTTP_OK).entity( new NeutronLoadBalancerListenerRequest(extractFields(ans, fields))).build(); } else { return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronLoadBalancerListenerRequest(loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID))).build(); } } /** * Creates new LoadBalancerListener */ @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 createLoadBalancerListeners(final NeutronLoadBalancerListenerRequest input) { INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = getNeutronInterfaces().getLoadBalancerListenerInterface(); if (input.isSingleton()) { NeutronLoadBalancerListener singleton = input.getSingleton(); /* * Verify that the LoadBalancerListener doesn't already exist. */ if (loadBalancerListenerInterface.neutronLoadBalancerListenerExists(singleton.getLoadBalancerListenerID())) { throw new BadRequestException("LoadBalancerListener UUID already exists"); } loadBalancerListenerInterface.addNeutronLoadBalancerListener(singleton); Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerListenerAware.class, this); if (instances != null) { if (instances.length > 0) { for (Object instance : instances) { INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance; int status = service.canCreateNeutronLoadBalancerListener(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); } loadBalancerListenerInterface.addNeutronLoadBalancerListener(singleton); if (instances != null) { for (Object instance : instances) { INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance; service.neutronLoadBalancerListenerCreated(singleton); } } } else { List bulk = input.getBulk(); Iterator i = bulk.iterator(); HashMap testMap = new HashMap(); Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerListenerAware.class, this); while (i.hasNext()) { NeutronLoadBalancerListener test = i.next(); /* * Verify that the firewall policy doesn't already exist */ if (loadBalancerListenerInterface.neutronLoadBalancerListenerExists(test.getLoadBalancerListenerID())) { throw new BadRequestException("LoadBalancerListener UUID already is already created"); } if (testMap.containsKey(test.getLoadBalancerListenerID())) { throw new BadRequestException("LoadBalancerListener UUID already exists"); } if (instances != null) { if (instances.length > 0) { for (Object instance : instances) { INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance; int status = service.canCreateNeutronLoadBalancerListener(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()) { NeutronLoadBalancerListener test = i.next(); loadBalancerListenerInterface.addNeutronLoadBalancerListener(test); if (instances != null) { for (Object instance : instances) { INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance; service.neutronLoadBalancerListenerCreated(test); } } } } return Response.status(HttpURLConnection.HTTP_CREATED).entity(input).build(); } /** * Updates a LoadBalancerListener Policy */ @Path("{loadBalancerListenerID}") @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 updateLoadBalancerListener( @PathParam("loadBalancerListenerID") String loadBalancerListenerID, final NeutronLoadBalancerListenerRequest input) { INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = getNeutronInterfaces().getLoadBalancerListenerInterface(); /* * verify the LoadBalancerListener exists and there is only one delta provided */ if (!loadBalancerListenerInterface.neutronLoadBalancerListenerExists(loadBalancerListenerID)) { throw new ResourceNotFoundException(UUID_NO_EXIST); } if (!input.isSingleton()) { throw new BadRequestException("Only singleton edit supported"); } NeutronLoadBalancerListener delta = input.getSingleton(); NeutronLoadBalancerListener original = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID); /* * updates restricted by Neutron */ if (delta.getLoadBalancerListenerID() != null || delta.getNeutronLoadBalancerListenerDefaultPoolID() != null || delta.getLoadBalancerListenerTenantID() != null || delta.getLoadBalancerListenerName() != null || delta.getLoadBalancerListenerDescription() != null || delta.getNeutronLoadBalancerListenerProtocol() != null || delta.getNeutronLoadBalancerListenerProtocolPort() != null || delta.getLoadBalancerListenerAdminStateIsUp() != null) { throw new BadRequestException("Attribute edit blocked by Neutron"); } Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerListenerAware.class, this); if (instances != null) { if (instances.length > 0) { for (Object instance : instances) { INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance; int status = service.canUpdateNeutronLoadBalancerListener(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 */ loadBalancerListenerInterface.updateNeutronLoadBalancerListener(loadBalancerListenerID, delta); NeutronLoadBalancerListener updatedLoadBalancerListener = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID); if (instances != null) { for (Object instance : instances) { INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance; service.neutronLoadBalancerListenerUpdated(updatedLoadBalancerListener); } } return Response.status(HttpURLConnection.HTTP_OK).entity(new NeutronLoadBalancerListenerRequest(loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID))).build(); } /** * Deletes a LoadBalancerListener */ @Path("{loadBalancerListenerID}") @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 deleteLoadBalancerListener( @PathParam("loadBalancerListenerID") String loadBalancerListenerID) { INeutronLoadBalancerListenerCRUD loadBalancerListenerInterface = getNeutronInterfaces().getLoadBalancerListenerInterface(); /* * verify the LoadBalancerListener exists and it isn't currently in use */ if (!loadBalancerListenerInterface.neutronLoadBalancerListenerExists(loadBalancerListenerID)) { throw new ResourceNotFoundException(UUID_NO_EXIST); } if (loadBalancerListenerInterface.neutronLoadBalancerListenerInUse(loadBalancerListenerID)) { return Response.status(HttpURLConnection.HTTP_CONFLICT).build(); } NeutronLoadBalancerListener singleton = loadBalancerListenerInterface.getNeutronLoadBalancerListener(loadBalancerListenerID); Object[] instances = NeutronUtil.getInstances(INeutronLoadBalancerListenerAware.class, this); if (instances != null) { if (instances.length > 0) { for (Object instance : instances) { INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance; int status = service.canDeleteNeutronLoadBalancerListener(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); } loadBalancerListenerInterface.removeNeutronLoadBalancerListener(loadBalancerListenerID); if (instances != null) { for (Object instance : instances) { INeutronLoadBalancerListenerAware service = (INeutronLoadBalancerListenerAware) instance; service.neutronLoadBalancerListenerDeleted(singleton); } } return Response.status(HttpURLConnection.HTTP_NO_CONTENT).build(); } }