org.mule.runtime.extension.api.runtime.operation

Interface OperationContext

public interface OperationContext

Provides context information about the execution of an operation

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Optional<ConfigurationInstance>	getConfiguration() Returns the ConfigurationInstance for the operation being executed.
ExtensionModel	getExtensionModel()
RuntimeOperationModel	getOperationModel() Returns the model associated to the operation being executed
<T> T	getParameter(String parameterName) Returns the value associated to a parameter of name parameterName
<T> T	getTypeSafeParameter(String parameterName, Class<? extends T> expectedType) Same as getParameter(String) with the added restriction that the returned value is expected to be either an instance of expectedType or null
boolean	hasParameter(String parameterName) Returns whether parameter of name parameterName has a value associated to it.

Method Detail

hasParameter

boolean hasParameter(String parameterName)

Returns whether parameter of name parameterName has a value associated to it.

Parameters:

parameterName - the name of a ParameterModel of the OperationModel being executed

Returns:

true if the parameter is present.

getParameter

<T> T getParameter(String parameterName)

Returns the value associated to a parameter of name parameterName

Type Parameters:

T - the returned value's generic type

Parameters:

parameterName - the name of a ParameterModel of the OperationModel being executed

Returns:

the parameter's value or null. Notice that null means that the parameter has been resolved to that value.

Throws:

NoSuchElementException - if the parameter is not present.

getTypeSafeParameter

<T> T getTypeSafeParameter(String parameterName,
                           Class<? extends T> expectedType)

Same as getParameter(String) with the added restriction that the returned value is expected to be either an instance of expectedType or null

Type Parameters:

T - the returned value's expected type

Parameters:

parameterName - the name of a ParameterModel of the OperationModel being executed

expectedType - a Class of which the returned value is expected to be an instance of

Returns:

the parameter's value or null. Notice that null means that the parameter has been resolved to that value.

Throws:

NoSuchElementException - if the parameter is not present.

IllegalArgumentException - if the returned value is not an instance of expectedType

getConfiguration

Optional<ConfigurationInstance> getConfiguration()

Returns the ConfigurationInstance for the operation being executed.

Returns:

a ConfigurationInstance consistent with a corresponding ConfigurationModel

getOperationModel

RuntimeOperationModel getOperationModel()

Returns the model associated to the operation being executed

Returns:

a RuntimeOperationModel

getExtensionModel

ExtensionModel getExtensionModel()