Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractConsoleRequest<R extends ConsoleRequest<R>> - Class in org.dellroad.jct.core
- AbstractConsoleRequest(Map<String, String>) - Constructor for class org.dellroad.jct.core.AbstractConsoleRequest
-
Constructor.
- AbstractConsoleSession<O,
R extends ConsoleRequest<R>> - Class in org.dellroad.jct.core -
Support superclass for
ConsoleSessionimplementations. - AbstractConsoleSession(O, R) - Constructor for class org.dellroad.jct.core.AbstractConsoleSession
-
Constructor.
- AbstractExecSession - Class in org.dellroad.jct.core
-
Support superclass for
ExecSessionimplementations. - AbstractExecSession(Exec, ExecRequest) - Constructor for class org.dellroad.jct.core.AbstractExecSession
-
Constructor.
- AbstractShellSession - Class in org.dellroad.jct.core
-
Support superclass for
ShellSessionimplementations. - AbstractShellSession(Shell, ShellRequest) - Constructor for class org.dellroad.jct.core.AbstractShellSession
-
Constructor.
- AbstractShellSession(Shell, ShellRequest, InputStream, PrintStream) - Constructor for class org.dellroad.jct.core.AbstractShellSession
-
Constructor.
- AbstractSimpleCommand - Class in org.dellroad.jct.core.simple
-
Support superclass for
SimpleCommandimplementations. - AbstractSimpleCommand(String, String, String) - Constructor for class org.dellroad.jct.core.simple.AbstractSimpleCommand
-
Constructor.
- authenticator - Variable in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer
- authenticator(PublickeyAuthenticator) - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer.Builder
-
Configure the public key authenticator that authenticates new incoming connections.
- authorizedKeys(InputStream) - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer.Builder
-
Read authorized users' public keys from an
InputStream. - authorizedKeys(String) - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer.Builder
-
Read authorized users' public keys from a
String. - authorizedKeys(Path) - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer.Builder
-
Configurea authorized users' public keys to be read from a file at connection time.
B
- build() - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer.Builder
-
Build a new
SimpleConsoleSshServerbased on this instance. - buildCommandMap() - Method in class org.dellroad.jct.core.simple.SimpleCommandSupport
-
Build a combined command map, where command names in earlier bundles hide later ones.
- builder() - Static method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer
-
Create an instance builder.
- buildInputStream(Terminal) - Method in class org.dellroad.jct.core.AbstractShellSession
-
Get the
InputStreamto use for input from the givenTerminal. - buildLineReader(ShellRequest) - Method in class org.dellroad.jct.core.simple.SimpleShell
-
Construct a
LineReaderfor a new shell session. - buildOutputStream(Terminal) - Method in class org.dellroad.jct.core.AbstractShellSession
-
Get the
PrintStreamto use for output from the givenTerminal. - buildOutputStream(Terminal) - Method in class org.dellroad.jct.jshell.JShellShellSession
- buildShellRequest(ShellSession, String, List<String>) - Method in class org.dellroad.jct.core.simple.command.SubshellCommand
-
Create the subshell request.
- Bundle - Class in org.dellroad.jct.core.simple.command
- Bundle - Class in org.dellroad.jct.jshell.command
- Bundle() - Constructor for class org.dellroad.jct.core.simple.command.Bundle
- Bundle() - Constructor for class org.dellroad.jct.jshell.command.Bundle
C
- channel - Variable in class org.dellroad.jct.ssh.JctExecCommand
- charset - Variable in class org.dellroad.jct.ssh.JctExecCommand
- close() - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer
-
Close this instance.
- command - Variable in class org.dellroad.jct.core.simple.SimpleExec.Session
- CommandBundle - Interface in org.dellroad.jct.core.simple
-
A collection of
SimpleCommands keyed by name. - commandBundles - Variable in class org.dellroad.jct.core.simple.SimpleCommandSupport
- commandLineParser - Variable in class org.dellroad.jct.core.simple.SimpleCommandSupport
- CommandLineParser - Interface in org.dellroad.jct.core.simple
-
Parses a command line string into a command name and parameters.
- CommandLineParser.SyntaxException - Exception in org.dellroad.jct.core.simple
-
Exception thrown by a
CommandLineParserwhen the line cannot be successfully parsed. - commandLoop() - Method in class org.dellroad.jct.core.simple.SimpleShell.Session
- complete(LineReader, ParsedLine, List<Candidate>) - Method in class org.dellroad.jct.core.simple.SimpleShell.SimpleCompleter
- ConsoleRequest<R extends ConsoleRequest<R>> - Interface in org.dellroad.jct.core
-
Represents a request to create a new
ConsoleSessionof some kind. - ConsoleSession<O,
R extends ConsoleRequest<R>> - Interface in org.dellroad.jct.core -
A session associated with a console component.
- ConsoleUtil - Class in org.dellroad.jct.core.util
-
Utility routines.
- createBuilder() - Method in class org.dellroad.jct.jshell.JShellShellSession
-
Create and configure the JShell builder for this new session.
- createCommand(ChannelSession, String) - Method in class org.dellroad.jct.ssh.JctExecFactory
- createLineReaderBuilder(ShellRequest) - Method in class org.dellroad.jct.core.simple.SimpleShell
-
Create and configure a
LineReaderBuilderfor a new shell session. - createSession() - Method in class org.dellroad.jct.ssh.JctExecCommand
- createSession() - Method in class org.dellroad.jct.ssh.JctShellCommand
- createSessionThread(Runnable) - Method in class org.dellroad.jct.ssh.JctExecCommand
- createShell(ChannelSession) - Method in class org.dellroad.jct.ssh.JctShellFactory
- createSubshell(ShellRequest) - Method in class org.dellroad.jct.core.simple.command.SubshellCommand
-
Create the subshell session.
- CrNlPrintStream - Class in org.dellroad.jct.core.util
-
A
PrintStreamthat ends every line with a CR-NL sequence. - CrNlPrintStream(OutputStream, boolean, String) - Constructor for class org.dellroad.jct.core.util.CrNlPrintStream
D
- DateCommand - Class in org.dellroad.jct.core.simple.command
-
A simple "date" command.
- DateCommand() - Constructor for class org.dellroad.jct.core.simple.command.DateCommand
- DemoMain - Class in org.dellroad.jct.demo
-
Demonstration of various Java Console Toolkit functionality.
- DemoMain() - Constructor for class org.dellroad.jct.demo.DemoMain
- destroy(ChannelSession) - Method in class org.dellroad.jct.ssh.JctExecCommand
- destroy(ChannelSession) - Method in class org.dellroad.jct.ssh.JctShellCommand
- doExecute() - Method in class org.dellroad.jct.core.AbstractConsoleSession
-
Execute this session.
- doExecute() - Method in class org.dellroad.jct.core.simple.SimpleExec.Session
-
Execute this instance's
SimpleExec.Session.commandin the context of this session. - doExecute() - Method in class org.dellroad.jct.core.simple.SimpleShell.Session
- doExecute() - Method in class org.dellroad.jct.jshell.JShellShellSession
- doInterrupt(Thread) - Method in class org.dellroad.jct.core.AbstractConsoleSession
-
Interrupt execution.
E
- EchoCommand - Class in org.dellroad.jct.core.simple.command
-
A simple "echo" command.
- EchoCommand() - Constructor for class org.dellroad.jct.core.simple.command.EchoCommand
- env - Variable in class org.dellroad.jct.ssh.JctExecCommand
- err - Variable in class org.dellroad.jct.ssh.JctExecCommand
- exec - Variable in class org.dellroad.jct.ssh.JctExecFactory
- exec - Variable in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer
- exec(Exec) - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer.Builder
-
Configure the
Execthat successful incoming execute connections should connect to. - Exec - Interface in org.dellroad.jct.core
-
A console component that is capable of executing individual commands.
- ExecRequest - Interface in org.dellroad.jct.core
-
Represents a request to create a new
ExecSessionto execute a command. - ExecSession - Interface in org.dellroad.jct.core
-
A
ConsoleSessionassociated with the direct execution of a single command. - execute() - Method in class org.dellroad.jct.core.AbstractConsoleSession
- execute() - Method in interface org.dellroad.jct.core.ConsoleSession
-
Execute this session synchronously in the current thread.
- execute(ConsoleSession<?, ?>) - Method in class org.dellroad.jct.core.simple.SimpleCommandSupport.FoundCommand
-
Execute this command.
- execute(ConsoleSession<?, ?>, String, List<String>) - Method in class org.dellroad.jct.core.simple.command.DateCommand
- execute(ConsoleSession<?, ?>, String, List<String>) - Method in class org.dellroad.jct.core.simple.command.EchoCommand
- execute(ConsoleSession<?, ?>, String, List<String>) - Method in class org.dellroad.jct.core.simple.command.ExitCommand
- execute(ConsoleSession<?, ?>, String, List<String>) - Method in class org.dellroad.jct.core.simple.command.HelpCommand
- execute(ConsoleSession<?, ?>, String, List<String>) - Method in class org.dellroad.jct.core.simple.command.SleepCommand
- execute(ConsoleSession<?, ?>, String, List<String>) - Method in class org.dellroad.jct.core.simple.command.SubshellCommand
- execute(ConsoleSession<?, ?>, String, List<String>) - Method in interface org.dellroad.jct.core.simple.SimpleCommand
-
Execute this command in the current thread and return success or failure.
- execute(SimpleCommandSupport.FoundCommand) - Method in class org.dellroad.jct.core.simple.SimpleShell.Session
-
Execute the given command in the context of this session.
- executeSession() - Method in class org.dellroad.jct.ssh.JctExecCommand
- executeSubshell(ShellSession) - Method in class org.dellroad.jct.core.simple.command.SubshellCommand
-
Execute the subshell session.
- exitCallback - Variable in class org.dellroad.jct.ssh.JctExecCommand
- ExitCommand - Class in org.dellroad.jct.core.simple.command
-
A simple "exit" (or "quit") command.
- ExitCommand() - Constructor for class org.dellroad.jct.core.simple.command.ExitCommand
- exitValue - Variable in class org.dellroad.jct.core.AbstractShellSession
-
This will be non-null if
AbstractShellSession.setExitValue(int)has been invoked.
F
- factory - Variable in class org.dellroad.jct.ssh.JctExecCommand
- findCommand(PrintStream, String) - Method in class org.dellroad.jct.core.simple.SimpleCommandSupport
-
Find the command in the bundle corresponding to the given command string, which will be parsed.
- findCommand(PrintStream, List<String>) - Method in class org.dellroad.jct.core.simple.SimpleCommandSupport
-
Find the command in the bundle corresponding to the given command list.
- findCommand(PrintStream, ExecRequest) - Method in class org.dellroad.jct.core.simple.SimpleCommandSupport
-
Find the command in the bundle corresponding to the given request.
- FoundCommand(SimpleCommand, String, List<String>) - Constructor for class org.dellroad.jct.core.simple.SimpleCommandSupport.FoundCommand
-
Constructor.
G
- getCommand() - Method in class org.dellroad.jct.core.simple.SimpleCommandSupport.FoundCommand
- getCommandBundles() - Method in class org.dellroad.jct.core.simple.SimpleCommandSupport
-
Get the list of command bundles.
- getCommandLineParser() - Method in class org.dellroad.jct.core.simple.SimpleCommandSupport
-
Get the configured command line parser.
- getCommandList() - Method in interface org.dellroad.jct.core.ExecRequest
-
Get this request's command to execute as a string array.
- getCommandList() - Method in class org.dellroad.jct.core.simple.SimpleExecRequest
- getCommandString() - Method in interface org.dellroad.jct.core.ExecRequest
-
Get this request's command to execute as a single string.
- getCommandString() - Method in class org.dellroad.jct.core.simple.SimpleExecRequest
- getContinuationPrompt() - Method in class org.dellroad.jct.core.simple.SimpleShell
-
Get the continuation line prompt.
- getContinuationPrompt() - Method in class org.dellroad.jct.core.simple.SimpleShell.Session
-
Get the continuation line prompt.
- getCurrent() - Static method in class org.dellroad.jct.jshell.JShellShellSession
-
Get the instance associated with the current thread.
- getDefaultAuthKeysFile() - Method in class org.dellroad.jct.demo.DemoMain
- getDefaultHostKeyFile() - Method in class org.dellroad.jct.demo.DemoMain
- getDefaultListenPort() - Method in class org.dellroad.jct.demo.DemoMain
- getDescription() - Method in interface org.dellroad.jct.core.simple.CommandBundle
-
Get a one line description of this bundle.
- getDescription() - Method in class org.dellroad.jct.core.simple.TreeMapBundle
- getEnvironment() - Method in class org.dellroad.jct.core.AbstractConsoleRequest
- getEnvironment() - Method in interface org.dellroad.jct.core.ConsoleRequest
-
Get the session's environment variables.
- getErrorStream() - Method in interface org.dellroad.jct.core.ConsoleSession
-
Get this session's error output stream.
- getErrorStream() - Method in interface org.dellroad.jct.core.ExecRequest
-
Get this request's error output stream.
- getErrorStream() - Method in interface org.dellroad.jct.core.ExecSession
-
Get this session's error output stream.
- getErrorStream() - Method in interface org.dellroad.jct.core.ShellSession
-
Get this session's error output stream.
- getErrorStream() - Method in class org.dellroad.jct.core.simple.SimpleExecRequest
- getExitValue() - Method in class org.dellroad.jct.core.AbstractShellSession
- getExitValue() - Method in interface org.dellroad.jct.core.ShellSession
-
Get the current exit value, if any.
- getGreeting() - Method in class org.dellroad.jct.core.simple.SimpleShell
-
Get the welcome greeting.
- getGreeting() - Method in class org.dellroad.jct.core.simple.SimpleShell.Session
-
Get the welcome greeting.
- getHelpDetail(String) - Method in class org.dellroad.jct.core.simple.AbstractSimpleCommand
- getHelpDetail(String) - Method in interface org.dellroad.jct.core.simple.SimpleCommand
-
Get expanded help.
- getHelpSummary(String) - Method in class org.dellroad.jct.core.simple.AbstractSimpleCommand
- getHelpSummary(String) - Method in interface org.dellroad.jct.core.simple.SimpleCommand
-
Get summarized help.
- getInputStream() - Method in class org.dellroad.jct.core.AbstractShellSession
- getInputStream() - Method in interface org.dellroad.jct.core.ConsoleSession
-
Get this session's input stream.
- getInputStream() - Method in interface org.dellroad.jct.core.ExecRequest
-
Get this request's input stream.
- getInputStream() - Method in interface org.dellroad.jct.core.ExecSession
-
Get this session's input stream.
- getInputStream() - Method in class org.dellroad.jct.core.simple.SimpleExecRequest
- getInstance() - Static method in class org.dellroad.jct.demo.DemoMain
- getJavaVersion() - Static method in class org.dellroad.jct.core.util.ConsoleUtil
-
Determine the current JDK version.
- getName() - Method in class org.dellroad.jct.core.simple.SimpleCommandSupport.FoundCommand
- getName() - Method in class org.dellroad.jct.demo.DemoMain
- getNormalPrompt() - Method in class org.dellroad.jct.core.simple.SimpleShell
-
Get the normal prompt.
- getNormalPrompt() - Method in class org.dellroad.jct.core.simple.SimpleShell.Session
-
Get the normal prompt.
- getOffset() - Method in exception org.dellroad.jct.core.simple.CommandLineParser.SyntaxException
-
Get the character offset of the error.
- getOutputStream() - Method in class org.dellroad.jct.core.AbstractShellSession
- getOutputStream() - Method in interface org.dellroad.jct.core.ConsoleSession
-
Get this session's output stream.
- getOutputStream() - Method in interface org.dellroad.jct.core.ExecRequest
-
Get this request's normal output stream.
- getOutputStream() - Method in interface org.dellroad.jct.core.ExecSession
-
Get this session's output stream.
- getOutputStream() - Method in class org.dellroad.jct.core.simple.SimpleExecRequest
- getOwner() - Method in class org.dellroad.jct.core.AbstractConsoleSession
- getOwner() - Method in interface org.dellroad.jct.core.ConsoleSession
-
Get the owner, i.e., the console component that created this session.
- getOwner() - Method in class org.dellroad.jct.core.simple.SimpleExec.Session
- getOwner() - Method in class org.dellroad.jct.core.simple.SimpleShell.Session
- getOwner() - Method in class org.dellroad.jct.jshell.JShellShellSession
- getParameters() - Method in class org.dellroad.jct.core.simple.SimpleCommandSupport.FoundCommand
- getRequest() - Method in class org.dellroad.jct.core.AbstractConsoleSession
- getRequest() - Method in interface org.dellroad.jct.core.ConsoleSession
-
Get the request from which this session was created.
- getShellArguments() - Method in interface org.dellroad.jct.core.ShellRequest
-
Get the command line arguments for the shell.
- getShellArguments() - Method in class org.dellroad.jct.core.simple.SimpleShellRequest
- getTerminal() - Method in interface org.dellroad.jct.core.ShellRequest
-
Get the associated
Terminal. - getTerminal() - Method in class org.dellroad.jct.core.simple.SimpleShellRequest
- getThreadName(ChannelSession, Environment) - Method in class org.dellroad.jct.ssh.JctExecCommand
- getUsage(String) - Method in class org.dellroad.jct.core.simple.AbstractSimpleCommand
- getUsage(String) - Method in interface org.dellroad.jct.core.simple.SimpleCommand
-
Get this command's usage string.
H
- handleChannelSignal(Channel, Signal) - Method in class org.dellroad.jct.ssh.JctExecCommand
- handleChannelSignal(Channel, Signal) - Method in class org.dellroad.jct.ssh.JctShellCommand
- HelpCommand - Class in org.dellroad.jct.core.simple.command
-
A simple "help" command that can be used with a console component extending
SimpleCommandSupport. - HelpCommand() - Constructor for class org.dellroad.jct.core.simple.command.HelpCommand
- hostKey(ClassLoader, String) - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer.Builder
-
Configure the host key to be read from a classpath resource at connection time.
- hostKey(Path) - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer.Builder
-
Configure the host key to be read from a file at connection time.
- hostKeyProvider - Variable in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer
- hostKeyProvider(KeyPairProvider) - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer.Builder
-
Configure the host key provider.
I
- in - Variable in class org.dellroad.jct.core.AbstractShellSession
- in - Variable in class org.dellroad.jct.ssh.JctExecCommand
- inferCharacterEncoding(Environment) - Static method in class org.dellroad.jct.ssh.SshUtil
-
Attempt to infer the character encoding associated with an SSH connection.
- inferLocale(Environment) - Static method in class org.dellroad.jct.ssh.SshUtil
-
Attempt to infer the locale associated with an SSH connection.
- interrruptHandler(Supplier<? extends ConsoleSession<?, ?>>, Terminal.SignalHandler) - Static method in class org.dellroad.jct.core.util.ConsoleUtil
-
Build a
Terminalsignal handler thatinterrupt()'s aConsoleSessionwhen aTerminal.Signal.INTsignal is received. - interrupt() - Method in class org.dellroad.jct.core.AbstractConsoleSession
- interrupt() - Method in interface org.dellroad.jct.core.ConsoleSession
-
Interrupt the execution of this session.
J
- JctExecCommand - Class in org.dellroad.jct.ssh
- JctExecCommand(Exec, ChannelSession, String) - Constructor for class org.dellroad.jct.ssh.JctExecCommand
- JctExecFactory - Class in org.dellroad.jct.ssh
-
An Apache MINA SSHD
CommandFactorythat connects to a Java Console ToolkitExecinstance. - JctExecFactory(Exec) - Constructor for class org.dellroad.jct.ssh.JctExecFactory
-
Constructor.
- JctShellCommand - Class in org.dellroad.jct.ssh
- JctShellCommand(Shell, ChannelSession) - Constructor for class org.dellroad.jct.ssh.JctShellCommand
- JctShellFactory - Class in org.dellroad.jct.ssh
-
An Apache MINA SSHD
ShellFactorythat connects to a Java Console ToolkitShellinstance. - JctShellFactory(Shell) - Constructor for class org.dellroad.jct.ssh.JctShellFactory
-
Constructor.
- JShellCommand - Class in org.dellroad.jct.jshell.command
-
A command that fires up a
JShellinstance. - JShellCommand() - Constructor for class org.dellroad.jct.jshell.command.JShellCommand
-
Default constructor.
- JShellCommand(JShellShell) - Constructor for class org.dellroad.jct.jshell.command.JShellCommand
-
Constructor.
- JShellCommand(JShellShell, String, String, String) - Constructor for class org.dellroad.jct.jshell.command.JShellCommand
-
Constructor.
- JShellShell - Class in org.dellroad.jct.jshell
- JShellShell() - Constructor for class org.dellroad.jct.jshell.JShellShell
- JShellShellSession - Class in org.dellroad.jct.jshell
-
A
ShellSessionthat builds and executes aJShellinstance. - JShellShellSession(JShellShell, ShellRequest) - Constructor for class org.dellroad.jct.jshell.JShellShellSession
-
Constructor.
L
- listCommands(PrintStream, Collection<? extends CommandBundle>) - Static method in class org.dellroad.jct.core.simple.command.HelpCommand
-
Pretty-print command names and descriptions.
- listenPort - Variable in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer
- listenPort(int) - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer.Builder
-
Configure the TCP port on which to listen for new connections.
- localContextClassLoader - Variable in class org.dellroad.jct.jshell.JShellShellSession
- locale - Variable in class org.dellroad.jct.ssh.JctExecCommand
- log - Variable in class org.dellroad.jct.ssh.JctExecCommand
- log - Variable in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer
- loopbackOnly - Variable in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer
- loopbackOnly(boolean) - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer.Builder
-
Configure whether to listen for new connections only on the loopback interface, or on all interfaces.
M
- main(String[]) - Static method in class org.dellroad.jct.demo.DemoMain
- mapSignalToTerminal(Signal) - Static method in class org.dellroad.jct.ssh.SshUtil
-
Map SSH channel signal to the corresponding
Terminalsignal, if able. - mapTerminalToSignal(Terminal.Signal) - Static method in class org.dellroad.jct.ssh.SshUtil
-
Map
Terminalsignal to the corresponding SSH channel signal. - modifyJShellParams(List<String>) - Method in class org.dellroad.jct.jshell.JShellShellSession
-
Generate a list of command line flags and parameters to be passed to the JShell tool, given the arguments given on the shell command line for this command.
N
- newExecSession(ExecRequest) - Method in interface org.dellroad.jct.core.Exec
-
Create a new non-interactive console session in which to execute a single command.
- newExecSession(ExecRequest) - Method in class org.dellroad.jct.core.simple.SimpleExec
- newExecSession(ExecRequest, SimpleCommandSupport.FoundCommand) - Method in class org.dellroad.jct.core.simple.SimpleExec
-
Alternate ssession creator for when the command line is already parsed and a command is already identified.
- newShellSession(ShellRequest) - Method in interface org.dellroad.jct.core.Shell
-
Create a new interactive shell session.
- newShellSession(ShellRequest) - Method in class org.dellroad.jct.core.simple.SimpleShell
- newShellSession(ShellRequest) - Method in class org.dellroad.jct.jshell.JShellShell
- newShellSession(ShellRequest, LineReader) - Method in class org.dellroad.jct.core.simple.SimpleShell
-
Alternate ssession creator for when a
LineReaderis already constructed.
O
- of(OutputStream) - Static method in class org.dellroad.jct.core.util.CrNlPrintStream
-
Create an instance using UTF-8 encoding.
- of(OutputStream, Charset) - Static method in class org.dellroad.jct.core.util.CrNlPrintStream
-
Create an instance using the specified encoding.
- of(Terminal) - Static method in class org.dellroad.jct.core.util.CrNlPrintStream
-
Create an instance appropriate for the given
Terminal's output. - org.dellroad.jct.core - package org.dellroad.jct.core
-
Core classes for the Java Console Toolkit.
- org.dellroad.jct.core.simple - package org.dellroad.jct.core.simple
-
Simple console implementation for the Java Console Toolkit.
- org.dellroad.jct.core.simple.command - package org.dellroad.jct.core.simple.command
-
A few simple commands.
- org.dellroad.jct.core.util - package org.dellroad.jct.core.util
-
Utility classes for the Java Console Toolkit.
- org.dellroad.jct.demo - package org.dellroad.jct.demo
-
Demonstration classes for the Java Console Toolkit.
- org.dellroad.jct.jshell - package org.dellroad.jct.jshell
-
Shellwrappers for JShell. - org.dellroad.jct.jshell.command - package org.dellroad.jct.jshell.command
-
JShell commands.
- org.dellroad.jct.ssh - package org.dellroad.jct.ssh
-
Classes for connecting an SSH server to the Java Console Toolkit.
- org.dellroad.jct.ssh.simple - package org.dellroad.jct.ssh.simple
-
A simple SSH server for the Java Console Toolkit.
- out - Variable in class org.dellroad.jct.core.AbstractShellSession
- out - Variable in class org.dellroad.jct.ssh.JctExecCommand
- owner - Variable in class org.dellroad.jct.core.AbstractConsoleSession
P
- parseCommandLine(String) - Method in interface org.dellroad.jct.core.simple.CommandLineParser
-
Parse the given command line into a command name and parameters.
- parseCommandLine(String) - Method in class org.dellroad.jct.core.simple.SimpleCommandLineParser
- println() - Method in class org.dellroad.jct.core.util.CrNlPrintStream
- println(boolean) - Method in class org.dellroad.jct.core.util.CrNlPrintStream
- println(char) - Method in class org.dellroad.jct.core.util.CrNlPrintStream
- println(char[]) - Method in class org.dellroad.jct.core.util.CrNlPrintStream
- println(double) - Method in class org.dellroad.jct.core.util.CrNlPrintStream
- println(float) - Method in class org.dellroad.jct.core.util.CrNlPrintStream
- println(int) - Method in class org.dellroad.jct.core.util.CrNlPrintStream
- println(long) - Method in class org.dellroad.jct.core.util.CrNlPrintStream
- println(Object) - Method in class org.dellroad.jct.core.util.CrNlPrintStream
- println(String) - Method in class org.dellroad.jct.core.util.CrNlPrintStream
- printUsage(ConsoleSession<?, ?>, String) - Method in class org.dellroad.jct.core.simple.AbstractSimpleCommand
R
- reader - Variable in class org.dellroad.jct.core.simple.SimpleShell.Session
- request - Variable in class org.dellroad.jct.core.AbstractConsoleSession
- run(String[]) - Method in class org.dellroad.jct.demo.DemoMain
S
- scanAndGenerate() - Static method in interface org.dellroad.jct.core.simple.CommandBundle
-
Scan the classpath for
CommandBundleimplementations, instantiate, and return them. - scanAndGenerate(ClassLoader) - Static method in interface org.dellroad.jct.core.simple.CommandBundle
-
Scan the classpath for
CommandBundleimplementations and instantiate and return them. - session - Variable in class org.dellroad.jct.ssh.JctExecCommand
- Session(SimpleExec, ExecRequest, SimpleCommandSupport.FoundCommand) - Constructor for class org.dellroad.jct.core.simple.SimpleExec.Session
-
Constructor.
- Session(SimpleShell, ShellRequest, LineReader) - Constructor for class org.dellroad.jct.core.simple.SimpleShell.Session
-
Constructor.
- setCommandLineParser(CommandLineParser) - Method in class org.dellroad.jct.core.simple.SimpleCommandSupport
-
Configure how command lines are parsed into separate arguments.
- setErrorStream(OutputStream) - Method in class org.dellroad.jct.ssh.JctExecCommand
- setExitCallback(ExitCallback) - Method in class org.dellroad.jct.ssh.JctExecCommand
- setExitValue(int) - Method in class org.dellroad.jct.core.AbstractShellSession
- setExitValue(int) - Method in interface org.dellroad.jct.core.ShellSession
-
Signal to the shell that it should exit with the specified exit value.
- setInputStream(InputStream) - Method in class org.dellroad.jct.ssh.JctExecCommand
- setLocalContextClassLoader(ClassLoader) - Method in class org.dellroad.jct.jshell.JShellShellSession
-
Configure a class loader to use with
LocalContextExecutionControlProviderfor local execution. - setOutputStream(OutputStream) - Method in class org.dellroad.jct.ssh.JctExecCommand
- shell - Variable in class org.dellroad.jct.core.simple.command.SubshellCommand
- shell - Variable in class org.dellroad.jct.ssh.JctShellFactory
- shell - Variable in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer
- shell(Shell) - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer.Builder
-
Configure the
Shellthat successful incoming shell connections should connect to. - Shell - Interface in org.dellroad.jct.core
-
A console component that is capable of interacting with a human via a terminal.
- ShellRequest - Interface in org.dellroad.jct.core
-
Represents a request to create a new
ShellSessionfor executing commands interactively. - ShellSession - Interface in org.dellroad.jct.core
-
A
ConsoleSessionassociated with an interactive shell. - SimpleCommand - Interface in org.dellroad.jct.core.simple
-
Implemented by commands that can be configured for a
SimpleExecorSimpleShell. - SimpleCommandLineParser - Class in org.dellroad.jct.core.simple
-
A simple command line parser: Command name and parameters are separated by whitespace Java-style doubly-quoted string literals are supported, and may span multiple lines Backslash escapes are supported for (in particular) double quote and backslash characters Backslash escapes are supported for end of line continuations to the next line
- SimpleCommandLineParser() - Constructor for class org.dellroad.jct.core.simple.SimpleCommandLineParser
- SimpleCommandSupport - Class in org.dellroad.jct.core.simple
-
Support superclass for console components that utilize
SimpleCommands. - SimpleCommandSupport() - Constructor for class org.dellroad.jct.core.simple.SimpleCommandSupport
- SimpleCommandSupport.FoundCommand - Class in org.dellroad.jct.core.simple
-
Represents a command line that has been parsed and the corresponding
SimpleCommandfound. - SimpleCompleter() - Constructor for class org.dellroad.jct.core.simple.SimpleShell.SimpleCompleter
- SimpleConsoleSshServer - Class in org.dellroad.jct.ssh.simple
- SimpleConsoleSshServer(SimpleConsoleSshServer.Builder) - Constructor for class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer
-
Constructor.
- SimpleConsoleSshServer.Builder - Class in org.dellroad.jct.ssh.simple
-
Builder for new
SimpleConsoleSshServerinstances. - SimpleExec - Class in org.dellroad.jct.core.simple
-
A simple implementation of the
Execinterface using a library ofSimpleCommands. - SimpleExec() - Constructor for class org.dellroad.jct.core.simple.SimpleExec
- SimpleExec.Session - Class in org.dellroad.jct.core.simple
-
Default
ExecSessionimplementation used bySimpleExec. - SimpleExecRequest - Class in org.dellroad.jct.core.simple
-
Straightforward implementation of the
ExecRequestinterface. - SimpleExecRequest(InputStream, PrintStream, PrintStream, Map<String, String>, String) - Constructor for class org.dellroad.jct.core.simple.SimpleExecRequest
-
Constructor.
- SimpleExecRequest(InputStream, PrintStream, PrintStream, Map<String, String>, List<String>) - Constructor for class org.dellroad.jct.core.simple.SimpleExecRequest
-
Constructor.
- SimpleShell - Class in org.dellroad.jct.core.simple
-
A simple implementation of the
Shellinterface based on a library ofSimpleCommands. - SimpleShell() - Constructor for class org.dellroad.jct.core.simple.SimpleShell
- SimpleShell.Session - Class in org.dellroad.jct.core.simple
-
Default
ShellSessionimplementation used bySimpleShell. - SimpleShell.SimpleCompleter - Class in org.dellroad.jct.core.simple
-
A simple
Completerfor command names. - SimpleShellRequest - Class in org.dellroad.jct.core.simple
-
Straightforward implementation of the
ShellRequestinterface. - SimpleShellRequest(Terminal, List<String>, Map<String, String>) - Constructor for class org.dellroad.jct.core.simple.SimpleShellRequest
-
Constructor.
- SleepCommand - Class in org.dellroad.jct.core.simple.command
-
A simple "sleep" command.
- SleepCommand() - Constructor for class org.dellroad.jct.core.simple.command.SleepCommand
- sshd - Variable in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer
- SshUtil - Class in org.dellroad.jct.ssh
-
Utility methods relating to Apache MINA SSHD.
- start() - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer
-
Start this instance.
- start(ChannelSession, Environment) - Method in class org.dellroad.jct.ssh.JctExecCommand
- stop() - Method in class org.dellroad.jct.ssh.simple.SimpleConsoleSshServer
-
Stop this instance.
- SubshellCommand - Class in org.dellroad.jct.core.simple.command
-
A command that fires up subshell sessions.
- SubshellCommand(Shell, String, String, String) - Constructor for class org.dellroad.jct.core.simple.command.SubshellCommand
-
Constructor.
- SyntaxException(int, String) - Constructor for exception org.dellroad.jct.core.simple.CommandLineParser.SyntaxException
-
Constructor.
- SyntaxException(int, String, Throwable) - Constructor for exception org.dellroad.jct.core.simple.CommandLineParser.SyntaxException
-
Constructor.
T
- toCandidate(String, SimpleCommand) - Method in class org.dellroad.jct.core.simple.SimpleShell.SimpleCompleter
- TreeMapBundle - Class in org.dellroad.jct.core.simple
-
CommandBundleimplementation usingTreeMap. - TreeMapBundle(String) - Constructor for class org.dellroad.jct.core.simple.TreeMapBundle
-
Default constructor.
- TreeMapBundle(String, Map<String, SimpleCommand>) - Constructor for class org.dellroad.jct.core.simple.TreeMapBundle
-
Constructor.
U
- unclosable(PrintStream) - Static method in class org.dellroad.jct.core.util.ConsoleUtil
-
Wrap an
PrintStreamin a new one that ignoresclose(). - updateAttributesFromEnvironment(Attributes, Environment) - Static method in class org.dellroad.jct.ssh.SshUtil
-
Update
Terminalattributes based on the given SSH connection. - updateSize(Terminal, Environment) - Static method in class org.dellroad.jct.ssh.SshUtil
-
Update
Terminalwindow size based on SSH environment variables. - usage(PrintStream) - Method in class org.dellroad.jct.demo.DemoMain
All Classes and Interfaces|All Packages|Serialized Form