Package ortus.boxlang.runtime.context

Class ThreadBoxContext

java.lang.Object

ortus.boxlang.runtime.context.BaseBoxContext

ortus.boxlang.runtime.context.ThreadBoxContext

All Implemented Interfaces:

Serializable, IBoxContext, IJDBCCapableContext, IBoxAttachable

public class ThreadBoxContext
extends BaseBoxContext
implements IJDBCCapableContext

This context represents the context of any function execution in BoxLang It encapsulates the arguments scope and local scope and has a reference to the function being invoked. This context is extended for use with both UDFs and Closures as well

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface ortus.boxlang.runtime.context.IBoxContext

IBoxContext.ScopeSearchResult

Field Summary

Fields

Modifier and Type	Field	Description
protected IScope	localScope	The thread local scope
protected IScope	thisScope	The parent's this scope
protected Thread	thread	The Thread
protected Key	threadName	The BoxLang name of the thread as registered in the thread manager.
protected IScope	variablesScope	The parent's variables scope

Fields inherited from class ortus.boxlang.runtime.context.BaseBoxContext

buffers, components, currentImports, parent, queryLoops, templates

Constructor Summary

Constructors

Constructor	Description
ThreadBoxContext(IBoxContext parent, RequestThreadManager threadManager, Key threadName)	Creates a new execution context with a bounded function instance and parent context

Method Summary

Modifier and Type	Method	Description
ConnectionManager	getConnectionManager()	Get the ConnectionManager, which is the central point for managing database connections and transactions.
IScope	getDefaultAssignmentScope()	Get the default variable assignment scope for this context
IScope	getScope(Key name)	Look for a scope by name
IScope	getScopeNearby(Key name, boolean shallow)	Look for a "nearby" scope by name
Thread	getThread()	Get the thread
IStruct	getVisibleScopes(IStruct scopes, boolean nearby, boolean shallow)	This is mostly for the debugger.
void	registerUDF(UDF udf)	Register a UDF with the local context.
IBoxContext.ScopeSearchResult	scopeFind(Key key, IScope defaultScope)	Search for a variable in scopes
IBoxContext.ScopeSearchResult	scopeFindNearby(Key key, IScope defaultScope, boolean shallow)	Search for a variable in "nearby" scopes
ThreadBoxContext	setThread(Thread thread)	Set the thread
void	shutdownConnections()	Shutdown the ConnectionManager and release any resources.

Methods inherited from class ortus.boxlang.runtime.context.BaseBoxContext

canOutput, clearBuffer, findBaseTemplate, findClosestComponent, findClosestComponent, findClosestFunctionName, findClosestTemplate, findFunction, flushBuffer, getAttachment, getAttachmentKeys, getBuffer, getComponents, getConfig, getConfigItem, getConfigItem, getConfigItems, getCurrentImports, getFunctionClass, getFunctionInterface, getFunctionParentContext, getModuleRecord, getModuleSettings, getParent, getParentOfType, getQueryRow, getRuntime, getScopeNearby, getTemplates, getVisibleScopes, hasAttachment, hasParent, hasTemplates, includeTemplate, incrementQueryLoop, injectParentContext, injectTopParentContext, invokeComponent, invokeFunction, invokeFunction, invokeFunction, invokeFunction, invokeFunction, invokeFunction, invokeFunction, invokeFunction, popBuffer, popComponent, popTemplate, pushBuffer, pushComponent, pushTemplate, putAttachment, queryFindNearby, registerQueryLoop, removeAttachment, removeParentContext, rethrow, scopeFindNearby, setParent, unregisterQueryLoop, unwrapQueryColumn, writeToBuffer, writeToBuffer

Methods inherited from class java.lang.Object

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

Methods inherited from interface ortus.boxlang.runtime.context.IBoxContext

startup

Field Details

localScope

protected IScope localScope

The thread local scope

variablesScope

protected IScope variablesScope

The parent's variables scope

thisScope

protected IScope thisScope

The parent's this scope

thread

protected Thread thread

The Thread

threadName

protected Key threadName

The BoxLang name of the thread as registered in the thread manager.

Constructor Details

ThreadBoxContext

public ThreadBoxContext(IBoxContext parent,
 RequestThreadManager threadManager,
 Key threadName)

Creates a new execution context with a bounded function instance and parent context

Parameters:

parent - The parent context

threadManager - The thread manager

threadName - The name of the thread

Method Details

setThread

public ThreadBoxContext setThread(Thread thread)

Set the thread

Returns:

THis context

getVisibleScopes

public IStruct getVisibleScopes(IStruct scopes,
 boolean nearby,
 boolean shallow)

Description copied from class: BaseBoxContext

This is mostly for the debugger. It returns all visible scopes from this context.

Specified by:

getVisibleScopes in interface IBoxContext

Overrides:

getVisibleScopes in class BaseBoxContext

Returns:

A struct containing all contextual and lexically visible scopes

scopeFindNearby

public IBoxContext.ScopeSearchResult scopeFindNearby(Key key,
 IScope defaultScope,
 boolean shallow)

Search for a variable in "nearby" scopes

Specified by:

scopeFindNearby in interface IBoxContext

Overrides:

scopeFindNearby in class BaseBoxContext

Parameters:

key - The key to search for

defaultScope - The default scope to use if the key is not found

shallow - Whether to search only the "nearby" scopes or all scopes

Returns:

The search result

scopeFind

public IBoxContext.ScopeSearchResult scopeFind(Key key,
 IScope defaultScope)

Search for a variable in scopes

Specified by:

scopeFind in interface IBoxContext

Overrides:

scopeFind in class BaseBoxContext

Parameters:

key - The key to search for

defaultScope - The default scope to use if the key is not found

Returns:

The search result

getScope

public IScope getScope(Key name)
                throws ScopeNotFoundException

Look for a scope by name

Specified by:

getScope in interface IBoxContext

Overrides:

getScope in class BaseBoxContext

Parameters:

name - The name of the scope to look for

Returns:

The scope reference to use

Throws:

ScopeNotFoundException - If the scope was not found in any context

getScopeNearby

public IScope getScopeNearby(Key name,
 boolean shallow)
                      throws ScopeNotFoundException

Look for a "nearby" scope by name

Specified by:

getScopeNearby in interface IBoxContext

Overrides:

getScopeNearby in class BaseBoxContext

Parameters:

name - The name of the scope to look for

shallow - true, do not delegate to parent or default scope if not found

Returns:

The scope reference to use

Throws:

ScopeNotFoundException - If the scope was not found in any context

getDefaultAssignmentScope

public IScope getDefaultAssignmentScope()

Get the default variable assignment scope for this context

Specified by:

getDefaultAssignmentScope in interface IBoxContext

Overrides:

getDefaultAssignmentScope in class BaseBoxContext

Returns:

The scope reference to use

registerUDF

public void registerUDF(UDF udf)

Description copied from class: BaseBoxContext

Register a UDF with the local context.

Specified by:

registerUDF in interface IBoxContext

Overrides:

registerUDF in class BaseBoxContext

Parameters:

udf - The UDF to register

getThread

public Thread getThread()

Get the thread

Returns:

The thread

getConnectionManager

public ConnectionManager getConnectionManager()

Get the ConnectionManager, which is the central point for managing database connections and transactions.

Specified by:

getConnectionManager in interface IJDBCCapableContext

shutdownConnections

public void shutdownConnections()

Shutdown the ConnectionManager and release any resources.

Specified by:

shutdownConnections in interface IJDBCCapableContext