content: // 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 java.util.Map;
  
  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.BaseAsyncCreateCmd;
  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.LBStickinessResponse;
  import org.apache.cloudstack.context.CallContext;
  
  import com.cloud.event.EventTypes;
  import com.cloud.exception.InvalidParameterValueException;
  import com.cloud.exception.NetworkRuleConflictException;
  import com.cloud.exception.ResourceAllocationException;
  import com.cloud.exception.ResourceUnavailableException;
  import com.cloud.network.rules.LoadBalancer;
  import com.cloud.network.rules.StickinessPolicy;
  import com.cloud.user.Account;
  
  @APICommand(name = "createLBStickinessPolicy", description = "Creates a load balancer stickiness policy ", responseObject = LBStickinessResponse.class, since = "3.0.0",
          requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
  @SuppressWarnings("rawtypes")
  public class CreateLBStickinessPolicyCmd extends BaseAsyncCreateCmd {
  
      private static final String s_name = "createLBStickinessPolicy";
  
      // ///////////////////////////////////////////////////
      // ////////////// API parameters /////////////////////
      // ///////////////////////////////////////////////////
  
      @Parameter(name = ApiConstants.LBID,
                 type = CommandType.UUID,
                 entityType = FirewallRuleResponse.class,
                 required = true,
                 description = "the ID of the load balancer rule")
      private Long lbRuleId;
  
      @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "the description of the load balancer stickiness policy")
      private String description;
  
      @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "name of the load balancer stickiness policy")
      private String lbStickinessPolicyName;
  
      @Parameter(name = ApiConstants.METHOD_NAME,
                 type = CommandType.STRING,
                 required = true,
                 description = "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased")
      private String stickinessMethodName;
  
      @Parameter(name = ApiConstants.PARAM_LIST, type = CommandType.MAP, description = "param list. Example: param[0].name=cookiename&param[0].value=LBCookie ")
      private Map paramList;
  
      @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;
  
  
      // ///////////////////////////////////////////////////
      // ///////////////// Accessors ///////////////////////
      // ///////////////////////////////////////////////////
  
      @Deprecated
      public Boolean getDisplay() {
          return display;
      }
  
      @Override
      public boolean isDisplay() {
          if(display == null)
              return true;
          else
              return display;
      }
  
      public Long getLbRuleId() {
          return lbRuleId;
      }
  
      public String getDescription() {
          return description;
      }
  
      public String getLBStickinessPolicyName() {
          return lbStickinessPolicyName;
      }
  
      public String getStickinessMethodName() {
          return stickinessMethodName;
      }
  
      public Map getparamList() {
          return paramList;
      }
  
      // ///////////////////////////////////////////////////
      // ///////////// API Implementation///////////////////
      // ///////////////////////////////////////////////////
  
      @Override
      public String getCommandName() {
          return s_name;
      }
  
      @Override
      public long getEntityOwnerId() {
          Account account = CallContext.current().getCallingAccount();
          if (account != null) {
              return account.getId();
          }
  
          return Account.ACCOUNT_ID_SYSTEM; // no account info given, parent this command to SYSTEM so ERROR events are tracked
      }
  
      @Override
      public void execute() throws ResourceAllocationException, ResourceUnavailableException {
          StickinessPolicy policy = null;
          boolean success = false;
  
          try {
              CallContext.current().setEventDetails("Rule Id: " + getEntityId());
              success = _lbService.applyLBStickinessPolicy(this);
              if (success) {
                  // State might be different after the rule is applied, so get new object here
                  policy = _entityMgr.findById(StickinessPolicy.class, getEntityId());
                  LoadBalancer lb = _lbService.findById(policy.getLoadBalancerId());
                  LBStickinessResponse spResponse = _responseGenerator.createLBStickinessPolicyResponse(policy, lb);
                  setResponseObject(spResponse);
                  spResponse.setResponseName(getCommandName());
              }
          } finally {
              if (!success || (policy == null)) {
                  throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create stickiness policy");
              }
          }
      }
  
      @Override
      public void create() {
          try {
              StickinessPolicy result = _lbService.createLBStickinessPolicy(this);
              this.setEntityId(result.getId());
              this.setEntityUuid(result.getUuid());
          } catch (NetworkRuleConflictException e) {
              logger.warn("Exception: ", e);
              throw new ServerApiException(ApiErrorCode.NETWORK_RULE_CONFLICT_ERROR, e.getMessage());
          }
      }
  
      @Override
      public String getEventType() {
          return EventTypes.EVENT_LB_STICKINESSPOLICY_CREATE;
      }
  
      @Override
      public String getEventDescription() {
          return "creating a load balancer stickiness policy: " + getLBStickinessPolicyName();
      }
  
      @Override
      public String getSyncObjType() {
          return BaseAsyncCmd.networkSyncObject;
      }
  
      @Override
      public Long getSyncObjId() {
          LoadBalancer lb = _lbService.findById(getLbRuleId());
          if (lb == null) {
              throw new InvalidParameterValueException("Unable to find load balancer rule " + getLbRuleId() + " to create stickiness rule");
          }
          return lb.getNetworkId();
      }
  }
  