org.teiid.dqp.internal.datamgr

Class ExecutionContextImpl

java.lang.Object

org.teiid.dqp.internal.datamgr.ExecutionContextImpl

All Implemented Interfaces:

ExecutionContext

public class ExecutionContextImpl
extends Object
implements ExecutionContext

Constructor Summary

Constructors

Constructor and Description
ExecutionContextImpl(CommandContext commandContext, String connectorName, String partId, String execCount, ConnectorWorkItem workItem)
ExecutionContextImpl(String vdbName, Object vdbVersion, Serializable executionPayload, String originalConnectionID, String connectorName, long requestId, String partId, String execCount)

Method Summary

Modifier and Type	Method and Description
void	addWarning(Exception ex) Add an exception as a warning to this Execution.
void	dataAvailable() Signal the engine that data is available and processing should be resumed.
boolean	equals(Object obj)
int	getBatchSize() Return the current connector batch size.
CacheDirective	getCacheDirective() Get the CacheDirective
CommandContext	getCommandContext() Get the CommandContext
Serializable	getCommandPayload() Get the command payload shortcut for ExecutionContext.getCommandContext().getCommandPayload()
String	getConnectionId() Get the identifier for the connection through which the command is being executed.
String	getConnectionID()
String	getConnectorIdentifier() Get the identifier for the current connector running the command
String	getExecutionCountIdentifier() Execution count defines an id; where every access to the connector from the server in a given command execution boundary is uniquely defined; Like for example in the case of "batched execution" of commands, each execution of command gets new identifier.
Serializable	getExecutionPayload()
String	getGeneralHint() Get the collection of general hints as a space concatenated string.
Collection<String>	getGeneralHints() Get the general hints.
String	getPartIdentifier() This specifies the node id for the atomic request in the relational plan of query.
String	getRequestId() Get the identifier for the command being executed.
String	getRequestID()
RuntimeMetadata	getRuntimeMetadata()
CacheDirective.Scope	getScope() Get the result cache scope for the current execution
Session	getSession() Get the current session.
String	getSourceHint() Get the collection of hints designated for this source as a space concatenated string.
Collection<String>	getSourceHints() Get the hints designated for this source.
Subject	getSubject() Get the user for the user running this query.
String	getVdbName() Get the name of the VDB this query is being run against.
String	getVdbVersion() Get the version of the VDB this query is being run against.
List<Exception>	getWarnings()
int	hashCode()
boolean	isDataAvailable()
boolean	isTransactional() Flag indicates that the operation needs to be executed in a XA transaction.
void	keepExecutionAlive(boolean alive) When the execution is turned on with "alive=true", the execution object will not be implicitly closed at the end of the last batch.
void	logCommand(Object... command) Log the source command to the command log
void	setBatchSize(int batchSize)
void	setCacheDirective(CacheDirective directive)
void	setGeneralHints(Collection<String> generalHint)
void	setHints(Collection<String> hint)
void	setRuntimeMetadata(RuntimeMetadataImpl queryMetadata)
void	setScope(CacheDirective.Scope scope) Set the result cache scope for the current execution.
void	setSession(Session session)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecutionContextImpl

public ExecutionContextImpl(String vdbName,
                            Object vdbVersion,
                            Serializable executionPayload,
                            String originalConnectionID,
                            String connectorName,
                            long requestId,
                            String partId,
                            String execCount)

ExecutionContextImpl

public ExecutionContextImpl(CommandContext commandContext,
                            String connectorName,
                            String partId,
                            String execCount,
                            ConnectorWorkItem workItem)

Method Detail

getCommandContext

public CommandContext getCommandContext()

Description copied from interface: ExecutionContext

Get the CommandContext

Specified by:

getCommandContext in interface ExecutionContext

Returns:

getConnectorIdentifier

public String getConnectorIdentifier()

Description copied from interface: ExecutionContext

Get the identifier for the current connector running the command

Specified by:

getConnectorIdentifier in interface ExecutionContext

Returns:

Connector identifier; never null

getRequestId

public String getRequestId()

Description copied from interface: ExecutionContext

Get the identifier for the command being executed. This can be correlated back to identifiers exposed in other parts of the system. shortcut for ExecutionContext.getCommandContext().getRequestId()

Specified by:

getRequestId in interface ExecutionContext

Returns:

command identifier

getPartIdentifier

public String getPartIdentifier()

Description copied from interface: ExecutionContext

This specifies the node id for the atomic request in the relational plan of query.

Specified by:

getPartIdentifier in interface ExecutionContext

getExecutionCountIdentifier

public String getExecutionCountIdentifier()

Description copied from interface: ExecutionContext

Execution count defines an id; where every access to the connector from the server in a given command execution boundary is uniquely defined; Like for example in the case of "batched execution" of commands, each execution of command gets new identifier.

Specified by:

getExecutionCountIdentifier in interface ExecutionContext

getVdbName

public String getVdbName()

Description copied from interface: ExecutionContext

Get the name of the VDB this query is being run against. shortcut for ExecutionContext.getCommandContext().getVdbName()

Specified by:

getVdbName in interface ExecutionContext

Returns:

VDB name, never null

getVdbVersion

public String getVdbVersion()

Description copied from interface: ExecutionContext

Get the version of the VDB this query is being run against. shortcut for ExecutionContext.getCommandContext().getVdbVersion()

