hudson.cli

Class UpdateNodeCommand

java.lang.Object

hudson.cli.CLICommand

hudson.cli.UpdateNodeCommand

All Implemented Interfaces:

ExtensionPoint, Cloneable

@Extension
public class UpdateNodeCommand
extends CLICommand

Since:

1.526

Author:

ogondza

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
Node	node

Fields inherited from class hudson.cli.CLICommand

channel, locale, stderr, stdin, stdout, TRANSPORT_AUTHENTICATION

Constructor Summary

Constructors

Constructor and Description
UpdateNodeCommand()

Method Summary

Modifier and Type	Method and Description
String	getShortDescription() Gets the quick summary of what this command does.
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, getUsage, loadStoredAuthentication, main, printUsage, printUsageSummary, registerOptionHandlers, setClientCharset, setTransportAuth, shouldPerformAuthentication

Methods inherited from class java.lang.Object

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

Field Detail

node

public Node node

Constructor Detail

UpdateNodeCommand

public UpdateNodeCommand()

Method Detail

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 IOException,
                  javax.servlet.ServletException

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:

AbortException - If the execution can't continue due to an other (rare, but foreseeable) issue

IOException

javax.servlet.ServletException