com.microsoft.azure.functions.internal.spi.middleware

Interface MiddlewareContext

All Superinterfaces:

ExecutionContext

public interface MiddlewareContext
extends ExecutionContext

Middleware Execution Context

This class is internal and is hence not for public use at this time. Its APIs are unstable and can change at any time.

Method Summary

Modifier and Type	Method and Description
String	getParameterName(String annotationSimpleClassName) Returns the name of parameter defined in customer function.
Object	getParameterValue(String name) Returns corresponding parameter value sent from host by the given the parameter name.
Object	getReturnValue() Returns the return value from customer function invocation.
void	updateParameterValue(String name, Object value) Updates the parameter value by parameter name.
void	updateReturnValue(Object returnValue) Updates the return value from customer function invocation.

Methods inherited from interface com.microsoft.azure.functions.ExecutionContext

getFunctionName, getInvocationId, getLogger, getRetryContext, getTraceContext

Method Detail

getParameterName

String getParameterName(String annotationSimpleClassName)

Returns the name of parameter defined in customer function. The input is the simple class name of target annotation.

Parameters:

annotationSimpleClassName - the simple class name of target annotation

Returns:

the name of parameter defined in customer function

getParameterValue

Object getParameterValue(String name)

Returns corresponding parameter value sent from host by the given the parameter name. The return type is Object but the real type is String (currently only support get String type, planning to support other types in the future.) Make it return Object to avoid break this API in the future.

Parameters:

name - the name of parameter

Returns:

an object which will be String type that represents parameter value of customer function

updateParameterValue

void updateParameterValue(String name,
                          Object value)

Updates the parameter value by parameter name. It will be the actual parameter value used when invoke customer function. This API give middleware ability to update function input.

Parameters:

name - the name of parameter to be updated

value - the value of parameter to be updated

getReturnValue

Object getReturnValue()

Returns the return value from customer function invocation.

Returns:

an object that is the return value of customer function

updateReturnValue

void updateReturnValue(Object returnValue)

Updates the return value from customer function invocation.

Parameters:

returnValue - value that will be updated as function return value.