cloudstack/server/src/com/cloud/async/executor/VolumeOperationExecutor.java

/**
 *  Copyright (C) 2010 Cloud.com, Inc.  All rights reserved.
 * 
 * This software is licensed under the GNU General Public License v3 or later.
 * 
 * It is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 */

package com.cloud.async.executor;

import org.apache.log4j.Logger;

import com.cloud.agent.api.Answer;
import com.cloud.api.BaseCmd;
import com.cloud.async.AsyncInstanceCreateStatus;
import com.cloud.async.AsyncJobManager;
import com.cloud.async.AsyncJobResult;
import com.cloud.async.AsyncJobVO;
import com.cloud.async.BaseAsyncJobExecutor;
import com.cloud.async.executor.VolumeOperationParam.VolumeOp;
import com.cloud.event.EventTypes;
import com.cloud.event.EventVO;
import com.cloud.exception.InternalErrorException;
import com.cloud.serializer.GsonHelper;
import com.cloud.storage.VolumeVO;
import com.cloud.uservm.UserVm;
import com.google.gson.Gson;


public class VolumeOperationExecutor extends BaseAsyncJobExecutor {
    public static final Logger s_logger = Logger.getLogger(VolumeOperationExecutor.class.getName());

	public boolean execute() {
    	Gson gson = GsonHelper.getBuilder().create();
    	AsyncJobManager asyncMgr = getAsyncJobMgr();
    	AsyncJobVO job = getJob();
    	/*
    	if (getSyncSource() == null) {
    		VolumeOperationParam param = gson.fromJson(job.getCmdInfo(), VolumeOperationParam.class);
	    	asyncMgr.syncAsyncJobExecution(job.getId(), "Volume", param.getVolumeId());
	    	
	    	// always true if it does not have sync-source
	    	return true;
    	} else {    		
    		VolumeOperationParam param = gson.fromJson(job.getCmdInfo(), VolumeOperationParam.class);
            boolean success = false;
            String eventType = null;
            String failureDescription = "";
    		try {
    			VolumeVO volume = null;
                VolumeOp op = param.getOp();
    			if (op == VolumeOp.Create) {
    			    eventType = EventTypes.EVENT_VOLUME_CREATE;
    			    failureDescription = "Failed to create volume";
    				volume = asyncMgr.getExecutorContext().getManagementServer().createVolume(param.getUserId(), param.getAccountId(), param.getName(), param.getZoneId(), param.getDiskOfferingId(), param.getEventId(), param.getSize());
    				if (volume.getStatus() == AsyncInstanceCreateStatus.Corrupted) {
    					asyncMgr.completeAsyncJob(getJob().getId(), AsyncJobResult.STATUS_FAILED, BaseCmd.INTERNAL_ERROR, "Failed to create volume.");
    				} else {
    				    success = true;
    					asyncMgr.completeAsyncJob(getJob().getId(), AsyncJobResult.STATUS_SUCCEEDED, 0, composeResultObject(volume, param));
    				}
    			}
    			else if (op == VolumeOp.Attach) {
                    eventType = EventTypes.EVENT_VOLUME_ATTACH;
                    failureDescription = "Failed to attach volume";

    				asyncMgr.getExecutorContext().getManagementServer().attachVolumeToVM(param.getVmId(), param.getVolumeId(), param.getDeviceId(), param.getEventId());

    				// get the VM instance and Volume for the result object
    				UserVm vmInstance = asyncMgr.getExecutorContext().getManagementServer().findUserVMInstanceById(param.getVmId());
    				VolumeVO vol = asyncMgr.getExecutorContext().getManagementServer().findVolumeById(param.getVolumeId());
    				success = true;
    				asyncMgr.completeAsyncJob(getJob().getId(), AsyncJobResult.STATUS_SUCCEEDED, 0, composeAttachResultObject(vmInstance, vol));
    			} 
    			else if (op == VolumeOp.Detach) {
                    eventType = EventTypes.EVENT_VOLUME_DETACH;
                    failureDescription = "Failed to detach volume";

    				asyncMgr.getExecutorContext().getManagementServer().detachVolumeFromVM(param.getVolumeId(), param.getEventId(),param.getDeviceId(),param.getVmId());
    				success = true;
    				asyncMgr.completeAsyncJob(getJob().getId(), AsyncJobResult.STATUS_SUCCEEDED, 0, null);
    			} else {
    				throw new Exception("Invalid Volume Operation. Valid Operations are: CreateVolume, AttachVolume, and DetachVolume.");
    			}

    		} catch (InternalErrorException e) {
    			asyncMgr.completeAsyncJob(getJob().getId(), AsyncJobResult.STATUS_FAILED, BaseCmd.INTERNAL_ERROR, e.getMessage());
    		} catch (Exception e) {
    			s_logger.warn("Unhandled Exception executing volume operation " + param.getOp(), e);
    			asyncMgr.completeAsyncJob(getJob().getId(), AsyncJobResult.STATUS_FAILED, BaseCmd.INTERNAL_ERROR, e.getMessage());
    		} finally {
    		    if(!success){
    		        // Save completed event when operation fails
    		        asyncMgr.getExecutorContext().getManagementServer().saveEvent(param.getUserId(), param.getAccountId(), EventVO.LEVEL_ERROR, eventType, failureDescription, null, param.getEventId());
    		    }
    		}
    		return true;
    	}
*/
    	return true;
	}
    
