Package gda.jython

Interface LocalJython

All Superinterfaces:

Findable, ICurrentScanInformationHolder, IDefaultScannableProvider, IJythonServerNotifer, IJythonServerStatusProvider, gda.observable.IObservable, Jython

All Known Implementing Classes:

JythonServer

public interface LocalJython
extends Jython, ICurrentScanInformationHolder, IJythonServerNotifer, IDefaultScannableProvider, IJythonServerStatusProvider

Interface for the local JythonServer object.

It supplies extra functionality to the distributed Jython interface so it may pass object references to server-side objects.

Examples of this would be objects in Jython scripts which would like access to the scan object as it is running.

Field Summary

Fields inherited from interface gda.jython.Jython

RAW_INPUT_RECEIVED, RAW_INPUT_REQUESTED, SERVER_NAME

Method Summary

Modifier and Type	Method	Description
default <F extends Findable> Set<String>	getAllNamesForType(Class<F> clazz)	Returns all names for all Objects of a type in the Jython namespace
<F extends Findable> Map<String,F>	getAllObjectsOfType(Class<F> clazz)
Thread	runAsJython(Runnable task, String jsfIdentifier)	Run the given task in a Jython thread - allows it to be linked to a specific client and be restricted by its authorization level

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.jython.ICurrentScanInformationHolder

getCurrentScanInformation, setCurrentScan

Methods inherited from interface gda.jython.IDefaultScannableProvider

getDefaultScannables

Methods inherited from interface gda.jython.IJythonServerNotifer

notifyServer

Methods inherited from interface gda.jython.IJythonServerStatusProvider

addJythonServerStatusObserver, deleteJythonServerStatusObserver, getJythonServerStatus

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.jython.Jython

abortCommands, addAliasedCommand, addAliasedVarargCommand, addFacade, amIBatonHolder, assignBaton, beamlineHalt, eval, evaluateCommand, exec, executeCommand, executeCommand, getAliasedCommands, getAliasedVarargCommands, getAllNamesForObject, getAllScriptProjectFolders, getClientInformation, getCommandThreadInfo, getCompletionsFor, getDefaultScriptProjectFolder, getFromJythonNamespace, getJythonServerStatus, getMessageHistory, getOtherClientInformation, getProjectNameForPath, getRelease, getScanStatus, getScriptStatus, getStartupOutput, hasAlias, isBatonHeld, isFinishEarlyRequested, locateScript, pauseCurrentScan, pauseCurrentScript, placeInJythonNamespace, print, projectIsConfigType, projectIsCoreType, projectIsUserType, removeAlias, removeFacade, requestBaton, requestFinishEarly, restartCurrentScan, resumeCurrentScan, resumeCurrentScript, returnBaton, runCommand, runScript, runsource, runsource, sendMessage, setRawInput, setScriptStatus, switchUser

Method Details

getAllObjectsOfType

<F extends Findable> Map<String,F> getAllObjectsOfType(Class<F> clazz)

getAllNamesForType

default <F extends Findable> Set<String> getAllNamesForType(Class<F> clazz)

Description copied from interface: Jython

Returns all names for all Objects of a type in the Jython namespace

Specified by:

getAllNamesForType in interface Jython

Parameters:

clazz - a Class extending Findable

Returns:

a set of all names of all objects of a type in the Jython namespace.

runAsJython

Thread runAsJython(Runnable task,
 String jsfIdentifier)

Run the given task in a Jython thread - allows it to be linked to a specific client and be restricted by its authorization level