org.teiid
Interface CommandContext

public interface CommandContext

Context information for the currently executing command. Can be used as an argument to UDFs.

Method Summary

java.util.Map<java.lang.String,DataPolicy>	getAllowedDataPolicies() Get the user's data policies, never null
java.io.Serializable	getCommandPayload() Get the current command payload
java.lang.String	getConnectionID() Get the connection id
java.util.Properties	getEnvironmentProperties() Deprecated.
double	getNextRand() Get the next random double value
double	getNextRand(long seed) Sets the seed value and returns the next random double value.
int	getProcessorBatchSize() Get the processor batch size set on the BufferManager
java.lang.String	getRequestId() Get the current request id
java.util.TimeZone	getServerTimeZone() Get the server TimeZone
Session	getSession() Get the current session
javax.security.auth.Subject	getSubject() Get the current subject
java.lang.String	getUserName() Get the current user name
VDB	getVdb() Get the current vdb
java.lang.String	getVdbName() Get the current vdb name
int	getVdbVersion() Get the current vdb version

Method Detail

getUserName

java.lang.String getUserName()

Get the current user name

Returns:

getVdbName

java.lang.String getVdbName()

Get the current vdb name

Returns:

getVdbVersion

int getVdbVersion()

Get the current vdb version

Returns:

getConnectionID

java.lang.String getConnectionID()

Get the connection id

Returns:

getEnvironmentProperties

java.util.Properties getEnvironmentProperties()

Deprecated.

Get the environment properties. The returned properties are associated only with the currently executing command. The only built-in key/value in the properties is the key "sessionid" with the same value as getConnectionID()

Returns:

getNextRand

double getNextRand()

Get the next random double value

Returns:

getNextRand

double getNextRand(long seed)

Sets the seed value and returns the next random double value. Additional calls to getNextRand() will be based upon the seed value.

Parameters:

seed -

Returns:

getProcessorBatchSize

int getProcessorBatchSize()

Get the processor batch size set on the BufferManager

Returns:

getServerTimeZone

java.util.TimeZone getServerTimeZone()

Get the server TimeZone

Returns:

getSubject

javax.security.auth.Subject getSubject()

Get the current subject

Returns:

getSession

Session getSession()

Get the current session

Returns:

getCommandPayload

java.io.Serializable getCommandPayload()

Get the current command payload

Returns:

may be null if the client did not set a payload

getRequestId

java.lang.String getRequestId()

Get the current request id

Returns:

getAllowedDataPolicies

java.util.Map<java.lang.String,DataPolicy> getAllowedDataPolicies()

Get the user's data policies, never null

Returns:

getVdb

VDB getVdb()

Get the current vdb

Returns: