CommandContext (Engine 13.1.0 API)

java.lang.Object
- org.teiid.query.util.CommandContext

All Implemented Interfaces:

Cloneable, CommandContext
```
public class CommandContext
extends Object
implements Cloneable, CommandContext
```
Defines the context that a command is processing in. For example, this defines who is processing the command and why. Also, this class (or subclasses) provide a means to pass context-specific information between users of the query processor framework.

Constructor Summary

Constructors
Constructor and Description
`CommandContext()`
`CommandContext(Object processorID, String connectionID, String userName, String vdbName, Object vdbVersion)` Construct a new context.
`CommandContext(String connectionID, String userName, Serializable commandPayload, String vdbName, Object vdbVersion, boolean collectNodeStatistics)` Construct a new context.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accessedDataObject(Object id)`
`void`	`accessedPlanningObject(Object id)`
`void`	`addAccessed(TempMetadataID id)` Used by the planner to track only what is accessed by the plan
`long`	`addAndGetReservedBuffers(int i)`
`void`	`addCreatedLob(FileStoreInputStreamFactory isf)`
`void`	`addListener(CommandListener listener)`
`void`	`addWarning(Exception warning)`
`void`	`clearGeneratedKeys()`
`CommandContext`	`clone()`
`void`	`close()`
`Date`	`currentDate()`
`Time`	`currentTime()`
`Timestamp`	`currentTimestamp()`
`void`	`disableAutoCleanLobs()`
`Map<String,String>`	`getAliasMapping()`
`Map<String,DataPolicy>`	`getAllowedDataPolicies()`
`List<Exception>`	`getAndClearWarnings()` Get all warnings found while processing this plan.
`AuthorizationValidator`	`getAuthorizationValidator()`
`Throwable`	`getBatchUpdateException()`
`BufferManager`	`getBufferManager()`
`int`	`getCallStackDepth()`
`TupleSource`	`getCodeLookup(String matTableName, Object keyValue)`
`boolean`	`getCollectNodeStatistics()`
`Serializable`	`getCommandPayload()`
`TeiidConnection`	`getConnection()`
`String`	`getConnectionId()`
`String`	`getConnectionID()`
`Set<Object>`	`getDataObjects()`
`static SimpleDateFormat`	`getDateFormat(CommandContext context, String format)`
`static DecimalFormat`	`getDecimalFormat(CommandContext context, String format)`
`FunctionMethod.Determinism`	`getDeterminismLevel()`
`DQPWorkContext`	`getDQPWorkContext()`
`Executor`	`getExecutor()`
`Object`	`getFromContext(Expression expression)`
`GeneratedKeysImpl`	`getGeneratedKeys()`
`GlobalTableStore`	`getGlobalTableStore()`
`Set<String>`	`getGroups()`
`QueryMetadataInterface`	`getMetadata()`
`double`	`getNextRand()`
`double`	`getNextRand(long seed)`
`Options`	`getOptions()`
`static Pattern`	`getPattern(CommandContext context, String regex, int flags)` Compile a regular expression into a `Pattern` and cache it in the `CommandContext` for future use.
`PreparedPlan`	`getPlan(String key)`
`Set<Object>`	`getPlanningObjects()`
`int`	`getProcessorBatchSize()`
`int`	`getProcessorBatchSize(List<Expression> schema)`
`QueryProcessor.ProcessorFactory`	`getQueryProcessorFactory()`
`String`	`getRequestId()`
`List<ElementSymbol>`	`getReturnAutoGeneratedKeys()`
`ReusableExecution<?>`	`getReusableExecution(Object key)`
`long`	`getReuseCount()`
`TimeZone`	`getServerTimeZone()`
`SessionMetadata`	`getSession()`
`TempTableStore`	`getSessionTempTableStore()`
`Object`	`getSessionVariable(String key)`
`Clob`	`getSpatialRefSys()` Used by the system table logic
`Subject`	`getSubject()`
`TempTableStore`	`getTempTableStore()`
`static CommandContext`	`getThreadLocalContext()`
`long`	`getTimeoutEnd()`
`long`	`getTimeSliceEnd()`
`TransactionContext`	`getTransactionContext()`
`TransactionService`	`getTransactionServer()`
`TupleSourceCache`	`getTupleSourceCache()`
`String`	`getUserName()`
`int`	`getUserRequestSourceConcurrency()`
`VariableContext`	`getVariableContext()`
`VDBMetaData`	`getVdb()`
`ClassLoader`	`getVDBClassLoader()`
`String`	`getVdbName()`
`String`	`getVdbVersion()`
`RequestWorkItem`	`getWorkItem()`
`void`	`incrementReuseCount()`
`Boolean`	`isAccessible(AbstractMetadataRecord record)`
`boolean`	`isAtomicBlock()` Used by transaction detection logic when starting an atomic block transaction
`boolean`	`isCancelled()` Check if this context or the parent has been cancelled.
`boolean`	`isContinuous()`
`boolean`	`isNonBlocking()`
`boolean`	`isParallel()`
`boolean`	`isReadOnly()`
`boolean`	`isResultSetCacheEnabled()`
`boolean`	`isReturnAutoGeneratedKeys()`
`void`	`popCall()`
`static void`	`popThreadLocalContext()`
`void`	`pushCall(String value)`
`static void`	`pushThreadLocalContext(CommandContext context)`
`void`	`pushVariableContext(VariableContext toPush)`
`void`	`putCodeLookup(String matTableName, Object keyValue, TupleSource ts)`
`void`	`putPlan(String key, PreparedPlan plan, FunctionMethod.Determinism determinismLevel)`
`void`	`putReusableExecution(Object key, ReusableExecution<?> execution)`
`void`	`removeListener(CommandListener listener)`
`void`	`requestCancelled()`
`FunctionMethod.Determinism`	`resetDeterminismLevel()`
`FunctionMethod.Determinism`	`resetDeterminismLevel(boolean detach)`
`GeneratedKeysImpl`	`returnGeneratedKeys(String[] columnNames, Class<?>[] columnDataTypes)`
`void`	`setAccessed(Collection<TempMetadataID> accessed)`
`void`	`setAccessible(AbstractMetadataRecord record, Boolean result)`
`void`	`setAtomicBlock(boolean atomicBlock)`
`void`	`setAuthoriziationValidator(AuthorizationValidator authorizationValidator)`
`void`	`setBatchUpdateException(Throwable t)`
`void`	`setBufferManager(BufferManager bm)`
`void`	`setCollectNodeStatistics(boolean collectNodeStatistics)`
`void`	`setCommandPayload(Serializable commandPayload)`
`void`	`setConnectionID(String connectionID)` Sets the connectionID.
`void`	`setContinuous()`
`void`	`setCurrentTimestamp(long currentTimeMillis)`
`void`	`setDataObjects(HashSet<Object> dataObjectsAccessed)`
`void`	`setDeterminismLevel(FunctionMethod.Determinism level)`
`void`	`setDQPWorkContext(DQPWorkContext workContext)`
`void`	`setExecutor(Executor e)`
`void`	`setGlobalTableStore(GlobalTableStore tempTableStore)`
`void`	`setMetadata(QueryMetadataInterface metadata)`
`void`	`setNewVDBState(DQPWorkContext newWorkContext)`
`void`	`setNonBlocking(boolean nonBlocking)`
`void`	`setOptions(Options options)`
`boolean`	`setParallel(boolean value)`
`void`	`setPreparedPlanCache(SessionAwareCache<PreparedPlan> cache)`
`void`	`setProcessorBatchSize(int processorBatchSize)`
`void`	`setQueryProcessorFactory(QueryProcessor.ProcessorFactory queryProcessorFactory)`
`void`	`setReadOnly(boolean b)`
`void`	`setRequestId(RequestID requestId)`
`void`	`setResultSetCacheEnabled(boolean resultSetCacheEnabled)`
`void`	`setReturnAutoGeneratedKeys(List<ElementSymbol> variables)`
`void`	`setSession(SessionMetadata session)`
`void`	`setSessionTempTableStore(TempTableStore tempTableStore)`
`Object`	`setSessionVariable(String key, Object value)`
`void`	`setSubject(Subject subject)`
`void`	`setTempTableStore(TempTableStore tempTableStore)`
`void`	`setTimeoutEnd(long timeoutEnd)`
`void`	`setTimeSliceEnd(long timeSliceEnd)`
`void`	`setTransactionContext(TransactionContext transactionContext)`
`void`	`setTransactionService(TransactionService transactionService)`
`void`	`setTupleSourceCache(TupleSourceCache tupleSourceCache)`
`void`	`setUserName(String userName)` Sets the userName.
`void`	`setUserRequestSourceConcurrency(int userRequestSourceConcurrency)`
`void`	`setVariableContext(VariableContext variableContext)`
`void`	`setVDBClassLoader(ClassLoader classLoader)`
`void`	`setVdbName(String vdbName)` Sets the vdbName.
`void`	`setVdbVersion(Object vdbVersion)` Sets the vdbVersion.
`void`	`setWorkItem(RequestWorkItem object)`
`<V> Future<V>`	`submit(Callable<V> callable)` Submit work that will notify the request work item of more work when complete
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CommandContext

public CommandContext(String connectionID,
                      String userName,
                      Serializable commandPayload,
                      String vdbName,
                      Object vdbVersion,
                      boolean collectNodeStatistics)

Construct a new context.

CommandContext

public CommandContext(Object processorID,
                      String connectionID,
                      String userName,
                      String vdbName,
                      Object vdbVersion)

Construct a new context.

CommandContext
```
public CommandContext()
```

Method Detail

getDeterminismLevel

public FunctionMethod.Determinism getDeterminismLevel()

resetDeterminismLevel

public FunctionMethod.Determinism resetDeterminismLevel(boolean detach)

resetDeterminismLevel

public FunctionMethod.Determinism resetDeterminismLevel()

setDeterminismLevel

public void setDeterminismLevel(FunctionMethod.Determinism level)

getWorkItem
```
public RequestWorkItem getWorkItem()
```
Returns:

setWorkItem

public void setWorkItem(RequestWorkItem object)

Parameters:: object -

clone
```
public CommandContext clone()
```
Overrides:

clone in class Object

setNewVDBState

public void setNewVDBState(DQPWorkContext newWorkContext)

toString
```
public String toString()
```
Overrides:

toString in class Object

getConnectionId
```
public String getConnectionId()
```
Specified by:

getConnectionId in interface CommandContext

getConnectionID
```
public String getConnectionID()
```
Specified by:

getConnectionID in interface CommandContext

getUserName
```
public String getUserName()
```
Specified by:

getUserName in interface CommandContext

getVdbName
```
public String getVdbName()
```
Specified by:

getVdbName in interface CommandContext

getVdbVersion
```
public String getVdbVersion()
```
Specified by:

getVdbVersion in interface CommandContext

setConnectionID
```
public void setConnectionID(String connectionID)
```
Sets the connectionID.

Parameters:

connectionID - The connectionID to set

setUserName
```
public void setUserName(String userName)
```
Sets the userName.

Parameters:

userName - The userName to set

setVdbName
```
public void setVdbName(String vdbName)
```
Sets the vdbName.

Parameters:

vdbName - The vdbName to set

setVdbVersion
```
public void setVdbVersion(Object vdbVersion)
```
Sets the vdbVersion.

Parameters:

vdbVersion - The vdbVersion to set

getCommandPayload
```
public Serializable getCommandPayload()
```
Specified by:

getCommandPayload in interface CommandContext

setCommandPayload

public void setCommandPayload(Serializable commandPayload)

setCollectNodeStatistics
```
public void setCollectNodeStatistics(boolean collectNodeStatistics)
```
Parameters:

collectNodeStatistics - The collectNodeStatistics to set.

Since:

4.2

getCollectNodeStatistics

public boolean getCollectNodeStatistics()

getProcessorBatchSize
```
public int getProcessorBatchSize()
```
Specified by:

getProcessorBatchSize in interface CommandContext

getProcessorBatchSize

public int getProcessorBatchSize(List<Expression> schema)

setProcessorBatchSize

public void setProcessorBatchSize(int processorBatchSize)

getNextRand
```
public double getNextRand()
```
Specified by:

getNextRand in interface CommandContext

getNextRand
```
public double getNextRand(long seed)
```
Specified by:

getNextRand in interface CommandContext

pushCall

public void pushCall(String value)
              throws QueryProcessingException

Throws:: QueryProcessingException

getCallStackDepth
```
public int getCallStackDepth()
```

popCall
```
public void popCall()
```

setAuthoriziationValidator

public void setAuthoriziationValidator(AuthorizationValidator authorizationValidator)

getTempTableStore

public TempTableStore getTempTableStore()

setTempTableStore

public void setTempTableStore(TempTableStore tempTableStore)

getSessionTempTableStore

public TempTableStore getSessionTempTableStore()

setSessionTempTableStore

public void setSessionTempTableStore(TempTableStore tempTableStore)

getServerTimeZone
```
public TimeZone getServerTimeZone()
```
Specified by:

getServerTimeZone in interface CommandContext

getQueryProcessorFactory

public QueryProcessor.ProcessorFactory getQueryProcessorFactory()

setQueryProcessorFactory

public void setQueryProcessorFactory(QueryProcessor.ProcessorFactory queryProcessorFactory)

getVariableContext

public VariableContext getVariableContext()

setVariableContext

public void setVariableContext(VariableContext variableContext)

pushVariableContext

public void pushVariableContext(VariableContext toPush)

getFromContext

public Object getFromContext(Expression expression)
                      throws TeiidComponentException

Throws:: TeiidComponentException

getGroups
```
public Set<String> getGroups()
```

getAliasMapping

public Map<String,String> getAliasMapping()

getTimeSliceEnd
```
public long getTimeSliceEnd()
```

getTimeoutEnd
```
public long getTimeoutEnd()
```

setTimeSliceEnd

public void setTimeSliceEnd(long timeSliceEnd)

setTimeoutEnd

public void setTimeoutEnd(long timeoutEnd)

setMetadata

public void setMetadata(QueryMetadataInterface metadata)

getMetadata

public QueryMetadataInterface getMetadata()

getBufferManager

public BufferManager getBufferManager()

setBufferManager

public void setBufferManager(BufferManager bm)

getGlobalTableStore

public GlobalTableStore getGlobalTableStore()

setGlobalTableStore

public void setGlobalTableStore(GlobalTableStore tempTableStore)

isNonBlocking
```
public boolean isNonBlocking()
```

setNonBlocking

public void setNonBlocking(boolean nonBlocking)

setPreparedPlanCache

public void setPreparedPlanCache(SessionAwareCache<PreparedPlan> cache)

getPlan

public PreparedPlan getPlan(String key)

putPlan

public void putPlan(String key,
                    PreparedPlan plan,
                    FunctionMethod.Determinism determinismLevel)

isResultSetCacheEnabled

public boolean isResultSetCacheEnabled()

setResultSetCacheEnabled

public void setResultSetCacheEnabled(boolean resultSetCacheEnabled)

getUserRequestSourceConcurrency

public int getUserRequestSourceConcurrency()

setUserRequestSourceConcurrency

public void setUserRequestSourceConcurrency(int userRequestSourceConcurrency)

getSubject
```
public Subject getSubject()
```
Specified by:

getSubject in interface CommandContext

setSubject

public void setSubject(Subject subject)

accessedPlanningObject

public void accessedPlanningObject(Object id)

getPlanningObjects

public Set<Object> getPlanningObjects()

accessedDataObject

public void accessedDataObject(Object id)

getDataObjects
```
public Set<Object> getDataObjects()
```

setDataObjects

public void setDataObjects(HashSet<Object> dataObjectsAccessed)

getSession
```
public SessionMetadata getSession()
```
Specified by:

getSession in interface CommandContext

setSession

public void setSession(SessionMetadata session)

getRequestId
```
public String getRequestId()
```
Specified by:

getRequestId in interface CommandContext

setRequestId

public void setRequestId(RequestID requestId)

setDQPWorkContext

public void setDQPWorkContext(DQPWorkContext workContext)

getAllowedDataPolicies
```
public Map<String,DataPolicy> getAllowedDataPolicies()
```
Specified by:

getAllowedDataPolicies in interface CommandContext

getVdb
```
public VDBMetaData getVdb()
```
Specified by:

getVdb in interface CommandContext

getDQPWorkContext

public DQPWorkContext getDQPWorkContext()

getTransactionContext

public TransactionContext getTransactionContext()

setTransactionContext

public void setTransactionContext(TransactionContext transactionContext)

getTransactionServer

public TransactionService getTransactionServer()

setTransactionService

public void setTransactionService(TransactionService transactionService)

getExecutor
```
public Executor getExecutor()
```

submit
```
public <V> Future<V> submit(Callable<V> callable)
```
Submit work that will notify the request work item of more work when complete

Parameters:

callable -

Returns:

setExecutor
```
public void setExecutor(Executor e)
```

getReusableExecution

public ReusableExecution<?> getReusableExecution(Object key)

putReusableExecution

public void putReusableExecution(Object key,
                                 ReusableExecution<?> execution)

close
```
public void close()
```

addListener
```
public void addListener(CommandListener listener)
```
Specified by:

addListener in interface CommandContext

removeListener
```
public void removeListener(CommandListener listener)
```
Specified by:

removeListener in interface CommandContext

getDecimalFormat

public static DecimalFormat getDecimalFormat(CommandContext context,
                                             String format)

getDateFormat

public static SimpleDateFormat getDateFormat(CommandContext context,
                                             String format)

getPattern
```
public static Pattern getPattern(CommandContext context,
                                 String regex,
                                 int flags)
