Index (Vert.x Shell 5.0.0.CR1 API)

A B C D E F G H I J L N O P R S T U V W
All Classes All Packages

A

actualPort() - Method in interface io.vertx.ext.shell.term.TermServer: The actual port the server is listening on.
addCrlPath(String) - Method in class io.vertx.ext.shell.term.HttpTermOptions
addCrlPath(String) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
addCrlValue(Buffer) - Method in class io.vertx.ext.shell.term.HttpTermOptions
addCrlValue(Buffer) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
addEnabledCipherSuite(String) - Method in class io.vertx.ext.shell.term.HttpTermOptions
addEnabledCipherSuite(String) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
address - Variable in class io.vertx.ext.shell.command.base.BusPublish
AnnotatedCommand - Class in io.vertx.ext.shell.command: The base command class that Java annotated command should extend.
AnnotatedCommand() - Constructor for class io.vertx.ext.shell.command.AnnotatedCommand
args() - Method in interface io.vertx.ext.shell.command.CommandProcess
argsTokens() - Method in interface io.vertx.ext.shell.command.CommandProcess
authenticationProvider(AuthenticationProvider) - Method in interface io.vertx.ext.shell.term.TermServer: Set an auth provider to use, any provider configured in options will override this provider.

B

backgroundHandler(Handler<Void>) - Method in interface io.vertx.ext.shell.command.CommandProcess: Set a background handler, this handler is called when the command is running and put to background.
BASE64 - io.vertx.ext.shell.command.base.ObjectType
BaseCommandPack - Class in io.vertx.ext.shell.command.base
BaseCommandPack(Vertx) - Constructor for class io.vertx.ext.shell.command.base.BaseCommandPack
baseCommands(Vertx) - Static method in interface io.vertx.ext.shell.command.CommandResolver
body - Variable in class io.vertx.ext.shell.command.base.BusPublish
BOOLEAN - io.vertx.ext.shell.command.base.ObjectType
BUFFER - io.vertx.ext.shell.command.base.ObjectType
build(Vertx) - Method in interface io.vertx.ext.shell.command.CommandBuilder: Build the command
BusPublish - Class in io.vertx.ext.shell.command.base
BusPublish() - Constructor for class io.vertx.ext.shell.command.base.BusPublish
BusSend - Class in io.vertx.ext.shell.command.base
BusSend() - Constructor for class io.vertx.ext.shell.command.base.BusSend
BusTail - Class in io.vertx.ext.shell.command.base
BusTail() - Constructor for class io.vertx.ext.shell.command.base.BusTail
BYTE - io.vertx.ext.shell.command.base.ObjectType

C

