| /* |
| * 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.vm; |
| |
| import org.apache.cloudstack.api.APICommand; |
| import org.apache.cloudstack.api.ApiConstants; |
| import org.apache.cloudstack.api.BaseCmd; |
| import org.apache.cloudstack.api.Parameter; |
| import org.apache.cloudstack.api.response.UserVmResponse; |
| import org.apache.cloudstack.api.response.VMUserDataResponse; |
| import org.apache.log4j.Logger; |
| |
| import com.cloud.user.Account; |
| import com.cloud.uservm.UserVm; |
| |
| @APICommand(name = "getVirtualMachineUserData", description = "Returns user data associated with the VM", responseObject = VMUserDataResponse.class, since = "4.4", |
| requestHasSensitiveInfo = false, responseHasSensitiveInfo = false) |
| public class GetVMUserDataCmd extends BaseCmd { |
| public static final Logger s_logger = Logger.getLogger(GetVMUserDataCmd.class); |
| private static final String s_name = "getvirtualmachineuserdataresponse"; |
| |
| ///////////////////////////////////////////////////// |
| //////////////// API parameters ///////////////////// |
| ///////////////////////////////////////////////////// |
| |
| @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the virtual machine") |
| private Long vmId; |
| |
| ///////////////////////////////////////////////////// |
| /////////////////// Accessors /////////////////////// |
| ///////////////////////////////////////////////////// |
| |
| public long getId() { |
| return vmId; |
| } |
| |
| ///////////////////////////////////////////////////// |
| /////////////// API Implementation/////////////////// |
| ///////////////////////////////////////////////////// |
| |
| @Override |
| public void execute() { |
| String userData = _userVmService.getVmUserData(getId()); |
| VMUserDataResponse resp = new VMUserDataResponse(); |
| resp.setVmId(_entityMgr.findById(UserVm.class, getId()).getUuid()); |
| resp.setUserData(userData); |
| resp.setObjectName("virtualmachineuserdata"); |
| resp.setResponseName(getCommandName()); |
| this.setResponseObject(resp); |
| } |
| |
| @Override |
| public long getEntityOwnerId() { |
| UserVm userVm = _entityMgr.findById(UserVm.class, getId()); |
| if (userVm != null) { |
| return userVm.getAccountId(); |
| } |
| |
| return Account.ACCOUNT_ID_SYSTEM; // no account info given, parent this command to SYSTEM so ERROR events are tracked |
| } |
| |
| @Override |
| public String getCommandName() { |
| return s_name; |
| } |
| } |