|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectsds.data.Message
public final class Message
Information sent to and received by distant servers. This information is to be encapsulated within a top-level envelope
Constructor Summary | |
---|---|
Message()
Creates an empty message. |
|
Message(Message other)
Duplicates an existing message. |
Method Summary | |
---|---|
Message |
createResponse()
Generates a pre-initialized response to this message. |
static Message |
createResponse(Message request)
Generates a pre-initialized response to a given message. |
java.lang.Object |
getData()
Gets the message content |
Reference |
getIssuer()
Gets the message issuer |
java.lang.Integer |
getTag()
Gets the current message tag |
TransactionInfo |
getTransactionInfo()
Gets the information related with transactions (requests / responses track identifiers) |
boolean |
isInitialized()
Makes sure this message can be sent |
boolean |
isTransactional()
Checks whether this message encloses transactional information |
void |
setData(java.lang.Object data)
Initializes the message content |
void |
setIssuer(Reference issuer)
Assigns the message issuer reference |
void |
setTag(java.lang.Integer tag)
Initializes the tag of this message |
void |
setTransactionInfo(TransactionInfo transactionInfo)
Updates the transactional information of this message (mainly based on a previous received message in case of a response) |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Message()
Creates an empty message. This constructor should not be used to create a response to an exiting (request) message
createResponse()
public Message(Message other)
Duplicates an existing message. As all fields but data are duplicated, this constructor should not be used to create a response to an exiting (request) message
other
- The source message to duplicate. The current message is left
empty in case the other message is nullcreateResponse()
Method Detail |
---|
public Message createResponse()
Generates a pre-initialized response to this message. This newly created message basically encloses default (duplicated) transactional information
TransactionInfo.createResponse()
public static Message createResponse(Message request)
Generates a pre-initialized response to a given message. The newly created message basically encloses default (duplicated) transactional information
request
- The request message to respond to
createResponse()
public Reference getIssuer()
Gets the message issuer
public void setIssuer(Reference issuer)
Assigns the message issuer reference
issuer
- The issuer reference. The message cannot be sent until this
reference is providedpublic TransactionInfo getTransactionInfo()
Gets the information related with transactions (requests / responses track identifiers)
public void setTransactionInfo(TransactionInfo transactionInfo)
Updates the transactional information of this message (mainly based on a previous received message in case of a response)
transactionInfo
- The transactional information or null
if no transaction information applies to this messagecreateResponse()
public java.lang.Integer getTag()
Gets the current message tag
public void setTag(java.lang.Integer tag)
Initializes the tag of this message
tag
- Any value. A null tag leads
isInitialized()
to return falsepublic java.lang.Object getData()
Gets the message content
public void setData(java.lang.Object data)
Initializes the message content
data
- The message contentpublic boolean isInitialized()
Makes sure this message can be sent
public boolean isTransactional()
Checks whether this message encloses transactional information
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |