io.permazen.cli

Class Console

java.lang.Object

io.permazen.cli.Console

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

TelnetConsole

public class Console
extends Object
implements Closeable

CLI console.

Field Summary

Fields

Modifier and Type	Field and Description
protected jline.console.ConsoleReader	console
protected Logger	log
protected CliSession	session

Constructor Summary

Constructors

Constructor and Description
Console(Database db, InputStream input, OutputStream output) Simplified constructor for SessionMode.CORE_API mode.
Console(KVDatabase kvdb, Database db, Permazen jdb, InputStream input, OutputStream output, jline.Terminal terminal, String encoding, String appName) Generic constructor.
Console(KVDatabase kvdb, InputStream input, OutputStream output) Simplified constructor for SessionMode.KEY_VALUE mode.
Console(Permazen jdb, InputStream input, OutputStream output) Simplified constructor for SessionMode.PERMAZEN mode.

Method Summary

Modifier and Type	Method and Description
void	close()
jline.console.ConsoleReader	getConsoleReader() Get the associated JLine ConsoleReader.
CliSession	getSession() Get the associated CliSession.
static jline.Terminal	getTerminal() Get the Terminal instance appropriate for this operating system.
List<CliSession.Action>	parseCommand(String text) Parse the given command(s).
boolean	run() Run this instance.
boolean	runNonInteractive(Reader input, String inputDescription) Run this instance in non-interactive (or "batch") mode on the given input.
void	setHistoryFile(File historyFile) Set/update the command history file.
void	setPassword(String password) Set a password that must be entered when run() is invoked.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final Logger log

console

protected final jline.console.ConsoleReader console

session

protected final CliSession session

Constructor Detail

Console

public Console(KVDatabase kvdb,
               InputStream input,
               OutputStream output)
        throws IOException

Simplified constructor for SessionMode.KEY_VALUE mode.

Parameters:

kvdb - key/value KVDatabase

input - console input

output - console output

Throws:

IOException - if an I/O error occurs

Console

public Console(Database db,
               InputStream input,
               OutputStream output)
        throws IOException

Simplified constructor for SessionMode.CORE_API mode.

Parameters:

db - core API Database

input - console input

output - console output

Throws:

IOException - if an I/O error occurs

Console

public Console(Permazen jdb,
               InputStream input,
               OutputStream output)
        throws IOException

Simplified constructor for SessionMode.PERMAZEN mode.

Parameters:

jdb - Permazen database

input - console input

output - console output

Throws:

IOException - if an I/O error occurs

Console

public Console(KVDatabase kvdb,
               Database db,
               Permazen jdb,
               InputStream input,
               OutputStream output,
               jline.Terminal terminal,
               String encoding,
               String appName)
        throws IOException

Generic constructor.

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

terminal - JLine terminal interface, or null for default

encoding - character encoding for terminal, or null for default

appName - JLine application name, or null for none

Throws:

IOException - if an I/O error occurs

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

Method Detail

getConsoleReader

public jline.console.ConsoleReader getConsoleReader()

Get the associated JLine ConsoleReader.

Returns:

associated console reader

getSession

public CliSession getSession()

Get the associated CliSession.

Returns:

associated CLI session

setPassword

public void setPassword(String password)

Set a password that must be entered when run() is invoked.

Default is no password.

Parameters:

password - required password, or null for none

setHistoryFile

public void setHistoryFile(File historyFile)
                    throws IOException

Set/update the command history file. May be reconfigured while executing.

Parameters:

historyFile - file for storing command history

Throws:

IOException - if historyFile cannot be read

IllegalArgumentException - if historyFile is null

runNonInteractive

public boolean runNonInteractive(Reader input,
                                 String inputDescription)
                          throws IOException

Run this instance in non-interactive (or "batch") mode on the given input.

Parameters:

input - command input; is not closed by this method

inputDescription - description of input (e.g., file name) used for error reporting, or null for none

Returns:

true if successful, false if an error occurred

Throws:

IOException - if an I/O error occurs

run

public boolean run()
            throws IOException

Run this instance. This method blocks until the connected user exits the console.

Returns:

true if successful, false if required password check failed

Throws:

IOException - if an I/O error occurs

parseCommand

public List<CliSession.Action> parseCommand(String text)

Parse the given command(s).

Parameters:

text - command input

Returns:

command actions, or null if there was an error during parsing

Throws:

ParseException - if text cannot be parsed

IllegalArgumentException - if text is null

getTerminal

public static jline.Terminal getTerminal()
                                  throws IOException

Get the Terminal instance appropriate for this operating system.

Returns:

JLine Terminal to use

Throws:

IOException - if an I/O error occurs

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable