com.migratorydata.client

Class MigratoryDataMessage

java.lang.Object

com.migratorydata.client.MigratoryDataMessage

All Implemented Interfaces:

Serializable

public class MigratoryDataMessage
extends Object
implements Serializable

Represent a MigratoryData message.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MigratoryDataMessage.MessageType
static class	MigratoryDataMessage.QoS The quality of service (QoS) levels for MigratoryData messaging.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	compressed
protected int	epoch
protected MigratoryDataMessage.MessageType	messageType
protected boolean	retained
protected int	seq

Constructor Summary

Constructors

Constructor and Description
MigratoryDataMessage(String subject, byte[] content) Create a MigratoryDataMessage object.
MigratoryDataMessage(String subject, byte[] content, String closure) Create a MigratoryDataMessage object.
MigratoryDataMessage(String subject, byte[] content, String closure, MigratoryDataMessage.QoS qos, boolean retained) Create a MigratoryDataMessage object.
MigratoryDataMessage(String subject, byte[] content, String closure, MigratoryDataMessage.QoS qos, boolean retained, String replySubject) Create a MigratoryDataMessage object.

Method Summary

Modifier and Type	Method and Description
String	getClosure() Get the closure of the message.
byte[]	getContent() Get the content of the message.
int	getEpoch()
MigratoryDataMessage.MessageType	getMessageType() Get the MessageType of the message.
MigratoryDataMessage.QoS	getQos() Get the QoS level of the message.
String	getReplySubject() Get the reply subject of the message.
String	getResponse()
int	getSeq()
String	getSubject() Get the subject of the message.
boolean	isCompressed() Indicate whether or not the message should be/was compressed.
boolean	isRetained() Indicate whether or not the message should be/was retained by the server.
void	respond(String response)
void	setCompressed(boolean compressed) Set whether to compress the content of the message or not.
String	toString()
boolean	waitForResponse(long timeout, TimeUnit unit)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

retained

protected boolean retained

seq

protected int seq

epoch

protected int epoch

compressed

protected boolean compressed

messageType

protected MigratoryDataMessage.MessageType messageType

Constructor Detail

MigratoryDataMessage

public MigratoryDataMessage(String subject,
                            byte[] content)

Create a MigratoryDataMessage object.

Parameters:

subject - the subject of the message

content - the content of the message

MigratoryDataMessage

public MigratoryDataMessage(String subject,
                            byte[] content,
                            String closure)

Create a MigratoryDataMessage object.

Parameters:

subject - the subject of the message

content - the content of the message

closure - the closure of the message

MigratoryDataMessage

public MigratoryDataMessage(String subject,
                            byte[] content,
                            String closure,
                            MigratoryDataMessage.QoS qos,
                            boolean retained)

Create a MigratoryDataMessage object.

Parameters:

subject - the subject of the message

content - the content of the message

closure - the closure of the message

qos - the QoS level of the message; the default is QoS.GUARANTEED

retained - indicate whether or not the message should be/was retained by the server; the default is true

MigratoryDataMessage

public MigratoryDataMessage(String subject,
                            byte[] content,
                            String closure,
                            MigratoryDataMessage.QoS qos,
                            boolean retained,
                            String replySubject)

Create a MigratoryDataMessage object. If a reply subject is attached to a message, the message acts as a request message. The clients which receive a request message will be able to reply by sending back one or more messages having as subject the reply subject. <p> Note: If the reply subject is not already subscribed, it will be subscribed by the library implicitly, and it can be reused for request/reply interactions (and even for receiving multiple replies to one request). When it is not needed anymore, it should be unsubscribed explicitly. </p>

Parameters:

subject - the subject of the message

content - the content of the message

closure - the closure of the message

qos - the QoS level of the message; the default is QoS.GUARANTEED

retained - indicate whether or not the message should be/was retained by the server; the default is true

replySubject - the reply subject of the message

Method Detail

getSubject

public String getSubject()

Get the subject of the message.

Returns:

the subject of the message

getContent

public byte[] getContent()

Get the content of the message.

Returns:

the content of the message

getClosure

public String getClosure()

Get the closure of the message.

Returns:

the closure of the message

isRetained

public boolean isRetained()

Indicate whether or not the message should be/was retained by the server.

Returns:

true if the message should be, or was, retained by the server

getReplySubject

public String getReplySubject()

Get the reply subject of the message.

Returns:

the reply subject of the message

getQos

public MigratoryDataMessage.QoS getQos()

Get the QoS level of the message.

Returns:

the QoS level of the message

getMessageType

public MigratoryDataMessage.MessageType getMessageType()

Get the MessageType of the message.

Returns:

the message type of the message

setCompressed

public void setCompressed(boolean compressed)

Set whether to compress the content of the message or not. <p> Note: If compression is enabled with this method but the size of the content of the message is smaller than the size of compressed content, then the message will be sent uncompressed to save bandwidth and CPU cycles with the decompression on the receiver side. </p>

Parameters:

compressed - if \c true, the content of the message will be published in ZLIB-compressed format; if \c false no compression format will be used; the default value is \c false.

isCompressed

public boolean isCompressed()

Indicate whether or not the message should be/was compressed.

Returns:

Return whether or not the message should be/was compressed. If the received message was compressed, the library automatically decompresses its content without any additional code.

waitForResponse

public boolean waitForResponse(long timeout,
                               TimeUnit unit)
                        throws InterruptedException

Throws:

InterruptedException

getResponse

public String getResponse()

respond

public void respond(String response)

toString

public String toString()

Overrides:

toString in class Object

Returns:

Return a string representation of the message.

getSeq

public int getSeq()

getEpoch

public int getEpoch()