hudson.cli
Class SessionIdCommand

java.lang.Object
  hudson.cli.CLICommand
      hudson.cli.SessionIdCommand

All Implemented Interfaces:

ExtensionPoint, Cloneable

@Extension
public class SessionIdCommand
extends CLICommand

Prints the current session ID number (that changes for every run) to allow clients to reliably wait for a restart.

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

SessionIdCommand()

Method Summary

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, getCurrent, getName, getTransportAuthentication, loadStoredAuthentication, 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

SessionIdCommand

public SessionIdCommand()

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()

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.