com.adaptris.core.msmq.javonet

Interface Message

public interface Message

Wrapper around an System.Messaging.Message exposing key fields.

Check the .NET documentation for more details about each of these properties.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Message.Format Enum describing the supported Message Formatters.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAcknowledgeType() Get the acknowledgement type that will be returned.
Acknowledgment	getAcknowledgment() Get the type of acknowledgement that this message represents.
java.lang.String	getAdministrationQueue() Get the queue that receives acknowledgement messages for this message.
java.util.Date	getArrivedTime() Gets the time that the message arrived in the destination queue.
java.lang.String	getBody() Get the body of the message.
java.lang.String	getCorrelationId() Get the correlation ID.
java.lang.String	getId() Get the ID of the message.
java.lang.String	getLabel() Get the label for this message.
long	getLookupId() Get the Lookup Id.
MessageType	getMessageType() Gets the message type: Normal, Acknowledgment, or Report.
java.lang.String	getResponseQueue() Gets the queue that receives application-generated response messages.
java.util.Date	getSentTime() Gets the date and time on the sending computer that the message was sent by the source queue manager.
java.lang.String	getSourceMachine() Gets the computer from which the message originated.
long	getTimeToBeReceived() Get the maximum amount of time for the message to be received from the destination queue
long	getTimeToReachQueue() Get the maximum amount of time for the message to reach the queue.
java.lang.String	getTransactionId() Gets the identifier for the transaction of which the message was a part.
boolean	getUseTracing() Indicates whether to trace a message as it moves toward its destination queue.
void	setAcknowledgeType(java.lang.String ackType) Sets the type of acknowledgment message to be returned to the sending application.
void	setAdministrationQueue(java.lang.String queueName) Sets the queue that receives the acknowledgement messages that Message Queuing generates.
void	setBody(java.lang.String s) Set the body of the message.
void	setCorrelationId(java.lang.String s) Set the correlation id.
void	setFormatter(Message.Format format) Set the formatter to use for this message.
void	setLabel(java.lang.String s) Set the label.
void	setLookupId(long s) Set the Lookup ID.
void	setResponseQueue(java.lang.String queueName) sets the queue that receives application-generated response messages.
void	setTimeToBeReceived(long ms) Set the maximum amount of time for the message to be received from the destination queue
void	setTimeToReachQueue(long ms) Set the maximum amount of time for the message to reach the queue.
void	setUseTracing(boolean b) Indicates whether to trace a message as it moves toward its destination queue.

Method Detail

getBody

java.lang.String getBody()
                  throws MSMQException

Get the body of the message.

Returns:

the body.

Throws:

MSMQException - wrapping any exceptions.

setBody

void setBody(java.lang.String s)
      throws MSMQException

Set the body of the message.

Parameters:

s - the body of the message.

Throws:

MSMQException - wrapping any exceptions.

setFormatter

void setFormatter(Message.Format format)
           throws MSMQException

Set the formatter to use for this message.

Parameters:

format - the formatter (default is Message.Format.BINARY)

Throws:

MSMQException - wrapping any exceptions.

getLabel

java.lang.String getLabel()
                   throws MSMQException

Get the label for this message.

Returns:

the label.

Throws:

MSMQException - wrapping any exceptions.

setLabel

void setLabel(java.lang.String s)
       throws MSMQException

Set the label.

Parameters:

s - the label

Throws:

MSMQException - wrapping any exceptions.

getId

java.lang.String getId()
                throws MSMQException

Get the ID of the message.

Returns:

the id.

Throws:

MSMQException - wrapping any exceptions.

getCorrelationId

java.lang.String getCorrelationId()
                           throws MSMQException

Get the correlation ID.

Returns:

the correlation Id.

Throws:

MSMQException - wrapping any exceptions.

setCorrelationId

void setCorrelationId(java.lang.String s)
               throws MSMQException

Set the correlation id.

Parameters:

s - the correlation id.

Throws:

MSMQException - wrapping any exceptions.

setLookupId

void setLookupId(long s)
          throws MSMQException

Set the Lookup ID.

Parameters:

s - the lookup Id.

Throws:

MSMQException - wrapping any exceptions.

getLookupId

long getLookupId()
          throws MSMQException

Get the Lookup Id.

Returns:

the Lookup Id. @throws MSMQException wrapping any exceptions.

