com.sshtools.server.vshell

Class Msh

java.lang.Object

com.sshtools.server.vshell.AbstractCommand

com.sshtools.server.vshell.ShellCommand

com.sshtools.server.vshell.Msh

All Implemented Interfaces:

Command, Completor

Direct Known Subclasses:

Catch, RootShell, Source

public class Msh
extends ShellCommand

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandFactory<ShellCommand>	commandFactory
static org.slf4j.Logger	log
static String	LOGIN_CONTEXT
protected Map<Integer,com.sshtools.server.vshell.Msh.Job>	runningJobs

Fields inherited from class com.sshtools.server.vshell.ShellCommand

SUBSYSTEM_CALLBACK, SUBSYSTEM_FILESYSTEM, SUBSYSTEM_HELP, SUBSYSTEM_JVM, SUBSYSTEM_POLICY, SUBSYSTEM_SHELL, SUBSYSTEM_SSHD, SUBSYSTEM_SYSTEM, SUBSYSTEM_TEXT_EDITING

Fields inherited from class com.sshtools.server.vshell.AbstractCommand

exitCode, process

Fields inherited from interface com.sshtools.server.vshell.Command

STILL_ACTIVE

Constructor Summary

Constructors

Constructor and Description
Msh(CommandFactory<ShellCommand> commandFactory)
Msh(String name, String subsystem, CommandFactory<ShellCommand> commandFactory)
Msh(String name, String subsystem, String signature, CommandFactory<ShellCommand> commandFactory)
Msh(String name, String subsystem, String signature, CommandFactory<ShellCommand> commandFactory, org.apache.commons.cli.Option... options)

Method Summary

Modifier and Type	Method and Description
protected int	doSpawn(Console term, VirtualProcess process, String[] args, boolean background)
void	exit()
String	expandEnvironmentVariables(String value, Map<String,String> additionalReplacements)
CommandFactory<ShellCommand>	getCommandFactory()
Throwable	getLastError()
protected void	parseArgs(VirtualProcess process, List<String> lineArgs)
protected void	parseLine(VirtualProcess process, String line)
void	run(org.apache.commons.cli.CommandLine cli, VirtualProcess process)
protected void	runShell(VirtualProcess process)
protected void	setCommandFactory(CommandFactory<ShellCommand> commandFactory)
protected void	source(VirtualProcess process, AbstractFile file)
protected void	source(VirtualProcess process, InputStream in)
protected int	spawn(Console term, VirtualProcess process, String[] args, boolean background)

Methods inherited from class com.sshtools.server.vshell.AbstractCommand

complete, getCollection, getCommandName, getDescription, getExitCode, getName, getOptions, getProcess, getSignature, getSubsystem, hasFixedOptions, init, isBuiltIn, isHidden, setBuiltIn, setDescription, setName, setSignature, setSubsystem

Methods inherited from class java.lang.Object

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

Field Detail

commandFactory

protected CommandFactory<ShellCommand> commandFactory

log

public static final org.slf4j.Logger log

runningJobs

protected Map<Integer,com.sshtools.server.vshell.Msh.Job> runningJobs

LOGIN_CONTEXT

public static final String LOGIN_CONTEXT

See Also:

Constant Field Values

Constructor Detail

Msh

public Msh(CommandFactory<ShellCommand> commandFactory)

Msh

public Msh(String name,
           String subsystem,
           String signature,
           CommandFactory<ShellCommand> commandFactory,
           org.apache.commons.cli.Option... options)

Msh

public Msh(String name,
           String subsystem,
           String signature,
           CommandFactory<ShellCommand> commandFactory)

Msh

public Msh(String name,
           String subsystem,
           CommandFactory<ShellCommand> commandFactory)

Method Detail

setCommandFactory

protected void setCommandFactory(CommandFactory<ShellCommand> commandFactory)

expandEnvironmentVariables

public String expandEnvironmentVariables(String value,
                                         Map<String,String> additionalReplacements)

runShell

protected void runShell(VirtualProcess process)
                 throws IOException

Throws:

IOException

run

public void run(org.apache.commons.cli.CommandLine cli,
                VirtualProcess process)
         throws IOException,
                PermissionDeniedException

Throws:

IOException

PermissionDeniedException

source

protected void source(VirtualProcess process,
                      AbstractFile file)
               throws IOException

Throws:

IOException

source

protected void source(VirtualProcess process,
                      InputStream in)
               throws IOException

Throws:

IOException

parseArgs

protected void parseArgs(VirtualProcess process,
                         List<String> lineArgs)
                  throws IOException

Throws:

IOException

parseLine

protected void parseLine(VirtualProcess process,
                         String line)
                  throws IOException

Throws:

IOException

spawn

protected int spawn(Console term,
                    VirtualProcess process,
                    String[] args,
                    boolean background)
             throws IOException

Throws:

IOException

doSpawn

protected int doSpawn(Console term,
                      VirtualProcess process,
                      String[] args,
                      boolean background)
               throws UnsupportedCommandException,
                      IllegalAccessException,
                      InstantiationException,
                      org.apache.commons.cli.ParseException,
                      IOException,
                      PermissionDeniedException,
                      UsageException

Throws:

UnsupportedCommandException

IllegalAccessException

InstantiationException

org.apache.commons.cli.ParseException

IOException

PermissionDeniedException

UsageException

getLastError

public Throwable getLastError()

exit

public void exit()

getCommandFactory

public CommandFactory<ShellCommand> getCommandFactory()