com.alipay.sofa.rpc.filter

类 Filter

java.lang.Object

com.alipay.sofa.rpc.filter.Filter

直接已知子类:

BeanIdMatchFilter, ConsumerExceptionFilter, ConsumerGenericFilter, ConsumerTracerFilter, ExcludeFilter, ProviderBaggageFilter, ProviderExceptionFilter, ProviderTracerFilter, RpcReferenceContextFilter, RpcServiceContextFilter

@Extensible(singleton=false)
public abstract class Filter
extends Object

Filter SPI

构造器概要

构造器

构造器和说明
Filter()

方法概要

方法

限定符和类型	方法和说明
abstract SofaResponse	invoke(FilterInvoker invoker, SofaRequest request) Do filtering doBeforeInvoke(); // the code before invoke, even new dummy response for return (skip all next invoke).
boolean	needToLoad(FilterInvoker invoker) Is this filter need load in this invoker
void	onAsyncResponse(ConsumerConfig config, SofaRequest request, SofaResponse response, Throwable exception) Do filtering after asynchronous respond, only supported in CONSUMER SIDE.

从类继承的方法 java.lang.Object

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

构造器详细资料

Filter

public Filter()

方法详细资料

needToLoad

public boolean needToLoad(FilterInvoker invoker)

Is this filter need load in this invoker

参数:

invoker - Filter invoker contains ProviderConfig or ConsumerConfig.

返回:

is need load

invoke

public abstract SofaResponse invoke(FilterInvoker invoker,
                  SofaRequest request)
                             throws SofaRpcException

Do filtering

  doBeforeInvoke(); // the code before invoke, even new dummy response for return (skip all next invoke).
  SofaResponse response = invoker.invoke(request); // do next invoke(call next filter, call remote, call implements).
  doAfterInvoke(); // the code after invoke
 

参数:

invoker - Invoker

request - Request

返回:

SofaResponse Response

抛出:

SofaRpcException - Occur rpc exception

onAsyncResponse

public void onAsyncResponse(ConsumerConfig config,
                   SofaRequest request,
                   SofaResponse response,
                   Throwable exception)
                     throws SofaRpcException

Do filtering after asynchronous respond, only supported in CONSUMER SIDE.

Because when do async invoke, the code after invoke has been executed after invoker return dummy empty response. We need execute filter code after get true response from server.

NOTICE: The thread run onAsyncResponse(com.alipay.sofa.rpc.config.ConsumerConfig, com.alipay.sofa.rpc.core.request.SofaRequest, com.alipay.sofa.rpc.core.response.SofaResponse, java.lang.Throwable) is different with the thread run invoke(com.alipay.sofa.rpc.filter.FilterInvoker, com.alipay.sofa.rpc.core.request.SofaRequest)

参数:

config - ConsumerConfig, READ ONLY PLEASE.

request - Request

response - Response from server (if exception is null)

exception - Exception from server (if response is null)

抛出:

SofaRpcException - Other rpc exception

另请参阅:

invoke(FilterInvoker, SofaRequest), SofaRequest.isAsync()