io.seata.rm.tcc.interceptor

Class ActionContextUtil

java.lang.Object

io.seata.rm.tcc.interceptor.ActionContextUtil

public final class ActionContextUtil
extends Object

Extracting TCC Context from Method

Method Summary

Modifier and Type	Method and Description
static <T> T	convertActionContext(String key, Object value, Class<T> targetClazz) Convert action context
static Map<String,Object>	fetchContextFromObject(Object targetParam) Extracting context data from parameters
static String	getParamNameFromAnnotation(BusinessActionContextParameter annotation)
static Object	handleActionContext(Object actionContext) Handle the action context.
static void	loadParamByAnnotationAndPutToContext(ParamType paramType, String paramName, Object paramValue, BusinessActionContextParameter annotation, Map<String,Object> actionContext) load param by the config of annotation, and then put into the action context
static boolean	putActionContext(Map<String,Object> actionContext, Map<String,Object> actionContextMap) put the action context after handle
static boolean	putActionContext(Map<String,Object> actionContext, String key, Object value) put the action context after handle
static boolean	putActionContextWithoutHandle(Map<String,Object> actionContext, Map<String,Object> actionContextMap) put the action context without handle
static boolean	putActionContextWithoutHandle(Map<String,Object> actionContext, String key, Object value) put the action context without handle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

fetchContextFromObject

public static Map<String,Object> fetchContextFromObject(@Nonnull
                                                        Object targetParam)

Extracting context data from parameters

Parameters:

targetParam - the target param

Returns:

map the context

loadParamByAnnotationAndPutToContext

public static void loadParamByAnnotationAndPutToContext(@Nonnull
                                                        ParamType paramType,
                                                        @Nonnull
                                                        String paramName,
                                                        Object paramValue,
                                                        @Nonnull
                                                        BusinessActionContextParameter annotation,
                                                        @Nonnull
                                                        Map<String,Object> actionContext)

load param by the config of annotation, and then put into the action context

Parameters:

paramType - the param type, 'param' or 'field'

paramName - the param name

paramValue - the param value

annotation - the annotation on the param or field

actionContext - the action context

getParamNameFromAnnotation

public static String getParamNameFromAnnotation(@Nonnull
                                                BusinessActionContextParameter annotation)

putActionContext

public static boolean putActionContext(Map<String,Object> actionContext,
                                       String key,
                                       Object value)

put the action context after handle

Parameters:

actionContext - the action context

key - the actionContext's key

value - the actionContext's value

Returns:

the action context is changed

putActionContext

public static boolean putActionContext(Map<String,Object> actionContext,
                                       @Nonnull
                                       Map<String,Object> actionContextMap)

put the action context after handle

Parameters:

actionContext - the action context

actionContextMap - the actionContextMap

Returns:

the action context is changed

putActionContextWithoutHandle

public static boolean putActionContextWithoutHandle(@Nonnull
                                                    Map<String,Object> actionContext,
                                                    String key,
                                                    Object value)

put the action context without handle

Parameters:

actionContext - the action context

key - the actionContext's key

value - the actionContext's value

Returns:

the action context is changed

putActionContextWithoutHandle

public static boolean putActionContextWithoutHandle(Map<String,Object> actionContext,
                                                    @Nonnull
                                                    Map<String,Object> actionContextMap)

put the action context without handle

Parameters:

actionContext - the action context

actionContextMap - the actionContextMap

Returns:

the action context is changed

handleActionContext

public static Object handleActionContext(@Nonnull
                                         Object actionContext)

Handle the action context. It is convenient to convert type in phase 2.

Parameters:

actionContext - the action context

Returns:

the action context or JSON string

See Also:

convertActionContext(String, Object, Class), BusinessActionContext.getActionContext(String, Class)

convertActionContext

public static <T> T convertActionContext(String key,
                                         @Nullable
                                         Object value,
                                         @Nonnull
                                         Class<T> targetClazz)

Convert action context

Type Parameters:

T - the target type

Parameters:

key - the actionContext's key

value - the actionContext's value

targetClazz - the target class

Returns:

the action context of the target type