org.hyperic.hq.hqapi1.tools.AbstractCommand.java Source code

Introduction

Here is the source code for org.hyperic.hq.hqapi1.tools.AbstractCommand.java

Source

/*
 * 
 * NOTE: This copyright does *not* cover user programs that use HQ
 * program services by normal system calls through the application
 * program interfaces provided as part of the Hyperic Plug-in Development
 * Kit or the Hyperic Client Development Kit - this is merely considered
 * normal use of the program, and does *not* fall under the heading of
 * "derived work".
 * 
 * Copyright (C) [2008, 2009], Hyperic, Inc.
 * This file is part of HQ.
 * 
 * HQ is free software; you can redistribute it and/or modify
 * it under the terms version 2 of the GNU General Public License as
 * published by the Free Software Foundation. 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA.
 * 
 */

package org.hyperic.hq.hqapi1.tools;

import joptsimple.OptionParser;
import joptsimple.OptionSet;
import org.apache.log4j.PropertyConfigurator;
import org.hyperic.hq.hqapi1.HQApi;
import org.hyperic.hq.hqapi1.types.Response;
import org.hyperic.hq.hqapi1.types.ResponseStatus;
import org.springframework.beans.factory.annotation.Autowired;

import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.io.IOException;
import java.util.Properties;

public abstract class AbstractCommand implements Command {

    static final String OPT_FILE = "file";

    @Autowired
    protected OptionParser optionParser;

    @Autowired
    protected HQApi hqApi;

    // Ripped out from PluginMain.java
    private static final String[][] LOG_PROPS = { { "log4j.appender.R", "org.apache.log4j.ConsoleAppender" },
            { "log4j.appender.R.layout.ConversionPattern", "%-5p [%t] [%c{1}] %m%n" },
            { "log4j.appender.R.layout", "org.apache.log4j.PatternLayout" } };

    private static void configureLogging(String level) {
        Properties props = new Properties();
        props.setProperty("log4j.rootLogger", level.toUpperCase() + ", R");
        props.setProperty("log4j.logger.httpclient.wire", level.toUpperCase());
        props.setProperty("log4j.logger.org.apache.commons.httpclient", level.toUpperCase());

        for (String[] PROPS : LOG_PROPS) {
            props.setProperty(PROPS[0], PROPS[1]);
        }

        props.putAll(System.getProperties());
        PropertyConfigurator.configure(props);
    }

    static {
        // Quiet all logging
        configureLogging("fatal");
    }

    OptionParser getOptionParser() {
        return this.optionParser;
    }

    protected OptionSet getOptions(OptionParser p, String[] args) throws IOException {
        OptionSet o = p.parse(args);

        if (o.has(OptionParserFactory.OPT_HELP[0]) || o.has(OptionParserFactory.OPT_HELP[1])) {
            p.printHelpOn(System.err);
            System.exit(0);
        }

        return o;
    }

    /**
     * TODO: This is not symmetrical
     * @param s The OptionSet parsed from the command line arguments.
     * @return A FileInputStream to the given file argument
     * @throws IOException If the file does not exist.
     */
    protected InputStream getInputStream(OptionSet s) throws IOException {
        String file = (String) s.valueOf(OPT_FILE);
        if (file == null) {
            return System.in;
        } else {
            File f = new File(file);
            return new FileInputStream(f);
        }
    }

    protected HQApi getApi(OptionSet s) {
        return hqApi;
    }

    protected Object getRequired(OptionSet s, String opt) {

        Object o = s.valueOf(opt);

        if (o == null) {
            System.err.println("Required argument " + opt + " not given.");
            System.exit(-1);
        }

        return o;
    }

    protected void checkSuccess(Response r) {
        if (r.getStatus() != ResponseStatus.SUCCESS) {
            System.err.println("Error running command: " + r.getError().getReasonText());
            System.exit(-1);
        }
    }

    /**
     * Trim the first argument from an array returning the resulting elements.
     * 
     * @param args The argument array to trim.
     * @return The trimmed array as defined as Array[1..len]
     */
    protected static String[] trim(String[] args) {
        String[] cmdArgs = new String[args.length - 1];
        System.arraycopy(args, 1, cmdArgs, 0, args.length - 1);
        return cmdArgs;
    }

}