com.alibaba.csp.sentinel.adapter.gateway.common.param

Class ConfigurableRequestItemParser<T>

java.lang.Object

com.alibaba.csp.sentinel.adapter.gateway.common.param.ConfigurableRequestItemParser<T>

All Implemented Interfaces:

RequestItemParser<T>

public class ConfigurableRequestItemParser<T>
extends Object
implements RequestItemParser<T>

delegate RequestItemParser, support add extractors to customize request item parse.

example: if you want to get client real ip in multi nginx proxy, you can register SentinelGatewayFilter bean as follows ConfigurableRequestItemParser parser = new ConfigurableRequestItemParser<>(new ServerWebExchangeItemParser()); List headerNames = Arrays.asList("X-Real-IP", "Client-IP"); parser.addRemoteAddressExtractor(serverWebExchange -> { for (String headerKey : headerNames) { String remoteAddress = serverWebExchange.getRequest().getHeaders().getFirst(headerKey); if (StringUtils.hasLength(remoteAddress)) { return remoteAddress; } } return null; }); return new SentinelGatewayFilter(parser);

Author:

icodening

Constructor Summary

Constructors

Constructor and Description
ConfigurableRequestItemParser(RequestItemParser<T> delegate)

Method Summary

Modifier and Type	Method and Description
ConfigurableRequestItemParser<T>	addCookieValueExtractor(BiFunction<T,String,String> extractor)
ConfigurableRequestItemParser<T>	addHeaderExtractor(BiFunction<T,String,String> extractor)
ConfigurableRequestItemParser<T>	addPathExtractor(Function<T,String> extractor)
ConfigurableRequestItemParser<T>	addRemoteAddressExtractor(Function<T,String> extractor)
ConfigurableRequestItemParser<T>	addUrlParamExtractor(BiFunction<T,String,String> extractor)
String	getCookieValue(T request, String cookieName) Get the cookie value associated with the cookie name.
String	getHeader(T request, String key) Get the header associated with the header key.
String	getPath(T request) Get API path from the request.
String	getRemoteAddress(T request) Get remote address from the request.
String	getUrlParam(T request, String paramName) Get the parameter value associated with the parameter name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurableRequestItemParser

public ConfigurableRequestItemParser(RequestItemParser<T> delegate)

Method Detail

getPath

public String getPath(T request)

Description copied from interface: RequestItemParser

Get API path from the request.

Specified by:

getPath in interface RequestItemParser<T>

Parameters:

request - valid request

Returns:

API path

getRemoteAddress

public String getRemoteAddress(T request)

Description copied from interface: RequestItemParser

Get remote address from the request.

Specified by:

getRemoteAddress in interface RequestItemParser<T>

Parameters:

request - valid request

Returns:

remote address

getHeader

public String getHeader(T request,
                        String key)

Description copied from interface: RequestItemParser

Get the header associated with the header key.

Specified by:

getHeader in interface RequestItemParser<T>

Parameters:

request - valid request

key - valid header key

Returns:

the header

getUrlParam

public String getUrlParam(T request,
                          String paramName)

Description copied from interface: RequestItemParser

Get the parameter value associated with the parameter name.

Specified by:

getUrlParam in interface RequestItemParser<T>

Parameters:

request - valid request

paramName - valid parameter name

Returns:

the parameter value

getCookieValue

public String getCookieValue(T request,
                             String cookieName)

Description copied from interface: RequestItemParser

Get the cookie value associated with the cookie name.

Specified by:

getCookieValue in interface RequestItemParser<T>

Parameters:

request - valid request

cookieName - valid cookie name

Returns:

the cookie value

addPathExtractor

public ConfigurableRequestItemParser<T> addPathExtractor(Function<T,String> extractor)

addRemoteAddressExtractor

public ConfigurableRequestItemParser<T> addRemoteAddressExtractor(Function<T,String> extractor)

addHeaderExtractor

public ConfigurableRequestItemParser<T> addHeaderExtractor(BiFunction<T,String,String> extractor)

addUrlParamExtractor

public ConfigurableRequestItemParser<T> addUrlParamExtractor(BiFunction<T,String,String> extractor)

addCookieValueExtractor

public ConfigurableRequestItemParser<T> addCookieValueExtractor(BiFunction<T,String,String> extractor)