|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mqe.MQe | +--com.ibm.mqe.MQeFields | +--com.ibm.mqe.MQeMsgObject | +--com.ibm.broker.mqimqe.wrapper.MQeMbMsgObject
MQePubSubMsgObject
.
This class represents a WebSphere Business Integrator (WBI)style message. It is designed for use with messages which flow between WBI and WMQe applications and use the WBI message format, i.e. 'system information' is stored in fields in a header section and the user data is stored in a byte array.
MQeMbMsgObjects are transformed by the WMQe/WMQ bridge support into suitably formatted WMQ messages that can be sent to the WBI broker. Messages flowing in the other direction are also supported by the bridge.
This class was originally shipped with WBI as part of the WMQe node support.
It is almost identical to the class com.ibm.mqe.mqemqmessage.MQeMQMsgObject
but unfortunately cannot extend this class due to differences in return types,
minor method names, return types & functional differences, coupled with the
need for strict compatability with the WBI version shipped in the WMQe node support.
Field Summary | |
static java.lang.String |
copyright
Deprecated. |
static int |
DEF_COMPLETION_CODE
Deprecated. The default value used for the FIELD_NAME_COMPLETION_CODE field if it is not set in the message. |
static boolean |
DEF_RETENTION
Deprecated. The default value used for the #RETENTION field if it is not set in the message. |
static java.lang.String |
FIELD_NAME_COMPLETION_CODE
Deprecated. The name of the optional integer field which holds
the WBI completion code. |
static java.lang.String |
FIELD_NAME_MQ_CODED_CHARACTER_SET
Deprecated. The name of the optional integer field which holds the
WMQ coded character id. |
static java.lang.String |
FIELD_NAME_MQ_MESSAGE_TYPE
Deprecated. The name of the optional integer field which holds the
message type (datagram, reply, request, report). |
static java.lang.String |
FIELD_NAME_MQ_PUT_DATE
Deprecated. The name of the optional ASCII String field which holds the
put date. |
static java.lang.String |
FIELD_NAME_MQ_PUT_TIME
Deprecated. The name of the optional ASCII String field which holds the
put time. |
static java.lang.String |
FIELD_NAME_MQ_STRUC_ID
Deprecated. The name of the optional ASCII String field which holds the
WMQ RFH2 structure id. |
static java.lang.String |
FIELD_NAME_MQ_VERSION
Deprecated. The name of the optional integer field which holds the
WMQ RFH2 version number. |
static java.lang.String |
FIELD_NAME_RESPONSES
Deprecated. The name of the optional Unicode array field which holds
any WBI response information. |
static java.lang.String |
MESSAGE
Deprecated. The name of the optional byte array field which holds the
message data. |
static java.lang.String |
MQ_AccountingToken
Deprecated. The name of an optional byte array field used to hold the accounting token associated
with this message, as defined in the WMQ reference material. |
static java.lang.String |
MQ_ApplicationIdData
Deprecated. The name of an optional Ascii String field which holds appliation data relating to identity. |
static java.lang.String |
MQ_ApplicationOriginData
Deprecated. The name of an optional Ascii String field which holds application data relating to the original
source of the data. |
static java.lang.String |
MQ_BackoutCount
Deprecated. The name of an optional integer field used to indicates how many times the message has
been backed-out, as defined in the WMQ reference manuals. |
static java.lang.String |
MQ_CodedCharacterSet
Deprecated. The name of an optional integer field used to hold the coded character set the data is encoded in. |
static java.lang.String |
MQ_Data
Deprecated. The name of the optional byte array field which holds the message payload. |
static java.lang.String |
MQ_DestQueueMgr
Deprecated. The name of the optional ASCII String field which holds the
destination queue manager name associated with a subscription. |
static java.lang.String |
MQ_DestQueueName
Deprecated. The name of the optional ASCII String field which holds the
destination queue name associated with a subscription. |
static java.lang.String |
MQ_Encoding
Deprecated. The name of an optional integer field used to hold the data encoding used for the message data. |
static java.lang.String |
MQ_Feedback
Deprecated. The name of an optional integer field used to hold the feedback, or reason code. |
static java.lang.String |
MQ_Format
Deprecated. The name of an optional Ascii String field used to indicate the
format of the message data, as defined by the WMQ reference manuals. |
static java.lang.String |
MQ_GroupId
Deprecated. The name of the optional byte array field which holds group identifier information,
as defined in the WMQ reference material. |
static java.lang.String |
MQ_MessageFlags
Deprecated. The name of the optional integer field which holds message flags,
as defined by the WMQ reference material. |
static java.lang.String |
MQ_MessageSequenceNumber
Deprecated. The name of the optional integer field which holds the sequence number of the logical message
within a group of messages, as defined by the WMQ reference material. |
static java.lang.String |
MQ_MessageType
Deprecated. The name of the optional integer field which holds the
message type (datagram, reply, request, report). |
static java.lang.String |
MQ_Offset
Deprecated. The name of the optional integer field which holds the offset of the data in the physical
message from the start of a logical message, as defined by the WMQ reference material. |
static java.lang.String |
MQ_OriginalLength
Deprecated. The name of the optional integer field which holds the length of the original message. |
static java.lang.String |
MQ_Persistence
Deprecated. The name of an optional integer field used to indicate whether the message
is persistent or not, as defined by the WMQ reference manuals. |
static java.lang.String |
MQ_PutApplicationName
Deprecated. The name of an optional Ascii String field which indicates the name of the
application which put the message. |
static java.lang.String |
MQ_PutApplicationType
Deprecated. The name of an optional integer field which indicates the type of the application which put the message. |
static java.lang.String |
MQ_PutDate
Deprecated. The name of the optional ASCII String field which holds
the put date in the WMQ standard message header. |
static java.lang.String |
MQ_PutTime
Deprecated. The name of the optional ASCII String field which holds
the put time in the WMQ standard message header. |
static java.lang.String |
MQ_Report
Deprecated. The name of an optional integer field used to hold the reporting options a message will use
when being conveyed on a WMQ system. |
static java.lang.String |
MQ_StrucId
Deprecated. The name of the optional ASCII String field which holds the
WMQ RFH2 structure id. |
static java.lang.String |
MQ_UserId
Deprecated. The name of an optional Ascii String field used to hold the name of the user who generated
the message, as defined in the WMQ reference manuals. |
static java.lang.String |
MQ_Version
Deprecated. The name of the optional integer field which holds the
WMQ RFH2 version number. |
static java.lang.String |
RETAINED
Deprecated. The name of the optional boolean field which holds the
retained flag. |
static java.lang.String |
TOPIC
Deprecated. The name of the optional ASCII String field which holds the
message topic. |
static int |
TYPE_MQE
Deprecated. A value for the optional TYPE_OF_MESSAGE field, indicating that the
purpose of the message is to drive a WMQ application through the subsequent creation of
a WMQ message with a defined MQMD and with a specified payload. |
static java.lang.String |
TYPE_OF_MSG
Deprecated. The name of the optional integer field which holds the
purpose of the message, i.e. |
static int |
TYPE_PUB
Deprecated. A value for the optional TYPE_OF_MESSAGE field, indicating that the
purpose of the message is to send a publication to the broker. |
static int |
TYPE_SUB
Deprecated. A value for the optional TYPE_OF_MESSAGE field, indicating that the
purpose of the message is to send a subscription to the broker. |
static int |
TYPE_UNSUB
Deprecated. A value for the optional TYPE_OF_MESSAGE field, indicating that the
purpose of the message is to send an un-subscription to the broker. |
Fields inherited from class com.ibm.mqe.MQeFields |
ArraySeparator, TypeArrayElements, TypeAscii, TypeBoolean, TypeByte, TypeDouble, TypeFields, TypeFloat, TypeInt, TypeLong, TypeShort, TypeUnicode, TypeUnTyped |
Constructor Summary | |
MQeMbMsgObject()
Deprecated. Creates an MQeMbMsgObject . |
|
MQeMbMsgObject(MQePubSubMsgObject pubSubMsg)
Deprecated. Creates an equivalent MQeMbMsgObject from a supplied MQePubSubMsgObject . |
Method Summary | |
java.lang.String |
dumpAllToString()
Deprecated. Dump all the fields in the message object into a String . |
java.lang.String |
dumpToString()
Deprecated. Dumps the field values in the message object to a string. |
byte[] |
getAccountingToken()
Deprecated. Gets the value of accounting token - this corresponds to a field in the WMQ standard message header. |
java.lang.String |
getApplicationIdData()
Deprecated. Gets the value of application id data - this corresponds to a field in the WMQ standard message header. |
java.lang.String |
getApplicationOriginData()
Deprecated. Gets the value of the application origin data - this corresponds to a field in the WMQ standard message header. |
java.lang.Integer |
getBackoutCount()
Deprecated. Gets the value of the backout count - this corresponds to a field in the WMQ standard message header. |
java.lang.Integer |
getCodedCharacterSetId()
Deprecated. Gets the value of the character set id - this corresponds to a field in the WMQ standard message header. |
byte[] |
getCorrelationId()
Deprecated. Gets the value of the correlation id - this corresponds to a field in the WMQ standard message header. |
byte[] |
getData()
Deprecated. Gets the user data - this corresponds to the payload of a WMQ message. |
java.lang.String |
getDestQueueMgr()
Deprecated. Gets the destination queue manager name for subscriptions. |
java.lang.String |
getDestQueueName()
Deprecated. Gets the destination queue name for subscriptions. |
java.lang.Integer |
getEncoding()
Deprecated. Gets the value of the encoding - this corresponds to a field in the WMQ standard message header. |
java.lang.Integer |
getExpiry()
Deprecated. Gets the value of the expiry time - this corresponds to a field in the WMQ standard message header. |
java.lang.Integer |
getFeedback()
Deprecated. Gets the value of the feedback - this corresponds to a field in the WMQ standard message header. |
java.lang.String |
getFormat()
Deprecated. Gets the value of the format - this corresponds to a field in the WMQ standard message header. |
byte[] |
getGroupId()
Deprecated. Gets the value of the group id - this corresponds to a field in the WMQ standard message header. |
java.lang.Integer |
getMessageFlags()
Deprecated. Gets the value of the message flags - this corresponds to a field in the WMQ standard message header. |
byte[] |
getMessageId()
Deprecated. Gets the value of the message id - this corresponds to a field in the WMQ standard message header. |
java.lang.Integer |
getMessageSequenceNumber()
Deprecated. Gets the value of the sequence number - this corresponds to a field in the WMQ standard message header. |
java.lang.Integer |
getMessageType()
Deprecated. Gets the message type (i.e datagram, reply, request, report) - this corresponds to a field in the WMQ standard message header. |
java.lang.Integer |
getOffset()
Deprecated. Gets the value of the offset - this corresponds to a field in the WMQ standard message header. |
java.lang.Integer |
getOriginalLength()
Deprecated. Gets the value of the original length - this corresponds to a field in the WMQ standard message header. |
java.lang.Integer |
getPersistence()
Deprecated. Gets the value of the persistence - this corresponds to a field in the WMQ standard message header. |
java.lang.Integer |
getPriority()
Deprecated. Gets the message priority - this corresponds to a field in the WMQ standard message header. |
java.lang.String |
getPutApplicationName()
Deprecated. Gets the put application name - this corresponds to a field in the WMQ standard message header. |
java.lang.Integer |
getPutApplicationType()
Deprecated. Gets the put application type - this corresponds to a field in the WMQ standard message header. |
java.lang.String |
getPutDate()
Deprecated. Gets the value of the put date - this corresponds to a field in the WMQ standard message header. |
java.lang.String |
getPutTime()
Deprecated. Gets the value of the put time - this corresponds to a field in the WMQ standard message header. |
java.lang.String |
getReplyToQueueManagerName()
Deprecated. Gets the reply-to queue manager name - this corresponds to a field in the WMQ standard message header. |
java.lang.String |
getReplyToQueueName()
Deprecated. Gets the reply-to queue name - this corresponds to a field in the WMQ standard message header. |
java.lang.Integer |
getReport()
Deprecated. Gets the report value - this corresponds to a field in the WMQ standard message header. |
java.lang.String |
getStrucId()
Deprecated. Gets the value of the structure id - this corresponds to a field in the WMQ RFH2 message header. |
java.lang.String |
getUserId()
Deprecated. Gets the value of the user id - this corresponds to a field in the WMQ standard message header. |
java.lang.Integer |
getVersion()
Deprecated. Gets the version number - this corresponds to a field in the WMQ RFH2 message header. |
void |
setAccountingToken(byte[] accountingToken)
Deprecated. Sets the value of the accounting token - this corresponds to a field in the WMQ standard message header. |
void |
setApplicationIdData(java.lang.String applicationIdData)
Deprecated. Sets the value of the application id data - this corresponds to a field in the WMQ standard message header. |
void |
setApplicationOriginData(java.lang.String applicationOriginData)
Deprecated. Sets the value of the application origin data - this corresponds to a field in the WMQ standard message header. |
void |
setBackoutCount(int backoutCount)
Deprecated. Sets the value of the backount count - this corresponds to a field in the WMQ standard message header. |
void |
setCodedCharacterSetId(int characterSetId)
Deprecated. Sets the value if the character set id - this corresponds to a field in the WMQ standard message header. |
void |
setCorrelationId(byte[] correlationId)
Deprecated. Sets the value of the correlation id - this corresponds to a field in the WMQ standard message header. |
void |
setData(byte[] data)
Deprecated. Sets the user data - this corresponds to the payload of the WMQ message. |
void |
setDestQueueMgr(java.lang.String destQueueMgr)
Deprecated. Sets the destination queue manager name - this corresponds to a field in the WMQ standard message header. |
void |
setDestQueueName(java.lang.String destQueueName)
Deprecated. Sets the destination queue name - this corresponds to a field in the WMQ standard message header. |
void |
setEncoding(int encoding)
Deprecated. Sets the encoding value - this corresponds to a field in the WMQ standard message header. |
void |
setExpiry(int expiry)
Deprecated. Sets the expiry value - this corresponds to a field in the WMQ standard message header. |
void |
setFeedback(int feedback)
Deprecated. Sets the value of feedback - this corresponds to a field in the WMQ standard message header. |
void |
setFormat(java.lang.String format)
Deprecated. Sets the value of the format - this corresponds to a field in the WMQ standard message header. |
void |
setGroupId(byte[] groupId)
Deprecated. Sets the value of the group id - this corresponds to a field in the WMQ standard message header. |
void |
setMessageFlags(int flags)
Deprecated. Sets the value of the message flags - this corresponds to a field in the WMQ standard message header. |
void |
setMessageId(byte[] messageId)
Deprecated. Sets the value of the message id - this corresponds to a field in the WMQ standard message header. |
void |
setMessageSequenceNumber(int seqNo)
Deprecated. Sets the value of the message sequence number - this corresponds to a field in the WMQ standard message header. |
void |
setMessageType(int messageType)
Deprecated. Sets the message type(i.e. |
void |
setOffset(int offset)
Deprecated. Sets the value of the offset - this corresponds to a field in the WMQ standard message header. |
void |
setOriginalLength(int len)
Deprecated. Sets the value of the original length - this corresponds to a field in the WMQ standard message header. |
void |
setPersistence(int persistence)
Deprecated. Sets the value of persistence - this corresponds to a field in the WMQ standard message header. |
void |
setPriority(int priority)
Deprecated. Sets the message priority - this corresponds to a field in the WMQ standard message header. |
void |
setPutApplicationName(java.lang.String putApplicationName)
Deprecated. Sets the put application name - this corresponds to a field in the WMQ standard message header. |
void |
setPutApplicationType(int putApplicationType)
Deprecated. Sets the put application type - this corresponds to a field in the WMQ standard message header. |
void |
setPutDate(java.util.GregorianCalendar calendar)
Deprecated. Sets the put date - this corresponds to a field in the WMQ standard message header. |
void |
setPutTime(java.util.GregorianCalendar calendar)
Deprecated. Sets the put time - this corresponds to a field in the WMQ standard message header. |
void |
setReplyToQueueManagerName(java.lang.String replyToQMName)
Deprecated. Sets the reply-to queue manager name - this corresponds to a field in the WMQ standard message header. |
void |
setReplyToQueueName(java.lang.String replyToQueueName)
Deprecated. Sets the reply-to queue name - this corresponds to a field in the WMQ standard message header. |
void |
setReport(int report)
Deprecated. Sets the report value - this corresponds to a field in the WMQ standard message header. |
void |
setStrucId(java.lang.String strucId)
Deprecated. Sets the structure id - this corresponds to a field in the WMQ RFH2 message header. |
void |
setUserId(java.lang.String userId)
Deprecated. Sets the value of the user id - this corresponds to a field in the WMQ standard message header. |
void |
setVersion(int version)
Deprecated. Sets the version number - this corresponds to a field in the WMQ RFH2 message header. |
MQePubSubMsgObject |
toMQePubSubMsgObject()
Deprecated. Returns an MQePubSubMsgObject message of equivalent content. |
Methods inherited from class com.ibm.mqe.MQeMsgObject |
getMsgUIDFields, getOriginQMgr, getTimeStamp, putOriginQMgr, resetMsgUIDFields, unwrapMsgObject |
Methods inherited from class com.ibm.mqe.MQe |
abbreviate, alias, asciiToByte, byteToAscii, byteToHex, byteToHex, byteToInt, byteToLong, byteToShort, byteToUnicode, fileSeparator, getEventLogHandler, hexToAscii, hexToByte, intToByte, isCLDC, loadClass, loadObject, log, setEventLogHandler, setLoader, sliceByteArray, type, unicodeToByte, uniqueValue |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String copyright
public static final int DEF_COMPLETION_CODE
FIELD_NAME_COMPLETION_CODE
field if it is not set in the message.
The default is RESULT_UNKNOWN
.
public static final boolean DEF_RETENTION
#RETENTION
field if it is not set in the message.
The default is false
.
public static final java.lang.String FIELD_NAME_MQ_MESSAGE_TYPE
integer
field which holds the
message type (datagram, reply, request, report). Message types are defined
by the constants defined in the MQe
class, e.g. MQe.Msg_Style_Datagram.
If the field is not defined in the message, then a value of
MQeMQMsgObject.DEF_MESSAGE_TYPE
is assumed.
public static final java.lang.String FIELD_NAME_MQ_PUT_DATE
ASCII String
field which holds the
put date.
If the field is not defined in the message, then a value of
null
is assumed.
public static final java.lang.String FIELD_NAME_MQ_PUT_TIME
ASCII String
field which holds the
put time.
If the field is not defined in the message, then a value of
null
is assumed.
public static final java.lang.String FIELD_NAME_MQ_STRUC_ID
ASCII String
field which holds the
WMQ RFH2 structure id.
If the field is not defined in the message, then a value of
null
is assumed.
public static final java.lang.String FIELD_NAME_MQ_VERSION
integer
field which holds the
WMQ RFH2 version number.
If the field is not defined in the message, then a value of
DEF_VERSION
is assumed.
public static final java.lang.String FIELD_NAME_MQ_CODED_CHARACTER_SET
integer
field which holds the
WMQ coded character id.
If the field is not defined in the message, then a value of
MQePubSubMsgObject.DEF_CHARACTER_SET
is assumed.
public static final java.lang.String FIELD_NAME_COMPLETION_CODE
integer
field which holds
the WBI completion code. This field is present in messages generated
by the MQeJMSRFHTransformer
as a consequence of receiving a response
from the broker.
public static final java.lang.String FIELD_NAME_RESPONSES
Unicode
array field which holds
any WBI response information. This field is present in messages generated
by the MQeJMSRFHTransformer
as a consequence of receiving a response
from the broker.
Each element of the array represents a response in the format "parameter1: value1; parameter2: value2; ...". If there are no responses available a zero length array is returned.
public static final java.lang.String TYPE_OF_MSG
integer
field which holds the
purpose of the message, i.e. one of: TYPE_MQE
, TYPE_PUB
,
TYPE_SUB
or TYPE_UNSUB
.
public static final java.lang.String TOPIC
ASCII String
field which holds the
message topic.
public static final java.lang.String MESSAGE
byte array
field which holds the
message data. The message must be converted from a source String
to
such an array using the MQe.asciiToByte(java.lang.String)
method (or equivalent).
public static final java.lang.String RETAINED
boolean
field which holds the
retained flag.
public static final int TYPE_MQE
TYPE_OF_MESSAGE
field, indicating that the
purpose of the message is to drive a WMQ application through the subsequent creation of
a WMQ message with a defined MQMD and with a specified payload.
public static final int TYPE_PUB
TYPE_OF_MESSAGE
field, indicating that the
purpose of the message is to send a publication to the broker.
public static final int TYPE_SUB
TYPE_OF_MESSAGE
field, indicating that the
purpose of the message is to send a subscription to the broker.
public static final int TYPE_UNSUB
TYPE_OF_MESSAGE
field, indicating that the
purpose of the message is to send an un-subscription to the broker.
public static final java.lang.String MQ_Report
integer
field used to hold the reporting options a message will use
when being conveyed on a WMQ system.
See the WMQ programming reference for more details of the available reporting options. Note that this field is not used by the WMQe messaging fabric.
If this field is missing from the message, then a value of
MQeMQMsgObject.DEF_REPORT
is assumed.
public static final java.lang.String MQ_Feedback
integer
field used to hold the feedback, or reason code.
See the WMQ programming reference material for a more detailed explanation.
If this field is missing from the message, then a value of
MQeMQMsgObject.DEF_FEEDBACK
is assumed.
public static final java.lang.String MQ_Encoding
integer
field used to hold the data encoding used for the message data.
If this field is missing from the message, then a value of
MQeMQMsgObject.DEF_ENCODING
is assumed.
public static final java.lang.String MQ_Format
Ascii String
field used to indicate the
format of the message data, as defined by the WMQ reference manuals.
The field is normally 8 characters long.
If this field is missing from the message, then a value of
MQeMQMsgObject.DEF_FORMAT
is assumed.
public static final java.lang.String MQ_Persistence
integer
field used to indicate whether the message
is persistent or not, as defined by the WMQ reference manuals.
MQe does not use this field, it has an effect only when the message is being conveyed to, from or over a WMQ queue manager.
If this field is missing then a value of
MQeMQMsgObject.DEF_PERSISTENCE
is assumed.
public static final java.lang.String MQ_BackoutCount
integer
field used to indicates how many times the message has
been backed-out, as defined in the WMQ reference manuals.
MQe does not use this field, it has an effect only when the message is being conveyed to, from or over a WMQ queue manager.
If this field is missing then a value of
MQeMQMsgObject.DEF_BACKOUT_COUNT
is assumed.
public static final java.lang.String MQ_UserId
Ascii String
field used to hold the name of the user who generated
the message, as defined in the WMQ reference manuals.
The field is usually of length 12 to match that used by WMQ.
If this field is missing then a value of
MQeMQMsgObject.DEF_USER_ID
is assumed.
public static final java.lang.String MQ_AccountingToken
byte array
field used to hold the accounting token associated
with this message, as defined in the WMQ reference material.
If this field is missing, then a value of
MQeMQMsgObject.DEF_ACCOUNTING_TOKEN
is assumed.
public static final java.lang.String MQ_ApplicationIdData
Ascii String
field which holds appliation data relating to identity.
If this field is missing, then a value of
MQeMQMsgObject.DEF_APPLICATION_ID_DATA
is assumed.
public static final java.lang.String MQ_PutApplicationType
integer
field which indicates the type of the application which put the message.
The values of this field are defined by the WMQ reference manuals.
If this field is missing from the message, then a value of
MQeMQMsgObject.DEF_PUT_APPLICATION_TYPE
is assumed.
public static final java.lang.String MQ_PutApplicationName
Ascii String
field which indicates the name of the
application which put the message.
If this field is missing from the message, then a value of
MQeMQMsgObject.DEF_PUT_APPLICATION_NAME
is assumed.
public static final java.lang.String MQ_ApplicationOriginData
Ascii String
field which holds application data relating to the original
source of the data.
If this field is missing from the message, then a default value of
MQeMQMsgObject.DEF_APPLICATION_ORIGIN_DATA
is assumed.
public static final java.lang.String MQ_Data
byte array
field which holds the message payload.
If this field is not in the message, then a zero-length byte array is assumed.
public static final java.lang.String MQ_GroupId
byte array
field which holds group identifier information,
as defined in the WMQ reference material.
If this field is missing from the message, then a value of
MQeMQMsgObject.DEF_GROUP_ID
is assumed.
public static final java.lang.String MQ_MessageSequenceNumber
integer
field which holds the sequence number of the logical message
within a group of messages, as defined by the WMQ reference material.
If this field is missing from the message, then a default value of
MQeMQMsgObject.DEF_SEQUENCE_NUMBER
is assumed.
public static final java.lang.String MQ_Offset
integer
field which holds the offset of the data in the physical
message from the start of a logical message, as defined by the WMQ reference material.
If this field is missing from the message, then a default value of
MQeMQMsgObject.DEF_OFFSET
is assumed.
public static final java.lang.String MQ_MessageFlags
integer
field which holds message flags,
as defined by the WMQ reference material.
If the field is not defined in the message, then a value of
MQeMQMsgObject.DEF_MESSAGE_FLAGS
is assumed.
public static final java.lang.String MQ_OriginalLength
integer
field which holds the length of the original message.
If the field is not defined in the message, then a value of
MQeMQMsgObject.DEF_ORIGINAL_LENGTH
is assumed.
public static final java.lang.String MQ_DestQueueName
ASCII String
field which holds the
destination queue name associated with a subscription.
public static final java.lang.String MQ_DestQueueMgr
ASCII String
field which holds the
destination queue manager name associated with a subscription.
public static final java.lang.String MQ_StrucId
ASCII String
field which holds the
WMQ RFH2 structure id. This value is ignored by MQeMbTransformer
.
public static final java.lang.String MQ_Version
integer
field which holds the
WMQ RFH2 version number. This value is ignored by MQeMbTransformer
.
public static final java.lang.String MQ_PutDate
ASCII String
field which holds
the put date in the WMQ standard message header. The value is held in the format
resulting from the method call java.text.SimpleDateFormat("d/MM/yy")
.
public static final java.lang.String MQ_PutTime
ASCII String
field which holds
the put time in the WMQ standard message header. The value is held in the format
resulting from the method call java.text.SimpleDateFormat("K:mm a")
.
public static final java.lang.String MQ_MessageType
integer
field which holds the
message type (datagram, reply, request, report). Message types are defined
by the constants defined in the MQe
class, e.g. MQe.Msg_Style_Datagram.
If the field is not defined in the message, then a value of
MQeMQMsgObject.DEF_MESSAGE_TYPE
is assumed.
public static final java.lang.String MQ_CodedCharacterSet
integer
field used to hold the coded character set the data is encoded in.
If this field is missing from the message, then a value of
MQePubSubMsgObject.DEF_CHARACTER_SET
is assumed.
Constructor Detail |
public MQeMbMsgObject() throws java.lang.Exception
MQeMbMsgObject
. The message has, by default, the field
TYPE_OF_MSG
TYPE_MQE.
java.lang.Exception.
java.lang.Exception
public MQeMbMsgObject(MQePubSubMsgObject pubSubMsg) throws java.lang.Exception
MQeMbMsgObject
from a supplied MQePubSubMsgObject
.
This constructor is provided primarily for the use by the bridge transformer
class MQeMbTransformer
.
pubSubMsg
- The message to be used as the data source.
java.lang.Exception.
java.lang.Exception
Method Detail |
public java.lang.String dumpAllToString()
String
.
String
representation of the data content.public java.lang.String dumpToString()
Dumps the field values in the message object to a string.
This method dumps header fields from the Websphere MQ style message with their corresponding field values to a string, together with the value of the data field. It is useful when debugging.
This method dumps only the fields that have been set to non-default
values. The dumpAllToString()
method dumps all the header fields to a string.
String
containing the field names and values and the data value.public byte[] getAccountingToken() throws java.lang.Exception
MQeMQMsgObject.DEF_ACCOUNTING_TOKEN
.
java.lang.Exception.
java.lang.Exception
public java.lang.String getApplicationIdData() throws java.lang.Exception
MQeMQMsgObject.DEF_APPLICATION_ID_DATA
.
java.lang.Exception.
java.lang.Exception
public java.lang.String getApplicationOriginData() throws java.lang.Exception
MQeMQMsgObject.DEF_APPLICATION_ORIGIN_DATA
.
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getBackoutCount() throws java.lang.Exception
new Integer(MQeMQMsgObject.DEF_BACKOUT_COUNT)
.
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getCodedCharacterSetId() throws java.lang.Exception
new Integer(DEF_CHARACTER_SET)
.
java.lang.Exception.
java.lang.Exception
public byte[] getCorrelationId() throws java.lang.Exception
MQeMQMsgObject.DEF_CORRELATION_ID
.
java.lang.Exception.
java.lang.Exception
public byte[] getData() throws java.lang.Exception
byte
array.
java.lang.Exception.
java.lang.Exception
public java.lang.String getDestQueueMgr() throws java.lang.Exception
null
.
java.lang.Exception.
java.lang.Exception
public java.lang.String getDestQueueName() throws java.lang.Exception
null
.
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getEncoding() throws java.lang.Exception
new Integer(MQeMQMsgObject.DEF_ENCODING)
.
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getExpiry() throws java.lang.Exception
new Integer(MQeMQMsgObject.DEF_EXPIRY)
.
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getFeedback() throws java.lang.Exception
new Integer(MQeMQMsgObject.DEF_FEEDBACK)
.
java.lang.Exception.
java.lang.Exception
public java.lang.String getFormat() throws java.lang.Exception
MQeMQMsgObject.DEF_FORMAT
.
java.lang.Exception.
java.lang.Exception
public byte[] getGroupId() throws java.lang.Exception
MQeMQMsgObject.DEF_GROUP_ID
.
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getMessageFlags() throws java.lang.Exception
new Integer(MQeMQMsgObject.DEF_MESSAGE_FLAGS)
.
java.lang.Exception.
java.lang.Exception
public byte[] getMessageId() throws java.lang.Exception
MQeMQMsgObject.DEF_MESSAGE_ID
.
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getMessageSequenceNumber() throws java.lang.Exception
new Integer(MQeMQMsgObject.DEF_SEQUENCE_NUMBER)
.
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getMessageType() throws java.lang.Exception
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getOffset() throws java.lang.Exception
new Integer(MQeMQMsgObject.DEF_OFFSET)
.
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getOriginalLength() throws java.lang.Exception
new Integer(MQeMQMsgObject.DEF_ORIGINAL_LENGTH)
.
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getPersistence() throws java.lang.Exception
new Integer(MQeMQMsgObject.DEF_PERSISTENCE)
.
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getPriority() throws java.lang.Exception
new Integer(MQeMQMsgObject.DEF_PRIORITY)
.
java.lang.Exception.
java.lang.Exception
public java.lang.String getPutApplicationName() throws java.lang.Exception
MQeMQMsgObject.DEF_PUT_APPLICATION_NAME
.
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getPutApplicationType() throws java.lang.Exception
new Integer(MQeMQMsgObject.DEF_PUT_APPLICATION_TYPE)
.
java.lang.Exception.
java.lang.Exception
public java.lang.String getPutDate() throws java.lang.Exception
null
.
java.lang.Exception.
java.lang.Exception
public java.lang.String getPutTime() throws java.lang.Exception
null
.
java.lang.Exception.
java.lang.Exception
public java.lang.String getReplyToQueueManagerName() throws java.lang.Exception
MQeMQMsgObject.DEF_REPLY_TO_QUEUE_MANAGER_NAME
.
java.lang.Exception.
java.lang.Exception
public java.lang.String getReplyToQueueName() throws java.lang.Exception
MQeMQMsgObject.DEF_REPLY_TO_QUEUE_NAME
.
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getReport() throws java.lang.Exception
new Integer(MQeMQMsgObject.DEF_REPORT)
.
java.lang.Exception.
java.lang.Exception
public java.lang.String getStrucId() throws java.lang.Exception
MQeMbTransformer
does not set
this value.
DEF_STRUC_ID
.
java.lang.Exception.
java.lang.Exception
public java.lang.String getUserId() throws java.lang.Exception
MQeMQMsgObject.DEF_USER_ID
.
java.lang.Exception.
java.lang.Exception
public java.lang.Integer getVersion() throws java.lang.Exception
MQeMbTransformer
does not set
this value.
new Integer(DEF_VERSION)
.
java.lang.Exception.
java.lang.Exception
public void setAccountingToken(byte[] accountingToken) throws java.lang.Exception
accountingToken
- The accounting token.
If not set, the accounting token defaults to
MQeMQMsgObject.DEF_ACCOUNTING_TOKEN
.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setApplicationIdData(java.lang.String applicationIdData) throws java.lang.Exception
applicationIdData
- The application id data.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setApplicationOriginData(java.lang.String applicationOriginData) throws java.lang.Exception
applicationOriginData
- The application origin data.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setBackoutCount(int backoutCount) throws java.lang.Exception
backoutCount
- The backout count.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setCodedCharacterSetId(int characterSetId) throws java.lang.Exception
characterSetId
- The character set id.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setCorrelationId(byte[] correlationId) throws java.lang.Exception
correlationId
- The correlation id.
If not set, the correlation id defaults to
MQeMQMsgObject.DEF_CORRELATION_ID
.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setData(byte[] data) throws java.lang.Exception
data
- The user data.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setDestQueueMgr(java.lang.String destQueueMgr) throws java.lang.Exception
destQueueMgr
- The destination queue manager name; null
values are ignored.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setDestQueueName(java.lang.String destQueueName) throws java.lang.Exception
destQueueName
- The destination queue name; null
values are ignored.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setEncoding(int encoding) throws java.lang.Exception
encoding
- The encoding value.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setExpiry(int expiry) throws java.lang.Exception
Sets the expiry value - this corresponds to a field in the WMQ standard message header.
This method sets the value of the Expiry header field in the Websphere WMQ style message. It also sets the expiry time of the message for use within the WebSphere MQ Everyplace system itself.
expiry
- An integer containing the value to be set in the expiry field.
The value should be in tenths of a second, as is used in Websphere MQ messages
(not in milliseconds, which is used for WebSphere MQ Everyplace expiry time).
java.lang.Exception
- if there is an error setting the value in the
message object.public void setFeedback(int feedback) throws java.lang.Exception
feedback
- The WMQ feedback.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setFormat(java.lang.String format) throws java.lang.Exception
format
- The WMQ format.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setGroupId(byte[] groupId) throws java.lang.Exception
groupId
- The group id.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setMessageFlags(int flags) throws java.lang.Exception
flags
- The message flags.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setMessageId(byte[] messageId) throws java.lang.Exception
messageId
- The message id.
If not set, the message id defaults to
MQeMQMsgObject.DEF_MESSAGE_ID
.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setMessageSequenceNumber(int seqNo) throws java.lang.Exception
seqNo
- The message sequence number.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setMessageType(int messageType) throws java.lang.Exception
messageType
- The WMQ message type.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setOffset(int offset) throws java.lang.Exception
offset
- The offset.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setOriginalLength(int len) throws java.lang.Exception
len
- The original length.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setPersistence(int persistence) throws java.lang.Exception
persistence
- The persistence.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setPriority(int priority) throws java.lang.Exception
priority
- The message priority,
an int
between the values 0
and 9
.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setPutApplicationName(java.lang.String putApplicationName) throws java.lang.Exception
putApplicationName
- The put application name.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setPutApplicationType(int putApplicationType) throws java.lang.Exception
putApplicationType
- The put application type.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setPutDate(java.util.GregorianCalendar calendar) throws java.lang.Exception
calendar
- The put date.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setPutTime(java.util.GregorianCalendar calendar) throws java.lang.Exception
calendar
- The put time.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setReplyToQueueManagerName(java.lang.String replyToQMName) throws java.lang.Exception
replyToQMName
- The reply-to queue manager name.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setReplyToQueueName(java.lang.String replyToQueueName) throws java.lang.Exception
replyToQueueName
- The reply-to queue name.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setReport(int report) throws java.lang.Exception
report
- The report value.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setStrucId(java.lang.String strucId) throws java.lang.Exception
MQeMbTransformer
.
strucId
- The structure id.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setUserId(java.lang.String userId) throws java.lang.Exception
userId
- The user id.
java.lang.Exception
- if there is an error setting the value in the
message object.public void setVersion(int version) throws java.lang.Exception
MQeMbTransformer
.
version
- The version number.
java.lang.Exception
- if there is an error setting the value in the
message object.public MQePubSubMsgObject toMQePubSubMsgObject()
MQePubSubMsgObject
message of equivalent content.
MQePubSubMsgObject
message of equivalent content. In
the event of errors, an attempt is made to return the maximum information content.
|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |