com.alibaba.dubbo.rpc

Class RpcContext

java.lang.Object

com.alibaba.dubbo.rpc.RpcContext

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. For example: A invokes B, then B invokes C. On service B, RpcContext saves invocation info from A to B before B starts invoking C, and saves invocation info from B to C after B invokes C.

See Also:

ContextFilter

Method Summary

Methods

Modifier and Type	Method and Description
<T> Future<T>	asyncCall(Callable<T> callable) Async invocation.
void	asyncCall(Runnable runnable) one way async call, send request only, and result is not required
void	clearAttachments()
Map<String,Object>	get() get values.
Object	get(String key) get value.
Object[]	getArguments() get arguments.
String	getAttachment(String key) get attachment.
Map<String,String>	getAttachments() get attachments.
static RpcContext	getContext() get context.
<T> Future<T>	getFuture() get future.
Invocation	getInvocation() Deprecated. Replace to getMethodName(), getParameterTypes(), getArguments()
Invoker<?>	getInvoker() Deprecated. Replace to getUrl()
List<Invoker<?>>	getInvokers() Deprecated. Replace to getUrls()
InetSocketAddress	getLocalAddress() get local address.
String	getLocalAddressString()
String	getLocalHost() get local host.
String	getLocalHostName() get local host name.
int	getLocalPort() get local port.
String	getMethodName() get method name.
Class<?>[]	getParameterTypes() get parameter types.
InetSocketAddress	getRemoteAddress() get remote address.
String	getRemoteAddressString() get remote address string.
String	getRemoteHost() get remote host.
String	getRemoteHostName() get remote host name.
int	getRemotePort() get remote port.
Object	getRequest() Get the request object of the underlying RPC protocol, e.g.
<T> T	getRequest(Class<T> clazz) Get the request object of the underlying RPC protocol, e.g.
Object	getResponse() Get the response object of the underlying RPC protocol, e.g.
<T> T	getResponse(Class<T> clazz) Get the response object of the underlying RPC protocol, e.g.
URL	getUrl()
List<URL>	getUrls()
boolean	isClientSide() Deprecated. Replace to isConsumerSide()
boolean	isConsumerSide() is consumer side.
boolean	isProviderSide() is provider side.
boolean	isServerSide() Deprecated. Replace to isProviderSide()
RpcContext	remove(String key) remove value.
RpcContext	removeAttachment(String key) remove attachment.
static void	removeContext() remove context.
RpcContext	set(String key, Object value) set value.
void	setArguments(Object[] arguments)
RpcContext	setAttachment(String key, String value) set attachment.
RpcContext	setAttachments(Map<String,String> attachment) set attachments
void	setFuture(Future<?> future) set future.
RpcContext	setInvocation(Invocation invocation)
RpcContext	setInvoker(Invoker<?> invoker)
RpcContext	setInvokers(List<Invoker<?>> invokers)
RpcContext	setLocalAddress(InetSocketAddress address) set local address.
RpcContext	setLocalAddress(String host, int port) set local address.
void	setMethodName(String methodName)
void	setParameterTypes(Class<?>[] parameterTypes)
RpcContext	setRemoteAddress(InetSocketAddress address) set remote address.
RpcContext	setRemoteAddress(String host, int port) set remote address.
void	setRequest(Object request)
void	setResponse(Object response)
void	setUrl(URL url)
void	setUrls(List<URL> urls)

Methods inherited from class java.lang.Object

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

Method Detail

getContext

public static RpcContext getContext()

get context.

Returns:

context

removeContext

public static void removeContext()

remove context.

See Also:

ContextFilter

getRequest

public Object getRequest()

Get the request object of the underlying RPC protocol, e.g. HttpServletRequest

Returns:

null if the underlying protocol doesn't provide support for getting request

getRequest

public <T> T getRequest(Class<T> clazz)

Get the request object of the underlying RPC protocol, e.g. HttpServletRequest

Returns:

null if the underlying protocol doesn't provide support for getting request or the request is not of the specified type

setRequest

public void setRequest(Object request)

getResponse

public Object getResponse()

Get the response object of the underlying RPC protocol, e.g. HttpServletResponse

Returns:

null if the underlying protocol doesn't provide support for getting response

