The shell service, provides a remotely accessible shell available via Telnet or SSH according to the ShellServiceOptions configuration.
The shell service will expose commands using CommandResolver on the classpath and the shared command registry for the Vert.x instance.Constructor and description |
---|
ShellService
(java.lang.Object delegate) |
Type | Name and description |
---|---|
static ShellService |
create(Vertx vertx) Like ShellService.create, with default options. |
static ShellService |
create(Vertx vertx, java.util.Map<java.lang.String, java.lang.Object> options) Create a new shell service. |
java.lang.Object |
getDelegate() |
ShellServer |
server() @return
|
void |
start() Start the shell service, this is an asynchronous start. |
void |
start(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>> startHandler) Start the shell service, this is an asynchronous start. |
void |
stop() Stop the shell service, this is an asynchronous stop. |
void |
stop(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>> stopHandler) Stop the shell service, this is an asynchronous start. |
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Like ShellService.create, with default options.
Create a new shell service.
vertx
- the Vert.x instanceoptions
- the service config options (see ShellServiceOptions)
Start the shell service, this is an asynchronous start.
Start the shell service, this is an asynchronous start.
startHandler
- handler for getting notified when service is startedStop the shell service, this is an asynchronous stop.
Stop the shell service, this is an asynchronous start.
stopHandler
- handler for getting notified when service is stopped