org.mule.runtime.module.extension.api.runtime.privileged

Interface ExecutionContextAdapter<M extends org.mule.runtime.api.meta.model.ComponentModel>

All Superinterfaces:

EventedExecutionContext<M>, org.mule.runtime.extension.api.runtime.operation.ExecutionContext<M>

All Known Implementing Classes:

AbstractExecutionContextAdapterDecorator, DefaultExecutionContext

@NoImplement
public interface ExecutionContextAdapter<M extends org.mule.runtime.api.meta.model.ComponentModel>
extends EventedExecutionContext<M>

Adapter interface which expands the contract of ExecutionContext which functionality that is internal to this implementation of the extensions API and shouldn't be accessible for the extensions themselves.

Among other things, it adds the concept of variables, which are key-value pairs in order to contain state that is not specific to the operation but to the extensions framework itself. It's not to contain operation parameters as its ExecutionContext.getParameter(String) counter part. It's meant for things like connection pointers, state to be shared between interceptors and operation executors, etc.

Since:

3.7.0

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.component.Component	getComponent()
org.mule.runtime.api.component.location.ComponentLocation	getComponentLocation() Deprecated. use #getComponent().getLocation()
org.mule.runtime.api.scheduler.Scheduler	getCurrentScheduler()
CursorProviderFactory	getCursorProviderFactory()
MuleContext	getMuleContext()
Optional<RetryPolicyTemplate>	getRetryPolicyTemplate()
org.mule.runtime.api.security.SecurityContext	getSecurityContext() The security context for this session.
StreamingManager	getStreamingManager()
Optional<TransactionConfig>	getTransactionConfig()
<T> T	getVariable(String key) Returns the value associated with the key
<T> T	removeVariable(String key) Removes the variable value associated with key.
void	setCurrentScheduler(org.mule.runtime.api.scheduler.Scheduler currentScheduler)
void	setSecurityContext(org.mule.runtime.api.security.SecurityContext securityContext) The security context for this session.
Object	setVariable(String key, Object value) Sets a variable of the given key and value.

Methods inherited from interface org.mule.runtime.module.extension.api.runtime.privileged.EventedExecutionContext

changeEvent, getEvent

Methods inherited from interface org.mule.runtime.extension.api.runtime.operation.ExecutionContext

getComponentModel, getConfiguration, getExtensionModel, getParameter, getParameterOrDefault, getParameters, hasParameter

Method Detail

getVariable

<T> T getVariable(String key)

Returns the value associated with the key

Type Parameters:

T - the generic type for the value

Parameters:

key - the variable's key

Returns:

the value associated with key or null if no such variable was registered.

setVariable

Object setVariable(String key,
                   Object value)

Sets a variable of the given key and value.

Parameters:

key - the variable's key. Cannot be null

value - the associated value. Cannot be null

Returns:

the value previously associated with the key or null if no such association existed.

removeVariable

<T> T removeVariable(String key)

Removes the variable value associated with key.

Type Parameters:

T - the generic type for the removed value

Parameters:

key - the variable's key. Cannot be null

Returns:

the value that was associated with the key or null if no such association existed

getTransactionConfig

Optional<TransactionConfig> getTransactionConfig()

Returns:

an Optional TransactionConfig if the operation is transactional

getMuleContext

MuleContext getMuleContext()

Returns:

The MuleContext on which the operation is being executed

getCursorProviderFactory

CursorProviderFactory getCursorProviderFactory()

Returns:

The CursorProviderFactory configured on the executing component

getStreamingManager

StreamingManager getStreamingManager()

Returns:

The application's StreamingManager

getComponent

org.mule.runtime.api.component.Component getComponent()

Returns:

The Component executing

Since:

4.1

getComponentLocation

@Deprecated
org.mule.runtime.api.component.location.ComponentLocation getComponentLocation()

Deprecated. use #getComponent().getLocation()

Returns:

The ComponentLocation of the executing component

getRetryPolicyTemplate

Optional<RetryPolicyTemplate> getRetryPolicyTemplate()

Returns:

The reconnection strategy to use in case of connectivity problems

setSecurityContext

void setSecurityContext(org.mule.runtime.api.security.SecurityContext securityContext)

The security context for this session. If not null outbound, inbound and/or method invocations will be authenticated using this context

Parameters:

securityContext - the context for this session or null if the request is not secure.

getSecurityContext

org.mule.runtime.api.security.SecurityContext getSecurityContext()

The security context for this session. If not null outbound, inbound and/or method invocations will be authenticated using this context

Returns:

the context for this session or null if the request is not secure.

setCurrentScheduler

void setCurrentScheduler(org.mule.runtime.api.scheduler.Scheduler currentScheduler)

Parameters:

currentScheduler - the scheduler that was determined by the ProcessingStrategy to execute this component.

getCurrentScheduler

org.mule.runtime.api.scheduler.Scheduler getCurrentScheduler()

Returns:

the scheduler that was determined by the ProcessingStrategy to execute this component.