Class TermServer
- java.lang.Object
-
- io.vertx.reactivex.ext.shell.term.TermServer
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<TermServer>
__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description TermServer(TermServer delegate)
TermServer(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
actualPort()
The actual port the server is listening on.TermServer
authenticationProvider(AuthenticationProvider provider)
Set an auth provider to use, any provider configured in options will override this provider.TermServer
authProvider(AuthProvider provider)
Deprecated.void
close()
Likeclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but supplying a handler that will be notified when close is complete.void
close(Handler<AsyncResult<Void>> completionHandler)
Likeclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but supplying a handler that will be notified when close is complete.static TermServer
createHttpTermServer(Vertx vertx)
Create a term server for the HTTP protocol.static TermServer
createHttpTermServer(Vertx vertx, HttpTermOptions options)
Create a term server for the HTTP protocol.static TermServer
createHttpTermServer(Vertx vertx, Router router)
Create a term server for the HTTP protocol, using an existing router.static TermServer
createHttpTermServer(Vertx vertx, Router router, HttpTermOptions options)
Create a term server for the HTTP protocol, using an existing router.static TermServer
createSSHTermServer(Vertx vertx)
Create a term server for the SSH protocol.static TermServer
createSSHTermServer(Vertx vertx, SSHTermOptions options)
Create a term server for the SSH protocol.static TermServer
createTelnetTermServer(Vertx vertx)
Create a term server for the Telnet protocol.static TermServer
createTelnetTermServer(Vertx vertx, TelnetTermOptions options)
Create a term server for the Telnet protocol.boolean
equals(Object o)
TermServer
getDelegate()
int
hashCode()
TermServer
listen()
Bind the term server, thetermHandler(io.vertx.core.Handler<io.vertx.reactivex.ext.shell.term.Term>)
must be set before.TermServer
listen(Handler<AsyncResult<Void>> listenHandler)
Bind the term server, thetermHandler(io.vertx.core.Handler<io.vertx.reactivex.ext.shell.term.Term>)
must be set before.static TermServer
newInstance(TermServer arg)
io.reactivex.Completable
rxClose()
Likeclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but supplying a handler that will be notified when close is complete.io.reactivex.Completable
rxListen()
Bind the term server, thetermHandler(io.vertx.core.Handler<io.vertx.reactivex.ext.shell.term.Term>)
must be set before.TermServer
termHandler(Handler<Term> handler)
Set the term handler that will receive incoming client connections.String
toString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<TermServer> __TYPE_ARG
-
-
Constructor Detail
-
TermServer
public TermServer(TermServer delegate)
-
TermServer
public TermServer(Object delegate)
-
-
Method Detail
-
getDelegate
public TermServer getDelegate()
-
createSSHTermServer
public static TermServer createSSHTermServer(Vertx vertx)
Create a term server for the SSH protocol.- Parameters:
vertx
- the vertx instance- Returns:
- the term server
-
createSSHTermServer
public static TermServer createSSHTermServer(Vertx vertx, SSHTermOptions options)
Create a term server for the SSH protocol.- Parameters:
vertx
- the vertx instanceoptions
- the ssh options- Returns:
- the term server
-
createTelnetTermServer
public static TermServer createTelnetTermServer(Vertx vertx)
Create a term server for the Telnet protocol.- Parameters:
vertx
- the vertx instance- Returns:
- the term server
-
createTelnetTermServer
public static TermServer createTelnetTermServer(Vertx vertx, TelnetTermOptions options)
Create a term server for the Telnet protocol.- Parameters:
vertx
- the vertx instanceoptions
- the term options- Returns:
- the term server
-
createHttpTermServer
public static TermServer createHttpTermServer(Vertx vertx)
Create a term server for the HTTP protocol.- Parameters:
vertx
- the vertx instance- Returns:
- the term server
-
createHttpTermServer
public static TermServer createHttpTermServer(Vertx vertx, HttpTermOptions options)
Create a term server for the HTTP protocol.- Parameters:
vertx
- the vertx instanceoptions
- the term options- Returns:
- the term server
-
createHttpTermServer
public static TermServer createHttpTermServer(Vertx vertx, Router router)
Create a term server for the HTTP protocol, using an existing router.- Parameters:
vertx
- the vertx instancerouter
- the router- Returns:
- the term server
-
createHttpTermServer
public static TermServer createHttpTermServer(Vertx vertx, Router router, HttpTermOptions options)
Create a term server for the HTTP protocol, using an existing router.- Parameters:
vertx
- the vertx instancerouter
- the routeroptions
- the term options- Returns:
- the term server
-
termHandler
public TermServer termHandler(Handler<Term> handler)
Set the term handler that will receive incoming client connections. When a remote terminal connects thehandler
will be called with theTerm
which can be used to interact with the remote terminal.- Parameters:
handler
- the term handler- Returns:
- this object
-
authProvider
@Deprecated public TermServer authProvider(AuthProvider provider)
Deprecated.- Parameters:
provider
- the auth to use- Returns:
- this object
-
authenticationProvider
public TermServer authenticationProvider(AuthenticationProvider provider)
Set an auth provider to use, any provider configured in options will override this provider. This should be used when a custom auth provider should be used.- Parameters:
provider
- the auth to use- Returns:
- this object
-
listen
public TermServer listen(Handler<AsyncResult<Void>> listenHandler)
Bind the term server, thetermHandler(io.vertx.core.Handler<io.vertx.reactivex.ext.shell.term.Term>)
must be set before.- Parameters:
listenHandler
- the listen handler- Returns:
- this object
-
listen
public TermServer listen()
Bind the term server, thetermHandler(io.vertx.core.Handler<io.vertx.reactivex.ext.shell.term.Term>)
must be set before.- Returns:
- this object
-
rxListen
public io.reactivex.Completable rxListen()
Bind the term server, thetermHandler(io.vertx.core.Handler<io.vertx.reactivex.ext.shell.term.Term>)
must be set before.- Returns:
- this object
-
actualPort
public int actualPort()
The actual port the server is listening on. This is useful if you bound the server specifying 0 as port number signifying an ephemeral port- Returns:
- the actual port the server is listening on.
-
close
public void close(Handler<AsyncResult<Void>> completionHandler)
Likeclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but supplying a handler that will be notified when close is complete.- Parameters:
completionHandler
- the handler to be notified when the term server is closed
-
close
public void close()
Likeclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but supplying a handler that will be notified when close is complete.
-
rxClose
public io.reactivex.Completable rxClose()
Likeclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but supplying a handler that will be notified when close is complete.- Returns:
-
newInstance
public static TermServer newInstance(TermServer arg)
-
-