Package org.apache.dubbo.rpc

Class RpcInvocation

java.lang.Object

org.apache.dubbo.rpc.RpcInvocation

All Implemented Interfaces:

Serializable, Invocation

public class RpcInvocation
extends Object
implements Invocation, Serializable

RPC Invocation.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RpcInvocation()	Deprecated. only for test
RpcInvocation(Method method, String interfaceName, String protocolServiceKey, Object[] arguments)	Deprecated. deprecated, will be removed in 3.1.x
RpcInvocation(Method method, String interfaceName, String protocolServiceKey, Object[] arguments, Map<String,Object> attachment, Map<Object,Object> attributes)	Deprecated. deprecated, will be removed in 3.1.x
RpcInvocation(String methodName, String interfaceName, String protocolServiceKey, Class<?>[] parameterTypes, Object[] arguments)	Deprecated. deprecated, will be removed in 3.1.x
RpcInvocation(String methodName, String interfaceName, String protocolServiceKey, Class<?>[] parameterTypes, Object[] arguments, Map<String,Object> attachments)	Deprecated. deprecated, will be removed in 3.1.x
RpcInvocation(String methodName, String interfaceName, String protocolServiceKey, Class<?>[] parameterTypes, Object[] arguments, Map<String,Object> attachments, Invoker<?> invoker, Map<Object,Object> attributes)	Deprecated. deprecated, will be removed in 3.1.x
RpcInvocation(String targetServiceUniqueName, ServiceModel serviceModel, String methodName, String interfaceName, String protocolServiceKey, Class<?>[] parameterTypes, Object[] arguments, Map<String,Object> attachments, Invoker<?> invoker, Map<Object,Object> attributes, InvokeMode invokeMode)	To create a brand-new invocation
RpcInvocation(Invocation invocation)	Deep clone of an invocation
RpcInvocation(Invocation invocation, Invoker<?> invoker)	Deep clone of an invocation invalid input: '&' put some service params into attachment from invoker (will not change the invoker in invocation)
RpcInvocation(ServiceModel serviceModel, Method method, String interfaceName, String protocolServiceKey, Object[] arguments)	Deprecated. deprecated, will be removed in 3.1.x
RpcInvocation(ServiceModel serviceModel, Method method, String interfaceName, String protocolServiceKey, Object[] arguments, Map<String,Object> attachment, Map<Object,Object> attributes)	Deprecated. deprecated, will be removed in 3.1.x
RpcInvocation(ServiceModel serviceModel, String methodName, String interfaceName, String protocolServiceKey, Class<?>[] parameterTypes, Object[] arguments)	To create a brand-new invocation
RpcInvocation(ServiceModel serviceModel, String methodName, String interfaceName, String protocolServiceKey, Class<?>[] parameterTypes, Object[] arguments, Map<String,Object> attachments)	Deprecated. deprecated, will be removed in 3.1.x
RpcInvocation(ServiceModel serviceModel, String methodName, String interfaceName, String protocolServiceKey, Class<?>[] parameterTypes, Object[] arguments, Map<String,Object> attachments, Invoker<?> invoker, Map<Object,Object> attributes)	Deprecated. deprecated, will be removed in 3.1.x
RpcInvocation(ServiceModel serviceModel, String methodName, String interfaceName, String protocolServiceKey, Class<?>[] parameterTypes, Object[] arguments, Map<String,Object> attachments, Invoker<?> invoker, Map<Object,Object> attributes, InvokeMode invokeMode)	Deprecated. deprecated, will be removed in 3.1.x

Method Summary