Throws:

MSMQException

getSentTime

java.util.Date getSentTime()
                    throws MSMQException

Gets the date and time on the sending computer that the message was sent by the source queue manager.

Returns:

the date.

Throws:

MSMQException - wrapping any exceptions.

getArrivedTime

java.util.Date getArrivedTime()
                       throws MSMQException

Gets the time that the message arrived in the destination queue.

Returns:

the date/time.

Throws:

MSMQException - wrapping any exceptions.

getSourceMachine

java.lang.String getSourceMachine()
                           throws MSMQException

Gets the computer from which the message originated.

Note that this will return null, if MSMQ is in the wrong mode (i.e. you are not installed in AD integration mode, as it will fail if the computer is in workgroup mode

Returns:

the source machine; or null.

Throws:

MSMQException - wrapping any exceptions.

getTransactionId

java.lang.String getTransactionId()
                           throws MSMQException

Gets the identifier for the transaction of which the message was a part.

Throws:

MSMQException - wrapping any exceptions.

setTimeToBeReceived

void setTimeToBeReceived(long ms)
                  throws MSMQException

Set the maximum amount of time for the message to be received from the destination queue

Throws:

MSMQException - wrapping any exceptions.

getTimeToBeReceived

long getTimeToBeReceived()
                  throws MSMQException

Get the maximum amount of time for the message to be received from the destination queue

Throws:

MSMQException - wrapping any exceptions.

setTimeToReachQueue

void setTimeToReachQueue(long ms)
                  throws MSMQException

Set the maximum amount of time for the message to reach the queue.

Throws:

MSMQException - wrapping any exceptions.

getTimeToReachQueue

long getTimeToReachQueue()
                  throws MSMQException

Get the maximum amount of time for the message to reach the queue.

Throws:

MSMQException - wrapping any exceptions.

setUseTracing

void setUseTracing(boolean b)
            throws MSMQException

Indicates whether to trace a message as it moves toward its destination queue.

Throws:

MSMQException - wrapping any exceptions.

getUseTracing

boolean getUseTracing()
               throws MSMQException

Indicates whether to trace a message as it moves toward its destination queue.

Throws:

MSMQException - wrapping any exceptions.

setAdministrationQueue

void setAdministrationQueue(java.lang.String queueName)
                     throws MSMQException

Sets the queue that receives the acknowledgement messages that Message Queuing generates.

Parameters:

queueName - the administration queue name.

Throws:

MSMQException - wrapping any exceptions.

getAdministrationQueue

java.lang.String getAdministrationQueue()
                                 throws MSMQException

Get the queue that receives acknowledgement messages for this message.

Returns:

the administration queue name.

Throws:

MSMQException - wrapping any exceptions.

setResponseQueue

void setResponseQueue(java.lang.String queueName)
               throws MSMQException

sets the queue that receives application-generated response messages.

Parameters:

queueName - the response queue name.

Throws:

MSMQException - wrapping any exceptions.

getResponseQueue

java.lang.String getResponseQueue()
                           throws MSMQException

Gets the queue that receives application-generated response messages.

Returns:

the response queue name.

Throws:

MSMQException - wrapping any exceptions.

setAcknowledgeType

void setAcknowledgeType(java.lang.String ackType)
                 throws MSMQException

Sets the type of acknowledgment message to be returned to the sending application.

Parameters:

ackType - the acknowledge type AcknowledgeTypes.Type

Throws:

MSMQException - wrapping any exceptions.

getAcknowledgeType

java.lang.String getAcknowledgeType()
                             throws MSMQException

Get the acknowledgement type that will be returned.

Returns:

the acknowledge types, effectively the ValueName string from theSystem.Messaging.AcknowledgeType enum.

Throws:

MSMQException - wrapping any exceptions

getAcknowledgment

Acknowledgment getAcknowledgment()
                          throws MSMQException

Get the type of acknowledgement that this message represents.

Returns:

the acknowledgement type, effectively the System.Messaging.Acknowledgment enum.

Throws:

MSMQException - wrapping any exceptions

getMessageType

MessageType getMessageType()
                    throws MSMQException

Gets the message type: Normal, Acknowledgment, or Report.

Returns:

type type of message, effectively the System.Messaging.MessageType enum.

Throws:

MSMQException - wrapping any exceptions