Package org.apache.dubbo.rpc

Class RpcServiceContext

java.lang.Object

org.apache.dubbo.rpc.RpcContext

org.apache.dubbo.rpc.RpcServiceContext

public class RpcServiceContext
extends RpcContext

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.dubbo.rpc.RpcContext

RpcContext.RestoreContext, RpcContext.RestoreServiceContext

Method Summary

Modifier and Type	Method	Description
void	asyncCall(Runnable runnable)	one way async call, send request only, and result is not required
<T> CompletableFuture<T>	asyncCall(Callable<T> callable)	Async invocation.
RpcServiceContext	copyOf(boolean needCopy)	Only part of the properties are copied, the others are either not used currently or can be got from invocation.
Object[]	getArguments()	get arguments.
<T> CompletableFuture<T>	getCompletableFuture()	get CompletableFuture.
URL	getConsumerUrl()
<T> Future<T>	getFuture()	get future.
String	getGroup()
String	getInterfaceName()
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.
Boolean	getLocalInvoke()
int	getLocalPort()	get local port.
String	getMethodName()	get method name.
Class<?>[]	getParameterTypes()	get parameter types.
String	getProtocol()
String	getProtocolServiceKey()
InetSocketAddress	getRemoteAddress()	get remote address.
String	getRemoteAddressString()	get remote address string.
String	getRemoteApplicationName()
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.
String	getServiceKey()
URL	getUrl()
List<URL>	getUrls()
String	getVersion()
boolean	isClientSide()	Deprecated. Replace to isConsumerSide()
boolean	isConsumerSide()	is consumer side.
boolean	isNeedPrintRouterSnapshot()
boolean	isProviderSide()	is provider side.
boolean	isServerSide()	Deprecated. Replace to isProviderSide()
void	setArguments(Object[] arguments)
void	setConsumerUrl(URL consumerUrl)
void	setFuture(CompletableFuture<?> future)	set future.
RpcServiceContext	setInvocation(Invocation invocation)
RpcServiceContext	setInvoker(Invoker<?> invoker)
RpcServiceContext	setInvokers(List<Invoker<?>> invokers)
RpcServiceContext	setLocalAddress(String host, int port)	set local address.
RpcServiceContext	setLocalAddress(InetSocketAddress address)	set local address.
RpcServiceContext	setLocalInvoke(boolean localInvoke)
void	setMethodName(String methodName)
void	setNeedPrintRouterSnapshot(boolean needPrintRouterSnapshot)
void	setParameterTypes(Class<?>[] parameterTypes)
RpcServiceContext	setRemoteAddress(String host, int port)	set remote address.
RpcServiceContext	setRemoteAddress(InetSocketAddress address)	set remote address.
RpcServiceContext	setRemoteApplicationName(String remoteApplicationName)
void	setRequest(Object request)
void	setResponse(Object response)
void	setUrl(URL url)
void	setUrls(List<URL> urls)

Methods inherited from class org.apache.dubbo.rpc.RpcContext

canRemove, clearAfterEachInvoke, clearAttachments, get, get, getAsyncContext, getAttachment, getAttachments, getCancellationContext, getClientAttachment, getClientResponseContext, getContext, getCurrentServiceContext, getObjectAttachment, getObjectAttachments, getServerAttachment, getServerContext, getServerResponseContext, getServiceContext, isAsyncStarted, remove, removeAttachment, removeCancellationContext, removeClientAttachment, removeClientResponseContext, removeContext, removeServerAttachment, removeServerContext, removeServerResponseContext, removeServiceContext, restoreCancellationContext, restoreServiceContext, set, setAttachment, setAttachment, setAttachments, setObjectAttachment, setObjectAttachments, setRpcContext, startAsync, stopAsync, storeServiceContext

Methods inherited from class java.lang.Object

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

Method Details

getRequest

public Object getRequest()

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

Overrides:

getRequest in class RpcContext

Returns:

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

setRequest

public void setRequest(Object request)

Overrides:

setRequest in class RpcContext

getRequest

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

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

Overrides:

getRequest in class RpcContext

Returns:

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

Overrides:

getResponse in class RpcContext

Returns:

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

setResponse

public void setResponse(Object response)

Overrides:

setResponse in class RpcContext

getResponse

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

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

Overrides:

getResponse in class RpcContext

Returns:

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.

Overrides:

isProviderSide in class RpcContext

Returns:

provider side.

isConsumerSide

public boolean isConsumerSide()

is consumer side.

Overrides:

isConsumerSide in class RpcContext

Returns:

consumer side.

getCompletableFuture

public <T> CompletableFuture<T> getCompletableFuture()

get CompletableFuture.

Overrides:

getCompletableFuture in class RpcContext

Type Parameters:

T -

Returns:

future

getFuture

public <T> Future<T> getFuture()

get future.

Overrides:

getFuture in class RpcContext

Type Parameters:

T -

Returns:

future

setFuture

public void setFuture(CompletableFuture<?> future)

set future.

Overrides:

setFuture in class RpcContext

Parameters:

future -

getUrls

public List<URL> getUrls()

Overrides:

getUrls in class RpcContext

setUrls

public void setUrls(List<URL> urls)

Overrides:

setUrls in class RpcContext

getUrl

public URL getUrl()

Overrides:

getUrl in class RpcContext

setUrl

public void setUrl(URL url)

Overrides:

setUrl in class RpcContext

getMethodName

public String getMethodName()

get method name.

Overrides:

getMethodName in class RpcContext

Returns:

method name.

setMethodName

public void setMethodName(String methodName)

Overrides:

