Package org.dellroad.jct.core.simple

Class SimpleShell.Session

java.lang.Object

org.dellroad.jct.core.AbstractConsoleSession<Shell,ShellRequest>

org.dellroad.jct.core.AbstractShellSession

org.dellroad.jct.core.simple.SimpleShell.Session

All Implemented Interfaces:

ConsoleSession<Shell,ShellRequest>, ShellSession

Enclosing class:

SimpleShell

public static class SimpleShell.Session
extends AbstractShellSession

Default ShellSession implementation used by SimpleShell.

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.jline.reader.LineReader	reader

Fields inherited from class org.dellroad.jct.core.AbstractShellSession

exitValue, in, out

Fields inherited from class org.dellroad.jct.core.AbstractConsoleSession

owner, request

Constructor Summary

Constructors

Constructor	Description
Session(SimpleShell shell, ShellRequest request, org.jline.reader.LineReader reader)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	commandLoop()
protected int	doExecute()	Execute this session.
protected int	execute(SimpleCommandSupport.FoundCommand command)	Execute the given command in the context of this session.
String	getContinuationPrompt()	Get the continuation line prompt.
String	getGreeting()	Get the welcome greeting.
String	getNormalPrompt()	Get the normal prompt.
SimpleShell	getOwner()	Get the owner, i.e., the console component that created this session.

Methods inherited from class org.dellroad.jct.core.AbstractShellSession

buildInputStream, buildOutputStream, getExitValue, getInputStream, getOutputStream, setExitValue

Methods inherited from class org.dellroad.jct.core.AbstractConsoleSession

doInterrupt, execute, getRequest, interrupt

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dellroad.jct.core.ConsoleSession

execute, getRequest, interrupt

Methods inherited from interface org.dellroad.jct.core.ShellSession

getErrorStream

Field Details

reader

protected final org.jline.reader.LineReader reader

Constructor Details

Session

public Session(SimpleShell shell,
 ShellRequest request,
 org.jline.reader.LineReader reader)
        throws IOException

Constructor.

Parameters:

shell - session owner

request - shell execution request

reader - console line reader

Throws:

IOException - if an I/O error occurs

IllegalArgumentException - if any parameter is null

Method Details

getOwner

public SimpleShell getOwner()

Description copied from interface: ConsoleSession

Get the owner, i.e., the console component that created this session.

Specified by:

getOwner in interface ConsoleSession<Shell,ShellRequest>

Overrides:

getOwner in class AbstractConsoleSession<Shell,ShellRequest>

Returns:

owning component

doExecute

protected int doExecute()
                 throws InterruptedException

Description copied from class: AbstractConsoleSession

Execute this session.

This method is invoked by AbstractConsoleSession.execute() to do the actual work.

Specified by:

doExecute in class AbstractConsoleSession<Shell,ShellRequest>

Returns:

zero if successful, non-zero error code if an error occurred

Throws:

InterruptedException - if the current thread is interrupted

getGreeting

public String getGreeting()

Get the welcome greeting.

The implementation in SimpleShell.Session delegates to SimpleShell.getGreeting().

Returns:

welcome greeting, or null for none

getNormalPrompt

public String getNormalPrompt()

Get the normal prompt.

The implementation in SimpleShell.Session delegates to SimpleShell.getNormalPrompt().

Returns:

the normal prompt

getContinuationPrompt

public String getContinuationPrompt()

Get the continuation line prompt.

The implementation in SimpleShell.Session delegates to SimpleShell.getContinuationPrompt().

Returns:

the continuation line prompt

commandLoop

protected void commandLoop()

execute

protected int execute(SimpleCommandSupport.FoundCommand command)
               throws InterruptedException

Execute the given command in the context of this session.

The implementation in SimpleShell.Session just invokes SimpleCommandSupport.FoundCommand.execute(org.dellroad.jct.core.ConsoleSession<?, ?>). Subclasses can override this method to intercept/wrap individual command execution.

Parameters:

command - command to execute

Returns:

command return value

Throws:

InterruptedException - if the current thread is interrupted

IllegalArgumentException - if command is null