Modifier and Type	Method	Description
void	addAttachments(Map<String,String> attachments)	Deprecated.
void	addAttachmentsIfAbsent(Map<String,String> attachments)	Deprecated.
void	addInvokedInvoker(Invoker<?> invoker)	To add invoked invokers into invocation.
void	addObjectAttachments(Map<String,Object> attachments)
void	addObjectAttachmentsIfAbsent(Map<String,Object> attachments)
Map<String,Object>	copyObjectAttachments()
void	foreachAttachment(Consumer<Map.Entry<String,Object>> consumer)
Object	get(Object key)
Object[]	getArguments()	get arguments.
String	getAttachment(String key)	Deprecated.
String	getAttachment(String key, String defaultValue)	Deprecated.
Map<String,String>	getAttachments()	Deprecated.
Map<Object,Object>	getAttributes()
String[]	getCompatibleParamSignatures()	get parameter's signature, string representation of parameter types.
List<Invoker<?>>	getInvokedInvokers()	Get all invoked invokers in current invocation.
InvokeMode	getInvokeMode()
Invoker<?>	getInvoker()	get the invoker in current context.
String	getMethodName()	get method name.
Object	getObjectAttachment(String key)
Object	getObjectAttachment(String key, Object defaultValue)	Deprecated.
Map<String,Object>	getObjectAttachments()
Object	getObjectAttachmentWithoutConvert(String key)
Class<?>[]	getParameterTypes()	get parameter types.
String	getParameterTypesDesc()
String	getProtocolServiceKey()
Class<?>	getReturnType()
Type[]	getReturnTypes()
ServiceModel	getServiceModel()
String	getServiceName()	get the interface name
String	getTargetServiceUniqueName()
Object	put(Object key, Object value)
Object	remove(Object key)
void	setArguments(Object[] arguments)
void	setAttachment(String key, Object value)
void	setAttachment(String key, String value)
void	setAttachmentIfAbsent(String key, Object value)
void	setAttachmentIfAbsent(String key, String value)
void	setAttachments(Map<String,String> attachments)	Deprecated.
void	setCompatibleParamSignatures(String[] compatibleParamSignatures)
void	setInvokeMode(InvokeMode invokeMode)
void	setInvoker(Invoker<?> invoker)
void	setMethodName(String methodName)
void	setObjectAttachment(String key, Object value)
void	setObjectAttachmentIfAbsent(String key, Object value)
void	setObjectAttachments(Map<String,Object> attachments)
void	setParameterTypes(Class<?>[] parameterTypes)
void	setParameterTypesDesc(String parameterTypesDesc)
void	setReturnType(Class<?> returnType)
void	setReturnTypes(Type[] returnTypes)
void	setServiceModel(ServiceModel serviceModel)
void	setServiceName(String interfaceName)
void	setTargetServiceUniqueName(String targetServiceUniqueName)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.dubbo.rpc.Invocation

getModuleModel

Constructor Details

RpcInvocation

@Deprecated
public RpcInvocation()

Deprecated.

only for test

RpcInvocation

public RpcInvocation(Invocation invocation)

Deep clone of an invocation

Parameters:

invocation - original invocation

RpcInvocation

public RpcInvocation(Invocation invocation,
 Invoker<?> invoker)

Deep clone of an invocation invalid input: '&' put some service params into attachment from invoker (will not change the invoker in invocation)

Parameters:

invocation - original invocation

invoker - target invoker

RpcInvocation

public RpcInvocation(ServiceModel serviceModel,
 String methodName,
 String interfaceName,
 String protocolServiceKey,
 Class<?>[] parameterTypes,
 Object[] arguments)

To create a brand-new invocation

RpcInvocation

@Deprecated
public RpcInvocation(ServiceModel serviceModel,
 Method method,
 String interfaceName,
 String protocolServiceKey,
 Object[] arguments)

Deprecated.

deprecated, will be removed in 3.1.x

RpcInvocation

@Deprecated
public RpcInvocation(Method method,
 String interfaceName,
 String protocolServiceKey,
 Object[] arguments)

Deprecated.

deprecated, will be removed in 3.1.x

RpcInvocation

@Deprecated
public RpcInvocation(ServiceModel serviceModel,
 Method method,
 String interfaceName,
 String protocolServiceKey,
 Object[] arguments,
 Map<String,Object> attachment,
 Map<Object,Object> attributes)

Deprecated.

deprecated, will be removed in 3.1.x

RpcInvocation

@Deprecated
public RpcInvocation(Method method,
 String interfaceName,
 String protocolServiceKey,
 Object[] arguments,
 Map<String,Object> attachment,
 Map<Object,Object> attributes)

Deprecated.

deprecated, will be removed in 3.1.x

RpcInvocation

@Deprecated
public RpcInvocation(String methodName,
 String interfaceName,
 String protocolServiceKey,
 Class<?>[] parameterTypes,
 Object[] arguments)

Deprecated.

deprecated, will be removed in 3.1.x

RpcInvocation

@Deprecated
public RpcInvocation(ServiceModel serviceModel,
 String methodName,
 String interfaceName,
 String protocolServiceKey,
 Class<?>[] parameterTypes,
 Object[] arguments,
 Map<String,Object> attachments)

