Package hudson.cli
Class WhoAmICommand
- java.lang.Object
-
- hudson.cli.CLICommand
-
- hudson.cli.WhoAmICommand
-
- All Implemented Interfaces:
ExtensionPoint,Cloneable
@Extension public class WhoAmICommand extends CLICommand
Report the current granted authorities- Author:
- Kohsuke Kawaguchi
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Field Summary
-
Fields inherited from class hudson.cli.CLICommand
ALLOW_AT_SYNTAX, channel, locale, stderr, stdin, stdout
-
-
Constructor Summary
Constructors Constructor Description WhoAmICommand()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetShortDescription()Gets the quick summary of what this command does.protected intrun()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, printUsageSummary, registerOptionHandlers, setClientCharset, setTransportAuth, setTransportAuth2
-
-
-
-
Method Detail
-
getShortDescription
public String getShortDescription()
Description copied from class:CLICommandGets the quick summary of what this command does. Used by the help command to generate the list of commands.- Specified by:
getShortDescriptionin classCLICommand
-
run
protected int run()
Description copied from class:CLICommandExecutes the command, and return the exit code.This is an internal contract between
CLICommandand its subtype. To execute CLI method from outside, useCLICommand.main(List, Locale, InputStream, PrintStream, PrintStream)- Specified by:
runin classCLICommand- 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.
-
-