| // 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.admin.offering; |
| |
| import org.apache.log4j.Logger; |
| |
| import org.apache.cloudstack.api.APICommand; |
| import org.apache.cloudstack.api.ApiConstants; |
| import org.apache.cloudstack.api.ApiErrorCode; |
| import org.apache.cloudstack.api.BaseCmd; |
| import org.apache.cloudstack.api.Parameter; |
| import org.apache.cloudstack.api.ServerApiException; |
| import org.apache.cloudstack.api.response.DiskOfferingResponse; |
| import org.apache.cloudstack.api.response.DomainResponse; |
| |
| import com.cloud.storage.Storage.ProvisioningType; |
| import com.cloud.offering.DiskOffering; |
| import com.cloud.offering.ServiceOffering; |
| import com.cloud.user.Account; |
| |
| @APICommand(name = "createDiskOffering", description = "Creates a disk offering.", responseObject = DiskOfferingResponse.class, |
| requestHasSensitiveInfo = false, responseHasSensitiveInfo = false) |
| public class CreateDiskOfferingCmd extends BaseCmd { |
| public static final Logger s_logger = Logger.getLogger(CreateDiskOfferingCmd.class.getName()); |
| |
| private static final String s_name = "creatediskofferingresponse"; |
| |
| ///////////////////////////////////////////////////// |
| //////////////// API parameters ///////////////////// |
| ///////////////////////////////////////////////////// |
| |
| @Parameter(name = ApiConstants.DISK_SIZE, type = CommandType.LONG, required = false, description = "size of the disk offering in GB (1GB = 1,073,741,824 bytes)") |
| private Long diskSize; |
| |
| @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, required = true, description = "alternate display text of the disk offering", length = 4096) |
| private String displayText; |
| |
| @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "name of the disk offering") |
| private String offeringName; |
| |
| @Parameter(name = ApiConstants.TAGS, type = CommandType.STRING, description = "tags for the disk offering", length = 4096) |
| private String tags; |
| |
| @Parameter(name = ApiConstants.CUSTOMIZED, type = CommandType.BOOLEAN, description = "whether disk offering size is custom or not") |
| private Boolean customized; |
| |
| @Parameter(name = ApiConstants.DOMAIN_ID, |
| type = CommandType.UUID, |
| entityType = DomainResponse.class, |
| description = "the ID of the containing domain, null for public offerings") |
| private Long domainId; |
| |
| @Parameter(name = ApiConstants.STORAGE_TYPE, type = CommandType.STRING, description = "the storage type of the disk offering. Values are local and shared.") |
| private String storageType = ServiceOffering.StorageType.shared.toString(); |
| |
| @Parameter(name = ApiConstants.PROVISIONINGTYPE, |
| type = CommandType.STRING, |
| description = "provisioning type used to create volumes. Valid values are thin, sparse, fat.") |
| private String provisioningType = ProvisioningType.THIN.toString(); |
| |
| @Parameter(name = ApiConstants.DISPLAY_OFFERING, |
| type = CommandType.BOOLEAN, |
| description = "an optional field, whether to display the offering to the end user or not.") |
| private Boolean displayOffering; |
| |
| @Parameter(name = ApiConstants.BYTES_READ_RATE, type = CommandType.LONG, required = false, description = "bytes read rate of the disk offering") |
| private Long bytesReadRate; |
| |
| @Parameter(name = ApiConstants.BYTES_WRITE_RATE, type = CommandType.LONG, required = false, description = "bytes write rate of the disk offering") |
| private Long bytesWriteRate; |
| |
| @Parameter(name = ApiConstants.IOPS_READ_RATE, type = CommandType.LONG, required = false, description = "io requests read rate of the disk offering") |
| private Long iopsReadRate; |
| |
| @Parameter(name = ApiConstants.IOPS_WRITE_RATE, type = CommandType.LONG, required = false, description = "io requests write rate of the disk offering") |
| private Long iopsWriteRate; |
| |
| @Parameter(name = ApiConstants.CUSTOMIZED_IOPS, type = CommandType.BOOLEAN, required = false, description = "whether disk offering iops is custom or not") |
| private Boolean customizedIops; |
| |
| @Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, required = false, description = "min iops of the disk offering") |
| private Long minIops; |
| |
| @Parameter(name = ApiConstants.MAX_IOPS, type = CommandType.LONG, required = false, description = "max iops of the disk offering") |
| private Long maxIops; |
| |
| @Parameter(name = ApiConstants.HYPERVISOR_SNAPSHOT_RESERVE, |
| type = CommandType.INTEGER, |
| required = false, |
| description = "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)") |
| private Integer hypervisorSnapshotReserve; |
| |
| ///////////////////////////////////////////////////// |
| /////////////////// Accessors /////////////////////// |
| ///////////////////////////////////////////////////// |
| |
| public Long getDiskSize() { |
| return diskSize; |
| } |
| |
| public String getDisplayText() { |
| return displayText; |
| } |
| |
| public String getOfferingName() { |
| return offeringName; |
| } |
| |
| public String getTags() { |
| return tags; |
| } |
| |
| public Boolean isCustomized() { |
| return customized; |
| } |
| |
| public Boolean isCustomizedIops() { |
| return customizedIops; |
| } |
| |
| public Long getMinIops() { |
| return minIops; |
| } |
| |
| public Long getMaxIops() { |
| return maxIops; |
| } |
| |
| public Long getDomainId() { |
| return domainId; |
| } |
| |
| public Long getBytesReadRate() { |
| return bytesReadRate; |
| } |
| |
| public Long getBytesWriteRate() { |
| return bytesWriteRate; |
| } |
| |
| public Long getIopsReadRate() { |
| return iopsReadRate; |
| } |
| |
| public Long getIopsWriteRate() { |
| return iopsWriteRate; |
| } |
| |
| public String getStorageType() { |
| return storageType; |
| } |
| |
| public String getProvisioningType(){ |
| return provisioningType; |
| } |
| |
| public Boolean getDisplayOffering() { |
| return displayOffering; |
| } |
| |
| public Integer getHypervisorSnapshotReserve() { |
| return hypervisorSnapshotReserve; |
| } |
| |
| ///////////////////////////////////////////////////// |
| /////////////// API Implementation/////////////////// |
| ///////////////////////////////////////////////////// |
| |
| @Override |
| public String getCommandName() { |
| return s_name; |
| } |
| |
| @Override |
| public long getEntityOwnerId() { |
| return Account.ACCOUNT_ID_SYSTEM; |
| } |
| |
| @Override |
| public void execute() { |
| DiskOffering offering = _configService.createDiskOffering(this); |
| if (offering != null) { |
| DiskOfferingResponse response = _responseGenerator.createDiskOfferingResponse(offering); |
| response.setResponseName(getCommandName()); |
| this.setResponseObject(response); |
| } else { |
| throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create disk offering"); |
| } |
| } |
| } |