Deprecated.

deprecated, will be removed in 3.1.x

RpcInvocation

@Deprecated
public RpcInvocation(String methodName,
 String interfaceName,
 String protocolServiceKey,
 Class<?>[] parameterTypes,
 Object[] arguments,
 Map<String,Object> attachments)

Deprecated.

deprecated, will be removed in 3.1.x

RpcInvocation

@Deprecated
public RpcInvocation(String methodName,
 String interfaceName,
 String protocolServiceKey,
 Class<?>[] parameterTypes,
 Object[] arguments,
 Map<String,Object> attachments,
 Invoker<?> invoker,
 Map<Object,Object> attributes)

Deprecated.

deprecated, will be removed in 3.1.x

RpcInvocation

@Deprecated
public RpcInvocation(ServiceModel serviceModel,
 String methodName,
 String interfaceName,
 String protocolServiceKey,
 Class<?>[] parameterTypes,
 Object[] arguments,
 Map<String,Object> attachments,
 Invoker<?> invoker,
 Map<Object,Object> attributes)

Deprecated.

deprecated, will be removed in 3.1.x

RpcInvocation

@Deprecated
public RpcInvocation(ServiceModel serviceModel,
 String methodName,
 String interfaceName,
 String protocolServiceKey,
 Class<?>[] parameterTypes,
 Object[] arguments,
 Map<String,Object> attachments,
 Invoker<?> invoker,
 Map<Object,Object> attributes,
 InvokeMode invokeMode)

Deprecated.

deprecated, will be removed in 3.1.x

RpcInvocation

public RpcInvocation(String targetServiceUniqueName,
 ServiceModel serviceModel,
 String methodName,
 String interfaceName,
 String protocolServiceKey,
 Class<?>[] parameterTypes,
 Object[] arguments,
 Map<String,Object> attachments,
 Invoker<?> invoker,
 Map<Object,Object> attributes,
 InvokeMode invokeMode)

To create a brand-new invocation

Method Details

getInvoker

public Invoker<?> getInvoker()

Description copied from interface: Invocation

get the invoker in current context.

Specified by:

getInvoker in interface Invocation

Returns:

invoker.

setInvoker

public void setInvoker(Invoker<?> invoker)

remove

public Object remove(Object key)

put

public Object put(Object key,
 Object value)

Specified by:

put in interface Invocation

get

public Object get(Object key)

Specified by:

get in interface Invocation

getAttributes

public Map<Object,Object> getAttributes()

Specified by:

getAttributes in interface Invocation

addInvokedInvoker

public void addInvokedInvoker(Invoker<?> invoker)

Description copied from interface: Invocation

To add invoked invokers into invocation. Can be used in ClusterFilter or Filter for tracing or debugging purpose. Currently, only support in consumer side.

Specified by:

addInvokedInvoker in interface Invocation

Parameters:

invoker - invoked invokers

getInvokedInvokers

public List<Invoker<?>> getInvokedInvokers()

Description copied from interface: Invocation

Get all invoked invokers in current invocation. NOTICE: A curtain invoker could be invoked for twice or more if retries.

Specified by:

getInvokedInvokers in interface Invocation

Returns:

invokers

getTargetServiceUniqueName

public String getTargetServiceUniqueName()

Specified by:

getTargetServiceUniqueName in interface Invocation

setTargetServiceUniqueName

public void setTargetServiceUniqueName(String targetServiceUniqueName)

getProtocolServiceKey

public String getProtocolServiceKey()

Specified by:

getProtocolServiceKey in interface Invocation

getMethodName

public String getMethodName()

Description copied from interface: Invocation

get method name.

Specified by:

getMethodName in interface Invocation

Returns:

method name.

setMethodName

public void setMethodName(String methodName)

getServiceName

public String getServiceName()

Description copied from interface: Invocation

get the interface name

Specified by:

getServiceName in interface Invocation

Returns:

setServiceName

public void setServiceName(String interfaceName)

getParameterTypes

public Class<?>[] getParameterTypes()

Description copied from interface: Invocation

get parameter types.

Specified by:

getParameterTypes in interface Invocation

Returns:

parameter types.

setParameterTypes

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

getParameterTypesDesc

public String getParameterTypesDesc()

