ReserveExternalResourceCommand.java

/*
 *  The MIT License
 *
 *  Copyright 2012 Sony Mobile Communications AB. All rights reserved.
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in
 *  all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 *  THE SOFTWARE.
 */
package com.sonyericsson.jenkins.plugins.externalresource.dispatcher.cli;

import com.sonyericsson.jenkins.plugins.externalresource.dispatcher.data.ExternalResource;
import com.sonyericsson.jenkins.plugins.externalresource.dispatcher.data.StashInfo;
import hudson.Extension;
import hudson.cli.CLICommand;
import org.kohsuke.args4j.Option;

import java.util.logging.Logger;

/**
 * Locks a specific external resource on a node.
 *
 * @author Tomas Westling <tomas.westling@sonymobile.com>
 */
@Extension
public class ReserveExternalResourceCommand extends CLICommand {
    private static final Logger logger = Logger.getLogger(LockExternalResourceCommand.class.getName());

    //CS IGNORE VisibilityModifier FOR NEXT 35 LINES. REASON: Standard Jenkins Args4J design pattern.
    /**
     * The name of the node.
     */
    @Option(required = true, name = "-node", usage = "The name of the node")
    public String nodeName;

    /**
     * The id of the resource.
     */
    @Option(required = true, name = "-id", usage = "The id of the external resource")
    public String id;

    /**
     * Information text regarding what reserved the resource.
     */
    @Option(required = true, name = "-reservedBy",
            usage = "Information text to Jenkins detailing who reserved the resource")
    public String reservedBy;

    /**
     * What reserved the resource.
     */
    @Option(required = true, name = "-clientInfo",
            usage = "Information regarding the client that reserved the resource")
    public String clientInfo;


    @Override
    public String getShortDescription() {
        return "Reserves an external resource.";
    }

    @Override
    protected int run() throws Exception {
        if (ErCliUtils.isRequestCircular(clientInfo)) {
            return 0;
        }
        ExternalResource er = ErCliUtils.findExternalResource(nodeName, id);
        StashInfo reservedInfo = new StashInfo(StashInfo.StashType.EXTERNAL, reservedBy, null, null);

        er.doReserve(reservedInfo);

        return 0;
    }
}