CHARACTER - io.vertx.ext.shell.command.base.ObjectType
cli() - Method in class io.vertx.ext.shell.command.AnnotatedCommand
cli() - Method in class io.vertx.ext.shell.command.base.Echo
cli() - Method in interface io.vertx.ext.shell.command.Command
CliToken - Interface in io.vertx.ext.shell.cli: A parsed token in the command line interface.
close() - Method in interface io.vertx.ext.shell.Shell: Close the shell.
close() - Method in interface io.vertx.ext.shell.ShellServer: Close the shell server, this is an asynchronous close.
close() - Method in interface io.vertx.ext.shell.system.JobController: Close the shell session and terminate all the underlying jobs.
close() - Method in interface io.vertx.ext.shell.term.Term: Close the connection to terminal.
close() - Method in interface io.vertx.ext.shell.term.TermServer: Close the server.
close(Handler<Void>) - Method in interface io.vertx.ext.shell.system.JobController: Close the controller and terminate all the underlying jobs, a closed controller does not accept anymore jobs.
closeHandler(Handler<Void>) - Method in interface io.vertx.ext.shell.term.Term: Set a handler that will be called when the terminal is closed.
command(CLI) - Static method in interface io.vertx.ext.shell.command.CommandBuilder: Create a new commmand with its CLI descriptor.
command(String) - Static method in interface io.vertx.ext.shell.command.CommandBuilder: Create a new commmand builder, the command is responsible for managing the options and arguments via the arguments.
Command - Interface in io.vertx.ext.shell.command: A Vert.x Shell command, it can be created from any language using the CommandBuilder.command(java.lang.String) or from a Java class using Command.create(io.vertx.core.Vertx, java.lang.Class<? extends io.vertx.ext.shell.command.AnnotatedCommand>)
CommandBuilder - Interface in io.vertx.ext.shell.command: A build for Vert.x Shell command.
commandLine() - Method in interface io.vertx.ext.shell.command.CommandProcess
CommandProcess - Interface in io.vertx.ext.shell.command: The command process provides interaction with the process of the command provided by Vert.x Shell.
CommandRegistry - Interface in io.vertx.ext.shell.command: A registry that contains the commands known by a shell.
CommandResolver - Interface in io.vertx.ext.shell.command: A resolver for commands, so the shell can discover commands.
CommandResolverFactory - Interface in io.vertx.ext.shell.spi: The SPI interface for discovering commands.
commands() - Method in class io.vertx.ext.shell.command.base.BaseCommandPack
commands() - Method in interface io.vertx.ext.shell.command.CommandResolver
complete(Completion) - Method in class io.vertx.ext.shell.command.AnnotatedCommand: Perform command completion, when the command is done completing it should call Completion.complete(List) or Completion.complete(String, boolean) )} method to signal completion is done.
complete(Completion) - Method in class io.vertx.ext.shell.command.base.FileSystemCd
complete(Completion) - Method in class io.vertx.ext.shell.command.base.FileSystemLs
complete(Completion) - Method in interface io.vertx.ext.shell.command.Command: Perform command completion, when the command is done completing it should call Completion.complete(List) or Completion.complete(String, boolean) )} method to signal completion is done.
complete(String, boolean) - Method in interface io.vertx.ext.shell.cli.Completion: End the completion with a value that will be inserted to complete the line.
complete(List<String>) - Method in interface io.vertx.ext.shell.cli.Completion: End the completion with a list of candidates, these candidates will be displayed by the shell on the console.
Completion - Interface in io.vertx.ext.shell.cli: The completion object
completionHandler(Handler<Completion>) - Method in interface io.vertx.ext.shell.command.CommandBuilder: Set the command completion handler, the completion handler when the user asks for contextual command line completion, usually hitting the tab key.
create() - Static method in interface io.vertx.ext.shell.session.Session: Create a new empty session.
create() - Static method in interface io.vertx.ext.shell.term.Pty: Create a new pseudo terminal with no terminal type.
create(Vertx) - Static method in interface io.vertx.ext.shell.command.CommandRegistry: Create a new registry.
create(Vertx) - Static method in interface io.vertx.ext.shell.ShellServer: Create a new shell server with specific options.
create(Vertx) - Static method in interface io.vertx.ext.shell.ShellService: Like ShellService.create(Vertx, ShellServiceOptions), with default options.
create(Vertx, ShellServerOptions) - Static method in interface io.vertx.ext.shell.ShellServer: Create a new shell server with default options.
create(Vertx, ShellServiceOptions) - Static method in interface io.vertx.ext.shell.ShellService: Create a new shell service.
create(Vertx, Class<? extends AnnotatedCommand>) - Static method in interface io.vertx.ext.shell.command.Command: Create a command from a Java class, annotated with Vert.x Core CLI annotations.
create(Vertx, String) - Static method in interface io.vertx.ext.shell.term.SockJSTermHandler
create(String) - Static method in interface io.vertx.ext.shell.term.Pty: Create a new pseudo terminal.
createBlank(String) - Static method in interface io.vertx.ext.shell.cli.CliToken: Create a new blank token.
createHttpTermServer(Vertx) - Static method in interface io.vertx.ext.shell.term.TermServer: Create a term server for the HTTP protocol.
createHttpTermServer(Vertx, HttpTermOptions) - Static method in interface io.vertx.ext.shell.term.TermServer: Create a term server for the HTTP protocol.
createHttpTermServer(Vertx, Router) - Static method in interface io.vertx.ext.shell.term.TermServer: Create a term server for the HTTP protocol, using an existing router.
createHttpTermServer(Vertx, Router, HttpTermOptions) - Static method in interface io.vertx.ext.shell.term.TermServer: Create a term server for the HTTP protocol, using an existing router.
createJob(Process, String) - Method in interface io.vertx.ext.shell.system.JobController: Create a job wrapping a process.
createJob(String) - Method in interface io.vertx.ext.shell.Shell: See Shell.createJob(List)
createJob(List<CliToken>) - Method in interface io.vertx.ext.shell.Shell: Create a job, the created job should then be executed with the Job.run() method.
createProcess() - Method in interface io.vertx.ext.shell.command.Command: Create a new process with empty arguments.
createProcess(List<CliToken>) - Method in interface io.vertx.ext.shell.command.Command: Create a new process with the passed arguments.
createShell() - Method in interface io.vertx.ext.shell.ShellServer: Create a new shell, the returned shell should be closed explicitely.
createShell(Term) - Method in interface io.vertx.ext.shell.ShellServer: Create a new shell, the returned shell should be closed explicitely.
createSSHTermServer(Vertx) - Static method in interface io.vertx.ext.shell.term.TermServer: Create a term server for the SSH protocol.
createSSHTermServer(Vertx, SSHTermOptions) - Static method in interface io.vertx.ext.shell.term.TermServer: Create a term server for the SSH protocol.
createTelnetTermServer(Vertx) - Static method in interface io.vertx.ext.shell.term.TermServer: Create a term server for the Telnet protocol.
createTelnetTermServer(Vertx, TelnetTermOptions) - Static method in interface io.vertx.ext.shell.term.TermServer: Create a term server for the Telnet protocol.
createText(String) - Static method in interface io.vertx.ext.shell.cli.CliToken: Create a text token.

D

