hudson.cli

Class LoginCommand

java.lang.Object

hudson.cli.CLICommand

hudson.cli.LoginCommand

All Implemented Interfaces:

ExtensionPoint, Cloneable

@Extension
public class LoginCommand
extends CLICommand

Saves the current credential to allow future commands to run without explicit credential information.

Since:

1.351

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

channel, locale, stderr, stdin, stdout, TRANSPORT_AUTHENTICATION

Constructor Summary

Constructors

Constructor and Description
LoginCommand()

Method Summary

Modifier and Type	Method and Description
String	getShortDescription() Gets the quick summary of what this command does.
protected org.acegisecurity.Authentication	loadStoredAuthentication() If we use the stored authentication for the login command, login becomes no-op, which is clearly not what the user has intended.
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, main, printUsage, printUsageSummary, registerOptionHandlers, setTransportAuth, shouldPerformAuthentication

Methods inherited from class java.lang.Object

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

Constructor Detail

LoginCommand

public LoginCommand()

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

loadStoredAuthentication

protected org.acegisecurity.Authentication loadStoredAuthentication()
                                                             throws InterruptedException

If we use the stored authentication for the login command, login becomes no-op, which is clearly not what the user has intended.

Overrides:

loadStoredAuthentication in class CLICommand

Throws:

InterruptedException

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 an error code.

Throws:

AbortException - If the processing should be aborted. Hudson will report the error message without stack trace, and then exits this command.

Exception - All the other exceptions cause the stack trace to be dumped, and then the command exits with an error code.