```
Compile a regular expression into a Pattern and cache it in the CommandContext for future use.

Parameters:

context -

regex - Regular expression.

flags - Bitmask flags like Pattern.CASE_INSENSITIVE.

Returns:

Compiled regex.

incrementReuseCount
```
public void incrementReuseCount()
```

getReuseCount
```
public long getReuseCount()
```
Specified by:

getReuseCount in interface CommandContext

isContinuous
```
public boolean isContinuous()
```
Specified by:

isContinuous in interface CommandContext

setContinuous
```
public void setContinuous()
```

getVDBClassLoader
```
public ClassLoader getVDBClassLoader()
```
Specified by:

getVDBClassLoader in interface CommandContext

setVDBClassLoader

public void setVDBClassLoader(ClassLoader classLoader)

getAndClearWarnings
```
public List<Exception> getAndClearWarnings()
```
Get all warnings found while processing this plan. These warnings may be detected throughout the plan lifetime, which means new ones may arrive at any time. This method returns all current warnings and clears the current warnings list. The warnings are in order they were detected.

Returns:

Current list of warnings, never null

addWarning
```
public void addWarning(Exception warning)
```
Specified by:

addWarning in interface CommandContext

getTupleSourceCache

public TupleSourceCache getTupleSourceCache()

setTupleSourceCache

public void setTupleSourceCache(TupleSourceCache tupleSourceCache)

getOptions
```
public Options getOptions()
```

setOptions

public void setOptions(Options options)

isReturnAutoGeneratedKeys
```
public boolean isReturnAutoGeneratedKeys()
```
Specified by:

isReturnAutoGeneratedKeys in interface CommandContext

setReturnAutoGeneratedKeys

public void setReturnAutoGeneratedKeys(List<ElementSymbol> variables)

getReturnAutoGeneratedKeys

public List<ElementSymbol> getReturnAutoGeneratedKeys()

returnGeneratedKeys

public GeneratedKeysImpl returnGeneratedKeys(String[] columnNames,
                                             Class<?>[] columnDataTypes)

Specified by:: returnGeneratedKeys in interface CommandContext

getGeneratedKeys
```
public GeneratedKeysImpl getGeneratedKeys()
```
Specified by:

getGeneratedKeys in interface CommandContext

getThreadLocalContext

public static CommandContext getThreadLocalContext()

pushThreadLocalContext

public static void pushThreadLocalContext(CommandContext context)

popThreadLocalContext

public static void popThreadLocalContext()

addAndGetReservedBuffers

public long addAndGetReservedBuffers(int i)

setSessionVariable

public Object setSessionVariable(String key,
                                 Object value)

Specified by:: setSessionVariable in interface CommandContext

getSessionVariable
```
public Object getSessionVariable(String key)
```
Specified by:

getSessionVariable in interface CommandContext

getAuthorizationValidator

public AuthorizationValidator getAuthorizationValidator()

getCodeLookup

public TupleSource getCodeLookup(String matTableName,
                                 Object keyValue)

putCodeLookup

public void putCodeLookup(String matTableName,
                          Object keyValue,
                          TupleSource ts)

getConnection

public TeiidConnection getConnection()
                              throws TeiidSQLException

Specified by:: getConnection in interface CommandContext
Throws:: TeiidSQLException

getSpatialRefSys
```
public Clob getSpatialRefSys()
```
Used by the system table logic

Returns:

addCreatedLob

public void addCreatedLob(FileStoreInputStreamFactory isf)

disableAutoCleanLobs
```
public void disableAutoCleanLobs()
```

requestCancelled
```
public void requestCancelled()
```

isCancelled
```
public boolean isCancelled()
```
Check if this context or the parent has been cancelled. If the parent has been, then we'll propagate.

Returns:

clearGeneratedKeys
```
public void clearGeneratedKeys()
```

isAccessible

public Boolean isAccessible(AbstractMetadataRecord record)

setAccessible

public void setAccessible(AbstractMetadataRecord record,
                          Boolean result)

getBatchUpdateException

public Throwable getBatchUpdateException()

setBatchUpdateException

public void setBatchUpdateException(Throwable t)

isParallel
```
public boolean isParallel()
```

setParallel

public boolean setParallel(boolean value)

currentDate
```
public Date currentDate()
```

currentTime
```
public Time currentTime()
```

currentTimestamp
```
public Timestamp currentTimestamp()
```

setCurrentTimestamp

public void setCurrentTimestamp(long currentTimeMillis)

isAtomicBlock
```
public boolean isAtomicBlock()
```
Used by transaction detection logic when starting an atomic block transaction

Returns:

setAtomicBlock

public void setAtomicBlock(boolean atomicBlock)

addAccessed
```
public void addAccessed(TempMetadataID id)
```
Used by the planner to track only what is accessed by the plan

setAccessed

public void setAccessed(Collection<TempMetadataID> accessed)

isReadOnly
```
public boolean isReadOnly()
```

setReadOnly
```
public void setReadOnly(boolean b)
```

Class CommandContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CommandContext

CommandContext

CommandContext

Method Detail

getDeterminismLevel

resetDeterminismLevel

resetDeterminismLevel

setDeterminismLevel

getWorkItem

setWorkItem

clone

setNewVDBState

toString

getConnectionId

getConnectionID

getUserName

getVdbName

getVdbVersion

setConnectionID

setUserName

setVdbName

setVdbVersion

getCommandPayload

setCommandPayload

setCollectNodeStatistics

getCollectNodeStatistics

getProcessorBatchSize

getProcessorBatchSize

setProcessorBatchSize

getNextRand

getNextRand

pushCall

getCallStackDepth

popCall

setAuthoriziationValidator

getTempTableStore

setTempTableStore

getSessionTempTableStore

setSessionTempTableStore

getServerTimeZone

getQueryProcessorFactory

setQueryProcessorFactory

getVariableContext

setVariableContext

pushVariableContext

getFromContext

getGroups

getAliasMapping

getTimeSliceEnd

getTimeoutEnd

setTimeSliceEnd

setTimeoutEnd

setMetadata

getMetadata

getBufferManager

setBufferManager

getGlobalTableStore

setGlobalTableStore

isNonBlocking

setNonBlocking

setPreparedPlanCache

getPlan

putPlan

isResultSetCacheEnabled

setResultSetCacheEnabled

getUserRequestSourceConcurrency

setUserRequestSourceConcurrency

getSubject

setSubject

accessedPlanningObject

getPlanningObjects

accessedDataObject

getDataObjects

setDataObjects

getSession