Example usage for org.apache.commons.cli HelpFormatter DEFAULT_DESC_PAD

List of usage examples for org.apache.commons.cli HelpFormatter DEFAULT_DESC_PAD

Introduction

In this page you can find the example usage for org.apache.commons.cli HelpFormatter DEFAULT_DESC_PAD.

Prototype

int DEFAULT_DESC_PAD

To view the source code for org.apache.commons.cli HelpFormatter DEFAULT_DESC_PAD.

Click Source Link

Document

the number of characters of padding to be prefixed to each description line

Usage

From source file:org.mskcc.cbio.importer.Admin.java

/**
 * Helper function - prints usage/*from  w  w  w .  j  a v a  2 s  . c o m*/
 */
public static void usage(PrintWriter writer) {

    HelpFormatter formatter = new HelpFormatter();
    formatter.printHelp(writer, HelpFormatter.DEFAULT_WIDTH, "Admin", "", options,
            HelpFormatter.DEFAULT_LEFT_PAD, HelpFormatter.DEFAULT_DESC_PAD, "");
}

From source file:org.openanzo.client.cli.DefaultConsole.java

public void printHelp(String syntax, String header, Options options, String footer) {
    StringWriter sw = new StringWriter();
    PrintWriter pw = new PrintWriter(sw);
    formatter.printHelp(pw, cr != null ? cr.getTerminal().getWidth() : HelpFormatter.DEFAULT_WIDTH, syntax,
            header, options, HelpFormatter.DEFAULT_LEFT_PAD, HelpFormatter.DEFAULT_DESC_PAD, footer);
    writeOutput(sw.toString());/*from w  w  w.  ja v  a  2  s. c  o  m*/
}

From source file:org.pepstock.jem.commands.util.ArgumentsParser.java

/**
 * Parses all arguments passed by command line.<br>
 * Creates all possible arguments with explanation to show in case of error.
 * /*from w w w . j a  v a2  s .c om*/
 * @param args arguments of main method
 * @return properties with all arguments
 * @throws ParseException if same args are missing or wrong
 */
public Properties parseArg(String[] args) throws ParseException {

    // creates all possible commands options

    // -help options
    Option help = new Option("help", "print this message");

    // loads all created options
    Options allOptions = new Options();
    allOptions.addOption(help);

    for (Option opt : options) {
        allOptions.addOption(opt);
    }
    // creates command line parser
    CommandLineParser parser = new PosixParser();
    CommandLine line;
    try {
        Properties properties = new Properties();
        // parses line
        line = parser.parse(allOptions, args);
        // checks if asked for help. If yes, prints help
        if ((line.getOptions().length == 1) && line.hasOption("help")) {
            StringWriter writer = new StringWriter();
            HelpFormatter formatter = new HelpFormatter();
            formatter.printHelp(new PrintWriter(writer), HelpFormatter.DEFAULT_WIDTH, getCommandLine(), "",
                    allOptions, HelpFormatter.DEFAULT_LEFT_PAD, HelpFormatter.DEFAULT_DESC_PAD, "");
            LogAppl.getInstance().emit(NodeMessage.JEMC056I, writer.getBuffer());
        } else {
            Option[] optionsLine = line.getOptions();
            for (int i = 0; i < optionsLine.length; i++) {
                String key = optionsLine[i].getArgName();
                String value;
                // to avoid null pointer exception in case of option line
                // with no arg
                if (optionsLine[i].hasArg()) {
                    value = optionsLine[i].getValue();
                } else {
                    value = "";
                }

                properties.setProperty(key, value);
            }
        }
        return properties;
    } catch (ParseException e) {
        // if exception, returns -help command
        // because if is here has found an error on arguments
        StringWriter writer = new StringWriter();
        HelpFormatter formatter = new HelpFormatter();
        formatter.printHelp(new PrintWriter(writer), HelpFormatter.DEFAULT_WIDTH, getCommandLine(), "",
                allOptions, HelpFormatter.DEFAULT_LEFT_PAD, HelpFormatter.DEFAULT_DESC_PAD, "");
        LogAppl.getInstance().emit(NodeMessage.JEMC056I, writer.getBuffer());
        throw e;
    }

}

From source file:org.signserver.client.cli.defaultimpl.SignDataGroupsCommand.java