setMethodName in class RpcContext

getParameterTypes

public Class<?>[] getParameterTypes()

get parameter types.

Overrides:

getParameterTypes in class RpcContext

setParameterTypes

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

Overrides:

setParameterTypes in class RpcContext

getArguments

public Object[] getArguments()

get arguments.

Overrides:

getArguments in class RpcContext

Returns:

arguments.

setArguments

public void setArguments(Object[] arguments)

Overrides:

setArguments in class RpcContext

setLocalAddress

public RpcServiceContext setLocalAddress(String host,
 int port)

set local address.

Overrides:

setLocalAddress in class RpcContext

Parameters:

host -

port -

Returns:

context

getLocalAddress

public InetSocketAddress getLocalAddress()

get local address.

Overrides:

getLocalAddress in class RpcContext

Returns:

local address

setLocalAddress

public RpcServiceContext setLocalAddress(InetSocketAddress address)

set local address.

Overrides:

setLocalAddress in class RpcContext

Parameters:

address -

Returns:

context

getLocalAddressString

public String getLocalAddressString()

Overrides:

getLocalAddressString in class RpcContext

getLocalHostName

public String getLocalHostName()

get local host name.

Overrides:

getLocalHostName in class RpcContext

Returns:

local host name

setRemoteAddress

public RpcServiceContext setRemoteAddress(String host,
 int port)

set remote address.

Overrides:

setRemoteAddress in class RpcContext

Parameters:

host -

port -

Returns:

context

getRemoteAddress

public InetSocketAddress getRemoteAddress()

get remote address.

Overrides:

getRemoteAddress in class RpcContext

Returns:

remote address

setRemoteAddress

public RpcServiceContext setRemoteAddress(InetSocketAddress address)

set remote address.

Overrides:

setRemoteAddress in class RpcContext

Parameters:

address -

Returns:

context

getRemoteApplicationName

public String getRemoteApplicationName()

Overrides:

getRemoteApplicationName in class RpcContext

setRemoteApplicationName

public RpcServiceContext setRemoteApplicationName(String remoteApplicationName)

Overrides:

setRemoteApplicationName in class RpcContext

getRemoteAddressString

public String getRemoteAddressString()

get remote address string.

Overrides:

getRemoteAddressString in class RpcContext

Returns:

remote address string.

getRemoteHostName

public String getRemoteHostName()

get remote host name.

Overrides:

getRemoteHostName in class RpcContext

Returns:

remote host name

getLocalHost

public String getLocalHost()

get local host.

Overrides:

getLocalHost in class RpcContext

Returns:

local host

getLocalPort

public int getLocalPort()

get local port.

Overrides:

getLocalPort in class RpcContext

Returns:

port

getRemoteHost

public String getRemoteHost()

get remote host.

Overrides:

getRemoteHost in class RpcContext

Returns:

remote host

getRemotePort

public int getRemotePort()

get remote port.

Overrides:

getRemotePort in class RpcContext

Returns:

remote port

isServerSide

@Deprecated
public boolean isServerSide()

Deprecated.

Replace to isProviderSide()

Overrides:

isServerSide in class RpcContext

isClientSide

@Deprecated
public boolean isClientSide()

Deprecated.

Replace to isConsumerSide()

Overrides:

isClientSide in class RpcContext

getInvokers

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

Deprecated.

Replace to getUrls()

Overrides:

getInvokers in class RpcContext

setInvokers

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

Overrides:

setInvokers in class RpcContext

getInvoker

@Deprecated
public Invoker<?> getInvoker()

Deprecated.

Replace to getUrl()

Overrides:

getInvoker in class RpcContext

setInvoker

public RpcServiceContext setInvoker(Invoker<?> invoker)

Overrides:

setInvoker in class RpcContext

getInvocation

@Deprecated
public Invocation getInvocation()

Deprecated.

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

Overrides:

getInvocation in class RpcContext

setInvocation

public RpcServiceContext setInvocation(Invocation invocation)

Overrides:

setInvocation in class RpcContext

asyncCall

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

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

Overrides:

asyncCall in class RpcContext

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

Overrides:

asyncCall in class RpcContext

Parameters:

runnable -

getGroup

public String getGroup()

Overrides:

getGroup in class RpcContext

getVersion

public String getVersion()

Overrides:

getVersion in class RpcContext

getInterfaceName

public String getInterfaceName()

Overrides:

getInterfaceName in class RpcContext

getProtocol

public String getProtocol()

Overrides:

getProtocol in class RpcContext

getServiceKey

public String getServiceKey()

Overrides:

getServiceKey in class RpcContext

getProtocolServiceKey

public String getProtocolServiceKey()

Overrides:

getProtocolServiceKey in class RpcContext

getConsumerUrl

public URL getConsumerUrl()

Overrides:

getConsumerUrl in class RpcContext

setConsumerUrl

public void setConsumerUrl(URL consumerUrl)

Overrides:

setConsumerUrl in class RpcContext

isNeedPrintRouterSnapshot

public boolean isNeedPrintRouterSnapshot()

setNeedPrintRouterSnapshot

public void setNeedPrintRouterSnapshot(boolean needPrintRouterSnapshot)

setLocalInvoke

public RpcServiceContext setLocalInvoke(boolean localInvoke)

getLocalInvoke

public Boolean getLocalInvoke()

copyOf

public RpcServiceContext copyOf(boolean needCopy)

Only part of the properties are copied, the others are either not used currently or can be got from invocation. Also see RpcContextAttachment.copyOf(boolean)

Parameters:

needCopy -

Returns:

a shallow copy of RpcServiceContext