public abstract class MQDestination extends MQManagedObject
alternateUserId, closeOptions, connectionReference, isOpen, name, openOptions| Modifier and Type | Method and Description |
|---|---|
void |
get(MQMessage message)
Retrieves a message from the queue or topic.
|
void |
get(MQMessage message,
MQGetMessageOptions getMessageOptions)
Retrieves a message from the queue or topic.
|
void |
get(MQMessage message,
MQGetMessageOptions getMessageOptions,
int maxMsgSize)
Retrieves a message from the queue or topic up to the maximum specified message size.
|
java.util.GregorianCalendar |
getCreationDateTime()
Gets the date and time that this destination was created.
|
int |
getDestinationType()
Gets the type of destination this object represents.
|
int |
getQueueManagerCmdLevel() |
void |
put(MQMessage message)
Places a message onto a queue or publishes a message to a topic.
|
void |
put(MQMessage message,
MQPutMessageOptions putMessageOptions)
Places a message onto a queue or publishes a message to a topic.
|
void |
setQueueManagerCmdLevel(int queueManagerCmdLevel) |
close, getAlternateUserId, getAttributeString, getCloseOptions, getConnectionReference, getDescription, getName, getOpenOptions, getResolvedObjectString, getResolvedQName, getResolvedType, inquire, inquire, isOpen, set, setAttributeString, setCloseOptionspublic void get(MQMessage message) throws MQException
MQMessage object as a
parameter. It uses some of the fields in the object as input parameters, in particular the
messageId and correlationId, so it is important to ensure that these
are set as required.
If the get fails, the MQMessage object is unchanged. If it succeeds, the message descriptor
(member variables) and message data portions of the MQMessage are completely replaced with the
message descriptor and message data from the incoming message.
This method uses a default instance of MQGetMessageOptions to do the get. The message
option used is CMQC.MQGMO_NO_WAIT.message - An input / output parameter containing the message descriptor information and
the returned message data.MQException - If the call fails.public void get(MQMessage message, MQGetMessageOptions getMessageOptions) throws MQException
MQMessage object as a
parameter. It uses some of the fields in the object as input parameters, in particular the
messageId and correlationId, so it is important to ensure that these
are set as required.
If the get fails, the MQMessage object is unchanged. If it succeeds, the message descriptor
(member variables) and message data portions of the MQMessage are completely replaced with the
message descriptor and message data from the incoming message.message - An input / output parameter containing the message descriptor information and
the returned message data.getMessageOptions - Options controlling the action of the get.MQException - If the call fails.public void get(MQMessage message, MQGetMessageOptions getMessageOptions, int maxMsgSize) throws MQException
MQMessage object as a parameter. It uses some of the fields in the
object as input parameters, in particular the messageId and
correlationId, so it is important to ensure that these are set as required.
If the get fails, the MQMessage object is unchanged. If it succeeds, the message descriptor
(member variables) and message data portions of the MQMessage are completely replaced with the
message descriptor and message data from the incoming message.message - An input / output parameter containing the message descriptor information and
the returned message data.getMessageOptions - Options controlling the action of the get.maxMsgSize - The largest message this method can receive. If the message on the queue is
larger than this size, once of two things occurs;
MQGetMessageOptions object, the message is filled with as much of the message
data as possible. An exception is thrown with the
CMQC.MQCC_WARNING completion code.
CMQC.MQGMO_ACCEPT_TRUNCATED_MSG flag is not set, the message is
left on the queue or topic and an exception is thrown with the
CMQC.MQCC_WARNING completion code and
CMQC.MQRC_TRUNCATED_MSG_FAILED reason code.
MQException - If the call fails.public void put(MQMessage message) throws MQException
MQPutMessageOptions to perform the put or publish. The default
MQPutMessageOptions instance may differ depending upon the destination type.message - An MQMessage object containing the Message Descriptor data (MQMD
) and message to be sent. The Message Descriptor properties of this object can be
altered as a result of this method. The values that they have immediately after the
completion of this method are the values that were put to the queue or published to
the topic.MQException - If the call fails.public void put(MQMessage message, MQPutMessageOptions putMessageOptions) throws MQException
Modifications to the MQMessage object after the put has completed do not affect the
actual message on the destination.
If you use the same MQMessage object to make further calls, then performing a put updates
MQMD.messageId and MQMD.correlationId.
Note also that calling put(MQMessage, MQPutMessageOptions) does not clear the message
data. For example:
msg.writeString("a"); destination.put(msg, pmo);
msg.writeString("b"); destination.put(msg, pmo);
This results in "ab" being put by the second call.message - An MQMessage object containing the Message Descriptor data (MQMD) and
message to be sent. The Message Descriptor properties of this object can be altered as
a result of this method. The values that they have immediately after the completion of
this method are the values that were put to the queue or published to the topic.putMessageOptions - Options controlling the action of the put.MQException - If the call fails.public int getDestinationType()
CMQC.MQOT_Q or
CMQC.MQOT_TOPIC.public java.util.GregorianCalendar getCreationDateTime()
throws MQException
MQException - if you call this method after you have closed the destination, to
indicate that the destination is no longer accessible.public int getQueueManagerCmdLevel()
public void setQueueManagerCmdLevel(int queueManagerCmdLevel)
queueManagerCmdLevel -