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.vpn;
  
  import com.cloud.event.EventTypes;
  import com.cloud.exception.ResourceAllocationException;
  import com.cloud.network.Site2SiteVpnGateway;
  import com.cloud.network.vpc.Vpc;
  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.IPAddressResponse;
  import org.apache.cloudstack.api.response.Site2SiteVpnGatewayResponse;
  import org.apache.cloudstack.api.response.VpcResponse;
  import org.apache.cloudstack.context.CallContext;
  
  @APICommand(name = "createVpnGateway", description = "Creates site to site vpn local gateway", responseObject = Site2SiteVpnGatewayResponse.class, entityType = {Site2SiteVpnGateway.class},
          requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
  public class CreateVpnGatewayCmd extends BaseAsyncCreateCmd {
  
  
      /////////////////////////////////////////////////////
      //////////////// API parameters /////////////////////
      /////////////////////////////////////////////////////
      @Parameter(name = ApiConstants.VPC_ID,
                 type = CommandType.UUID,
                 entityType = VpcResponse.class,
                 required = true,
                 description = "id of the vpc")
      private Long vpcId;
  
      @Parameter(name = ApiConstants.IP_ADDRESS_ID,
              type = CommandType.UUID,
              entityType = IPAddressResponse.class,
              description = "the public IP address ID for which VPN gateway is being enabled. By default the source NAT IP or router IP will be used.",
              since = "4.21.0")
      private Long ipAddressId;
  
      @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the vpn to the end user or not", since = "4.4", authorized = {RoleType.Admin})
      private Boolean display;
  
      /////////////////////////////////////////////////////
      /////////////////// Accessors ///////////////////////
      /////////////////////////////////////////////////////
  
      public Long getVpcId() {
          return vpcId;
      }
  
      public Long getIpAddressId() {
          return ipAddressId;
      }
  
      @Deprecated
      public Boolean getDisplay() {
          return display;
      }
  
      @Override
      public boolean isDisplay() {
          if (display != null) {
              return display;
          } else {
              return true;
          }
      }
  
      /////////////////////////////////////////////////////
      /////////////// API Implementation///////////////////
      /////////////////////////////////////////////////////
  
      @Override
      public long getEntityOwnerId() {
          Vpc vpc = _entityMgr.findById(Vpc.class, vpcId);
          return vpc.getAccountId();
      }
  
      @Override
      public String getEventDescription() {
          return "Create site-to-site VPN gateway for account " + getEntityOwnerId();
      }
  
      @Override
      public String getEventType() {
          return EventTypes.EVENT_S2S_VPN_GATEWAY_CREATE;
      }
  
      @Override
      public void execute() {
          CallContext.current().setEventDetails("VPN gateway Id: " + getEntityId());
          Site2SiteVpnGateway result = _s2sVpnService.getVpnGateway(getEntityId());
          if (result != null) {
              Site2SiteVpnGatewayResponse response = _responseGenerator.createSite2SiteVpnGatewayResponse(result);
              response.setResponseName(getCommandName());
              setResponseObject(response);
          } else {
              throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create VPN gateway");
          }
      }
  
      @Override
      public String getSyncObjType() {
          return BaseAsyncCmd.vpcSyncObject;
      }
  
      @Override
      public Long getSyncObjId() {
          return getVpcId();
      }
  
      @Override
      public void create() throws ResourceAllocationException {
          Site2SiteVpnGateway result = _s2sVpnService.createVpnGateway(this);
          if (result != null) {
              setEntityId(result.getId());
              setEntityUuid(result.getUuid());
          } else {
              throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create VPN gateway");
          }
      }
  }
  