/**
 * Abiquo community edition
 * cloud management application for hybrid clouds
 * Copyright (C) 2008-2010 - Abiquo Holdings S.L.
 *
 * This application is free software; you can redistribute it and/or
 * modify it under the terms of the GNU LESSER GENERAL PUBLIC
 * LICENSE as published by the Free Software Foundation under
 * version 3 of the License
 *
 * This software 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
 * LESSER GENERAL PUBLIC LICENSE v.3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
package com.abiquo.api.resources.cloud;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;

import org.apache.wink.common.annotations.Parent;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;

import com.abiquo.api.exceptions.mapper.APIExceptionMapper;
import com.abiquo.api.resources.AbstractResource;
import com.abiquo.api.services.StorageService;
import com.abiquo.api.util.IRESTBuilder;
import com.abiquo.model.util.ModelTransformer;
import com.abiquo.server.core.cloud.VirtualDatacenter;
import com.abiquo.server.core.infrastructure.storage.DiskManagement;
import com.abiquo.server.core.infrastructure.storage.DiskManagementDto;
import com.abiquo.server.core.infrastructure.storage.DisksManagementDto;

/**
 * <pre>
 * Resource that contains all the methods related to single of {@link DiskManagementDto}. Exposes all
 * the methods inside the URI
 * http://{host}/api/cloud/virtualdatacenters/{vdcid}/disks/{diskId}
 * </pre>
 * 
 * Extra disks are resources created here and used by virtual machines
 * 
 * @author jdevesa
 */
@Parent(DisksResource.class)
@Path(DiskResource.DISK_PARAM)
@Controller
public class DiskResource extends AbstractResource
{

    public final static String DISK = "disk";

    public final static String DISK_PARAM = "{" + DISK + "}";

    /** Autowired business logic service. */
    @Autowired
    protected StorageService service;

    /**
     * Exposes the method to query the extra disks generated into a virtual datacenter.
     * 
     * @title Retrieve a hard disk
     * @param vdcId identifier of the virtual datacenter.
     * @param diskId identifier of the disk.
     * @param restBuilder a Context-injected object to create the links of the Dto
     * @return a instance of {@link DisksManagementDto}. Is the wrapper list for
     *         {@link DiskManagementDto} object.
     * @throws Exception any thrown exception. Moved to HTTP status code in the
     *             {@link APIExceptionMapper} exception mapper.
     */
    @GET
    @Produces(DiskManagementDto.MEDIA_TYPE)
    public DiskManagementDto getHardDisk(
        @PathParam(VirtualDatacenterResource.VIRTUAL_DATACENTER) @NotNull @Min(1) final Integer vdcId,
        @PathParam(DiskResource.DISK) @NotNull @Min(1) final Integer diskId,
        @Context final IRESTBuilder restBuilder) throws Exception
    {
        DiskManagement disk = service.getHardDiskByVirtualDatacenter(vdcId, diskId);

        return createDiskTransferObject(disk, restBuilder);
    }

    /**
     * Expose the method to delete an existing Hard Disk.
     * 
     * @title Delete a hard disk
     * @wiki Deletes a Hard Disk. This method will raise an exception if the hard disk is used by a
     *       Virtual Machine.
     * @param vdcId identifier of the {@link VirtualDatacenter}
     * @param diskId identifier fo the {@link DiskManagement} to delete.
     * @param restBuilder a Context-injected object to create the links of the Dto
     * @return the created Disk.
     * @throws Exception any thrown exception. Moved to HTTP status code in the
     *             {@link APIExceptionMapper} exception mapper.
     */
    @DELETE
    public void deleteHardDisk(
        @PathParam(VirtualDatacenterResource.VIRTUAL_DATACENTER) @NotNull @Min(1) final Integer vdcId,
        @PathParam(DiskResource.DISK) @NotNull @Min(1) final Integer diskId,
        @Context final IRESTBuilder restBuilder) throws Exception
    {
        service.deleteHardDisk(vdcId, diskId);
    }

    /**
     * Creates the DTO {@link DiskManagementDto} from the pojo object {@link DiskManagement} and
     * sets its related links.
     * 
     * @param disk input {@link DiskManagement} object.
     * @param restBuilder a Context-injected object to create the links of the Dto
     * @return the output {@link DiskManagementDto} object.
     * @throws Exception any thrown exception. Moved to HTTP status code in the
     *             {@link APIExceptionMapper} exception mapper.
     */
    public static DiskManagementDto createDiskTransferObject(final DiskManagement disk,
        final IRESTBuilder restBuilder) throws Exception
    {
        DiskManagementDto dto =
            ModelTransformer.transportFromPersistence(DiskManagementDto.class, disk);
        dto.addLinks(restBuilder.buildVirtualDatacenterDiskLinks(disk));

        return dto;
    }
}