BaseCommand (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.sshd.BaseCommand

All Implemented Interfaces:

org.apache.sshd.server.Command

Direct Known Subclasses:

AbstractGitCommand, AliasCommand, GarbageCollectionCommand, ListGroupsCommand, ListMembersCommand, SshCommand, SuExec
```
public abstract class BaseCommand
extends Object
implements org.apache.sshd.server.Command
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BaseCommand.CommandRunnable` Runnable function which can throw an exception.
`static class`	`BaseCommand.Failure` Thrown from `BaseCommand.CommandRunnable.run()` with client message and code.
`static interface`	`BaseCommand.ProjectCommandRunnable` Runnable function which can retrieve a project name related to the task
`static class`	`BaseCommand.UnloggedFailure` Thrown from `BaseCommand.CommandRunnable.run()` with client message and code.

Field Summary

Fields
Modifier and Type Field and Description

static String ENC

protected OutputStream err

protected InputStream in

protected OutputStream out

static int STATUS_NOT_ADMIN

Fields
Modifier and Type	Field and Description
`static String`	`ENC`
`protected OutputStream`	`err`
`protected InputStream`	`in`
`protected OutputStream`	`out`
`static int`	`STATUS_NOT_ADMIN`

Constructor Summary

Constructors
Constructor and Description

BaseCommand()

Constructors
Constructor and Description
`BaseCommand()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkExclusivity(Object arg1, String arg1name, Object arg2, String arg2name)`
`void`	`destroy()`
`protected BaseCommand.UnloggedFailure`	`die(String msg)`
`protected BaseCommand.UnloggedFailure`	`die(Throwable why)`
`String[]`	`getArguments()`
`protected String`	`getName()`
`protected String`	`getPluginName()`
`protected com.google.gerrit.util.cli.CmdLineParser`	`newCmdLineParser(Object options)` Construct a new parser for this command's received command line.
`protected void`	`onExit(int rc)` Terminate this command and return a result code to the remote client.
`protected void`	`parseCommandLine()` Parses the command line argument, injecting parsed values into fields.
`protected void`	`parseCommandLine(Object options)` Parses the command line argument, injecting parsed values into fields.
`protected void`	`provideStateTo(org.apache.sshd.server.Command cmd)` Pass all state into the command, then run its start method.
`void`	`setArguments(String[] argv)`
`void`	`setErrorStream(OutputStream err)`
`void`	`setExitCallback(org.apache.sshd.server.ExitCallback callback)`
`void`	`setInputStream(InputStream in)`
`void`	`setOutputStream(OutputStream out)`
`protected void`	`startThread(BaseCommand.CommandRunnable thunk)` Spawn a function into its own thread.
`protected void`	`startThread(Runnable thunk)` Spawn a function into its own thread.
`protected static PrintWriter`	`toPrintWriter(OutputStream o)` Wrap the supplied output stream in a UTF-8 encoded PrintWriter.
`protected String`	`usage()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.sshd.server.Command
start

- Field Detail
  - ENC
```
public static final String ENC
```
    See Also:
    Constant Field Values
  - STATUS_NOT_ADMIN
```
public static final int STATUS_NOT_ADMIN
```
    See Also:
    Constant Field Values
  - in
```
protected InputStream in
```
  - out
```
protected OutputStream out
```
  - err
```
protected OutputStream err
```
- Constructor Detail
  - BaseCommand
```
public BaseCommand()
```
- Method Detail
  - setInputStream
```
public void setInputStream(InputStream in)
```
    Specified by:
    
    setInputStream in interface org.apache.sshd.server.Command
  - setOutputStream
```
public void setOutputStream(OutputStream out)
```
    Specified by:
    
    setOutputStream in interface org.apache.sshd.server.Command
  - setErrorStream
```
public void setErrorStream(OutputStream err)
```
    Specified by:
    
    setErrorStream in interface org.apache.sshd.server.Command
  - setExitCallback
```
public void setExitCallback(org.apache.sshd.server.ExitCallback callback)
```
    Specified by:
    
    setExitCallback in interface org.apache.sshd.server.Command
  - getPluginName
```
protected String getPluginName()
```
  - getName
```
protected String getName()
```
  - getArguments
```
public String[] getArguments()
```
  - setArguments
```
public void setArguments(String[] argv)
```
  - destroy
```
public void destroy()
```
    Specified by:
    
    destroy in interface org.apache.sshd.server.Command
  - provideStateTo
```
protected void provideStateTo(org.apache.sshd.server.Command cmd)
```
    Pass all state into the command, then run its start method.
    This method copies all critical state, like the input and output streams, into the supplied command. The caller must still invoke cmd.start() if wants to pass control to the command.
    
    Parameters:
    cmd - the command that will receive the current state.
  - parseCommandLine
```
protected void parseCommandLine()
                         throws BaseCommand.UnloggedFailure
```
    Parses the command line argument, injecting parsed values into fields.
    This method must be explicitly invoked to cause a parse.
    
    Throws:
    
    BaseCommand.UnloggedFailure - if the command line arguments were invalid.
    See Also:
    Option, Argument
  - parseCommandLine
```
protected void parseCommandLine(Object options)
                         throws BaseCommand.UnloggedFailure
```
    Parses the command line argument, injecting parsed values into fields.
    This method must be explicitly invoked to cause a parse.
    
    Parameters:
    options - object whose fields declare Option and Argument annotations to describe the parameters of the command. Usually this.
    
    Throws:
    
    BaseCommand.UnloggedFailure - if the command line arguments were invalid.
    See Also:
    Option, Argument
  - usage
```
protected String usage()
```
  - newCmdLineParser
```
protected com.google.gerrit.util.cli.CmdLineParser newCmdLineParser(Object options)
```
    Construct a new parser for this command's received command line.
  - startThread
```
protected void startThread(Runnable thunk)
```
    Spawn a function into its own thread.
    Typically this should be invoked within Command.start(Environment), such as:
```
 startThread(new Runnable() {
   public void run() {
     runImp();
   }
 });
 
```
    Parameters:
    thunk - the runnable to execute on the thread, performing the command's logic.
  - startThread
```
protected void startThread(BaseCommand.CommandRunnable thunk)
```
    Spawn a function into its own thread.
    Typically this should be invoked within Command.start(Environment), such as:
```
 startThread(new CommandRunnable() {
   public void run() throws Exception {
     runImp();
   }
 });
 
```
    If the function throws an exception, it is translated to a simple message for the client, a non-zero exit code, and the stack trace is logged.
    Parameters:
    thunk - the runnable to execute on the thread, performing the command's logic.
  - onExit
```
protected void onExit(int rc)
```
    Terminate this command and return a result code to the remote client.
    Commands should invoke this at most once. Once invoked, the command may lose access to request based resources as any callbacks previously registered with RequestCleanup will fire.
    
    Parameters:
    rc - exit code for the remote client.
  - toPrintWriter
```
protected static PrintWriter toPrintWriter(OutputStream o)
```
    Wrap the supplied output stream in a UTF-8 encoded PrintWriter.
  - die
```
protected BaseCommand.UnloggedFailure die(String msg)
```
  - die
```
protected BaseCommand.UnloggedFailure die(Throwable why)
```
  - checkExclusivity
```
public void checkExclusivity(Object arg1,
                    String arg1name,
                    Object arg2,
                    String arg2name)
                      throws BaseCommand.UnloggedFailure
```
    Throws:
    
    BaseCommand.UnloggedFailure

Class BaseCommand

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.sshd.server.Command

Field Detail

ENC

STATUS_NOT_ADMIN

in

out

err

Constructor Detail

BaseCommand

Method Detail

setInputStream

setOutputStream

setErrorStream

setExitCallback

getPluginName

getName

getArguments

setArguments

destroy

provideStateTo

parseCommandLine

parseCommandLine

usage

newCmdLineParser

startThread

startThread

onExit

toPrintWriter

die

die

checkExclusivity