DEFAULT_CHARSET - Static variable in class io.vertx.ext.shell.term.HttpTermOptions
DEFAULT_CHARSET - Static variable in class io.vertx.ext.shell.term.TelnetTermOptions
DEFAULT_DEFAULT_CHARSET - Static variable in class io.vertx.ext.shell.term.SSHTermOptions
DEFAULT_HOST - Static variable in class io.vertx.ext.shell.term.SSHTermOptions
DEFAULT_IN_BINARY - Static variable in class io.vertx.ext.shell.term.TelnetTermOptions
DEFAULT_INPUTRC - Static variable in class io.vertx.ext.shell.term.HttpTermOptions
DEFAULT_INPUTRC - Static variable in class io.vertx.ext.shell.term.SSHTermOptions
DEFAULT_INPUTRC - Static variable in class io.vertx.ext.shell.term.TelnetTermOptions
DEFAULT_OUT_BINARY - Static variable in class io.vertx.ext.shell.term.TelnetTermOptions
DEFAULT_PORT - Static variable in class io.vertx.ext.shell.term.SSHTermOptions
DEFAULT_REAPER_INTERVAL - Static variable in class io.vertx.ext.shell.ShellServerOptions: Default of how often, in ms, to check for expired sessions
DEFAULT_SESSION_TIMEOUT - Static variable in class io.vertx.ext.shell.ShellServerOptions: Default time, in ms, that a shell session lasts for without being accessed before expiring.
DEFAULT_WELCOME_MESSAGE - Static variable in class io.vertx.ext.shell.ShellServerOptions
defaultShellHtmlResource() - Static method in class io.vertx.ext.shell.term.HttpTermOptions
defaultTermJsResource() - Static method in class io.vertx.ext.shell.term.HttpTermOptions
defaultVertxShellJsResource() - Static method in class io.vertx.ext.shell.term.HttpTermOptions
deliver(int) - Method in interface io.vertx.ext.shell.term.SignalHandler
DOUBLE - io.vertx.ext.shell.command.base.ObjectType

E

echo(String) - Method in interface io.vertx.ext.shell.term.Term: Echo some text in the terminal, escaped if necessary.
Echo - Class in io.vertx.ext.shell.command.base
Echo() - Constructor for class io.vertx.ext.shell.command.base.Echo
end() - Method in interface io.vertx.ext.shell.command.CommandProcess: End the process with the exit status 0
end(int) - Method in interface io.vertx.ext.shell.command.CommandProcess: End the process.
endHandler(Handler<Void>) - Method in interface io.vertx.ext.shell.command.CommandProcess: Set an end handler, this handler is called when the command is ended, for instance the command is running and the shell closes.
ExecStatus - Enum in io.vertx.ext.shell.system: The status of an execution.
exitCode() - Method in interface io.vertx.ext.shell.system.Process

F

FileSystemCd - Class in io.vertx.ext.shell.command.base
FileSystemCd() - Constructor for class io.vertx.ext.shell.command.base.FileSystemCd
FileSystemLs - Class in io.vertx.ext.shell.command.base
FileSystemLs() - Constructor for class io.vertx.ext.shell.command.base.FileSystemLs
FileSystemPwd - Class in io.vertx.ext.shell.command.base
FileSystemPwd() - Constructor for class io.vertx.ext.shell.command.base.FileSystemPwd
findLongestCommonPrefix(Collection<String>) - Static method in interface io.vertx.ext.shell.cli.Completion
FLOAT - io.vertx.ext.shell.command.base.ObjectType
foregroundHandler(Handler<Void>) - Method in interface io.vertx.ext.shell.command.CommandProcess: Set a foreground handler, this handler is called when the command is running and put to foreground.
foregroundJob() - Method in interface io.vertx.ext.shell.system.JobController

G

get(String) - Method in interface io.vertx.ext.shell.session.Session: Get some data from the session
getAuthOptions() - Method in class io.vertx.ext.shell.term.HttpTermOptions
getAuthOptions() - Method in class io.vertx.ext.shell.term.SSHTermOptions
getCharset() - Method in class io.vertx.ext.shell.term.HttpTermOptions
getCharset() - Method in class io.vertx.ext.shell.term.TelnetTermOptions
getCommand(String) - Method in interface io.vertx.ext.shell.command.CommandResolver: Returns a single command by its name.
getDefaultCharset() - Method in class io.vertx.ext.shell.term.SSHTermOptions
getDeploymentOptions() - Method in class io.vertx.ext.shell.command.base.VerticleDeploy
getHost() - Method in class io.vertx.ext.shell.term.SSHTermOptions
getHttpOptions() - Method in class io.vertx.ext.shell.ShellServiceOptions
getInBinary() - Method in class io.vertx.ext.shell.term.TelnetTermOptions
getIntputrc() - Method in class io.vertx.ext.shell.term.HttpTermOptions
getIntputrc() - Method in class io.vertx.ext.shell.term.SSHTermOptions
getIntputrc() - Method in class io.vertx.ext.shell.term.TelnetTermOptions
getJob(int) - Method in interface io.vertx.ext.shell.system.JobController: Returns an active job in this session by its id.
getKeyPairOptions() - Method in class io.vertx.ext.shell.term.SSHTermOptions
getOutBinary() - Method in class io.vertx.ext.shell.term.TelnetTermOptions
getPort() - Method in class io.vertx.ext.shell.term.SSHTermOptions
getReaperInterval() - Method in class io.vertx.ext.shell.ShellServerOptions
getSession() - Method in interface io.vertx.ext.shell.system.Process
getSessionTimeout() - Method in class io.vertx.ext.shell.ShellServerOptions
getShared(Vertx) - Static method in interface io.vertx.ext.shell.command.CommandRegistry: Get the shared registry for the Vert.x instance.
getShellHtmlResource() - Method in class io.vertx.ext.shell.term.HttpTermOptions
getSockJSHandlerOptions() - Method in class io.vertx.ext.shell.term.HttpTermOptions
getSockJSPath() - Method in class io.vertx.ext.shell.term.HttpTermOptions
getSSHOptions() - Method in class io.vertx.ext.shell.ShellServiceOptions
getTelnetOptions() - Method in class io.vertx.ext.shell.ShellServiceOptions
getTermJsResource() - Method in class io.vertx.ext.shell.term.HttpTermOptions
getTty() - Method in interface io.vertx.ext.shell.system.Process
getVertsShellJsResource() - Method in class io.vertx.ext.shell.term.HttpTermOptions
getWelcomeMessage() - Method in class io.vertx.ext.shell.ShellServerOptions