@Override
public String getUsages() {
    StringBuilder footer = new StringBuilder();
    footer.append(NL).append("Sample usages:").append(NL).append("a) ").append(COMMAND)
            .append(" -workername MRTDSODSigner -data \"1=value1&2=value2&3=value3\"").append(NL).append("b) ")
            .append(COMMAND)//ww w.j av a 2  s . com
            .append(" -workername MRTDSODSigner -data \"1=value1&2=value2&3=value3\" -metadata param1=value1 -metadata param2=value2")
            .append(NL);
    ByteArrayOutputStream bout = new ByteArrayOutputStream();
    final HelpFormatter formatter = new HelpFormatter();
    PrintWriter pw = new PrintWriter(bout);
    formatter.printHelp(pw, HelpFormatter.DEFAULT_WIDTH, "signdatagroups <options>", getDescription(), OPTIONS,
            HelpFormatter.DEFAULT_LEFT_PAD, HelpFormatter.DEFAULT_DESC_PAD, footer.toString());
    pw.close();
    return bout.toString();
}

From source file:org.signserver.client.cli.defaultimpl.SignDocumentCommand.java

@Override
public String getUsages() {
    StringBuilder footer = new StringBuilder();
    footer.append(NL).append("Sample usages:").append(NL).append("a) ").append(COMMAND)
            .append(" -workername XMLSigner -data \"<root/>\"").append(NL).append("b) ").append(COMMAND)
            .append(" -workername XMLSigner -infile /tmp/document.xml").append(NL).append("c) ").append(COMMAND)
            .append(" -workerid 2 -data \"<root/>\" -truststore truststore.jks -truststorepwd changeit")
            .append(NL).append("d) ").append(COMMAND)
            .append(" -workerid 2 -data \"<root/>\" -keystore superadmin.jks -keystorepwd foo123").append(NL)
            .append("e) ").append(COMMAND)
            .append(" -workerid 2 -data \"<root/>\" -metadata param1=value1 -metadata param2=value2").append(NL)
            .append("f) ").append(COMMAND)
            .append(" -workerid 3 -indir ./input/ -removefromindir -outdir ./output/ -threads 5").append(NL);

    ByteArrayOutputStream bout = new ByteArrayOutputStream();
    final HelpFormatter formatter = new HelpFormatter();

    PrintWriter pw = new PrintWriter(bout);
    formatter.printHelp(pw, HelpFormatter.DEFAULT_WIDTH,
            "signdocument <-workername WORKERNAME | -workerid WORKERID> [options]", getDescription(), OPTIONS,
            HelpFormatter.DEFAULT_LEFT_PAD, HelpFormatter.DEFAULT_DESC_PAD, footer.toString());
    pw.close();/*from w ww . j  a v a2s .  c o m*/

    return bout.toString();
}

From source file:org.signserver.client.cli.defaultimpl.ValidateDocumentCommand.java

@Override
public String getUsages() {

    StringBuilder footer = new StringBuilder();
    footer.append(NL).append("Sample usages:").append(NL).append("a) ").append(COMMAND)
            .append(" -workername XMLValidator -data \"<root><Signature...").append(NL).append("b) ")
            .append(COMMAND).append(" -workername XMLValidator -infile /tmp/signed.xml").append(NL)
            .append("c) ").append(COMMAND)
            .append(" -workerid 2 -infile /tmp/signed.xml -truststore truststore.jks -truststorepwd changeit")
            .append(NL).append("d) ").append(COMMAND)
            .append(" -workerid 2 -infile /tmp/signed.xml -keystore superadmin.jks -keystorepwd foo123")
            .append(NL).append("e) ").append(COMMAND)
            .append(" -workername XMLValidator -protocol HTTP -infile /tmp/signed.xml").append(NL).append("f) ")
            .append(COMMAND)// ww  w.j  av  a  2s .com
            .append(" -workername XMLValidator -infile /tmp/signed.xml -metadata param1=value1 -metadata param2=value2")
            .append(NL);

    ByteArrayOutputStream bout = new ByteArrayOutputStream();
    final HelpFormatter formatter = new HelpFormatter();
    PrintWriter pw = new PrintWriter(bout);
    formatter.printHelp(pw, HelpFormatter.DEFAULT_WIDTH,
            "validatedocument <-workername WORKERNAME | -workerid WORKERID> [options]",
            "Request a document to be validated by SignServer", OPTIONS, HelpFormatter.DEFAULT_LEFT_PAD,
            HelpFormatter.DEFAULT_DESC_PAD, footer.toString());
    pw.close();
    return bout.toString();
}