Specified by:

getVdbVersion in interface ExecutionContext

Returns:

VDB version

getSubject

public Subject getSubject()

Description copied from interface: ExecutionContext

Get the user for the user running this query.

Specified by:

getSubject in interface ExecutionContext

Returns:

User, never null

getCommandPayload

public Serializable getCommandPayload()

Description copied from interface: ExecutionContext

Get the command payload shortcut for ExecutionContext.getCommandContext().getCommandPayload()

Specified by:

getCommandPayload in interface ExecutionContext

Returns:

the payload or null if one was not set by the client

getConnectionId

public String getConnectionId()

Description copied from interface: ExecutionContext

Get the identifier for the connection through which the command is being executed. This represents the original user connection to the Teiid system shortcut for ExecutionContext.getCommandContext().getConnectionId()

Specified by:

getConnectionId in interface ExecutionContext

Returns:

Connection identifier

keepExecutionAlive

public void keepExecutionAlive(boolean alive)

Description copied from interface: ExecutionContext

When the execution is turned on with "alive=true", the execution object will not be implicitly closed at the end of the last batch. It will only be closed at end of the user query.

The engine will already detect situations when the connection should stay open for LOB (clob/blob/xml) streaming.

Keeping the execution alive unnecessarily may cause issues with connection usage as the connection instance may not be usable by other queries.

Specified by:

keepExecutionAlive in interface ExecutionContext

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

isTransactional

public boolean isTransactional()

Description copied from interface: ExecutionContext

Flag indicates that the operation needs to be executed in a XA transaction.

Specified by:

isTransactional in interface ExecutionContext

Returns:

getBatchSize

public int getBatchSize()

Description copied from interface: ExecutionContext

Return the current connector batch size. This may be used as a hint to the underlying source query.

Specified by:

getBatchSize in interface ExecutionContext

Returns:

the Connector batch size.

setBatchSize

public void setBatchSize(int batchSize)

addWarning

public void addWarning(Exception ex)

Add an exception as a warning to this Execution.

Specified by:

addWarning in interface ExecutionContext

getWarnings

public List<Exception> getWarnings()

getSession

public Session getSession()

Description copied from interface: ExecutionContext

Get the current session. shortcut for ExecutionContext.getCommandContext().getSession()

Specified by:

getSession in interface ExecutionContext

Returns:

setSession

public void setSession(Session session)

dataAvailable

public void dataAvailable()

Description copied from interface: ExecutionContext

Signal the engine that data is available and processing should be resumed.

Specified by:

dataAvailable in interface ExecutionContext

isDataAvailable

public boolean isDataAvailable()

getGeneralHint

public String getGeneralHint()

Description copied from interface: ExecutionContext

Get the collection of general hints as a space concatenated string.

Specified by:

getGeneralHint in interface ExecutionContext

Returns:

the general hint or null if none was specified

getSourceHint

public String getSourceHint()

Description copied from interface: ExecutionContext

Get the collection of hints designated for this source as a space concatenated string.

Specified by:

getSourceHint in interface ExecutionContext

Returns:

the source hint or null if none was specified

getGeneralHints

public Collection<String> getGeneralHints()

Description copied from interface: ExecutionContext

Get the general hints.

Specified by:

getGeneralHints in interface ExecutionContext

Returns:

the general hint or null if none was specified

getSourceHints

public Collection<String> getSourceHints()

Description copied from interface: ExecutionContext

Get the hints designated for this source.

Specified by:

getSourceHints in interface ExecutionContext

Returns:

the source hint or null if none was specified

setGeneralHints

public void setGeneralHints(Collection<String> generalHint)

setHints

public void setHints(Collection<String> hint)

getConnectionID

public String getConnectionID()

Specified by:

getConnectionID in interface ExecutionContext

Returns:

getExecutionPayload

public Serializable getExecutionPayload()

Specified by:

getExecutionPayload in interface ExecutionContext

Returns:

getRequestID

public String getRequestID()

Specified by:

getRequestID in interface ExecutionContext

Returns:

getCacheDirective

public CacheDirective getCacheDirective()

Description copied from interface: ExecutionContext

Get the CacheDirective

Specified by:

getCacheDirective in interface ExecutionContext

Returns:

setCacheDirective

public void setCacheDirective(CacheDirective directive)

setRuntimeMetadata

public void setRuntimeMetadata(RuntimeMetadataImpl queryMetadata)

getRuntimeMetadata

public RuntimeMetadata getRuntimeMetadata()

Specified by:

getRuntimeMetadata in interface ExecutionContext

Returns:

the RuntimeMetadata

logCommand

public void logCommand(Object... command)

Description copied from interface: ExecutionContext

Log the source command to the command log

Specified by:

logCommand in interface ExecutionContext

getScope

public CacheDirective.Scope getScope()

Description copied from interface: ExecutionContext

Get the result cache scope for the current execution

Specified by:

getScope in interface ExecutionContext

Returns:

setScope

public void setScope(CacheDirective.Scope scope)

Description copied from interface: ExecutionContext

Set the result cache scope for the current execution.
Setting to CacheDirective.Scope.NONE will typically result in the user query result being cached at the CacheDirective.Scope.SESSION level.

Specified by:

setScope in interface ExecutionContext