Package hudson.cli

Class BuildCommand

java.lang.Object

hudson.cli.CLICommand

hudson.cli.BuildCommand

All Implemented Interfaces:

ExtensionPoint, Cloneable

@Extension
public class BuildCommand
extends CLICommand

Builds a job, and optionally waits until its completion.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BuildCommand.CLICause

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	BUILD_SCHEDULING_REFUSED
boolean	checkSCM
boolean	consoleOutput
boolean	follow
Job<?,?>	job
Map<String,String>	parameters
int	retryCnt	Deprecated.
boolean	sync
boolean	wait

Fields inherited from class hudson.cli.CLICommand

ALLOW_AT_SYNTAX, channel, locale, stderr, stdin, stdout

Constructor Summary

Constructors

Constructor	Description
BuildCommand()

Method Summary

Modifier and Type	Method	Description
String	getShortDescription()	Gets the quick summary of what this command does.
protected void	printUsageSummary(PrintStream stderr)	Called while producing usage.
protected int	run()	Executes the command, and return the exit code.

Methods inherited from class hudson.cli.CLICommand

all, checkChannel, clone, createClone, getClientCharset, getClientEnvironmentVariable, getClientSystemProperty, getCmdLineParser, getCurrent, getLongDescription, getName, getSingleLineSummary, getTransportAuthentication, getTransportAuthentication2, getUsage, main, printUsage, registerOptionHandlers, setClientCharset, setTransportAuth, setTransportAuth2

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

job

public Job<?,?> job

follow

public boolean follow

sync

public boolean sync

wait

public boolean wait

checkSCM

public boolean checkSCM

parameters

public Map<String,String> parameters

consoleOutput

public boolean consoleOutput

retryCnt

@Deprecated
public int retryCnt

Deprecated.

BUILD_SCHEDULING_REFUSED

protected static final String BUILD_SCHEDULING_REFUSED

See Also:

• Constant Field Values

Constructor Details

BuildCommand

public BuildCommand()

Method Details

getShortDescription

public String getShortDescription()

Description copied from class: CLICommand

Gets the quick summary of what this command does. Used by the help command to generate the list of commands.

Specified by:

getShortDescription in class CLICommand

run

protected int run()
           throws Exception

Description copied from class: CLICommand

Executes the command, and return the exit code.

This is an internal contract between CLICommand and its subtype. To execute CLI method from outside, use CLICommand.main(List, Locale, InputStream, PrintStream, PrintStream)

Specified by:

run in class CLICommand

Returns:

0 to indicate a success, otherwise a custom error code. Error codes 1-15 shouldn;t be used in CLICommand.run() as a custom error code.

Throws:

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.springframework.security.access.AccessDeniedException - If the caller doesn't have sufficient rights for requested action

org.springframework.security.authentication.BadCredentialsException - If bad credentials were provided to CLI

printUsageSummary

protected void printUsageSummary(PrintStream stderr)

Description copied from class: CLICommand

Called while producing usage. This is a good method to override to render the general description of the command that goes beyond a single-line summary.

Overrides:

printUsageSummary in class CLICommand