|Constructor and Description|
|Modifier and Type||Method and Description|
Gets the quick summary of what this command does.
Called while producing usage.
Executes the command, and return the exit code.
all, checkChannel, clone, createClone, getClientCharset, getClientEnvironmentVariable, getClientSystemProperty, getCmdLineParser, getCurrent, getLongDescription, getName, getSingleLineSummary, getTransportAuthentication, getUsage, main, printUsage, registerOptionHandlers, setClientCharset, setTransportAuth, shouldPerformAuthentication
public String getShortDescription()
protected void printUsageSummary(PrintStream stderr)
protected int run() throws Exception
This is an internal contract between
CLICommand and its subtype.
To execute CLI method from outside, use
CLICommand.main(List, Locale, InputStream, PrintStream, PrintStream)
CLICommand.run()as a custom error code.
Exception- If a further unspecified exception is thrown; means: Unknown and/or unexpected issue occurred
org.kohsuke.args4j.CmdLineException- If a wrong parameter specified, input value can't be decoded etc.
IllegalArgumentException- If the execution can't continue due to wrong input parameter (job doesn't exist etc.)
IllegalStateException- If the execution can't continue due to an incorrect state of Jenkins, job, build etc.
AbortException- If the execution can't continue due to an other (rare, but foreseeable) issue
org.acegisecurity.AccessDeniedException- If the caller doesn't have sufficient rights for requested action
org.acegisecurity.BadCredentialsException- If bad credentials were provided to CLI
Copyright © 2004–2020. All rights reserved.