org.crsh.shell
Interface Shell

All Superinterfaces:

Closeable

All Known Implementing Classes:

AsyncShell, CRaSHSession, ServerAutomaton

public interface Shell

extends Closeable

getWelcome

String getWelcome()

Returns the welcome message.

Returns:

the welcome message

getPrompt

String getPrompt()

Returns the shell prompt.

Returns:

the shell prompt

createProcess

ShellProcess createProcess(String request)
                           throws IllegalStateException

Process a request.

Parameters:

request - the request to process

Returns:

the process

Throws:

IllegalStateException - if the shell cannot create a process

complete

CompletionMatch complete(String prefix)

Completion.

Parameters:

prefix - the prefix to complete

Returns:

the sorted list of available suffixes