Package org.apache.dubbo.rpc

Class AppResponse

java.lang.Object

org.apache.dubbo.rpc.AppResponse

All Implemented Interfaces:

Serializable, Result

public class AppResponse
extends Object
implements Result

AsyncRpcResult is introduced in 3.0.0 to replace RpcResult, and RpcResult is replaced with AppResponse:

• AsyncRpcResult is the object that is actually passed in the call chain
• AppResponse only simply represents the business result

The relationship between them can be described as follow, an abstraction of the definition of AsyncRpcResult:

  invalid input: '{@code
   Public class AsyncRpcResult implements CompletionStage<AppResponse> {
       ......
  }
 </pre>
 AsyncRpcResult is a future representing an unfinished RPC call, while AppResponse is the actual return type of this call.
 In theory, AppResponse doesn't have to implement the {@link Result} interface, this is done mainly for compatibility purpose.

 @serial Do not change the class name and properties.'

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AppResponse()
AppResponse(Object result)
AppResponse(Throwable exception)
AppResponse(Invocation invocation)

Method Summary

Modifier and Type	Method	Description
void	addAttachments(Map<String,String> map)	Add the specified map to existing attachments in this instance.
void	addObjectAttachments(Map<String,Object> map)	Add the specified map to existing attachments in this instance.
void	clear()
Result	get()
Result	get(long timeout, TimeUnit unit)
String	getAttachment(String key)	get attachment by key.
String	getAttachment(String key, String defaultValue)	get attachment by key with default value.
Map<String,String>	getAttachments()	Deprecated.
Object	getAttribute(String key)
Throwable	getException()	Get exception.
Object	getObjectAttachment(String key)	get attachment by key.
Object	getObjectAttachment(String key, Object defaultValue)	get attachment by key with default value.
Map<String,Object>	getObjectAttachments()	get attachments.
Object	getValue()	Get invoke result.
boolean	hasException()	Has exception.
Object	recreate()	Recreate.
void	setAttachment(String key, Object value)
void	setAttachment(String key, String value)
void	setAttachments(Map<String,String> map)	Append all items from the map into the attachment, if map is empty then nothing happens
void	setAttribute(String key, Object value)
void	setException(Throwable e)
void	setObjectAttachment(String key, Object value)
void	setObjectAttachments(Map<String,Object> map)	Replace the existing attachments with the specified param.
void	setValue(Object value)
<U> CompletableFuture<U>	thenApply(Function<Result,? extends U> fn)
String	toString()
Result	whenCompleteWithContext(BiConsumer<Result,Throwable> fn)	Add a callback which can be triggered when the RPC call finishes.

Methods inherited from class java.lang.Object

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

Constructor Details

AppResponse

public AppResponse()

AppResponse

public AppResponse(Invocation invocation)

AppResponse

public AppResponse(Object result)

AppResponse

public AppResponse(Throwable exception)

Method Details

recreate

public Object recreate()
                throws Throwable

Description copied from interface: Result

Recreate.

if (hasException()) { throw getException(); } else { return getValue(); }

Specified by:

recreate in interface Result

Returns:

result.

Throws:

Throwable

getValue

public Object getValue()

Description copied from interface: Result

Get invoke result.

Specified by:

getValue in interface Result

Returns:

result. if no result return null.

setValue

public void setValue(Object value)

Specified by:

setValue in interface Result

getException

public Throwable getException()

Description copied from interface: Result

Get exception.

Specified by:

getException in interface Result

Returns:

exception. if no exception return null.

setException

public void setException(Throwable e)

Specified by:

setException in interface Result

hasException

public boolean hasException()

Description copied from interface: Result

Has exception.

Specified by:

hasException in interface Result

Returns:

has exception.

getAttachments

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

Deprecated.

Description copied from interface: Result

get attachments.

Specified by:

getAttachments in interface Result

Returns:

attachments.

getObjectAttachments

public Map<String,Object> getObjectAttachments()

Description copied from interface: Result

get attachments.

Specified by:

getObjectAttachments in interface Result

Returns:

attachments.

setAttachments

public void setAttachments(Map<String,String> map)

Append all items from the map into the attachment, if map is empty then nothing happens

Specified by:

setAttachments in interface Result

Parameters:

map - contains all key-value pairs to append

setObjectAttachments

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

Description copied from interface: Result

Replace the existing attachments with the specified param.

Specified by:

setObjectAttachments in interface Result

Parameters:

map -

addAttachments

public void addAttachments(Map<String,String> map)

Description copied from interface: Result

Add the specified map to existing attachments in this instance.

Specified by:

addAttachments in interface Result

Parameters:

map -

addObjectAttachments

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

Description copied from interface: Result

Add the specified map to existing attachments in this instance.

Specified by:

addObjectAttachments in interface Result

Parameters:

map -

getAttachment

public String getAttachment(String key)

Description copied from interface: Result

get attachment by key.

Specified by:

getAttachment in interface Result

Returns:

attachment value.

getObjectAttachment

public Object getObjectAttachment(String key)

Description copied from interface: Result

get attachment by key.

Specified by:

getObjectAttachment in interface Result

Returns:

attachment value.

getAttachment

public String getAttachment(String key,
 String defaultValue)

Description copied from interface: Result

get attachment by key with default value.

Specified by:

getAttachment in interface Result

Returns:

attachment value.

getObjectAttachment

public Object getObjectAttachment(String key,
 Object defaultValue)

Description copied from interface: Result

get attachment by key with default value.

Specified by:

getObjectAttachment in interface Result

Returns:

attachment value.

setAttachment

public void setAttachment(String key,
 String value)

Specified by:

setAttachment in interface Result

setAttachment

public void setAttachment(String key,
 Object value)

Specified by:

setAttachment in interface Result

setObjectAttachment

public void setObjectAttachment(String key,
 Object value)

Specified by:

setObjectAttachment in interface Result

getAttribute

public Object getAttribute(String key)

setAttribute

public void setAttribute(String key,
 Object value)

whenCompleteWithContext

public Result whenCompleteWithContext(BiConsumer<Result,Throwable> fn)

Description copied from interface: Result

Add a callback which can be triggered when the RPC call finishes.

Just as the method name implies, this method will guarantee the callback being triggered under the same context as when the call was started, see implementation in Result.whenCompleteWithContext(BiConsumer)

Specified by:

whenCompleteWithContext in interface Result

Parameters:

fn -

Returns:

thenApply

public <U> CompletableFuture<U> thenApply(Function<Result,? extends U> fn)

Specified by:

thenApply in interface Result

get

public Result get()
           throws InterruptedException,
ExecutionException

Specified by:

get in interface Result

Throws:

InterruptedException

ExecutionException

get

public Result get(long timeout,
 TimeUnit unit)
           throws InterruptedException,
ExecutionException,
TimeoutException

Specified by:

get in interface Result

Throws:

InterruptedException

ExecutionException

TimeoutException

clear

public void clear()

toString

public String toString()

Overrides:

toString in class Object