程序包 org.apache.dubbo.rpc

类 RpcContext

  • 直接已知子类:
    RpcContextAttachment, RpcServiceContext
    public class RpcContext
extends Object
    Thread local context. (API, ThreadLocal, ThreadSafe)

    Note: RpcContext is a temporary state holder. States in RpcContext changes every time when request is sent or received.

    There are four kinds of RpcContext, which are ServerContext, ClientAttachment, ServerAttachment and ServiceContext.

    ServiceContext: Using to pass environment parameters in the whole invocation. For example, `remotingApplicationName`, `remoteAddress`, etc. RpcServiceContext ClientAttachment, ServerAttachment and ServiceContext are using to transfer attachments. Imaging a situation like this, A is calling B, and B will call C, after that, B wants to return some attachments back to A. ClientAttachment is using to pass attachments to next hop as a consumer. ( A --> B , in A side) ServerAttachment is using to fetch attachments from previous hop as a provider. ( A --> B , in B side) ServerContext is using to return some attachments back to client as a provider. ( A <-- B , in B side) The reason why using `ServiceContext` is to make API compatible with previous.

    另请参阅:
    ContextFilter

    • 方法详细资料

      • getServerContext

        public static RpcContextAttachment getServerContext()
        get server side context. ( A <-- B , in B side)
        返回:
        server context

      • restoreServerContext

        public static void restoreServerContext​(RpcContextAttachment oldServerContext)

      • removeServerContext

        public static void removeServerContext()
        remove server side context.
        另请参阅:
        ContextFilter

      • getContext

        @Deprecated