From source file:org.signserver.client.cli.validationservice.ValidateCertificateCommand.java

@Override
public String getUsages() {
    final StringBuilder footer = new StringBuilder();
    footer.append(NL).append("The following values is returned by the program that can be used when scripting.")
            .append(NL).append("  -2   : Error happened during execution").append(NL)
            .append("  -1   : Bad arguments").append(NL).append("   0   : Certificate is valid").append(NL)
            .append("   1   : Certificate is revoked").append(NL)
            .append("   2   : Certificate is not yet valid").append(NL)
            .append("   3   : Certificate have expired").append(NL)
            .append("   4   : Certificate doesn't verify").append(NL)
            .append("   5   : CA Certificate have been revoked").append(NL)
            .append("   6   : CA Certificate is not yet valid").append(NL)
            .append("   7   : CA Certificate have expired.").append(NL)
            .append("   8   : Certificate have no valid certificate purpose.").append(NL).append(NL)
            .append("Sample usages:").append(NL).append("a) ").append(COMMAND)
            .append(" -service CertValidationWorker -hosts localhost -cert").append(NL)
            .append("    certificate.pem").append(NL).append("b) ").append(COMMAND)
            .append(" -service 5806 -hosts localhost -cert certificate.pem").append(NL)
            .append("    -truststore p12/truststore.jks -truststorepwd changeit").append(NL).append("c) ")
            .append(COMMAND)/*  w  w  w.  ja  va  2 s  .c  o  m*/
            .append(" -service CertValidationWorker -hosts localhost -cert certificate.pem -protocol HTTP")
            .append(NL);

    ByteArrayOutputStream bout = new ByteArrayOutputStream();
    final HelpFormatter formatter = new HelpFormatter();

    PrintWriter pw = new PrintWriter(bout);
    formatter.printHelp(pw, HelpFormatter.DEFAULT_WIDTH, "Usage: signclient validatecertificate <options>\n",
            null, options, HelpFormatter.DEFAULT_LEFT_PAD, HelpFormatter.DEFAULT_DESC_PAD, footer.toString(),
            false);
    pw.close();
    return bout.toString();
}

From source file:org.signserver.test.performance.cli.Main.java

/**
 * Print usage message./* ww  w.  j  av  a  2 s.  com*/
 */
private static void printUsage() {
    StringBuilder footer = new StringBuilder();
    footer.append(NL).append("Sample usages:").append(NL).append("a) ").append(COMMAND)
            .append(" -testsuite TimeStamp1 -threads 4 -tsaurl http://localhost:8080/signserver/tsa?workerId=1")
            .append(NL).append("b) ").append(COMMAND)
            .append(" -testsuite TimeStamp1 -threads 4 -maxwaittime 100 -statoutputdir ./statistics/ -tsaurl http://localhost:8080/signserver/tsa?workerId=1")
            .append(NL).append("c) ").append(COMMAND)
            .append(" -testsuite DocumentSigner1 -threads 4 -processurl http://localhost:8080/signserver/process -worker PDFSigner -infile test.pdf")
            .append(NL).append("d) ").append(COMMAND)
            .append(" -testsuite DocumentSigner1 -threads 4 -processurl http://localhost:8080/signserver/process -worker XMLSigner -data \"<root/>\"")
            .append(NL).append("e) ").append(COMMAND)
            .append(" -testsuite DocumentSigner1 -threads 4 -processurl http://localhost:8080/signserver/process -worker XMLSigner -data \"<root/>\" -userprefix user -usersuffixmin 1 -usersuffixmax 50")
            .append(NL);

    ByteArrayOutputStream bout = new ByteArrayOutputStream();
    final HelpFormatter formatter = new HelpFormatter();
    PrintWriter pw = new PrintWriter(bout);
    formatter.printHelp(pw, HelpFormatter.DEFAULT_WIDTH, COMMAND + " <options>", "Performance testing tool",
            OPTIONS, HelpFormatter.DEFAULT_LEFT_PAD, HelpFormatter.DEFAULT_DESC_PAD, footer.toString());
    pw.close();
    LOG.info(bout.toString());
}

