Package org.apache.apisix.plugin.runner.filter

Interface PluginFilter

public interface PluginFilter

Method Summary

Modifier and Type	Method	Description
void	filter(HttpRequest request, HttpResponse response, PluginFilterChain chain)	do the plugin filter chain
String	name()
Boolean	requiredBody()	need request body in plugins or not
List<String>	requiredVars()	declare in advance the nginx variables that you want to use in the plugin

Method Details

name

String name()

Returns:

the name of plugin filter

filter

void filter(HttpRequest request,
 HttpResponse response,
 PluginFilterChain chain)

do the plugin filter chain

Parameters:

request - the request form APISIX

response - the response for APISIX

chain - the chain of filters

requiredVars

List<String> requiredVars()

declare in advance the nginx variables that you want to use in the plugin

Returns:

the nginx variables as list

requiredBody

Boolean requiredBody()

need request body in plugins or not

Returns:

true if need request body