public static RpcContext getContext()
        已过时。
        get context.
        返回:
        context

      • getClientAttachment

        public static RpcContextAttachment getClientAttachment()
        get consumer side attachment ( A --> B , in A side)
        返回:
        context

      • getServerAttachment

        public static RpcContextAttachment getServerAttachment()
        get provider side attachment from consumer ( A --> B , in B side)
        返回:
        context

      • getServiceContext

        public static RpcServiceContext getServiceContext()
        Using to pass environment parameters in the whole invocation. For example, `remotingApplicationName`, `remoteAddress`, etc. RpcServiceContext
        返回:
        context

      • removeServiceContext

        public static void removeServiceContext()

      • removeClientAttachment

        public static void removeClientAttachment()

      • removeServerAttachment

        public static void removeServerAttachment()

      • canRemove

        public boolean canRemove()

      • clearAfterEachInvoke

        public void clearAfterEachInvoke​(boolean remove)

      • removeContext

        public static void removeContext()
        remove context.
        另请参阅:
        ContextFilter

      • removeContext

        public static void removeContext​(boolean checkCanRemove)
        customized for internal use.
        参数:
        checkCanRemove - if need check before remove

      • getRequest

        public Object getRequest()
        Get the request object of the underlying RPC protocol, e.g. HttpServletRequest
        返回:
        null if the underlying protocol doesn't provide support for getting request

      • setRequest

        public void setRequest​(Object request)

      • getRequest

        public <T> T getRequest​(Class<T> clazz)
        Get the request object of the underlying RPC protocol, e.g. HttpServletRequest
        返回:
        null if the underlying protocol doesn't provide support for getting request or the request is not of the specified type

      • getResponse

        public Object getResponse()
        Get the response object of the underlying RPC protocol, e.g. HttpServletResponse
        返回:
        null if the underlying protocol doesn't provide support for getting response

      • setResponse

        public void setResponse​(Object response)

      • getResponse

        public <T> T getResponse​(Class<T> clazz)
        Get the response object of the underlying RPC protocol, e.g. HttpServletResponse
        返回:
        null if the underlying protocol doesn't provide support for getting response or the response is not of the specified type

      • isProviderSide

        public boolean isProviderSide()
        is provider side.
        返回:
        provider side.

      • isConsumerSide

        public boolean isConsumerSide()
        is consumer side.
        返回:
        consumer side.

      • getCompletableFuture

        public <T> CompletableFuture<T> getCompletableFuture()
        get CompletableFuture.
        类型参数:
        T -
        返回:
        future

      • getFuture

        public <T> Future<T> getFuture()
        get future.
        类型参数:
        T -
        返回:
        future

      • setFuture

        public void setFuture​(CompletableFuture<?> future)
        set future.
        参数:
        future -

      • getUrls

        public List<URL> getUrls()

      • setUrls

        public void setUrls​(List<URL> urls)

      • getUrl

        public URL getUrl()

      • setUrl

        public void setUrl​(URL url)

      • getMethodName

        public String getMethodName()
        get method name.
        返回:
        method name.

      • setMethodName

        public void setMethodName​(String methodName)

      • getParameterTypes

        public Class<?>[] getParameterTypes()
        get parameter types.

      • setParameterTypes

        public void setParameterTypes​(Class<?>[] parameterTypes)

      • getArguments

        public Object[] getArguments()
        get arguments.
        返回:
        arguments.

      • setArguments

        public void setArguments​(Object[] arguments)

      • setLocalAddress

        public RpcContext setLocalAddress​(String host,
                                  int port)
        set local address.
        参数:
        host -
        port -
        返回:
        context

      • getLocalAddress

        public InetSocketAddress getLocalAddress()
        get local address.
        返回:
        local address

      • setLocalAddress

        public RpcContext setLocalAddress​(InetSocketAddress address)
        set local address.
        参数:
        address -
        返回:
        context

      • getLocalAddressString

        public String getLocalAddressString()

      • getLocalHostName

        public String getLocalHostName()
        get local host name.
        返回:
        local host name

      • setRemoteAddress

        public RpcContext setRemoteAddress​(String host,
                                   int port)
        set remote address.
        参数:
        host -
        port -
        返回:
        context

      • getRemoteAddress

        public InetSocketAddress getRemoteAddress()
        get remote address.
        返回:
        remote address

      • setRemoteAddress

        public RpcContext setRemoteAddress​(InetSocketAddress address)
        set remote address.
        参数:
        address -
        返回:
        context

      • getRemoteApplicationName

        public String getRemoteApplicationName()

      • setRemoteApplicationName

        public RpcContext setRemoteApplicationName​(String remoteApplicationName)

      • getRemoteAddressString

        public String getRemoteAddressString()
        get remote address string.
        返回:
        remote address string.

      • getRemoteHostName

        public String getRemoteHostName()
        get remote host name.
        返回:
        remote host name

      • getLocalHost

        public String getLocalHost()
        get local host.
        返回:
        local host

      • getLocalPort

        public int getLocalPort()
        get local port.
        返回:
        port

      • getRemoteHost

        public String getRemoteHost()
        get remote host.
        返回:
        remote host

      • getRemotePort

        public int getRemotePort()
        get remote port.
        返回:
        remote port

      • getObjectAttachment

        public Object getObjectAttachment​(String key)
        get attachment.
        参数:
        key -
        返回:
        attachment

      • setAttachment

        public RpcContext setAttachment​(String key,
                                String value)
        set attachment.
        参数:
        key -
        value -
        返回:
        context

      • removeAttachment

        public RpcContext removeAttachment​(String key)
        remove attachment.
        参数:
        key -
        返回:
        context

      • getObjectAttachments

        public Map<String,​Object> getObjectAttachments()
        get attachments.
        返回:
        attachments

      • setAttachments

        public RpcContext setAttachments​(Map<String,​String> attachment)
        set attachments
        参数:
        attachment -
        返回:
        context

      • setObjectAttachments

        public RpcContext setObjectAttachments​(Map<String,​Object> attachment)
        set attachments
        参数:
        attachment -
        返回:
        context

      • clearAttachments

        public void clearAttachments()

      • isServerSide

        @Deprecated
public boolean isServerSide()
        已过时。
        Replace to isProviderSide()

      • isClientSide

        @Deprecated
public boolean isClientSide()
        已过时。
        Replace to isConsumerSide()

      • getInvoker

        @Deprecated
public Invoker<?> getInvoker()
        已过时。
        Replace to getUrl()

      • getInvocation

        @Deprecated
public Invocation getInvocation()
        已过时。
        Replace to getMethodName(), getParameterTypes(), getArguments()

      • asyncCall

        public <T> CompletableFuture<T> asyncCall​(Callable<T> callable)
        Async invocation. Timeout will be handled even if Future.get() is not called.
        参数:
        callable -
        返回:
        get the return result from future.get()

      • asyncCall

        public void asyncCall​(Runnable runnable)
        one way async call, send request only, and result is not required
        参数:
        runnable -

      • isAsyncStarted

        public boolean isAsyncStarted()

      • stopAsync

        public boolean stopAsync()

      • getGroup

        public String getGroup()

      • getVersion

        public String getVersion()

      • getInterfaceName

        public String getInterfaceName()

      • getProtocol

        public String getProtocol()

      • getServiceKey

        public String getServiceKey()

      • getProtocolServiceKey

        public String getProtocolServiceKey()

      • getConsumerUrl

        public URL getConsumerUrl()

      • setConsumerUrl

        public void setConsumerUrl​(URL consumerUrl)

      • setRpcContext

        public static void setRpcContext​(URL url)