com.opendxl.client.message

Class Response

java.lang.Object

com.opendxl.client.message.Message

com.opendxl.client.message.Response

Direct Known Subclasses:

ErrorResponse

public class Response
extends Message

Response messages are sent by service instances upon receiving Request messages. Response messages are sent using the DxlClient.sendResponse(com.opendxl.client.message.Response) method of a client instance. Clients that are invoking the service (sending a request) will receive the response as a return value of the DxlClient.syncRequest(com.opendxl.client.message.Request) method of a client instance or via the ResponseCallback callback when invoking the asynchronous method, DxlClient.asyncRequest(com.opendxl.client.message.Request, com.opendxl.client.callback.ResponseCallback, long).

Field Summary

Fields inherited from class com.opendxl.client.message.Message

CHARSET_ASCII, CHARSET_UTF8, MESSAGE_TYPE_ERROR, MESSAGE_TYPE_EVENT, MESSAGE_TYPE_REQUEST, MESSAGE_TYPE_RESPONSE, MESSAGE_VERSION

Constructor Summary

Constructors

Constructor and Description
Response(DxlClient client, Request request) Constructor for Response
Response(Request request) Constructor for Response
Response(java.lang.String sourceClientId, Request request) Constructor for Response

Method Summary

Modifier and Type	Method and Description
byte	getMessageType() Returns the numeric type of the message
Request	getRequest() Returns the Request message that this is a response for
java.lang.String	getRequestMessageId() Returns the unique identifier (UUID) for the Request message that this message is a response for.
java.lang.String	getServiceId() Returns the identifier of the service that sent this response (the service that the corresponding Request was routed to).

Methods inherited from class com.opendxl.client.message.Message

fromBytes, getBrokerIds, getClientIds, getDestinationTopic, getDestTenantGuids, getMessageId, getMessagePack, getOtherFields, getPayload, getSourceBrokerId, getSourceClientId, getSourceClientInstanceId, getSourceTenantGuid, getVersion, setBrokerIds, setClientIds, setDestinationTopic, setDestTenantGuids, setOtherFields, setPayload, setSourceClientId, setSourceClientInstanceId, setSourceTenantGuid, toBytes

Methods inherited from class java.lang.Object

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

Constructor Detail

Response

public Response(DxlClient client,
                Request request)

Constructor for Response

Parameters:

client - The client that will be sending this response

request - The Request message that this is a response for

Response

public Response(Request request)

Constructor for Response

Parameters:

request - The Request message that this is a response for

Response

public Response(java.lang.String sourceClientId,
                Request request)

Constructor for Response

Parameters:

sourceClientId - The identifier of the client that will be sending this message.

request - The Request message that this is a response for

Method Detail

getMessageType

public byte getMessageType()

Returns the numeric type of the message

Specified by:

getMessageType in class Message

Returns:

The numeric type of the message

getRequestMessageId

public java.lang.String getRequestMessageId()

Returns the unique identifier (UUID) for the Request message that this message is a response for. This is used by the invoking DxlClient to correlate an incoming Response message with the Request message that was initially sent by the client.

Returns:

The unique identifier (UUID) for the Request message that this message is a response for.

getRequest

public Request getRequest()

Returns the Request message that this is a response for

Returns:

The Request message that this is a response for

getServiceId

public java.lang.String getServiceId()

Returns the identifier of the service that sent this response (the service that the corresponding Request was routed to).

Returns:

The identifier of the service that sent this response (the service that the corresponding Request was routed to)