getResponse

public <T> T getResponse(Class<T> clazz)

Get the response object of the underlying RPC protocol, e.g. HttpServletResponse

Returns:

null if the underlying protocol doesn't provide support for getting response or the response is not of the specified type

setResponse

public void setResponse(Object response)

isProviderSide

public boolean isProviderSide()

is provider side.

Returns:

provider side.

isConsumerSide

public boolean isConsumerSide()

is consumer side.

Returns:

consumer side.

getFuture

public <T> Future<T> getFuture()

get future.

Type Parameters:

T -

Returns:

future

setFuture

public void setFuture(Future<?> future)

set future.

Parameters:

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.

Returns:

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.

Returns:

arguments.

setArguments

public void setArguments(Object[] arguments)

setLocalAddress

public RpcContext setLocalAddress(String host,
                         int port)

set local address.

Parameters:

host -

port -

Returns:

context

getLocalAddress

public InetSocketAddress getLocalAddress()

get local address.

Returns:

local address

setLocalAddress

public RpcContext setLocalAddress(InetSocketAddress address)

set local address.

Parameters:

address -

Returns:

context

getLocalAddressString

public String getLocalAddressString()

getLocalHostName

public String getLocalHostName()

get local host name.

Returns:

local host name

setRemoteAddress

public RpcContext setRemoteAddress(String host,
                          int port)

set remote address.

Parameters:

host -

port -

Returns:

context

getRemoteAddress

public InetSocketAddress getRemoteAddress()

get remote address.

Returns:

remote address

setRemoteAddress

public RpcContext setRemoteAddress(InetSocketAddress address)

set remote address.

Parameters:

address -

Returns:

context

getRemoteAddressString

public String getRemoteAddressString()

get remote address string.

Returns:

remote address string.

getRemoteHostName

public String getRemoteHostName()

get remote host name.

Returns:

remote host name

getLocalHost

public String getLocalHost()

get local host.

Returns:

local host

getLocalPort

public int getLocalPort()

get local port.

Returns:

port

getRemoteHost

public String getRemoteHost()

get remote host.

Returns:

remote host

getRemotePort

public int getRemotePort()

get remote port.

Returns:

remote port

getAttachment

public String getAttachment(String key)

get attachment.

Parameters:

key -

Returns:

attachment

setAttachment

public RpcContext setAttachment(String key,
                       String value)

set attachment.

Parameters:

key -

value -

Returns:

context

removeAttachment

public RpcContext removeAttachment(String key)

remove attachment.

Parameters:

key -

Returns:

context

getAttachments

public Map<String,String> getAttachments()

get attachments.

Returns:

attachments

setAttachments

public RpcContext setAttachments(Map<String,String> attachment)

set attachments

Parameters:

attachment -

Returns:

context

clearAttachments

public void clearAttachments()

get

public Map<String,Object> get()

get values.

Returns:

values

set

public RpcContext set(String key,
             Object value)

set value.

Parameters:

key -

value -

Returns:

context

remove

public RpcContext remove(String key)

remove value.

Parameters:

key -

Returns:

value

get

public Object get(String key)

get value.

Parameters:

key -

Returns:

value

isServerSide

@Deprecated
public boolean isServerSide()

Deprecated. Replace to isProviderSide()

isClientSide

@Deprecated
public boolean isClientSide()

Deprecated. Replace to isConsumerSide()

getInvokers

@Deprecated
public List<Invoker<?>> getInvokers()

Deprecated. Replace to getUrls()

setInvokers

public RpcContext setInvokers(List<Invoker<?>> invokers)

getInvoker

@Deprecated
public Invoker<?> getInvoker()

Deprecated. Replace to getUrl()

setInvoker

public RpcContext setInvoker(Invoker<?> invoker)

getInvocation

@Deprecated
public Invocation getInvocation()

Deprecated. Replace to getMethodName(), getParameterTypes(), getArguments()

setInvocation

public RpcContext setInvocation(Invocation invocation)

asyncCall

public <T> Future<T> asyncCall(Callable<T> callable)

Async invocation. Timeout will be handled even if Future.get() is not called.

Parameters:

callable -

Returns:

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

Parameters:

runnable -