| // Licensed to the Apache Software Foundation (ASF) under one |
| // or more contributor license agreements. See the NOTICE file |
| // distributed with this work for additional information |
| // regarding copyright ownership. The ASF licenses this file |
| // to you under the Apache License, Version 2.0 (the |
| // "License"); you may not use this file except in compliance |
| // with 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. |
| package org.apache.cloudstack.api.command.user.loadbalancer; |
| |
| import org.apache.cloudstack.acl.RoleType; |
| import org.apache.cloudstack.api.APICommand; |
| import org.apache.cloudstack.api.ApiConstants; |
| import org.apache.cloudstack.api.ApiErrorCode; |
| import org.apache.cloudstack.api.BaseAsyncCmd; |
| import org.apache.cloudstack.api.BaseAsyncCustomIdCmd; |
| import org.apache.cloudstack.api.Parameter; |
| import org.apache.cloudstack.api.ServerApiException; |
| import org.apache.cloudstack.api.response.FirewallRuleResponse; |
| import org.apache.cloudstack.api.response.LoadBalancerResponse; |
| import org.apache.cloudstack.context.CallContext; |
| |
| import com.cloud.event.EventTypes; |
| import com.cloud.exception.InvalidParameterValueException; |
| import com.cloud.network.rules.FirewallRule; |
| import com.cloud.network.rules.LoadBalancer; |
| import com.cloud.user.Account; |
| |
| @APICommand(name = "updateLoadBalancerRule", description = "Updates load balancer", responseObject = LoadBalancerResponse.class, |
| requestHasSensitiveInfo = false, responseHasSensitiveInfo = false) |
| public class UpdateLoadBalancerRuleCmd extends BaseAsyncCustomIdCmd { |
| |
| ///////////////////////////////////////////////////// |
| //////////////// API parameters ///////////////////// |
| ///////////////////////////////////////////////////// |
| |
| @Parameter(name = ApiConstants.ALGORITHM, type = CommandType.STRING, description = "load balancer algorithm (source, roundrobin, leastconn)") |
| private String algorithm; |
| |
| @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "the description of the load balancer rule", length = 4096) |
| private String description; |
| |
| @Parameter(name = ApiConstants.ID, |
| type = CommandType.UUID, |
| entityType = FirewallRuleResponse.class, |
| required = true, |
| description = "the ID of the load balancer rule to update") |
| private Long id; |
| |
| @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the load balancer rule") |
| private String loadBalancerName; |
| |
| @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin}) |
| private Boolean display; |
| |
| @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "The protocol for the LB") |
| private String lbProtocol; |
| |
| ///////////////////////////////////////////////////// |
| /////////////////// Accessors /////////////////////// |
| ///////////////////////////////////////////////////// |
| |
| public String getAlgorithm() { |
| return algorithm; |
| } |
| |
| public String getDescription() { |
| return description; |
| } |
| |
| public Long getId() { |
| return id; |
| } |
| |
| public String getLoadBalancerName() { |
| return loadBalancerName; |
| } |
| |
| public Boolean getDisplay() { |
| return display; |
| } |
| |
| public String getLbProtocol() { |
| return lbProtocol; |
| } |
| |
| ///////////////////////////////////////////////////// |
| /////////////// API Implementation/////////////////// |
| ///////////////////////////////////////////////////// |
| |
| @Override |
| public long getEntityOwnerId() { |
| LoadBalancer lb = _entityMgr.findById(LoadBalancer.class, getId()); |
| if (lb == null) { |
| return Account.ACCOUNT_ID_SYSTEM; // bad id given, parent this command to SYSTEM so ERROR events are tracked |
| } |
| return lb.getAccountId(); |
| } |
| |
| @Override |
| public String getEventType() { |
| return EventTypes.EVENT_LOAD_BALANCER_UPDATE; |
| } |
| |
| @Override |
| public String getEventDescription() { |
| return "updating load balancer rule"; |
| } |
| |
| @Override |
| public void execute() { |
| CallContext.current().setEventDetails("Load balancer ID: " + getId()); |
| LoadBalancer result = _lbService.updateLoadBalancerRule(this); |
| if (result != null) { |
| LoadBalancerResponse response = _responseGenerator.createLoadBalancerResponse(result); |
| response.setResponseName(getCommandName()); |
| this.setResponseObject(response); |
| } else { |
| throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update load balancer rule"); |
| } |
| } |
| |
| @Override |
| public String getSyncObjType() { |
| return BaseAsyncCmd.networkSyncObject; |
| } |
| |
| @Override |
| public Long getSyncObjId() { |
| LoadBalancer lb = _lbService.findById(getId()); |
| if (lb == null) { |
| throw new InvalidParameterValueException("Unable to find load balancer rule by ID " + getId()); |
| } |
| return lb.getNetworkId(); |
| } |
| |
| @Override |
| public void checkUuid() { |
| if (this.getCustomId() != null) { |
| _uuidMgr.checkUuid(this.getCustomId(), FirewallRule.class); |
| } |
| } |
| } |