org.jetlinks.rule.engine.api.task

接口 ExecutionContext

所有已知实现类:

AbstractExecutionContext, DefaultExecutionContext

public interface ExecutionContext

规则执行上下文,一个上下文对应一个执行中的规则

从以下版本开始:

1.1

作者:

zhouhao

方法概要

限定符和类型	方法和说明
<T> reactor.core.publisher.Mono<T>	fireEvent(String event, RuleData data) 触发事件,此方法永远返回Mono.empty()
default FlowScope	flow() 获取当前规则流作用域
default FlowScope	flow(String id) 获取指定的规则流作用域
Input	getInput() 获取输入接口，用于从上游接收数据
String	getInstanceId()
ScheduleJob	getJob() 获取任务信息
Logger	getLogger() 获取日志接口,通过此日志接口打印的日志可进行试试日志展示和记录
Output	getOutput() 获取输出接口，用于向下游节点输出数据
GlobalScope	global()
boolean	isDebug()
default Logger	logger() 同getLogger()
RuleData	newRuleData(Object data) 创建规则数据
default NodeScope	node() 获取当前规则节点作用域
default NodeScope	node(String id) 获取指定节点的作用域
default <T> reactor.core.publisher.Mono<T>	onError(@NotNull java.util.function.Supplier<Throwable> e, RuleData sourceData) 异步触发错误消息，在某些条件需要手动触发错误时,可以使用此方法。
<T> reactor.core.publisher.Mono<T>	onError(Throwable e, RuleData sourceData) 触发error,此方法永远返回Mono.empty(),此操作也会触发RuleConstants.Event.error事件
void	onShutdown(Runnable runnable) 监听停止事件
default ContextScope	scope(RuleData ruleData) 根据规则数据来获取上下文作用域,默认使用RuleData#getContextId()作为上下文ID
default ContextScope	scope(String id) 获取上下文作用域
reactor.core.publisher.Mono<Void>	shutdown(String code, String message) 停止规则

方法详细资料

getInstanceId

String getInstanceId()

返回:

规则实例ID

getLogger

Logger getLogger()

获取日志接口,通过此日志接口打印的日志可进行试试日志展示和记录

返回:

日志接口

logger

default Logger logger()

同getLogger()

返回:

日志接口

getJob

ScheduleJob getJob()

获取任务信息

返回:

任务信息

fireEvent

<T> reactor.core.publisher.Mono<T> fireEvent(@Nonnull
                                             String event,
                                             @Nonnull
                                             RuleData data)

触发事件,此方法永远返回Mono.empty()

类型参数:

T - 适配empty 泛型

参数:

event - 事件标识

data - 规则数据

返回:

Mono

onError

<T> reactor.core.publisher.Mono<T> onError(@Nullable
                                           Throwable e,
                                           @Nullable
                                           RuleData sourceData)

触发error,此方法永远返回Mono.empty(),此操作也会触发RuleConstants.Event.error事件

类型参数:

T - 适配empty 泛型

参数:

e - 异常信息

sourceData - 规则数据

返回:

Mono

onError

default <T> reactor.core.publisher.Mono<T> onError(@NotNull
                                                   @NotNull java.util.function.Supplier<Throwable> e,
                                                   @Nullable
                                                   RuleData sourceData)

异步触发错误消息，在某些条件需要手动触发错误时,可以使用此方法。

     mono
     .switchIfEmpty(context.onError(RuntimeException::new,data))
 

类型参数:

T - 适配empty 泛型

参数:

e - 异常提供信息

sourceData - 规则数据

返回:

Mono

getInput

Input getInput()

获取输入接口，用于从上游接收数据

返回:

输入接口

getOutput

Output getOutput()

获取输出接口，用于向下游节点输出数据

返回:

输出接口

shutdown

reactor.core.publisher.Mono<Void> shutdown(String code,
                                           String message)

停止规则

参数:

code - 停止原因码

message - 消息

返回:

Mono

newRuleData

RuleData newRuleData(Object data)

创建规则数据

参数:

data - 原始数据

返回:

规则数据

onShutdown

void onShutdown(Runnable runnable)

监听停止事件

参数:

runnable - 事件监听器

isDebug

boolean isDebug()

返回:

是否为debug模式

global

GlobalScope global()

返回:

获取全局作用域

scope

default ContextScope scope(String id)

获取上下文作用域

参数:

id - 上下文ID

返回:

上下文作用域

scope

default ContextScope scope(RuleData ruleData)

根据规则数据来获取上下文作用域,默认使用RuleData#getContextId()作为上下文ID

参数:

ruleData - 规则数据

返回:

上下文作用域

node

default NodeScope node()

获取当前规则节点作用域

返回:

节点作用域

node

default NodeScope node(String id)

获取指定节点的作用域

参数:

id - 节点ID

返回:

节点作用域

flow

default FlowScope flow()

获取当前规则流作用域

返回:

规则流作用域

flow

default FlowScope flow(String id)

获取指定的规则流作用域

参数:

id - 规则流ID

返回:

规则流作用域