setParameterTypesDesc

public void setParameterTypesDesc(String parameterTypesDesc)

getCompatibleParamSignatures

public String[] getCompatibleParamSignatures()

Description copied from interface: Invocation

get parameter's signature, string representation of parameter types.

Specified by:

getCompatibleParamSignatures in interface Invocation

Returns:

parameter's signature

setCompatibleParamSignatures

public void setCompatibleParamSignatures(String[] compatibleParamSignatures)

getArguments

public Object[] getArguments()

Description copied from interface: Invocation

get arguments.

Specified by:

getArguments in interface Invocation

Returns:

arguments.

setArguments

public void setArguments(Object[] arguments)

getObjectAttachments

public Map<String,Object> getObjectAttachments()

Specified by:

getObjectAttachments in interface Invocation

copyObjectAttachments

public Map<String,Object> copyObjectAttachments()

Specified by:

copyObjectAttachments in interface Invocation

foreachAttachment

public void foreachAttachment(Consumer<Map.Entry<String,Object>> consumer)

Specified by:

foreachAttachment in interface Invocation

setObjectAttachments

public void setObjectAttachments(Map<String,Object> attachments)

setAttachment

public void setAttachment(String key,
 String value)

Specified by:

setAttachment in interface Invocation

getAttachments

@Deprecated
public Map<String,String> getAttachments()

Deprecated.

Description copied from interface: Invocation

get attachments.

Specified by:

getAttachments in interface Invocation

Returns:

attachments.

setAttachments

@Deprecated
public void setAttachments(Map<String,String> attachments)

Deprecated.

setAttachment

public void setAttachment(String key,
 Object value)

Specified by:

setAttachment in interface Invocation

setObjectAttachment

public void setObjectAttachment(String key,
 Object value)

Specified by:

setObjectAttachment in interface Invocation

setAttachmentIfAbsent

public void setAttachmentIfAbsent(String key,
 String value)

Specified by:

setAttachmentIfAbsent in interface Invocation

setAttachmentIfAbsent

public void setAttachmentIfAbsent(String key,
 Object value)

Specified by:

setAttachmentIfAbsent in interface Invocation

setObjectAttachmentIfAbsent

public void setObjectAttachmentIfAbsent(String key,
 Object value)

Specified by:

setObjectAttachmentIfAbsent in interface Invocation

addAttachments

@Deprecated
public void addAttachments(Map<String,String> attachments)

Deprecated.

addObjectAttachments

public void addObjectAttachments(Map<String,Object> attachments)

addAttachmentsIfAbsent

@Deprecated
public void addAttachmentsIfAbsent(Map<String,String> attachments)

Deprecated.

addObjectAttachmentsIfAbsent

public void addObjectAttachmentsIfAbsent(Map<String,Object> attachments)

getAttachment

@Deprecated
public String getAttachment(String key)

Deprecated.

Description copied from interface: Invocation

get attachment by key.

Specified by:

getAttachment in interface Invocation

Returns:

attachment value.

getObjectAttachment

public Object getObjectAttachment(String key)

Specified by:

getObjectAttachment in interface Invocation

getAttachment

@Deprecated
public String getAttachment(String key,
 String defaultValue)

Deprecated.

Description copied from interface: Invocation

get attachment by key with default value.

Specified by:

getAttachment in interface Invocation

Returns:

attachment value.

getObjectAttachment

@Deprecated
public Object getObjectAttachment(String key,
 Object defaultValue)

Deprecated.

Specified by:

getObjectAttachment in interface Invocation

getObjectAttachmentWithoutConvert

public Object getObjectAttachmentWithoutConvert(String key)

Specified by:

getObjectAttachmentWithoutConvert in interface Invocation

getReturnType

public Class<?> getReturnType()

setReturnType

public void setReturnType(Class<?> returnType)

getReturnTypes

public Type[] getReturnTypes()

setReturnTypes

public void setReturnTypes(Type[] returnTypes)

getInvokeMode

public InvokeMode getInvokeMode()

setInvokeMode

public void setInvokeMode(InvokeMode invokeMode)

setServiceModel

public void setServiceModel(ServiceModel serviceModel)

Specified by:

setServiceModel in interface Invocation

getServiceModel

public ServiceModel getServiceModel()

Specified by:

getServiceModel in interface Invocation

toString

public String toString()

Overrides:

toString in class Object