org.dromara.soul.web.plugin

接口 SoulPlugin

所有已知实现类:

AbstractSoulPlugin, DividePlugin, DubboPlugin, DubboResponsePlugin, GlobalPlugin, MonitorPlugin, NettyClientResponsePlugin, NettyHttpClientPlugin, RateLimiterPlugin, RewritePlugin, SignPlugin, SpringCloudPlugin, WafPlugin, WebClientPlugin, WebClientResponsePlugin, WebSocketPlugin

public interface SoulPlugin

the soul plugin interface.

作者:

xiaoyu

方法概要

限定符和类型	方法和说明
reactor.core.publisher.Mono<Void>	execute(org.springframework.web.server.ServerWebExchange exchange, SoulPluginChain chain) Process the Web request and (optionally) delegate to the next WebFilter through the given SoulPluginChain.
int	getOrder() return plugin order .
String	named() acquire plugin name.
PluginTypeEnum	pluginType() return plugin type.
default Boolean	skip(org.springframework.web.server.ServerWebExchange exchange) plugin is execute.

方法详细资料

execute

reactor.core.publisher.Mono<Void> execute(org.springframework.web.server.ServerWebExchange exchange,
                                          SoulPluginChain chain)

Process the Web request and (optionally) delegate to the next WebFilter through the given SoulPluginChain.

参数:

exchange - the current server exchange

chain - provides a way to delegate to the next filter

返回:

Mono<Void> to indicate when request processing is complete

pluginType

PluginTypeEnum pluginType()

return plugin type. the plugin execution order before type The first to perform then Function Type ,then last type.

返回:

PluginTypeEnum

getOrder

int getOrder()

return plugin order . This attribute To determine the plugin execution order in the same type plugin.

返回:

int order

named

String named()

acquire plugin name. this is plugin name define if you extend AbstractSoulPlugin you must Provide the right name. if you impl AbstractSoulPlugin this attribute not use.

返回:

plugin name.

skip

default Boolean skip(org.springframework.web.server.ServerWebExchange exchange)

plugin is execute. if return true this plugin can not execute.

参数:

exchange - the current server exchange

返回:

default false.