	public void processAnswer(VolumeOperationListener listener, long agentId, long seq, Answer answer) {
	}
	
	public void processDisconnect(VolumeOperationListener listener, long agentId) {
	}

	public void processTimeout(VolumeOperationListener listener, long agentId, long seq) {
	}
	
	protected VolumeOperationResultObject composeResultObject(VolumeVO volume, VolumeOperationParam param) {
		VolumeOperationResultObject resultObject = new VolumeOperationResultObject();
		Long diskOfferingId = null;
			
		diskOfferingId = volume.getDiskOfferingId();
		
        resultObject.setId(volume.getId());
		resultObject.setName(param.getName());
		resultObject.setVolumeType(volume.getVolumeType());
		resultObject.setVolumeSize(volume.getSize());
		resultObject.setCreatedDate(volume.getCreated());
		resultObject.setState(volume.getStatus());
		resultObject.setAccountName(getAsyncJobMgr().getExecutorContext().getManagementServer().findAccountById(param.getAccountId()).getAccountName());
		resultObject.setDomainId(volume.getDomainId());
		resultObject.setDiskOfferingId(volume.getDiskOfferingId());
		
		if (diskOfferingId != null) {
			resultObject.setDiskOfferingName(getAsyncJobMgr().getExecutorContext().getManagementServer().findDiskOfferingById(diskOfferingId).getName());
			resultObject.setDiskOfferingDisplayText(getAsyncJobMgr().getExecutorContext().getManagementServer().findDiskOfferingById(diskOfferingId).getDisplayText());
		}
//		resultObject.setDomain(getAsyncJobMgr().getExecutorContext().getManagementServer().findDomainIdById(volume.getDomainId()).getName());
		resultObject.setStorageType("shared"); // NOTE: You can never create a local disk volume but if that changes, we need to change this
		if (volume.getPoolId() != null)
			resultObject.setStorage(getAsyncJobMgr().getExecutorContext().getManagementServer().findPoolById(volume.getPoolId()).getName());
		resultObject.setZoneId(volume.getDataCenterId());
//		resultObject.setZoneName(getAsyncJobMgr().getExecutorContext().getManagementServer().getDataCenterBy(volume.getDataCenterId()).getName());
		return resultObject;
	}

	private AttachVolumeOperationResultObject composeAttachResultObject(UserVm instance, VolumeVO vol) {
        AttachVolumeOperationResultObject resultObject = new AttachVolumeOperationResultObject();

        resultObject.setVmName(instance.getHostName());
        resultObject.setVmDisplayName(instance.getDisplayName());
        resultObject.setVirtualMachineId(instance.getId());
        resultObject.setVmState(instance.getState().toString());
        resultObject.setStorageType("shared"); // NOTE: You can never attach a local disk volume but if that changes, we need to change this
        resultObject.setVolumeId(vol.getId());
        resultObject.setVolumeName(vol.getName());

        return resultObject;
    }
}