Package com.pnfsoftware.jeb.client.script

Class JebPythonInterpreter

java.lang.Object

com.pnfsoftware.jeb.client.script.JebPythonInterpreter

All Implemented Interfaces:

ICommandInterpreter

public class JebPythonInterpreter
extends Object
implements ICommandInterpreter

Python interpreter using Jython.

Constructor Summary

Constructors

Constructor	Description
JebPythonInterpreter(File scriptsDir, IClientContext ctx)	Create a Python command interpreter able to interact with JEB objects.

Method Summary

Modifier and Type	Method	Description
boolean	addToSystemPath(File dir)
AutocompletionResult	autoComplete(String command)	Provide a best-effort completion suggestion for the provided partial command.
ExecutionResult	executeCommand(String command)	Execute a command.
ExecutionResult	executeInternal(String command, boolean allowAutoImport)
Collection<String>	getAutoImportedTypes()
String	getBanner()	Retrieve the interpreter's banner/logo string.
String	getDescription()	Get the long name or description.
String	getName()	Get the (short) name of this interpreter.
TypeInfoProvider	getTypeInfoProvider()
void	injectObject(String name, Object value)
boolean	isAllowAutoImport()
void	prepare()	Interpreters may place resource intensive preparation operations here.
void	setAllowAutoImport(boolean allowAutoImport)
void	setTypeInfoProvider(TypeInfoProvider typeinfoprv)
boolean	shouldDisplayRawResults()	Determine whether this interpreter prefers that the results of executed commands be printed as-is.

Methods inherited from class java.lang.Object

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

Constructor Details

JebPythonInterpreter

public JebPythonInterpreter(File scriptsDir,
 IClientContext ctx)
                     throws JebException

Create a Python command interpreter able to interact with JEB objects.

Parameters:

scriptsDir - optional scripts directory, will be added to the interpreter's sys.path for easy import

ctx - optional JEB context - if provided, the context object will be made available as a global variable `jeb`

Throws:

Exception

JebException

Method Details

setAllowAutoImport

public void setAllowAutoImport(boolean allowAutoImport)

isAllowAutoImport

public boolean isAllowAutoImport()

setTypeInfoProvider

public void setTypeInfoProvider(TypeInfoProvider typeinfoprv)

getTypeInfoProvider

public TypeInfoProvider getTypeInfoProvider()

addToSystemPath

public boolean addToSystemPath(File dir)

prepare

public void prepare()

Description copied from interface: ICommandInterpreter

Interpreters may place resource intensive preparation operations here. Clients may optionally call this method before invoking either: ICommandInterpreter.executeCommand(String) or ICommandInterpreter.autoComplete(String). Clients may decide to not call this method. An interpreter implementation must handle cases where prepare() is never called, sometimes called, called multiple times, etc.

Specified by:

prepare in interface ICommandInterpreter

injectObject

public void injectObject(String name,
 Object value)
                  throws ScriptExecutionException

Throws:

ScriptExecutionException

executeCommand

public ExecutionResult executeCommand(String command)

Description copied from interface: ICommandInterpreter

Execute a command.

Specified by:

executeCommand in interface ICommandInterpreter

Parameters:

command - command line to execute

Returns:

the execution result

executeInternal

public ExecutionResult executeInternal(String command,
 boolean allowAutoImport)

getAutoImportedTypes

public Collection<String> getAutoImportedTypes()

getName

public String getName()

Description copied from interface: ICommandInterpreter

Get the (short) name of this interpreter.

Specified by:

getName in interface ICommandInterpreter

Returns:

non-null string

getDescription

public String getDescription()

Description copied from interface: ICommandInterpreter

Get the long name or description.

Specified by:

getDescription in interface ICommandInterpreter

Returns:

optional string

getBanner

public String getBanner()

Description copied from interface: ICommandInterpreter

Retrieve the interpreter's banner/logo string.

Specified by:

getBanner in interface ICommandInterpreter

Returns:

optional string that client code (shells) may display when the interpreter was just instantiated

shouldDisplayRawResults

public boolean shouldDisplayRawResults()

Description copied from interface: ICommandInterpreter

Determine whether this interpreter prefers that the results of executed commands be printed as-is. Clients decide whether or not they want to follow this guideline.

Specified by:

shouldDisplayRawResults in interface ICommandInterpreter

Returns:

true if clients should display execution results without additional formatting

autoComplete

public AutocompletionResult autoComplete(String command)

Description copied from interface: ICommandInterpreter

Provide a best-effort completion suggestion for the provided partial command.

Specified by:

autoComplete in interface ICommandInterpreter

Parameters:

command - partial command line

Returns:

optional auto-completion result object