From source file:org.signserver.test.random.cli.Main.java

private static void printUsage() {
    StringBuilder footer = new StringBuilder();
    footer.append(NL).append("Sample usages:").append(NL).append("a) ").append(COMMAND).append(
            " -testsuite signWhileUpdatingConfig -workergroup1 5678/xml,5679/tsa,5680/xml -threadgroup1 4 -workergroup2 5677/xml,5678/xml,5679/tsa -threadgroup2 3 -timelimit 30000")
            .append(NL).append("b) ").append(COMMAND)
            .append(" -testsuite signAndCountSignings -workergroup1 5678/xml,5679/tsa,5680/xml -threadgroup1 10 -timelimit 30000")
            .append(NL).append("c) ").append(COMMAND)
            .append(" -testsuite signWhileRenewing -workergroup1 300/xml -workergroup2 301/xml,302/xml -threadgroup1 5 -workergroup3 309/renew -timelimit 20000")
            .append("d) ").append(COMMAND)
            .append(" -testsuite signWithRandomUsers -workergroup1 300/xml -threadgroup1 5 -timelimit 20000 -userprefix testuser -usersuffixmin 1 -usersuffixmax 100")
            .append(NL).append("Available worker types:").append(NL).append(" - workerType can be any of ")
            .append(Arrays.asList(WorkerType.values())).append(NL).append("Test suite: signAndCountSignings")
            .append(NL)/*from w  ww.  j  av  a 2s .  c  om*/
            .append(" - Signs documents with the workers from group 1 with the number of threads defined for group 1")
            .append(NL)
            .append(" - Pauses signings and counts performed signings a compares to the key usage counter value")
            .append(NL).append(" - Notice that it is assumed that all workers use the same key-pair").append(NL)
            .append("Test suite: signWhileUpdatingConfig").append(NL)
            .append(" - Signs documents with the workers from group 1 with the number of threads defined for group 1")
            .append(NL).append(" - Increases a counter in the configuration of group 2").append(NL)
            .append(" - Notice that the size of thread group 2 must be equal to the number of workers in group 2")
            .append(NL).append("Test suite: signWhileRenewing").append(NL)
            .append(" - Signs documents with the workers from group 1 with the number of threads defined for group 1")
            .append(NL).append(" - Renews signers from group 2 using the one renewal worker in group 3")
            .append(NL).append(" - Notice that group 3 should only include one renewal worker").append(NL)
            .append("Test suite: signWithRandomUsers").append(NL)
            .append(" - Signs documents with the workers from group 1 with the number of threads defined for group 1")
            .append(NL)
            .append(" - Sends requests from usernames starting with the supplied 'userprefix' and ends with a random number between 'usersuffixmin' and 'usersuffixmax'")
            .append(NL);
    ByteArrayOutputStream bout = new ByteArrayOutputStream();
    final HelpFormatter formatter = new HelpFormatter();
    PrintWriter pw = new PrintWriter(bout);
    formatter.printHelp(pw, HelpFormatter.DEFAULT_WIDTH, COMMAND + " <options>", "Random testing tool", OPTIONS,
            HelpFormatter.DEFAULT_LEFT_PAD, HelpFormatter.DEFAULT_DESC_PAD, footer.toString());
    pw.close();
    LOG.info(bout.toString());
}

From source file:org.sybila.parasim.application.ParasimOptions.java

public static void printHelp(PrintStream out) {
    PrintWriter output = new PrintWriter(out);
    output.println();/*  w w w.j a  v  a2  s  . c om*/
    HelpFormatter helpFormatter = new HelpFormatter();
    helpFormatter.printUsage(output, HelpFormatter.DEFAULT_WIDTH, "parasim", getOptions());
    output.println();
    helpFormatter.printOptions(output, HelpFormatter.DEFAULT_WIDTH, getOptions(),
            HelpFormatter.DEFAULT_LEFT_PAD, HelpFormatter.DEFAULT_DESC_PAD);
    output.println();
    output.flush();
}