Package hudson.cli

Class OfflineNodeCommand

java.lang.Object

hudson.cli.CLICommand

hudson.cli.OfflineNodeCommand

All Implemented Interfaces:

ExtensionPoint, Cloneable

@Extension
public class OfflineNodeCommand
extends CLICommand

CLI Command, which puts the Jenkins node offline.

Since:

2.15

Author:

pjanouse

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
String	cause

Fields inherited from class hudson.cli.CLICommand

ALLOW_AT_SYNTAX, channel, locale, stderr, stdin, stdout

Constructor Summary

Constructors

Constructor	Description
OfflineNodeCommand()

Method Summary

Modifier and Type	Method	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, getTransportAuthentication2, getUsage, handleException, main, printUsage, printUsageSummary, setClientCharset, setTransportAuth, setTransportAuth2

Methods inherited from class java.lang.Object

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

Field Details

cause

public String cause

Constructor Details

OfflineNodeCommand

public OfflineNodeCommand()

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