H

height() - Method in interface io.vertx.ext.shell.term.Tty
Help - Class in io.vertx.ext.shell.command.base
Help() - Constructor for class io.vertx.ext.shell.command.base.Help
HEX - io.vertx.ext.shell.command.base.ObjectType
HttpTermOptions - Class in io.vertx.ext.shell.term: The web term configuration options.
HttpTermOptions() - Constructor for class io.vertx.ext.shell.term.HttpTermOptions
HttpTermOptions(JsonObject) - Constructor for class io.vertx.ext.shell.term.HttpTermOptions
HttpTermOptions(HttpTermOptions) - Constructor for class io.vertx.ext.shell.term.HttpTermOptions
HttpTermOptionsConverter - Class in io.vertx.ext.shell.term: Converter and mapper for HttpTermOptions.
HttpTermOptionsConverter() - Constructor for class io.vertx.ext.shell.term.HttpTermOptionsConverter

I

id() - Method in interface io.vertx.ext.shell.system.Job
INTEGER - io.vertx.ext.shell.command.base.ObjectType
interrupt() - Method in interface io.vertx.ext.shell.system.Job: Attempt to interrupt the job.
interrupt() - Method in interface io.vertx.ext.shell.system.Process: Attempt to interrupt the process.
interrupt(Handler<Void>) - Method in interface io.vertx.ext.shell.system.Process: Attempt to interrupt the process.
interruptHandler(Handler<Void>) - Method in interface io.vertx.ext.shell.command.CommandProcess: Set an interrupt handler, this handler is called when the command is interrupted, for instance user press Ctrl-C.
interruptHandler(SignalHandler) - Method in interface io.vertx.ext.shell.term.Term: Set an interrupt signal handler on the term.
io.vertx.ext.shell - package io.vertx.ext.shell
io.vertx.ext.shell.cli - package io.vertx.ext.shell.cli
io.vertx.ext.shell.command - package io.vertx.ext.shell.command
io.vertx.ext.shell.command.base - package io.vertx.ext.shell.command.base
io.vertx.ext.shell.session - package io.vertx.ext.shell.session
io.vertx.ext.shell.spi - package io.vertx.ext.shell.spi
io.vertx.ext.shell.system - package io.vertx.ext.shell.system
io.vertx.ext.shell.term - package io.vertx.ext.shell.term
isBlank() - Method in interface io.vertx.ext.shell.cli.CliToken
isForeground() - Method in interface io.vertx.ext.shell.command.CommandProcess
isText() - Method in interface io.vertx.ext.shell.cli.CliToken

J

Job - Interface in io.vertx.ext.shell.system: A job executed in a JobController, grouping one or several process.
jobController() - Method in interface io.vertx.ext.shell.Shell
JobController - Interface in io.vertx.ext.shell.system: The job controller.
jobs() - Method in interface io.vertx.ext.shell.system.JobController
JSON_ARRAY - io.vertx.ext.shell.command.base.ObjectType
JSON_OBJECT - io.vertx.ext.shell.command.base.ObjectType

L

lastAccessedTime() - Method in interface io.vertx.ext.shell.term.Term
lastStopped() - Method in interface io.vertx.ext.shell.system.Job
line() - Method in interface io.vertx.ext.shell.system.Job
lineTokens() - Method in interface io.vertx.ext.shell.cli.Completion
listen() - Method in interface io.vertx.ext.shell.ShellServer: Start the shell service, this is an asynchronous start.
listen() - Method in interface io.vertx.ext.shell.term.TermServer: Bind the term server, the TermServer.termHandler(Handler) must be set before.
LocalMapGet - Class in io.vertx.ext.shell.command.base
LocalMapGet() - Constructor for class io.vertx.ext.shell.command.base.LocalMapGet
LocalMapPut - Class in io.vertx.ext.shell.command.base
LocalMapPut() - Constructor for class io.vertx.ext.shell.command.base.LocalMapPut
LocalMapRm - Class in io.vertx.ext.shell.command.base
LocalMapRm() - Constructor for class io.vertx.ext.shell.command.base.LocalMapRm
LONG - io.vertx.ext.shell.command.base.ObjectType

N

name() - Method in class io.vertx.ext.shell.command.AnnotatedCommand
name() - Method in class io.vertx.ext.shell.command.base.Echo
name() - Method in interface io.vertx.ext.shell.command.Command
NetCommandLs - Class in io.vertx.ext.shell.command.base
NetCommandLs() - Constructor for class io.vertx.ext.shell.command.base.NetCommandLs

O

ObjectType - Enum in io.vertx.ext.shell.command.base
options - Variable in class io.vertx.ext.shell.command.base.BusPublish

P

