io.permazen.cli.telnet

Class TelnetConsole

java.lang.Object

io.permazen.cli.Console

io.permazen.cli.telnet.TelnetConsole

All Implemented Interfaces:

Closeable, AutoCloseable

public final class TelnetConsole
extends Console

A Console connected to a telnet client via a Socket.

This class can be used to implement an embedded CLI console within an application, accessed via telnet. For example:

      // Accept a new connection and setup telnet CLI console
      try (Socket socket = /* accept new TCP connection */;
           TelnetConsole console = TelnetConsole.create(database, socket)) {

          // Install commands and functions
          console.getSession().loadFunctionsFromClasspath();
          console.getSession().loadCommandsFromClasspath();

          // Run the console
          console.run();
      }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TelnetConsole.ForwardingTerminal Wrapper class for a JLine Terminal that forwards all methods to the wrapped delegate.
static class	TelnetConsole.TelnetTerminal JLine Terminal that gets window size information from an associated nvt4j Terminal.

Field Summary

Fields inherited from class io.permazen.cli.Console

console, log, session

Method Summary

Modifier and Type	Method and Description
static TelnetConsole	create(Database db, Socket socket) Simplified factory method for SessionMode.CORE_API mode.
static TelnetConsole	create(KVDatabase kvdb, Database db, Permazen jdb, InputStream input, OutputStream output, String encoding, String appName) Generic factory method.
static TelnetConsole	create(KVDatabase kvdb, Socket socket) Simplified factory method for SessionMode.KEY_VALUE mode.
static TelnetConsole	create(Permazen jdb, Socket socket) Simplified factory method for SessionMode.PERMAZEN mode.

Methods inherited from class io.permazen.cli.Console

close, getConsoleReader, getSession, getTerminal, parseCommand, run, runNonInteractive, setHistoryFile, setPassword

Methods inherited from class java.lang.Object

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

Method Detail

create

public static TelnetConsole create(KVDatabase kvdb,
                                   Socket socket)
                            throws IOException

Simplified factory method for SessionMode.KEY_VALUE mode.

Parameters:

kvdb - key/value KVDatabase

socket - socket connected to telnet client

Returns:

new telnet console instance

Throws:

IOException - if an I/O error occurs

create

public static TelnetConsole create(Database db,
                                   Socket socket)
                            throws IOException

Simplified factory method for SessionMode.CORE_API mode.

Parameters:

db - core API Database

socket - socket connected to telnet client

Returns:

new telnet console instance

Throws:

IOException - if an I/O error occurs

create

public static TelnetConsole create(Permazen jdb,
                                   Socket socket)
                            throws IOException

Simplified factory method for SessionMode.PERMAZEN mode.

Parameters:

jdb - Permazen database

socket - socket connected to telnet client

Returns:

new telnet console instance

Throws:

IOException - if an I/O error occurs

create

public static TelnetConsole create(KVDatabase kvdb,
                                   Database db,
                                   Permazen jdb,
                                   InputStream input,
                                   OutputStream output,
                                   String encoding,
                                   String appName)
                            throws IOException

Generic factory method.

Parameters:

kvdb - KVDatabase for SessionMode.KEY_VALUE (otherwise must be null)

db - Database for SessionMode.CORE_API (otherwise must be null)

jdb - Permazen for SessionMode.PERMAZEN (otherwise must be null)

input - console input

output - console output

encoding - character encoding for terminal, or null for default

appName - JLine application name, or null for none

Returns:

new telnet console instance

Throws:

IOException - if an I/O error occurs

IllegalArgumentException - if not exactly one of kvdb, db or jdb is not null