You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by mu...@apache.org on 2012/06/22 03:56:11 UTC
[4/6] moving out NetScaler network element code from CloudStack core
into plugins/network-elements/netscaler
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/49b88472/plugins/network-elements/netscaler/src/com/cloud/network/element/NetscalerElement.java
----------------------------------------------------------------------
diff --git a/plugins/network-elements/netscaler/src/com/cloud/network/element/NetscalerElement.java b/plugins/network-elements/netscaler/src/com/cloud/network/element/NetscalerElement.java
new file mode 100644
index 0000000..7fcb6d0
--- /dev/null
+++ b/plugins/network-elements/netscaler/src/com/cloud/network/element/NetscalerElement.java
@@ -0,0 +1,784 @@
+// Copyright 2012 Citrix Systems, Inc. Licensed under the
+// Apache License, Version 2.0 (the "License"); you may not use this
+// file except in compliance with the License. Citrix Systems, Inc.
+// reserves all rights not expressly granted by the License.
+// You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Automatically generated by addcopyright.py at 04/03/2012
+package com.cloud.network.element;
+
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import javax.ejb.Local;
+
+import org.apache.log4j.Logger;
+
+import com.cloud.agent.AgentManager;
+import com.cloud.agent.api.Answer;
+import com.cloud.agent.api.routing.LoadBalancerConfigCommand;
+import com.cloud.agent.api.routing.SetStaticNatRulesAnswer;
+import com.cloud.agent.api.routing.SetStaticNatRulesCommand;
+import com.cloud.agent.api.to.LoadBalancerTO;
+import com.cloud.agent.api.to.StaticNatRuleTO;
+import com.cloud.api.ApiConstants;
+import com.cloud.api.commands.AddNetscalerLoadBalancerCmd;
+import com.cloud.api.commands.ConfigureNetscalerLoadBalancerCmd;
+import com.cloud.api.commands.DeleteNetscalerLoadBalancerCmd;
+import com.cloud.api.commands.ListNetscalerLoadBalancerNetworksCmd;
+import com.cloud.api.commands.ListNetscalerLoadBalancersCmd;
+import com.cloud.api.response.NetscalerLoadBalancerResponse;
+import com.cloud.configuration.Config;
+import com.cloud.configuration.ConfigurationManager;
+import com.cloud.configuration.dao.ConfigurationDao;
+import com.cloud.dc.DataCenter;
+import com.cloud.dc.DataCenterIpAddressVO;
+import com.cloud.dc.HostPodVO;
+import com.cloud.dc.DataCenter.NetworkType;
+import com.cloud.dc.dao.DataCenterDao;
+import com.cloud.dc.dao.DataCenterIpAddressDao;
+import com.cloud.deploy.DeployDestination;
+import com.cloud.exception.ConcurrentOperationException;
+import com.cloud.exception.InsufficientCapacityException;
+import com.cloud.exception.InsufficientNetworkCapacityException;
+import com.cloud.exception.InvalidParameterValueException;
+import com.cloud.exception.ResourceUnavailableException;
+import com.cloud.host.Host;
+import com.cloud.host.HostVO;
+import com.cloud.host.dao.HostDao;
+import com.cloud.host.dao.HostDetailsDao;
+import com.cloud.network.ExternalLoadBalancerDeviceManager;
+import com.cloud.network.ExternalLoadBalancerDeviceManagerImpl;
+import com.cloud.network.ExternalLoadBalancerDeviceVO;
+import com.cloud.network.ExternalLoadBalancerDeviceVO.LBDeviceState;
+import com.cloud.network.ExternalNetworkDeviceManager.NetworkDevice;
+import com.cloud.network.IpAddress;
+import com.cloud.network.NetScalerPodVO;
+import com.cloud.network.Network;
+import com.cloud.network.Network.Capability;
+import com.cloud.network.Network.Provider;
+import com.cloud.network.Network.Service;
+import com.cloud.network.NetworkExternalLoadBalancerVO;
+import com.cloud.network.NetworkManager;
+import com.cloud.network.NetworkVO;
+import com.cloud.network.Networks.TrafficType;
+import com.cloud.network.PhysicalNetworkServiceProvider;
+import com.cloud.network.PhysicalNetworkVO;
+import com.cloud.network.PublicIpAddress;
+import com.cloud.network.dao.ExternalLoadBalancerDeviceDao;
+import com.cloud.network.dao.NetScalerPodDao;
+import com.cloud.network.dao.NetworkDao;
+import com.cloud.network.dao.NetworkExternalLoadBalancerDao;
+import com.cloud.network.dao.NetworkServiceMapDao;
+import com.cloud.network.dao.PhysicalNetworkDao;
+import com.cloud.network.lb.LoadBalancingRule;
+import com.cloud.network.lb.LoadBalancingRule.LbDestination;
+import com.cloud.network.resource.NetscalerResource;
+import com.cloud.network.rules.FirewallRule;
+import com.cloud.network.rules.FirewallRule.Purpose;
+import com.cloud.network.rules.LbStickinessMethod;
+import com.cloud.network.rules.LbStickinessMethod.StickinessMethodType;
+import com.cloud.network.rules.StaticNat;
+import com.cloud.offering.NetworkOffering;
+import com.cloud.resource.ServerResource;
+import com.cloud.utils.NumbersUtil;
+import com.cloud.utils.component.Inject;
+import com.cloud.utils.db.DB;
+import com.cloud.utils.db.Transaction;
+import com.cloud.utils.exception.CloudRuntimeException;
+import com.cloud.utils.net.UrlUtil;
+import com.cloud.vm.NicProfile;
+import com.cloud.vm.ReservationContext;
+import com.cloud.vm.VirtualMachine;
+import com.cloud.vm.VirtualMachineProfile;
+import com.google.gson.Gson;
+
+@Local(value = NetworkElement.class)
+public class NetscalerElement extends ExternalLoadBalancerDeviceManagerImpl implements LoadBalancingServiceProvider, NetscalerLoadBalancerElementService, ExternalLoadBalancerDeviceManager, IpDeployer,
+ StaticNatServiceProvider {
+
+ private static final Logger s_logger = Logger.getLogger(NetscalerElement.class);
+
+ @Inject
+ NetworkManager _networkManager;
+ @Inject
+ ConfigurationManager _configMgr;
+ @Inject
+ NetworkServiceMapDao _ntwkSrvcDao;
+ @Inject
+ AgentManager _agentMgr;
+ @Inject
+ NetworkManager _networkMgr;
+ @Inject
+ HostDao _hostDao;
+ @Inject
+ DataCenterDao _dcDao;
+ @Inject
+ ExternalLoadBalancerDeviceDao _lbDeviceDao;
+ @Inject
+ NetworkExternalLoadBalancerDao _networkLBDao;
+ @Inject
+ PhysicalNetworkDao _physicalNetworkDao;
+ @Inject
+ NetworkDao _networkDao;
+ @Inject
+ HostDetailsDao _detailsDao;
+ @Inject
+ ConfigurationDao _configDao;
+ @Inject
+ NetScalerPodDao _netscalerPodDao;
+ @Inject
+ DataCenterIpAddressDao _privateIpAddressDao;
+
+ private boolean canHandle(Network config, Service service) {
+ DataCenter zone = _dcDao.findById(config.getDataCenterId());
+ boolean handleInAdvanceZone = (zone.getNetworkType() == NetworkType.Advanced && config.getGuestType() == Network.GuestType.Isolated && config.getTrafficType() == TrafficType.Guest);
+ boolean handleInBasicZone = (zone.getNetworkType() == NetworkType.Basic && config.getGuestType() == Network.GuestType.Shared && config.getTrafficType() == TrafficType.Guest);
+
+ if (!(handleInAdvanceZone || handleInBasicZone)) {
+ s_logger.trace("Not handling network with Type " + config.getGuestType() + " and traffic type " + config.getTrafficType() + " in zone of type " + zone.getNetworkType());
+ return false;
+ }
+
+ return (_networkManager.isProviderForNetwork(getProvider(), config.getId()) && _ntwkSrvcDao.canProviderSupportServiceInNetwork(config.getId(), service, Network.Provider.Netscaler));
+ }
+
+ private boolean isBasicZoneNetwok(Network config) {
+ DataCenter zone = _dcDao.findById(config.getDataCenterId());
+ return (zone.getNetworkType() == NetworkType.Basic && config.getGuestType() == Network.GuestType.Shared && config.getTrafficType() == TrafficType.Guest);
+ }
+
+ @Override
+ public boolean implement(Network guestConfig, NetworkOffering offering, DeployDestination dest, ReservationContext context) throws ResourceUnavailableException, ConcurrentOperationException,
+ InsufficientNetworkCapacityException {
+
+ if (!canHandle(guestConfig, Service.Lb)) {
+ return false;
+ }
+
+ if (_ntwkSrvcDao.canProviderSupportServiceInNetwork(guestConfig.getId(), Service.StaticNat, Network.Provider.Netscaler) && !isBasicZoneNetwok(guestConfig)) {
+ s_logger.error("NetScaler provider can not be Static Nat service provider for the network " + guestConfig.getGuestType() +
+ " and traffic type " + guestConfig.getTrafficType());
+ return false;
+ }
+
+ try {
+ return manageGuestNetworkWithExternalLoadBalancer(true, guestConfig);
+ } catch (InsufficientCapacityException capacityException) {
+ throw new ResourceUnavailableException("There are no NetScaler load balancer devices with the free capacity for implementing this network", DataCenter.class, guestConfig.getDataCenterId());
+ }
+ }
+
+ @Override
+ public boolean prepare(Network config, NicProfile nic, VirtualMachineProfile<? extends VirtualMachine> vm, DeployDestination dest, ReservationContext context) throws ConcurrentOperationException,
+ InsufficientNetworkCapacityException, ResourceUnavailableException {
+ return true;
+ }
+
+ @Override
+ public boolean release(Network config, NicProfile nic, VirtualMachineProfile<? extends VirtualMachine> vm, ReservationContext context) {
+ return true;
+ }
+
+ @Override
+ public boolean shutdown(Network guestConfig, ReservationContext context, boolean cleanup) throws ResourceUnavailableException, ConcurrentOperationException {
+ if (!canHandle(guestConfig, Service.Lb)) {
+ return false;
+ }
+
+ try {
+ return manageGuestNetworkWithExternalLoadBalancer(false, guestConfig);
+ } catch (InsufficientCapacityException capacityException) {
+ // TODO: handle out of capacity exception gracefully in case of multple providers available
+ return false;
+ }
+ }
+
+ @Override
+ public boolean destroy(Network config) {
+ return true;
+ }
+
+ @Override
+ public boolean validateLBRule(Network network, LoadBalancingRule rule) {
+ return true;
+ }
+
+ @Override
+ public boolean applyLBRules(Network config, List<LoadBalancingRule> rules) throws ResourceUnavailableException {
+ if (!canHandle(config, Service.Lb)) {
+ return false;
+ }
+
+ if (isBasicZoneNetwok(config)) {
+ return applyElasticLoadBalancerRules(config, rules);
+ } else {
+ return applyLoadBalancerRules(config, rules);
+ }
+ }
+
+ @Override
+ public Map<Service, Map<Capability, String>> getCapabilities() {
+ Map<Service, Map<Capability, String>> capabilities = new HashMap<Service, Map<Capability, String>>();
+
+ // Set capabilities for LB service
+ Map<Capability, String> lbCapabilities = new HashMap<Capability, String>();
+
+ // Specifies that the RoundRobin and Leastconn algorithms are supported for load balancing rules
+ lbCapabilities.put(Capability.SupportedLBAlgorithms, "roundrobin,leastconn");
+
+ // specifies that Netscaler network element can provided both shared and isolation modes
+ lbCapabilities.put(Capability.SupportedLBIsolation, "dedicated, shared");
+
+ // Specifies that load balancing rules can be made for either TCP or UDP traffic
+ lbCapabilities.put(Capability.SupportedProtocols, "tcp,udp");
+
+ // Specifies that this element can measure network usage on a per public IP basis
+ lbCapabilities.put(Capability.TrafficStatistics, "per public ip");
+
+ // Specifies that load balancing rules can only be made with public IPs that aren't source NAT IPs
+ lbCapabilities.put(Capability.LoadBalancingSupportedIps, "additional");
+
+ LbStickinessMethod method;
+ List<LbStickinessMethod> methodList = new ArrayList<LbStickinessMethod>();
+ method = new LbStickinessMethod(StickinessMethodType.LBCookieBased, "This is cookie based sticky method, can be used only for http");
+ methodList.add(method);
+ method.addParam("holdtime", false, "time period in minutes for which persistence is in effect.", false);
+
+ method = new LbStickinessMethod(StickinessMethodType.AppCookieBased, "This is app session based sticky method, can be used only for http");
+ methodList.add(method);
+ method.addParam("name", true, "cookie name passed in http header by apllication to the client", false);
+
+ method = new LbStickinessMethod(StickinessMethodType.SourceBased, "This is source based sticky method, can be used for any type of protocol.");
+ methodList.add(method);
+ method.addParam("holdtime", false, "time period for which persistence is in effect.", false);
+
+ Gson gson = new Gson();
+ String stickyMethodList = gson.toJson(methodList);
+ lbCapabilities.put(Capability.SupportedStickinessMethods, stickyMethodList);
+
+ lbCapabilities.put(Capability.ElasticLb, "true");
+
+ capabilities.put(Service.Lb, lbCapabilities);
+
+ Map<Capability, String> staticNatCapabilities = new HashMap<Capability, String>();
+ staticNatCapabilities.put(Capability.ElasticIp, "true");
+ capabilities.put(Service.StaticNat, staticNatCapabilities);
+
+ // TODO - Murali, please put correct capabilities here
+ Map<Capability, String> firewallCapabilities = new HashMap<Capability, String>();
+ firewallCapabilities.put(Capability.TrafficStatistics, "per public ip");
+ firewallCapabilities.put(Capability.SupportedProtocols, "tcp,udp,icmp");
+ firewallCapabilities.put(Capability.MultipleIps, "true");
+
+ capabilities.put(Service.Firewall, firewallCapabilities);
+
+ return capabilities;
+ }
+
+ @Override
+ public ExternalLoadBalancerDeviceVO addNetscalerLoadBalancer(AddNetscalerLoadBalancerCmd cmd) {
+ String deviceName = cmd.getDeviceType();
+
+ if (!isNetscalerDevice(deviceName)) {
+ throw new InvalidParameterValueException("Invalid Netscaler device type");
+ }
+
+ URI uri;
+ try {
+ uri = new URI(cmd.getUrl());
+ } catch (Exception e) {
+ String msg = "Error parsing the url parameter specified in addNetscalerLoadBalancer command due to " + e.getMessage();
+ s_logger.debug(msg);
+ throw new InvalidParameterValueException(msg);
+ }
+ Map<String, String> configParams = new HashMap<String, String>();
+ UrlUtil.parseQueryParameters(uri.getQuery(), false, configParams);
+ boolean dedicatedUse = (configParams.get(ApiConstants.LOAD_BALANCER_DEVICE_DEDICATED) != null) ? Boolean.parseBoolean(configParams.get(ApiConstants.LOAD_BALANCER_DEVICE_DEDICATED)) : false;
+
+ if (dedicatedUse && !deviceName.equals(NetworkDevice.NetscalerVPXLoadBalancer.getName())) {
+ String msg = "Only Netscaler VPX load balancers can be specified for dedicated use";
+ s_logger.debug(msg);
+ throw new InvalidParameterValueException(msg);
+ }
+
+ ExternalLoadBalancerDeviceVO lbDeviceVO = addExternalLoadBalancer(cmd.getPhysicalNetworkId(), cmd.getUrl(), cmd.getUsername(), cmd.getPassword(), deviceName, (ServerResource) new NetscalerResource());
+ return lbDeviceVO;
+ }
+
+ @Override
+ public boolean deleteNetscalerLoadBalancer(DeleteNetscalerLoadBalancerCmd cmd) {
+ Long lbDeviceId = cmd.getLoadBalancerDeviceId();
+
+ ExternalLoadBalancerDeviceVO lbDeviceVo = _lbDeviceDao.findById(lbDeviceId);
+ if ((lbDeviceVo == null) || !isNetscalerDevice(lbDeviceVo.getDeviceName())) {
+ throw new InvalidParameterValueException("No netscaler device found with ID: " + lbDeviceId);
+ }
+
+ return deleteExternalLoadBalancer(lbDeviceVo.getHostId());
+ }
+
+ @Override
+ public ExternalLoadBalancerDeviceVO configureNetscalerLoadBalancer(ConfigureNetscalerLoadBalancerCmd cmd) {
+ Long lbDeviceId = cmd.getLoadBalancerDeviceId();
+ Boolean dedicatedUse = cmd.getLoadBalancerDedicated();
+ Boolean inline = cmd.getLoadBalancerInline();
+ Long capacity = cmd.getLoadBalancerCapacity();
+ List<Long> podIds = cmd.getPodIds();
+ try {
+ return configureNetscalerLoadBalancer(lbDeviceId, capacity, inline, dedicatedUse, podIds);
+ } catch (Exception e) {
+ throw new CloudRuntimeException("failed to configure netscaler device due to " + e.getMessage());
+ }
+ }
+
+ @DB
+ private ExternalLoadBalancerDeviceVO configureNetscalerLoadBalancer(long lbDeviceId, Long capacity, Boolean inline, Boolean dedicatedUse, List<Long> newPodsConfig) {
+ ExternalLoadBalancerDeviceVO lbDeviceVo = _lbDeviceDao.findById(lbDeviceId);
+ Map<String, String> lbDetails = _detailsDao.findDetails(lbDeviceVo.getHostId());
+
+ if ((lbDeviceVo == null) || !isNetscalerDevice(lbDeviceVo.getDeviceName())) {
+ throw new InvalidParameterValueException("No netscaler device found with ID: " + lbDeviceId);
+ }
+
+ List<Long> currentPodsConfig = new ArrayList<Long>();
+ List<NetScalerPodVO> currentPodVOs = _netscalerPodDao.listByNetScalerDeviceId(lbDeviceVo.getId());
+ if (currentPodVOs != null && currentPodVOs.size() > 0) {
+ for (NetScalerPodVO nsPodVo: currentPodVOs) {
+ currentPodsConfig.add(nsPodVo.getPodId());
+ }
+ }
+
+ List<Long> podsToAssociate = new ArrayList<Long>();
+ if (newPodsConfig != null && newPodsConfig.size() > 0) {
+ for (Long podId: newPodsConfig) {
+ HostPodVO pod = _podDao.findById(podId);
+ if (pod == null) {
+ throw new InvalidParameterValueException("Can't find pod by id " + podId);
+ }
+ }
+
+ for (Long podId: newPodsConfig) {
+ if (!currentPodsConfig.contains(podId)) {
+ podsToAssociate.add(podId);
+ }
+ }
+ }
+
+ List<Long> podsToDeassociate = new ArrayList<Long>();
+ for (Long podId: currentPodsConfig) {
+ if (!newPodsConfig.contains(podId)) {
+ podsToDeassociate.add(podId);
+ }
+ }
+
+ String deviceName = lbDeviceVo.getDeviceName();
+ if (dedicatedUse != null || capacity != null || inline != null) {
+ if (NetworkDevice.NetscalerSDXLoadBalancer.getName().equalsIgnoreCase(deviceName) ||
+ NetworkDevice.NetscalerMPXLoadBalancer.getName().equalsIgnoreCase(deviceName)) {
+ if (dedicatedUse != null && dedicatedUse == true) {
+ throw new InvalidParameterValueException("Netscaler MPX and SDX device should be shared and can not be dedicated to a single account.");
+ }
+ }
+
+ // check if any networks are using this netscaler device
+ List<NetworkExternalLoadBalancerVO> networks = _networkLBDao.listByLoadBalancerDeviceId(lbDeviceId);
+ if ((networks != null) && !networks.isEmpty()) {
+ if (capacity != null && capacity < networks.size()) {
+ throw new CloudRuntimeException("There are more number of networks already using this netscaler device than configured capacity");
+ }
+
+ if (dedicatedUse != null && dedicatedUse == true) {
+ throw new CloudRuntimeException("There are networks already using this netscaler device to make device dedicated");
+ }
+
+ if (inline != null) {
+ boolean _setInline = Boolean.parseBoolean((String) lbDetails.get("inline"));
+ if (inline != _setInline) {
+ throw new CloudRuntimeException("There are networks already using this netscaler device to change the device inline or side-by-side configuration");
+ }
+ }
+ }
+ }
+
+ if (!NetworkDevice.NetscalerSDXLoadBalancer.getName().equalsIgnoreCase(deviceName)) {
+ if (capacity != null) {
+ lbDeviceVo.setCapacity(capacity);
+ }
+ } else {
+ // FIXME how to interpret configured capacity of the SDX device
+ }
+
+ if (dedicatedUse != null) {
+ lbDeviceVo.setIsDedicatedDevice(dedicatedUse);
+ }
+
+ if (inline != null && inline == true) {
+ lbDeviceVo.setIsInlineMode(true);
+ lbDetails.put("inline", "true");
+ } else {
+ lbDeviceVo.setIsInlineMode(false);
+ lbDetails.put("inline", "false");
+ }
+
+ Transaction txn = Transaction.currentTxn();
+ txn.start();
+
+ _lbDeviceDao.update(lbDeviceId, lbDeviceVo);
+
+ for (Long podId: podsToAssociate) {
+ NetScalerPodVO nsPodVo = new NetScalerPodVO(lbDeviceId, podId);
+ _netscalerPodDao.persist(nsPodVo);
+ }
+
+ for (Long podId: podsToDeassociate) {
+ NetScalerPodVO nsPodVo = _netscalerPodDao.findByPodId(podId);
+ _netscalerPodDao.remove(nsPodVo.getId());
+ }
+
+ // FIXME get the row lock to avoid race condition
+ _detailsDao.persist(lbDeviceVo.getHostId(), lbDetails);
+ HostVO host = _hostDao.findById(lbDeviceVo.getHostId());
+ txn.commit();
+
+ _agentMgr.reconnect(host.getId());
+ return lbDeviceVo;
+ }
+
+ @Override
+ public String getPropertiesFile() {
+ return "netscalerloadbalancer_commands.properties";
+ }
+
+ @Override
+ public List<? extends Network> listNetworks(ListNetscalerLoadBalancerNetworksCmd cmd) {
+ Long lbDeviceId = cmd.getLoadBalancerDeviceId();
+ List<NetworkVO> networks = new ArrayList<NetworkVO>();
+
+ ExternalLoadBalancerDeviceVO lbDeviceVo = _lbDeviceDao.findById(lbDeviceId);
+ if (lbDeviceVo == null || !isNetscalerDevice(lbDeviceVo.getDeviceName())) {
+ throw new InvalidParameterValueException("Could not find Netscaler load balancer device with ID " + lbDeviceId);
+ }
+
+ List<NetworkExternalLoadBalancerVO> networkLbMaps = _networkLBDao.listByLoadBalancerDeviceId(lbDeviceId);
+ if (networkLbMaps != null && !networkLbMaps.isEmpty()) {
+ for (NetworkExternalLoadBalancerVO networkLbMap : networkLbMaps) {
+ NetworkVO network = _networkDao.findById(networkLbMap.getNetworkId());
+ networks.add(network);
+ }
+ }
+
+ return networks;
+ }
+
+ @Override
+ public List<ExternalLoadBalancerDeviceVO> listNetscalerLoadBalancers(ListNetscalerLoadBalancersCmd cmd) {
+ Long physcialNetworkId = cmd.getPhysicalNetworkId();
+ Long lbDeviceId = cmd.getLoadBalancerDeviceId();
+ PhysicalNetworkVO pNetwork = null;
+ List<ExternalLoadBalancerDeviceVO> lbDevices = new ArrayList<ExternalLoadBalancerDeviceVO>();
+
+ if (physcialNetworkId == null && lbDeviceId == null) {
+ throw new InvalidParameterValueException("Either physical network Id or load balancer device Id must be specified");
+ }
+
+ if (lbDeviceId != null) {
+ ExternalLoadBalancerDeviceVO lbDeviceVo = _lbDeviceDao.findById(lbDeviceId);
+ if (lbDeviceVo == null || !isNetscalerDevice(lbDeviceVo.getDeviceName())) {
+ throw new InvalidParameterValueException("Could not find Netscaler load balancer device with ID: " + lbDeviceId);
+ }
+ lbDevices.add(lbDeviceVo);
+ return lbDevices;
+ }
+
+ if (physcialNetworkId != null) {
+ pNetwork = _physicalNetworkDao.findById(physcialNetworkId);
+ if (pNetwork == null) {
+ throw new InvalidParameterValueException("Could not find phyical network with ID: " + physcialNetworkId);
+ }
+ lbDevices = _lbDeviceDao.listByPhysicalNetworkAndProvider(physcialNetworkId, Provider.Netscaler.getName());
+ return lbDevices;
+ }
+
+ return null;
+ }
+
+ @Override
+ public NetscalerLoadBalancerResponse createNetscalerLoadBalancerResponse(ExternalLoadBalancerDeviceVO lbDeviceVO) {
+ NetscalerLoadBalancerResponse response = new NetscalerLoadBalancerResponse();
+ Host lbHost = _hostDao.findById(lbDeviceVO.getHostId());
+ Map<String, String> lbDetails = _detailsDao.findDetails(lbDeviceVO.getHostId());
+
+ response.setId(lbDeviceVO.getId());
+ response.setIpAddress(lbHost.getPrivateIpAddress());
+ response.setPhysicalNetworkId(lbDeviceVO.getPhysicalNetworkId());
+ response.setPublicInterface(lbDetails.get("publicInterface"));
+ response.setPrivateInterface(lbDetails.get("privateInterface"));
+ response.setDeviceName(lbDeviceVO.getDeviceName());
+ if (lbDeviceVO.getCapacity() == 0) {
+ long defaultLbCapacity = NumbersUtil.parseLong(_configDao.getValue(Config.DefaultExternalLoadBalancerCapacity.key()), 50);
+ response.setDeviceCapacity(defaultLbCapacity);
+ } else {
+ response.setDeviceCapacity(lbDeviceVO.getCapacity());
+ }
+ response.setInlineMode(lbDeviceVO.getIsInLineMode());
+ response.setDedicatedLoadBalancer(lbDeviceVO.getIsDedicatedDevice());
+ response.setProvider(lbDeviceVO.getProviderName());
+ response.setDeviceState(lbDeviceVO.getState().name());
+ response.setObjectName("netscalerloadbalancer");
+
+ List<Long> associatedPods = new ArrayList<Long>();
+ List<NetScalerPodVO> currentPodVOs = _netscalerPodDao.listByNetScalerDeviceId(lbDeviceVO.getId());
+ if (currentPodVOs != null && currentPodVOs.size() > 0) {
+ for (NetScalerPodVO nsPodVo: currentPodVOs) {
+ associatedPods.add(nsPodVo.getPodId());
+ }
+ }
+ response.setAssociatedPods(associatedPods);
+ return response;
+ }
+
+ @Override
+ public Provider getProvider() {
+ return Provider.Netscaler;
+ }
+
+ @Override
+ public boolean isReady(PhysicalNetworkServiceProvider provider) {
+ List<ExternalLoadBalancerDeviceVO> lbDevices = _lbDeviceDao.listByPhysicalNetworkAndProvider(provider.getPhysicalNetworkId(), Provider.Netscaler.getName());
+
+ // true if at-least one Netscaler device is added in to physical network and is in configured (in enabled state)
+// state
+ if (lbDevices != null && !lbDevices.isEmpty()) {
+ for (ExternalLoadBalancerDeviceVO lbDevice : lbDevices) {
+ if (lbDevice.getState() == LBDeviceState.Enabled) {
+ return true;
+ }
+ }
+ }
+ return false;
+ }
+
+ @Override
+ public boolean shutdownProviderInstances(PhysicalNetworkServiceProvider provider, ReservationContext context) throws ConcurrentOperationException,
+ ResourceUnavailableException {
+ // TODO reset the configuration on all of the netscaler devices in this physical network
+ return true;
+ }
+
+ @Override
+ public boolean canEnableIndividualServices() {
+ return true;
+ }
+
+ private boolean isNetscalerDevice(String deviceName) {
+ if ((deviceName == null) || ((!deviceName.equalsIgnoreCase(NetworkDevice.NetscalerMPXLoadBalancer.getName())) &&
+ (!deviceName.equalsIgnoreCase(NetworkDevice.NetscalerSDXLoadBalancer.getName())) &&
+ (!deviceName.equalsIgnoreCase(NetworkDevice.NetscalerVPXLoadBalancer.getName())))) {
+ return false;
+ } else {
+ return true;
+ }
+ }
+
+ @Override
+ public boolean verifyServicesCombination(List<String> services) {
+ List<String> netscalerServices = new ArrayList<String>();
+ netscalerServices.add(Service.Lb.getName());
+ netscalerServices.add(Service.StaticNat.getName());
+
+ // NetScaler can only act as Lb and Static Nat service provider
+ if (services != null && !services.isEmpty() && !netscalerServices.containsAll(services)) {
+ s_logger.warn("NetScaler network element can only support LB and Static NAT services and service combination "
+ + services + " is not supported.");
+ return false;
+ }
+
+ return true;
+ }
+
+ @Override
+ public boolean applyIps(Network network, List<? extends PublicIpAddress> ipAddress, Set<Service> service) throws ResourceUnavailableException {
+ // return true, as IP will be associated as part of LB rule configuration
+ return false;
+ }
+
+ @Override
+ public IpDeployer getIpDeployer(Network network) {
+ return this;
+ }
+
+ public boolean applyElasticLoadBalancerRules(Network network, List<? extends FirewallRule> rules) throws ResourceUnavailableException {
+
+ List<LoadBalancingRule> loadBalancingRules = new ArrayList<LoadBalancingRule>();
+ for (FirewallRule rule : rules) {
+ if (rule.getPurpose().equals(Purpose.LoadBalancing)) {
+ loadBalancingRules.add((LoadBalancingRule) rule);
+ }
+ }
+
+ if (loadBalancingRules == null || loadBalancingRules.isEmpty()) {
+ return true;
+ }
+
+ String errMsg = null;
+ ExternalLoadBalancerDeviceVO lbDeviceVO = getExternalLoadBalancerForNetwork(network);
+ if (lbDeviceVO == null) {
+ try {
+ lbDeviceVO = allocateLoadBalancerForNetwork(network);
+ } catch (Exception e) {
+ errMsg = "Could not allocate a NetSclaer load balancer for configuring elastic load balancer rules due to " + e.getMessage();
+ s_logger.error(errMsg);
+ throw new ResourceUnavailableException(errMsg, this.getClass(), 0);
+ }
+ }
+
+ if (!isNetscalerDevice(lbDeviceVO.getDeviceName())) {
+ errMsg = "There are no NetScaler load balancer assigned for this network. So NetScaler element can not be handle elastic load balancer rules.";
+ s_logger.error(errMsg);
+ throw new ResourceUnavailableException(errMsg, this.getClass(), 0);
+ }
+
+ List<LoadBalancerTO> loadBalancersToApply = new ArrayList<LoadBalancerTO>();
+ for (int i = 0; i < loadBalancingRules.size(); i++) {
+ LoadBalancingRule rule = loadBalancingRules.get(i);
+ boolean revoked = (rule.getState().equals(FirewallRule.State.Revoke));
+ String protocol = rule.getProtocol();
+ String algorithm = rule.getAlgorithm();
+ String srcIp = _networkMgr.getIp(rule.getSourceIpAddressId()).getAddress().addr();
+ int srcPort = rule.getSourcePortStart();
+ List<LbDestination> destinations = rule.getDestinations();
+
+ if (destinations != null && !destinations.isEmpty()) {
+ LoadBalancerTO loadBalancer = new LoadBalancerTO(srcIp, srcPort, protocol, algorithm, revoked, false, destinations, rule.getStickinessPolicies());
+ loadBalancersToApply.add(loadBalancer);
+ }
+ }
+
+ if (loadBalancersToApply.size() > 0) {
+ int numLoadBalancersForCommand = loadBalancersToApply.size();
+ LoadBalancerTO[] loadBalancersForCommand = loadBalancersToApply.toArray(new LoadBalancerTO[numLoadBalancersForCommand]);
+ LoadBalancerConfigCommand cmd = new LoadBalancerConfigCommand(loadBalancersForCommand);
+
+ HostVO externalLoadBalancer = _hostDao.findById(lbDeviceVO.getHostId());
+ Answer answer = _agentMgr.easySend(externalLoadBalancer.getId(), cmd);
+ if (answer == null || !answer.getResult()) {
+ String details = (answer != null) ? answer.getDetails() : "details unavailable";
+ String msg = "Unable to apply elastic load balancer rules to the external load balancer appliance in zone " + network.getDataCenterId() + " due to: " + details + ".";
+ s_logger.error(msg);
+ throw new ResourceUnavailableException(msg, DataCenter.class, network.getDataCenterId());
+ }
+ }
+
+ return true;
+ }
+
+ @Override
+ public boolean applyStaticNats(Network config, List<? extends StaticNat> rules) throws ResourceUnavailableException {
+
+ if (!canHandle(config, Service.StaticNat)) {
+ return false;
+ }
+
+ boolean multiNetScalerDeployment = Boolean.valueOf(_configDao.getValue(Config.EIPWithMultipleNetScalersEnabled.key()));
+
+ try {
+ if (!multiNetScalerDeployment) {
+ String errMsg;
+ ExternalLoadBalancerDeviceVO lbDevice = getExternalLoadBalancerForNetwork(config);
+ if (lbDevice == null) {
+ try {
+ lbDevice = allocateLoadBalancerForNetwork(config);
+ } catch (Exception e) {
+ errMsg = "Could not allocate a NetSclaer load balancer for configuring static NAT rules due to" + e.getMessage();
+ s_logger.error(errMsg);
+ throw new ResourceUnavailableException(errMsg, this.getClass(), 0);
+ }
+ }
+
+ if (!isNetscalerDevice(lbDevice.getDeviceName())) {
+ errMsg = "There are no NetScaler load balancer assigned for this network. So NetScaler element will not be handling the static nat rules.";
+ s_logger.error(errMsg);
+ throw new ResourceUnavailableException(errMsg, this.getClass(), 0);
+ }
+ SetStaticNatRulesAnswer answer = null;
+ List<StaticNatRuleTO> rulesTO = null;
+ if (rules != null) {
+ rulesTO = new ArrayList<StaticNatRuleTO>();
+ for (StaticNat rule : rules) {
+ IpAddress sourceIp = _networkMgr.getIp(rule.getSourceIpAddressId());
+ StaticNatRuleTO ruleTO = new StaticNatRuleTO(0, sourceIp.getAddress().addr(), null, null, rule.getDestIpAddress(), null, null, null, rule.isForRevoke(), false);
+ rulesTO.add(ruleTO);
+ }
+ }
+
+ SetStaticNatRulesCommand cmd = new SetStaticNatRulesCommand(rulesTO);
+ answer = (SetStaticNatRulesAnswer) _agentMgr.send(lbDevice.getHostId(), cmd);
+ if (answer == null) {
+ return false;
+ } else {
+ return answer.getResult();
+ }
+ } else {
+ if (rules != null) {
+ for (StaticNat rule : rules) {
+ // validate if EIP rule can be configured.
+ ExternalLoadBalancerDeviceVO lbDevice = getNetScalerForEIP(rule);
+ if (lbDevice == null) {
+ String errMsg = "There is no NetScaler device configured to perform EIP to guest IP address: " + rule.getDestIpAddress();
+ s_logger.error(errMsg);
+ throw new ResourceUnavailableException(errMsg, this.getClass(), 0);
+ }
+
+ List<StaticNatRuleTO> rulesTO = new ArrayList<StaticNatRuleTO>();
+ IpAddress sourceIp = _networkMgr.getIp(rule.getSourceIpAddressId());
+ StaticNatRuleTO ruleTO = new StaticNatRuleTO(0, sourceIp.getAddress().addr(), null, null, rule.getDestIpAddress(), null, null, null, rule.isForRevoke(), false);
+ rulesTO.add(ruleTO);
+ SetStaticNatRulesCommand cmd = new SetStaticNatRulesCommand(rulesTO);
+
+ // send commands to configure INAT rule on the NetScaler device
+ SetStaticNatRulesAnswer answer = (SetStaticNatRulesAnswer) _agentMgr.send(lbDevice.getHostId(), cmd);
+ if (answer == null) {
+ String errMsg = "Failed to configure INAT rule on NetScaler device " + lbDevice.getHostId();
+ s_logger.error(errMsg);
+ throw new ResourceUnavailableException(errMsg, this.getClass(), 0);
+ }
+ }
+ return true;
+ }
+ }
+ return true;
+ } catch (Exception e) {
+ s_logger.error("Failed to configure StaticNat rule due to " + e.getMessage());
+ return false;
+ }
+ }
+
+ // returns configured NetScaler device that is associated with the pod that owns guest IP
+ private ExternalLoadBalancerDeviceVO getNetScalerForEIP(StaticNat rule) {
+ String guestIP = rule.getDestIpAddress();
+ List <DataCenterIpAddressVO> dcGuestIps = _privateIpAddressDao.listAll();
+ if (dcGuestIps != null) {
+ for (DataCenterIpAddressVO dcGuestIp: dcGuestIps) {
+ if (dcGuestIp.getIpAddress().equalsIgnoreCase(guestIP)) {
+ long podId = dcGuestIp.getPodId();
+ NetScalerPodVO nsPodVO = _netscalerPodDao.findByPodId(podId);
+ if (nsPodVO != null) {
+ ExternalLoadBalancerDeviceVO lbDeviceVO = _lbDeviceDao.findById(nsPodVO.getNetscalerDeviceId());
+ return lbDeviceVO;
+ }
+ }
+ }
+ }
+ return null;
+ }
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/49b88472/plugins/network-elements/netscaler/src/com/cloud/network/element/NetscalerLoadBalancerElementService.java
----------------------------------------------------------------------
diff --git a/plugins/network-elements/netscaler/src/com/cloud/network/element/NetscalerLoadBalancerElementService.java b/plugins/network-elements/netscaler/src/com/cloud/network/element/NetscalerLoadBalancerElementService.java
new file mode 100644
index 0000000..d96ced6
--- /dev/null
+++ b/plugins/network-elements/netscaler/src/com/cloud/network/element/NetscalerLoadBalancerElementService.java
@@ -0,0 +1,69 @@
+// Copyright 2012 Citrix Systems, Inc. Licensed under the
+// Apache License, Version 2.0 (the "License"); you may not use this
+// file except in compliance with the License. Citrix Systems, Inc.
+// reserves all rights not expressly granted by the License.
+// You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Automatically generated by addcopyright.py at 04/03/2012
+package com.cloud.network.element;
+
+import java.util.List;
+import com.cloud.api.commands.AddNetscalerLoadBalancerCmd;
+import com.cloud.api.commands.ConfigureNetscalerLoadBalancerCmd;
+import com.cloud.api.commands.DeleteNetscalerLoadBalancerCmd;
+import com.cloud.api.commands.ListNetscalerLoadBalancerNetworksCmd;
+import com.cloud.api.commands.ListNetscalerLoadBalancersCmd;
+import com.cloud.api.response.NetscalerLoadBalancerResponse;
+import com.cloud.network.ExternalLoadBalancerDeviceVO;
+import com.cloud.network.Network;
+import com.cloud.utils.component.PluggableService;
+
+public interface NetscalerLoadBalancerElementService extends PluggableService {
+
+ /**
+ * adds a Netscaler load balancer device in to a physical network
+ * @param AddNetscalerLoadBalancerCmd
+ * @return ExternalLoadBalancerDeviceVO object for the device added
+ */
+ public ExternalLoadBalancerDeviceVO addNetscalerLoadBalancer(AddNetscalerLoadBalancerCmd cmd);
+
+ /**
+ * removes a Netscaler load balancer device from a physical network
+ * @param DeleteNetscalerLoadBalancerCmd
+ * @return true if Netscaler device is deleted successfully
+ */
+ public boolean deleteNetscalerLoadBalancer(DeleteNetscalerLoadBalancerCmd cmd);
+
+ /**
+ * configures a Netscaler load balancer device added in a physical network
+ * @param ConfigureNetscalerLoadBalancerCmd
+ * @return ExternalLoadBalancerDeviceVO for the device configured
+ */
+ public ExternalLoadBalancerDeviceVO configureNetscalerLoadBalancer(ConfigureNetscalerLoadBalancerCmd cmd);
+
+ /**
+ * lists all the load balancer devices added in to a physical network
+ * @param ListNetscalerLoadBalancersCmd
+ * @return list of ExternalLoadBalancerDeviceVO for the devices in the physical network.
+ */
+ public List<ExternalLoadBalancerDeviceVO> listNetscalerLoadBalancers(ListNetscalerLoadBalancersCmd cmd);
+
+ /**
+ * lists all the guest networks using a Netscaler load balancer device
+ * @param ListNetscalerLoadBalancerNetworksCmd
+ * @return list of the guest networks that are using this Netscaler load balancer
+ */
+ public List<? extends Network> listNetworks(ListNetscalerLoadBalancerNetworksCmd cmd);
+
+ /**
+ * creates API response object for netscaler load balancers
+ * @param lbDeviceVO external load balancer VO object
+ * @return NetscalerLoadBalancerResponse
+ */
+ public NetscalerLoadBalancerResponse createNetscalerLoadBalancerResponse(ExternalLoadBalancerDeviceVO lbDeviceVO);
+}