parseBody() - Method in class io.vertx.ext.shell.command.base.BusPublish
process() - Method in interface io.vertx.ext.shell.system.Job
process(CommandProcess) - Method in class io.vertx.ext.shell.command.AnnotatedCommand: Process the command, when the command is done processing it should call the CommandProcess.end() method.
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.BusPublish
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.BusSend
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.BusTail
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.Echo
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.FileSystemCd
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.FileSystemLs
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.FileSystemPwd
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.Help
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.LocalMapGet
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.LocalMapPut
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.LocalMapRm
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.NetCommandLs
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.Sleep
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.VerticleDeploy
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.VerticleFactories
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.VerticleLs
process(CommandProcess) - Method in class io.vertx.ext.shell.command.base.VerticleUndeploy
Process - Interface in io.vertx.ext.shell.system: A process managed by the shell.
processHandler(Handler<CommandProcess>) - Method in interface io.vertx.ext.shell.command.CommandBuilder: Set the command process handler, the process handler is called when the command is executed.
Pty - Interface in io.vertx.ext.shell.term: A pseudo terminal used for controlling a Tty.
put(String, Object) - Method in interface io.vertx.ext.shell.session.Session: Put some data in a session

R

raw() - Method in interface io.vertx.ext.shell.cli.CliToken
rawLine() - Method in interface io.vertx.ext.shell.cli.Completion
readline(String, Handler<String>) - Method in interface io.vertx.ext.shell.term.Term: Prompt the user a line of text.
readline(String, Handler<String>, Handler<Completion>) - Method in interface io.vertx.ext.shell.term.Term: Prompt the user a line of text, providing a completion handler to handle user's completion.
READY - io.vertx.ext.shell.system.ExecStatus: The job is ready, it can be running or terminated.
registerCommand(Command) - Method in interface io.vertx.ext.shell.command.CommandRegistry: Register a command
registerCommand(Class<? extends AnnotatedCommand>) - Method in interface io.vertx.ext.shell.command.CommandRegistry: Register a single command.
registerCommandResolver(CommandResolver) - Method in interface io.vertx.ext.shell.ShellServer: Register a command resolver for this server.
registerCommands(List<Command>) - Method in interface io.vertx.ext.shell.command.CommandRegistry: Register a list of commands.
registerTermServer(TermServer) - Method in interface io.vertx.ext.shell.ShellServer: Register a term server to this shell server, the term server lifecycle methods are managed by this shell server.
remove(String) - Method in interface io.vertx.ext.shell.session.Session: Remove some data from the session
resizehandler(Handler<Void>) - Method in interface io.vertx.ext.shell.command.CommandProcess
resizehandler(Handler<Void>) - Method in interface io.vertx.ext.shell.term.Term
resizehandler(Handler<Void>) - Method in interface io.vertx.ext.shell.term.Tty: Set a resize handler, the handler is called when the tty size changes.
resolver(Vertx, Handler<AsyncResult<CommandResolver>>) - Method in interface io.vertx.ext.shell.spi.CommandResolverFactory: Obtain a command resolver for a Vert.x instance.
resume() - Method in interface io.vertx.ext.shell.system.Job: Resume the job to foreground.
resume() - Method in interface io.vertx.ext.shell.system.Process: Suspend the process.
resume(boolean) - Method in interface io.vertx.ext.shell.system.Job: Resume the job.
resume(boolean) - Method in interface io.vertx.ext.shell.system.Process: Suspend the process.
resume(boolean, Handler<Void>) - Method in interface io.vertx.ext.shell.system.Process: Suspend the process.
resume(Handler<Void>) - Method in interface io.vertx.ext.shell.system.Process: Suspend the process.
resumeHandler(Handler<Void>) - Method in interface io.vertx.ext.shell.command.CommandProcess: Set a resume handler, this handler is called when the command is resumed, for instance user types bg or fg to resume the command.
run() - Method in interface io.vertx.ext.shell.system.Job: Run the job, before running the job a Tty must be set.
run() - Method in interface io.vertx.ext.shell.system.Process: Run the process.
run(boolean) - Method in interface io.vertx.ext.shell.system.Process: Run the process.
RUNNING - io.vertx.ext.shell.system.ExecStatus: The job is running, it can be stopped or terminated.

S

