| // 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.cluster; |
| |
| import java.util.ArrayList; |
| import java.util.List; |
| |
| import org.apache.log4j.Logger; |
| |
| import org.apache.cloudstack.api.APICommand; |
| import org.apache.cloudstack.api.ApiConstants; |
| import org.apache.cloudstack.api.BaseListCmd; |
| import org.apache.cloudstack.api.Parameter; |
| import org.apache.cloudstack.api.command.user.offering.ListServiceOfferingsCmd; |
| import org.apache.cloudstack.api.response.ClusterResponse; |
| import org.apache.cloudstack.api.response.ListResponse; |
| import org.apache.cloudstack.api.response.PodResponse; |
| import org.apache.cloudstack.api.response.ZoneResponse; |
| |
| import com.cloud.org.Cluster; |
| import com.cloud.utils.Pair; |
| |
| @APICommand(name = "listClusters", description = "Lists clusters.", responseObject = ClusterResponse.class, |
| requestHasSensitiveInfo = false, responseHasSensitiveInfo = false) |
| public class ListClustersCmd extends BaseListCmd { |
| public static final Logger s_logger = Logger.getLogger(ListServiceOfferingsCmd.class.getName()); |
| |
| private static final String s_name = "listclustersresponse"; |
| |
| ///////////////////////////////////////////////////// |
| //////////////// API parameters ///////////////////// |
| ///////////////////////////////////////////////////// |
| |
| @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "lists clusters by the cluster ID") |
| private Long id; |
| |
| @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "lists clusters by the cluster name") |
| private String clusterName; |
| |
| @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "lists clusters by Pod ID") |
| private Long podId; |
| |
| @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "lists clusters by Zone ID") |
| private Long zoneId; |
| |
| @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "lists clusters by hypervisor type") |
| private String hypervisorType; |
| |
| @Parameter(name = ApiConstants.CLUSTER_TYPE, type = CommandType.STRING, description = "lists clusters by cluster type") |
| private String clusterType; |
| |
| @Parameter(name = ApiConstants.ALLOCATION_STATE, type = CommandType.STRING, description = "lists clusters by allocation state") |
| private String allocationState; |
| |
| @Parameter(name = ApiConstants.MANAGED_STATE, type = CommandType.STRING, description = "whether this cluster is managed by cloudstack") |
| private String managedState; |
| |
| @Parameter(name = ApiConstants.SHOW_CAPACITIES, type = CommandType.BOOLEAN, description = "flag to display the capacity of the clusters") |
| private Boolean showCapacities; |
| |
| ///////////////////////////////////////////////////// |
| /////////////////// Accessors /////////////////////// |
| ///////////////////////////////////////////////////// |
| |
| public Long getId() { |
| return id; |
| } |
| |
| public String getClusterName() { |
| return clusterName; |
| } |
| |
| public Long getPodId() { |
| return podId; |
| } |
| |
| public Long getZoneId() { |
| return zoneId; |
| } |
| |
| public String getHypervisorType() { |
| return hypervisorType; |
| } |
| |
| public String getClusterType() { |
| return clusterType; |
| } |
| |
| public String getAllocationState() { |
| return allocationState; |
| } |
| |
| public String getManagedstate() { |
| return managedState; |
| } |
| |
| public void setManagedstate(String managedstate) { |
| this.managedState = managedstate; |
| } |
| |
| public Boolean getShowCapacities() { |
| return showCapacities; |
| } |
| |
| ///////////////////////////////////////////////////// |
| /////////////// API Implementation/////////////////// |
| ///////////////////////////////////////////////////// |
| |
| @Override |
| public String getCommandName() { |
| return s_name; |
| } |
| |
| protected List<ClusterResponse> getClusterResponses() { |
| Pair<List<? extends Cluster>, Integer> result = _mgr.searchForClusters(this); |
| List<ClusterResponse> clusterResponses = new ArrayList<ClusterResponse>(); |
| for (Cluster cluster : result.first()) { |
| ClusterResponse clusterResponse = _responseGenerator.createClusterResponse(cluster, showCapacities); |
| clusterResponse.setObjectName("cluster"); |
| clusterResponses.add(clusterResponse); |
| } |
| return clusterResponses; |
| } |
| |
| @Override |
| public void execute() { |
| List<ClusterResponse> clusterResponses = getClusterResponses(); |
| ListResponse<ClusterResponse> response = new ListResponse<ClusterResponse>(); |
| response.setResponses(clusterResponses, clusterResponses.size()); |
| response.setResponseName(getCommandName()); |
| this.setResponseObject(response); |
| } |
| } |