org.apache.shenyu.plugin.api

Interface ShenyuPlugin

public interface ShenyuPlugin

the shenyu plugin interface.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Void>	execute(org.springframework.web.server.ServerWebExchange exchange, ShenyuPluginChain chain) Process the Web request and (optionally) delegate to the next WebFilter through the given ShenyuPluginChain.
int	getOrder() return plugin order .
default String	named() acquire plugin name.
default Boolean	skip(org.springframework.web.server.ServerWebExchange exchange) plugin is execute.

Method Detail

execute

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

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

Parameters:

exchange - the current server exchange

chain - provides a way to delegate to the next filter

Returns:

Mono<Void> to indicate when request processing is complete

getOrder

int getOrder()

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

Returns:

int order

named

default String named()

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

Returns:

plugin name.

skip

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

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

Parameters:

exchange - the current server exchange

Returns:

default false.