server() - Method in interface io.vertx.ext.shell.ShellService
session() - Method in interface io.vertx.ext.shell.cli.Completion
session() - Method in interface io.vertx.ext.shell.command.CommandProcess
session() - Method in interface io.vertx.ext.shell.Shell
Session - Interface in io.vertx.ext.shell.session: A shell session.
setAcceptBacklog(int) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setAcceptBacklog(int) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
setAddress(String) - Method in class io.vertx.ext.shell.command.base.BusPublish
setAddresses(List<String>) - Method in class io.vertx.ext.shell.command.base.BusTail
setAll(boolean) - Method in class io.vertx.ext.shell.command.base.FileSystemLs
setAuthOptions(JsonObject) - Method in class io.vertx.ext.shell.term.HttpTermOptions: Set the auth options.
setAuthOptions(JsonObject) - Method in class io.vertx.ext.shell.term.SSHTermOptions: Set the auth options.
setBody(String) - Method in class io.vertx.ext.shell.command.base.BusPublish
setCharset(String) - Method in class io.vertx.ext.shell.term.HttpTermOptions: Set the charset used for encoding / decoding text data from/to SockJS
setCharset(String) - Method in class io.vertx.ext.shell.term.TelnetTermOptions: Set the charset to use when binary mode is active, see TelnetTermOptions.setInBinary(boolean) and TelnetTermOptions.setOutBinary(boolean).
setClientAuth(ClientAuth) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setCompressionSupported(boolean) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setDefaultCharset(String) - Method in class io.vertx.ext.shell.term.SSHTermOptions: Set the default charset to use when the client does not specifies one.
setDir(String) - Method in class io.vertx.ext.shell.command.base.FileSystemCd
setEll(boolean) - Method in class io.vertx.ext.shell.command.base.FileSystemLs
setFile(String) - Method in class io.vertx.ext.shell.command.base.FileSystemLs
setHandle100ContinueAutomatically(boolean) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setHeaders(List<String>) - Method in class io.vertx.ext.shell.command.base.BusPublish
setHost(String) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setHost(String) - Method in class io.vertx.ext.shell.term.SSHTermOptions: Set the host
setHost(String) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
setHttpOptions(HttpTermOptions) - Method in class io.vertx.ext.shell.ShellServiceOptions
setId(String) - Method in class io.vertx.ext.shell.command.base.VerticleUndeploy
setIdleTimeout(int) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setIdleTimeout(int) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
setInBinary(boolean) - Method in class io.vertx.ext.shell.term.TelnetTermOptions: Set the telnet connection to negociate binary data format when receiving from the client, the default value is true.
setIntputrc(String) - Method in class io.vertx.ext.shell.term.HttpTermOptions: The path of the inputrc config.
setIntputrc(String) - Method in class io.vertx.ext.shell.term.SSHTermOptions: The path of the inputrc config.
setIntputrc(String) - Method in class io.vertx.ext.shell.term.TelnetTermOptions: The path of the inputrc config.
setKey(String) - Method in class io.vertx.ext.shell.command.base.LocalMapPut
setKeyPairOptions(JksOptions) - Method in class io.vertx.ext.shell.term.SSHTermOptions: Set the key pair options in jks format, aka Java keystore.
setKeys(List<String>) - Method in class io.vertx.ext.shell.command.base.LocalMapGet
setKeys(List<String>) - Method in class io.vertx.ext.shell.command.base.LocalMapRm
setLocal(boolean) - Method in class io.vertx.ext.shell.command.base.BusTail
setMap(String) - Method in class io.vertx.ext.shell.command.base.LocalMapGet
setMap(String) - Method in class io.vertx.ext.shell.command.base.LocalMapPut
setMap(String) - Method in class io.vertx.ext.shell.command.base.LocalMapRm
setName(String) - Method in class io.vertx.ext.shell.command.base.VerticleDeploy
setOptions(String) - Method in class io.vertx.ext.shell.command.base.VerticleDeploy
setOutBinary(boolean) - Method in class io.vertx.ext.shell.term.TelnetTermOptions: Set the telnet connection to negociate binary data format when sending to the client, the default value is true.
setPemKeyPairOptions(PemKeyCertOptions) - Method in class io.vertx.ext.shell.term.SSHTermOptions: Set the key pair store options in pem format.
setPfxKeyPairOptions(PfxOptions) - Method in class io.vertx.ext.shell.term.SSHTermOptions: Set the key pair options in pfx format.
setPort(int) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setPort(int) - Method in class io.vertx.ext.shell.term.SSHTermOptions: Set the port
setPort(int) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
setPrompt(Function<Session, String>) - Method in interface io.vertx.ext.shell.Shell: Set a new prompt in this session.
setReaperInterval(long) - Method in class io.vertx.ext.shell.ShellServerOptions: Set the repear interval, i.e the period at which session eviction is performed.
setReaperInterval(long) - Method in class io.vertx.ext.shell.ShellServiceOptions
setReceiveBufferSize(int) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setReceiveBufferSize(int) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
setReply(boolean) - Method in class io.vertx.ext.shell.command.base.BusSend
setReuseAddress(boolean) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setReuseAddress(boolean) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
setSeconds(String) - Method in class io.vertx.ext.shell.command.base.Sleep
setSendBufferSize(int) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setSendBufferSize(int) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
setSession(Session) - Method in interface io.vertx.ext.shell.system.Job: Set a session on the job.
setSession(Session) - Method in interface io.vertx.ext.shell.system.Process: Set the process session
setSession(Session) - Method in interface io.vertx.ext.shell.term.Term: Associate the term with a session.
setSessionTimeout(long) - Method in class io.vertx.ext.shell.ShellServerOptions: Set the session timeout.
setSessionTimeout(long) - Method in class io.vertx.ext.shell.ShellServiceOptions
setShellHtmlResource(Buffer) - Method in class io.vertx.ext.shell.term.HttpTermOptions: Set shell.html resource to use.
setSize(int, int) - Method in interface io.vertx.ext.shell.term.Pty: Resize the terminal.
setSockJSHandlerOptions(SockJSHandlerOptions) - Method in class io.vertx.ext.shell.term.HttpTermOptions: The SockJS handler options.
setSockJSPath(String) - Method in class io.vertx.ext.shell.term.HttpTermOptions: Configure the SockJS path, the default value is /term/*.
setSoLinger(int) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setSoLinger(int) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
setSSHOptions(SSHTermOptions) - Method in class io.vertx.ext.shell.ShellServiceOptions: Set the SSH options, if the option is null, SSH will not be started.
setSsl(boolean) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setSsl(boolean) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
setTcpKeepAlive(boolean) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setTcpKeepAlive(boolean) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
setTcpNoDelay(boolean) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setTcpNoDelay(boolean) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
setTelnetOptions(TelnetTermOptions) - Method in class io.vertx.ext.shell.ShellServiceOptions: Set the Telnet options, if the option is null, Telnet will not be started.
setTermJsResource(Buffer) - Method in class io.vertx.ext.shell.term.HttpTermOptions: Set term.js resource to use.
setTimeout(long) - Method in class io.vertx.ext.shell.command.base.BusSend
setTrafficClass(int) - Method in class io.vertx.ext.shell.term.HttpTermOptions
setTrafficClass(int) - Method in class io.vertx.ext.shell.term.TelnetTermOptions
setTty(Tty) - Method in interface io.vertx.ext.shell.system.Job: Set a tty on the job.
setTty(Tty) - Method in interface io.vertx.ext.shell.system.Process: Set the process tty.
setType(ObjectType) - Method in class io.vertx.ext.shell.command.base.BusPublish
setValue(String) - Method in class io.vertx.ext.shell.command.base.LocalMapPut
setVerbose(boolean) - Method in class io.vertx.ext.shell.command.base.BusPublish
setVerbose(boolean) - Method in class io.vertx.ext.shell.command.base.BusTail
setVertsShellJsResource(Buffer) - Method in class io.vertx.ext.shell.term.HttpTermOptions: Set vertxshell.js resource to use.
setWelcomeMessage(String) - Method in class io.vertx.ext.shell.ShellServerOptions: Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.
setWelcomeMessage(String) - Method in class io.vertx.ext.shell.ShellServiceOptions
Shell - Interface in io.vertx.ext.shell: An interactive session between a consumer and a shell.
shellHandler(Handler<Shell>) - Method in interface io.vertx.ext.shell.ShellServer: Called when a new shell is created.
ShellServer - Interface in io.vertx.ext.shell: The shell server.
ShellServerOptions - Class in io.vertx.ext.shell: The configurations options for the shell server.
ShellServerOptions() - Constructor for class io.vertx.ext.shell.ShellServerOptions
ShellServerOptions(JsonObject) - Constructor for class io.vertx.ext.shell.ShellServerOptions
ShellServerOptions(ShellServerOptions) - Constructor for class io.vertx.ext.shell.ShellServerOptions
ShellServerOptionsConverter - Class in io.vertx.ext.shell: Converter and mapper for ShellServerOptions.
ShellServerOptionsConverter() - Constructor for class io.vertx.ext.shell.ShellServerOptionsConverter
ShellService - Interface in io.vertx.ext.shell: The shell service, provides a remotely accessible shell available via Telnet or SSH according to the ShellServiceOptions configuration.
ShellServiceOptions - Class in io.vertx.ext.shell: The configurations options for the shell service, the shell connectors can be configured with TelnetTermOptions, SSHTermOptions and HttpTermOptions.
ShellServiceOptions() - Constructor for class io.vertx.ext.shell.ShellServiceOptions
ShellServiceOptions(JsonObject) - Constructor for class io.vertx.ext.shell.ShellServiceOptions
ShellServiceOptions(ShellServiceOptions) - Constructor for class io.vertx.ext.shell.ShellServiceOptions
ShellServiceOptionsConverter - Class in io.vertx.ext.shell: Converter and mapper for ShellServiceOptions.
ShellServiceOptionsConverter() - Constructor for class io.vertx.ext.shell.ShellServiceOptionsConverter
ShellVerticle - Class in io.vertx.ext.shell
ShellVerticle() - Constructor for class io.vertx.ext.shell.ShellVerticle
SHORT - io.vertx.ext.shell.command.base.ObjectType
SignalHandler - Interface in io.vertx.ext.shell.term
slave() - Method in interface io.vertx.ext.shell.term.Pty
Sleep - Class in io.vertx.ext.shell.command.base
Sleep() - Constructor for class io.vertx.ext.shell.command.base.Sleep
SockJSTermHandler - Interface in io.vertx.ext.shell.term
SSHTermOptions - Class in io.vertx.ext.shell.term: The SSH term configuration options.
SSHTermOptions() - Constructor for class io.vertx.ext.shell.term.SSHTermOptions
SSHTermOptions(JsonObject) - Constructor for class io.vertx.ext.shell.term.SSHTermOptions
SSHTermOptions(SSHTermOptions) - Constructor for class io.vertx.ext.shell.term.SSHTermOptions
SSHTermOptionsConverter - Class in io.vertx.ext.shell.term: Converter and mapper for SSHTermOptions.
SSHTermOptionsConverter() - Constructor for class io.vertx.ext.shell.term.SSHTermOptionsConverter
start() - Method in interface io.vertx.ext.shell.ShellService: Start the shell service, this is an asynchronous start.
start(Promise<Void>) - Method in class io.vertx.ext.shell.ShellVerticle
status() - Method in interface io.vertx.ext.shell.system.Job
status() - Method in interface io.vertx.ext.shell.system.Process
statusUpdateHandler(Handler<ExecStatus>) - Method in interface io.vertx.ext.shell.system.Job: Set an handler called when the job terminates.
stdinHandler(Handler<String>) - Method in interface io.vertx.ext.shell.command.CommandProcess
stdinHandler(Handler<String>) - Method in interface io.vertx.ext.shell.term.Term
stdinHandler(Handler<String>) - Method in interface io.vertx.ext.shell.term.Tty: Set a stream handler on the standard input to read the data.
stdoutHandler(Handler<String>) - Method in interface io.vertx.ext.shell.term.Pty: Set the standard out handler of the pseudo terminal.
stop() - Method in interface io.vertx.ext.shell.ShellService: Stop the shell service, this is an asynchronous stop.
STOPPED - io.vertx.ext.shell.system.ExecStatus: The job is stopped, it can be running or terminated.
STRING - io.vertx.ext.shell.command.base.ObjectType
suspend() - Method in interface io.vertx.ext.shell.system.Job: Resume the job.
suspend() - Method in interface io.vertx.ext.shell.system.Process: Resume the process.
suspend(Handler<Void>) - Method in interface io.vertx.ext.shell.system.Process: Resume the process.
suspendHandler(Handler<Void>) - Method in interface io.vertx.ext.shell.command.CommandProcess: Set a suspend handler, this handler is called when the command is suspended, for instance user press Ctrl-Z.
suspendHandler(SignalHandler) - Method in interface io.vertx.ext.shell.term.Term: Set a suspend signal handler on the term.

T

TelnetTermOptions - Class in io.vertx.ext.shell.term: Telnet terminal options configuration, extends NetServerOptions.
TelnetTermOptions() - Constructor for class io.vertx.ext.shell.term.TelnetTermOptions
TelnetTermOptions(JsonObject) - Constructor for class io.vertx.ext.shell.term.TelnetTermOptions
TelnetTermOptions(TelnetTermOptions) - Constructor for class io.vertx.ext.shell.term.TelnetTermOptions
TelnetTermOptionsConverter - Class in io.vertx.ext.shell.term: Converter and mapper for TelnetTermOptions.
TelnetTermOptionsConverter() - Constructor for class io.vertx.ext.shell.term.TelnetTermOptionsConverter
Term - Interface in io.vertx.ext.shell.term: The terminal.
termHandler(Handler<Term>) - Method in interface io.vertx.ext.shell.term.SockJSTermHandler
termHandler(Handler<Term>) - Method in interface io.vertx.ext.shell.term.TermServer: Set the term handler that will receive incoming client connections.
terminate() - Method in interface io.vertx.ext.shell.system.Job: Terminate the job.
terminate() - Method in interface io.vertx.ext.shell.system.Process: Terminate the process.
terminate(Handler<Void>) - Method in interface io.vertx.ext.shell.system.Process: Terminate the process.
TERMINATED - io.vertx.ext.shell.system.ExecStatus: The job is terminated.
terminatedHandler(Handler<Integer>) - Method in interface io.vertx.ext.shell.system.Process: Set an handler for being notified when the process terminates.
TermServer - Interface in io.vertx.ext.shell.term: A server for terminal based applications.
toBackground() - Method in interface io.vertx.ext.shell.system.Job: Send the job to background.
toBackground() - Method in interface io.vertx.ext.shell.system.Process: Set the process in background.
toBackground(Handler<Void>) - Method in interface io.vertx.ext.shell.system.Process: Set the process in background.
toForeground() - Method in interface io.vertx.ext.shell.system.Job: Send the job to foreground.
toForeground() - Method in interface io.vertx.ext.shell.system.Process: Set the process in foreground.
toForeground(Handler<Void>) - Method in interface io.vertx.ext.shell.system.Process: Set the process in foreground.
tokenize(String) - Static method in interface io.vertx.ext.shell.cli.CliToken: Tokenize the string argument and return a list of tokens.
Tty - Interface in io.vertx.ext.shell.term: Provide interactions with the Shell TTY.
type - Variable in class io.vertx.ext.shell.command.base.BusPublish
type() - Method in interface io.vertx.ext.shell.term.Tty

U

unregisterCommand(String) - Method in interface io.vertx.ext.shell.command.CommandRegistry: Unregister a command.

V

value() - Method in interface io.vertx.ext.shell.cli.CliToken
valueOf(String) - Static method in enum io.vertx.ext.shell.command.base.ObjectType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.ext.shell.system.ExecStatus: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.vertx.ext.shell.command.base.ObjectType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.ext.shell.system.ExecStatus: Returns an array containing the constants of this enum type, in the order they are declared.
verbose - Variable in class io.vertx.ext.shell.command.base.BusPublish
VerticleDeploy - Class in io.vertx.ext.shell.command.base
VerticleDeploy() - Constructor for class io.vertx.ext.shell.command.base.VerticleDeploy
VerticleFactories - Class in io.vertx.ext.shell.command.base
VerticleFactories() - Constructor for class io.vertx.ext.shell.command.base.VerticleFactories
VerticleLs - Class in io.vertx.ext.shell.command.base
VerticleLs() - Constructor for class io.vertx.ext.shell.command.base.VerticleLs
VerticleUndeploy - Class in io.vertx.ext.shell.command.base
VerticleUndeploy() - Constructor for class io.vertx.ext.shell.command.base.VerticleUndeploy
vertx() - Method in interface io.vertx.ext.shell.cli.Completion
vertx() - Method in interface io.vertx.ext.shell.command.CommandProcess

W

width() - Method in interface io.vertx.ext.shell.term.Tty
write(String) - Method in interface io.vertx.ext.shell.command.CommandProcess: Write some text to the standard output.
write(String) - Method in interface io.vertx.ext.shell.term.Pty: Write data to the slave standard input of the pseudo terminal.
write(String) - Method in interface io.vertx.ext.shell.term.Term
write(String) - Method in interface io.vertx.ext.shell.term.Tty: Write data to the standard output.

A B C D E F G H I J L N O P R S T U V W
All Classes All Packages