com.opendxl.client.message

Class Request

java.lang.Object

com.opendxl.client.message.Message

com.opendxl.client.message.Request

public class Request
extends Message

A Request messages are sent using the DxlClient.syncRequest(com.opendxl.client.message.Request) and DxlClient.asyncRequest(com.opendxl.client.message.Request, com.opendxl.client.callback.ResponseCallback, long) methods of a client instance. Request messages are used when invoking a method on a remote service. This communication is one-to-one where a client sends a request to a service instance and in turn receives a response.

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
Request(DxlClient client, java.lang.String destinationTopic) Constructor for Request
Request(java.lang.String destinationTopic) Constructor for Request
Request(java.lang.String sourceClientId, java.lang.String destinationTopic) Constructor for Request

Method Summary

Modifier and Type	Method and Description
byte	getMessageType() Returns the numeric type of the message
java.lang.String	getReplyToTopic() Returns the topic that the Response to this Request will be sent to
java.lang.String	getServiceId() Returns the identifier of the service that this request will be routed to.
void	setReplyToTopic(java.lang.String topic) Sets the topic that the Response to this Request will be sent to
void	setServiceId(java.lang.String serviceId) Sets the identifier of the service that this request will be 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

Request

public Request(DxlClient client,
               java.lang.String destinationTopic)

Constructor for Request

Parameters:

client - The client that will be sending this request.

destinationTopic - The topic to publish the request to

Request

public Request(java.lang.String destinationTopic)

Constructor for Request

Parameters:

destinationTopic - The topic to publish the request to

Request

public Request(java.lang.String sourceClientId,
               java.lang.String destinationTopic)

Constructor for Request

Parameters:

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

destinationTopic - The topic to publish the request to

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

getReplyToTopic

public java.lang.String getReplyToTopic()

Returns the topic that the Response to this Request will be sent to

Returns:

The topic that the Response to this Request will be sent to

setReplyToTopic

public void setReplyToTopic(java.lang.String topic)

Sets the topic that the Response to this Request will be sent to

Parameters:

topic - the topic that the Response to this Request will be sent to

getServiceId

public java.lang.String getServiceId()

Returns the identifier of the service that this request will be routed to. If an identifier is not specified, the initial broker that receives the request will select the service to handle the request (round-robin by default).

Returns:

The identifier of the service that this request will be routed to.

setServiceId

public void setServiceId(java.lang.String serviceId)

Sets the identifier of the service that this request will be routed to.

Parameters:

serviceId - The identifier of the service that this request will be routed to.