Websphere MQ Everyplace

com.ibm.broker.mqimqe.wrapper
Class MQeMbMsgObject

java.lang.Object
  |
  +--com.ibm.mqe.MQe
        |
        +--com.ibm.mqe.MQeFields
              |
              +--com.ibm.mqe.MQeMsgObject
                    |
                    +--com.ibm.broker.mqimqe.wrapper.MQeMbMsgObject
All Implemented Interfaces:
MQeExceptionCodes
Direct Known Subclasses:
MQeMbConstants

Deprecated. Use MQePubSubMsgObject.

public class MQeMbMsgObject
extends MQeMsgObject

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
 
Fields inherited from class com.ibm.mqe.MQe
Admin_Queue_Name, Admin_Reply_Queue_Name, DeadLetter_Queue_Name, Event_Activate, Event_Attribute, Event_Authenticate, Event_Close, Event_Logoff, Event_Logon, Event_MiniCert_Validate, Event_Queue, Event_QueueManager, Event_UserBase, JMS_Version, MQ_Headers, MQe_Log_Audit_Failure, MQe_Log_Audit_Success, MQe_Log_Error, MQe_Log_Information, MQe_Log_Success, MQe_Log_Warning, Msg_BackoutCount, Msg_CorrelID, Msg_ExpireTime, Msg_LockID, Msg_MsgID, Msg_OriginQMgr, Msg_Priority, Msg_ReplyToQ, Msg_ReplyToQMgr, Msg_Resend, Msg_Style, Msg_Style_Datagram, Msg_Style_Reply, Msg_Style_Request, Msg_Time, Msg_WrapMsg, sccsid, System_Default_Queue_Name, version
 
Fields inherited from interface com.ibm.mqe.MQeExceptionCodes
Except_Active, Except_AdapterException, Except_AdapterMissingRemoteAddress, Except_Admin_ActionNotSupported, Except_Admin_InvalidField, Except_Admin_NotAdminMsg, Except_AdminAction, Except_Authenticate, Except_BadRequest, Except_BridgeListener, Except_Chnl_Attributes, Except_Chnl_ID, Except_Chnl_Limit, Except_Chnl_Overrun, Except_Closed, Except_Con_AdapterRequired, Except_Con_AliasAlreadyExists, Except_Con_AlreadyExists, Except_Con_InvalidName, Except_Connect_Failure, Except_ConnectonType, Except_Cryptor, Except_Data, Except_Duplicate, Except_JmxProperties, Except_Listener, Except_MessageStore, Except_MiniCertReg_ActivateFailed, Except_MiniCertReg_BadPIN, Except_MiniCertReg_NotOpen, Except_NotActive, Except_NotAllowed, Except_NotFound, Except_NotSupported, Except_PrivateReg_ActivateFailed, Except_PrivateReg_BadPIN, Except_PrivateReg_NotOpen, Except_PublicReg_ActivateFailed, Except_PublicReg_InvalidAddress, Except_PublicReg_InvalidRequest, Except_Q_Full, Except_Q_InvalidName, Except_Q_InvalidPriority, Except_Q_MsgTooLarge, Except_Q_NoMatchingMsg, Except_Q_TargetRegistryRequired, Except_QMgr_Activated, Except_QMgr_AlreadyExists, Except_QMgr_InvalidQMgrName, Except_QMgr_InvalidQName, Except_QMgr_NotActive, Except_QMgr_NotBridgeEnabled, Except_QMgr_NotConfigured, Except_QMgr_QDoesNotExist, Except_QMgr_QExists, Except_QMgr_QNotEmpty, Except_QMgr_RegistryDataVersion, Except_QMgr_UnknownQMgr, Except_QMgr_WrongQType, Except_Reg_AddFailed, Except_Reg_AlreadyExists, Except_Reg_AlreadyOpen, Except_Reg_CRTKeyDecFailed, Except_Reg_CRTKeySignFailed, Except_Reg_DeleteFailed, Except_Reg_DeleteRegistryFailed, Except_Reg_DoesNotExist, Except_Reg_InvalidSession, Except_Reg_ListFailed, Except_Reg_NotDefined, Except_Reg_NotSecure, Except_Reg_NullName, Except_Reg_OpenFailed, Except_Reg_ReadFailed, Except_Reg_RenameFailed, Except_Reg_ResetPINFailed, Except_Reg_SearchFailed, Except_Reg_UpdateFailed, Except_RemoteException, Except_Rule, Except_S_BadIntegrity, Except_S_BadSubject, Except_S_CertificateExpired, Except_S_Cipher, Except_S_InvalidAttribute, Except_S_InvalidSignature, Except_S_MiniCertNotAvailable, Except_S_MissingSection, Except_S_NoPresetKeyAvailable, Except_S_RegistryNotAvailable, Except_Stopped, Except_Syntax, Except_TimeOut, Except_Transporter, Except_TriggerTransmission, Except_Trnsport_QMgr, Except_Trnsport_Request, Except_Type, Except_UdpipAdapterStateException, Except_UdpipAdapterTimeOut, Except_UdpipAdapterUnableToConfirmSuccess, Except_UnCoded, Except_Uncontactable_DontTransmit
 
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.MQeFields
contains, copy, copy, dataType, deepCopy, delete, dump, dumpedType, dumpToString, equals, fields, getArrayLength, getArrayOfByte, getArrayOfDoubleAsLong, getArrayOfFloatAsInt, getArrayOfInt, getArrayOfLong, getArrayOfShort, getAscii, getAsciiArray, getAttribute, getBoolean, getByte, getDoubleAsLong, getFields, getFieldsArray, getFloatAsInt, getInt, getIntArray, getLong, getLongArray, getObject, getShort, getShortArray, getUnicode, getUnicodeArray, includes, isEqualTo, putArrayLength, putArrayOfByte, putArrayOfDoubleAsLong, putArrayOfFloatAsInt, putArrayOfInt, putArrayOfLong, putArrayOfShort, putAscii, putAsciiArray, putBoolean, putByte, putByteArray, putDoubleAsLong, putFields, putFieldsArray, putFloatAsInt, putInt, putIntArray, putLong, putLongArray, putObject, putShort, putShortArray, putUnicode, putUnicodeArray, rename, restore, restoreFromString, restoreFromString, restoreFromString, setAttribute, updateValue
 
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

copyright

public static final java.lang.String copyright
Deprecated. 
See Also:
Constant Field Values

DEF_COMPLETION_CODE

public static final int DEF_COMPLETION_CODE
Deprecated. 
The default value used for the FIELD_NAME_COMPLETION_CODE field if it is not set in the message.

The default is RESULT_UNKNOWN.

See Also:
Constant Field Values

DEF_RETENTION

public static final boolean DEF_RETENTION
Deprecated. 
The default value used for the #RETENTION field if it is not set in the message.

The default is false.

See Also:
Constant Field Values

FIELD_NAME_MQ_MESSAGE_TYPE

public static final 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). 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.

See Also:
Constant Field Values

FIELD_NAME_MQ_PUT_DATE

public static final java.lang.String FIELD_NAME_MQ_PUT_DATE
Deprecated. 
The name of the optional ASCII String field which holds the put date.

If the field is not defined in the message, then a value of null is assumed.

See Also:
Constant Field Values

FIELD_NAME_MQ_PUT_TIME

public static final java.lang.String FIELD_NAME_MQ_PUT_TIME
Deprecated. 
The name of the optional ASCII String field which holds the put time.

If the field is not defined in the message, then a value of null is assumed.

See Also:
Constant Field Values

FIELD_NAME_MQ_STRUC_ID

public static final java.lang.String FIELD_NAME_MQ_STRUC_ID
Deprecated. 
The name of the optional 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.

See Also:
Constant Field Values

FIELD_NAME_MQ_VERSION

public static final java.lang.String FIELD_NAME_MQ_VERSION
Deprecated. 
The name of the optional 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.

See Also:
Constant Field Values

FIELD_NAME_MQ_CODED_CHARACTER_SET

public static final java.lang.String FIELD_NAME_MQ_CODED_CHARACTER_SET
Deprecated. 
The name of the optional 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.

See Also:
Constant Field Values

FIELD_NAME_COMPLETION_CODE

public static final java.lang.String FIELD_NAME_COMPLETION_CODE
Deprecated. 
The name of the optional 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.

See Also:
Constant Field Values

FIELD_NAME_RESPONSES

public static final java.lang.String FIELD_NAME_RESPONSES
Deprecated. 
The name of the optional 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.

See Also:
Constant Field Values

TYPE_OF_MSG

public static final java.lang.String TYPE_OF_MSG
Deprecated. 
The name of the optional integer field which holds the purpose of the message, i.e. one of: TYPE_MQE, TYPE_PUB, TYPE_SUB or TYPE_UNSUB.

See Also:
Constant Field Values

TOPIC

public static final java.lang.String TOPIC
Deprecated. 
The name of the optional ASCII String field which holds the message topic.

See Also:
Constant Field Values

MESSAGE

public static final java.lang.String MESSAGE
Deprecated. 
The name of the optional 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).

See Also:
Constant Field Values

RETAINED

public static final java.lang.String RETAINED
Deprecated. 
The name of the optional boolean field which holds the retained flag.

See Also:
Constant Field Values

TYPE_MQE

public static final 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.

See Also:
Constant Field Values

TYPE_PUB

public static final 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.

See Also:
Constant Field Values

TYPE_SUB

public static final 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.

See Also:
Constant Field Values

TYPE_UNSUB

public static final 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.

See Also:
Constant Field Values

MQ_Report

public static final 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.

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.

See Also:
Constant Field Values

MQ_Feedback

public static final java.lang.String MQ_Feedback
Deprecated. 
The name of an optional 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.

See Also:
Constant Field Values

MQ_Encoding

public static final java.lang.String MQ_Encoding
Deprecated. 
The name of an optional 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.

See Also:
Constant Field Values

MQ_Format

public static final 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.

The field is normally 8 characters long.

If this field is missing from the message, then a value of MQeMQMsgObject.DEF_FORMAT is assumed.

See Also:
Constant Field Values

MQ_Persistence

public static final 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.

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.

See Also:
Constant Field Values

MQ_BackoutCount

public static final 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.

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.

See Also:
Constant Field Values

MQ_UserId

public static final 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.

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.

See Also:
Constant Field Values

MQ_AccountingToken

public static final 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.

If this field is missing, then a value of MQeMQMsgObject.DEF_ACCOUNTING_TOKEN is assumed.

See Also:
Constant Field Values

MQ_ApplicationIdData

public static final java.lang.String MQ_ApplicationIdData
Deprecated. 
The name of an optional 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.

See Also:
Constant Field Values

MQ_PutApplicationType

public static final java.lang.String MQ_PutApplicationType
Deprecated. 
The name of an optional 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.

See Also:
Constant Field Values

MQ_PutApplicationName

public static final 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.

If this field is missing from the message, then a value of MQeMQMsgObject.DEF_PUT_APPLICATION_NAME is assumed.

See Also:
Constant Field Values

MQ_ApplicationOriginData

public static final 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.

If this field is missing from the message, then a default value of MQeMQMsgObject.DEF_APPLICATION_ORIGIN_DATA is assumed.

See Also:
Constant Field Values

MQ_Data

public static final java.lang.String MQ_Data
Deprecated. 
The name of the optional byte array field which holds the message payload.

If this field is not in the message, then a zero-length byte array is assumed.

See Also:
Constant Field Values

MQ_GroupId

public static final 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.

If this field is missing from the message, then a value of MQeMQMsgObject.DEF_GROUP_ID is assumed.

See Also:
Constant Field Values

MQ_MessageSequenceNumber

public static final 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.

If this field is missing from the message, then a default value of MQeMQMsgObject.DEF_SEQUENCE_NUMBER is assumed.

See Also:
Constant Field Values

MQ_Offset

public static final 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.

If this field is missing from the message, then a default value of MQeMQMsgObject.DEF_OFFSET is assumed.

See Also:
Constant Field Values

MQ_MessageFlags

public static final java.lang.String MQ_MessageFlags
Deprecated. 
The name of the optional 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.

See Also:
Constant Field Values

MQ_OriginalLength

public static final java.lang.String MQ_OriginalLength
Deprecated. 
The name of the optional 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.

See Also:
Constant Field Values

MQ_DestQueueName

public static final java.lang.String MQ_DestQueueName
Deprecated. 
The name of the optional ASCII String field which holds the destination queue name associated with a subscription.

See Also:
Constant Field Values

MQ_DestQueueMgr

public static final 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.

See Also:
Constant Field Values

MQ_StrucId

public static final java.lang.String MQ_StrucId
Deprecated. 
The name of the optional ASCII String field which holds the WMQ RFH2 structure id. This value is ignored by MQeMbTransformer.

See Also:
Constant Field Values

MQ_Version

public static final java.lang.String MQ_Version
Deprecated. 
The name of the optional integer field which holds the WMQ RFH2 version number. This value is ignored by MQeMbTransformer.

See Also:
Constant Field Values

MQ_PutDate

public static final 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. The value is held in the format resulting from the method call java.text.SimpleDateFormat("d/MM/yy").

See Also:
Constant Field Values

MQ_PutTime

public static final 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. The value is held in the format resulting from the method call java.text.SimpleDateFormat("K:mm a").

See Also:
Constant Field Values

MQ_MessageType

public static final java.lang.String MQ_MessageType
Deprecated. 
The name of the optional 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.

See Also:
Constant Field Values

MQ_CodedCharacterSet

public static final 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.

If this field is missing from the message, then a value of MQePubSubMsgObject.DEF_CHARACTER_SET is assumed.

See Also:
Constant Field Values
Constructor Detail

MQeMbMsgObject

public MQeMbMsgObject()
               throws java.lang.Exception
Deprecated. 
Creates an MQeMbMsgObject. The message has, by default, the field TYPE_OF_MSGTYPE_MQE.

Throws:
java.lang.Exception.
java.lang.Exception

MQeMbMsgObject

public MQeMbMsgObject(MQePubSubMsgObject pubSubMsg)
               throws java.lang.Exception
Deprecated. 
Creates an equivalent MQeMbMsgObject from a supplied MQePubSubMsgObject. This constructor is provided primarily for the use by the bridge transformer class MQeMbTransformer.

Parameters:
pubSubMsg - The message to be used as the data source.
Throws:
java.lang.Exception.
java.lang.Exception
Method Detail

dumpAllToString

public java.lang.String dumpAllToString()
Deprecated. 
Dump all the fields in the message object into a String.

Returns:
A readable String representation of the data content.

dumpToString

public java.lang.String dumpToString()
Deprecated. 

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.

Returns:
A String containing the field names and values and the data value.

getAccountingToken

public byte[] getAccountingToken()
                          throws java.lang.Exception
Deprecated. 
Gets the value of accounting token - this corresponds to a field in the WMQ standard message header.

Returns:
The accounting token if present, otherwise the value MQeMQMsgObject.DEF_ACCOUNTING_TOKEN.
Throws:
java.lang.Exception.
java.lang.Exception

getApplicationIdData

public java.lang.String getApplicationIdData()
                                      throws java.lang.Exception
Deprecated. 
Gets the value of application id data - this corresponds to a field in the WMQ standard message header.

Returns:
The application id data if present, otherwise the value MQeMQMsgObject.DEF_APPLICATION_ID_DATA.
Throws:
java.lang.Exception.
java.lang.Exception

getApplicationOriginData

public java.lang.String getApplicationOriginData()
                                          throws java.lang.Exception
Deprecated. 
Gets the value of the application origin data - this corresponds to a field in the WMQ standard message header.

Returns:
The application origin data if present, otherwise the value MQeMQMsgObject.DEF_APPLICATION_ORIGIN_DATA.
Throws:
java.lang.Exception.
java.lang.Exception

getBackoutCount

public java.lang.Integer getBackoutCount()
                                  throws java.lang.Exception
Deprecated. 
Gets the value of the backout count - this corresponds to a field in the WMQ standard message header.

Returns:
The backout count if present, otherwise the value new Integer(MQeMQMsgObject.DEF_BACKOUT_COUNT).
Throws:
java.lang.Exception.
java.lang.Exception

getCodedCharacterSetId

public java.lang.Integer getCodedCharacterSetId()
                                         throws java.lang.Exception
Deprecated. 
Gets the value of the character set id - this corresponds to a field in the WMQ standard message header.

Returns:
The character set id if present, otherwise the value new Integer(DEF_CHARACTER_SET).
Throws:
java.lang.Exception.
java.lang.Exception

getCorrelationId

public byte[] getCorrelationId()
                        throws java.lang.Exception
Deprecated. 
Gets the value of the correlation id - this corresponds to a field in the WMQ standard message header.

Returns:
The correlation id if present, otherwise the value MQeMQMsgObject.DEF_CORRELATION_ID.
Throws:
java.lang.Exception.
java.lang.Exception

getData

public byte[] getData()
               throws java.lang.Exception
Deprecated. 
Gets the user data - this corresponds to the payload of a WMQ message.

Returns:
The user data if present, otherwise a zero length byte array.
Throws:
java.lang.Exception.
java.lang.Exception

getDestQueueMgr

public java.lang.String getDestQueueMgr()
                                 throws java.lang.Exception
Deprecated. 
Gets the destination queue manager name for subscriptions.

Returns:
The destination queue manager name if present, otherwise null.
Throws:
java.lang.Exception.
java.lang.Exception

getDestQueueName

public java.lang.String getDestQueueName()
                                  throws java.lang.Exception
Deprecated. 
Gets the destination queue name for subscriptions.

Returns:
The destination queue name if present, otherwise null.
Throws:
java.lang.Exception.
java.lang.Exception

getEncoding

public java.lang.Integer getEncoding()
                              throws java.lang.Exception
Deprecated. 
Gets the value of the encoding - this corresponds to a field in the WMQ standard message header.

Returns:
The WMQ encoding if present, otherwise the value new Integer(MQeMQMsgObject.DEF_ENCODING).
Throws:
java.lang.Exception.
java.lang.Exception

getExpiry

public java.lang.Integer getExpiry()
                            throws java.lang.Exception
Deprecated. 
Gets the value of the expiry time - this corresponds to a field in the WMQ standard message header.

Returns:
The expiry time (as an WMQ value) if present, otherwise the valuenew Integer(MQeMQMsgObject.DEF_EXPIRY).
Throws:
java.lang.Exception.
java.lang.Exception

getFeedback

public java.lang.Integer getFeedback()
                              throws java.lang.Exception
Deprecated. 
Gets the value of the feedback - this corresponds to a field in the WMQ standard message header.

Returns:
The WMQ feedback if present, otherwise the value new Integer(MQeMQMsgObject.DEF_FEEDBACK).
Throws:
java.lang.Exception.
java.lang.Exception

getFormat

public java.lang.String getFormat()
                           throws java.lang.Exception
Deprecated. 
Gets the value of the format - this corresponds to a field in the WMQ standard message header.

Returns:
The WMQ format if present, otherwise the value MQeMQMsgObject.DEF_FORMAT.
Throws:
java.lang.Exception.
java.lang.Exception

getGroupId

public byte[] getGroupId()
                  throws java.lang.Exception
Deprecated. 
Gets the value of the group id - this corresponds to a field in the WMQ standard message header.

Returns:
The group id if present, otherwise the value MQeMQMsgObject.DEF_GROUP_ID.
Throws:
java.lang.Exception.
java.lang.Exception

getMessageFlags

public java.lang.Integer getMessageFlags()
                                  throws java.lang.Exception
Deprecated. 
Gets the value of the message flags - this corresponds to a field in the WMQ standard message header.

Returns:
The message flags if present, otherwise the value new Integer(MQeMQMsgObject.DEF_MESSAGE_FLAGS).
Throws:
java.lang.Exception.
java.lang.Exception

getMessageId

public byte[] getMessageId()
                    throws java.lang.Exception
Deprecated. 
Gets the value of the message id - this corresponds to a field in the WMQ standard message header.

Returns:
The message id if present, otherwise the value MQeMQMsgObject.DEF_MESSAGE_ID.
Throws:
java.lang.Exception.
java.lang.Exception

getMessageSequenceNumber

public java.lang.Integer getMessageSequenceNumber()
                                           throws java.lang.Exception
Deprecated. 
Gets the value of the sequence number - this corresponds to a field in the WMQ standard message header.

Returns:
The sequence number if present, otherwise the value new Integer(MQeMQMsgObject.DEF_SEQUENCE_NUMBER).
Throws:
java.lang.Exception.
java.lang.Exception

getMessageType

public java.lang.Integer getMessageType()
                                 throws java.lang.Exception
Deprecated. 
Gets the message type (i.e datagram, reply, request, report) - this corresponds to a field in the WMQ standard message header.

Returns:
The WMQ message type.
Throws:
java.lang.Exception.
java.lang.Exception

getOffset

public java.lang.Integer getOffset()
                            throws java.lang.Exception
Deprecated. 
Gets the value of the offset - this corresponds to a field in the WMQ standard message header.

Returns:
The offset if present, otherwise the value new Integer(MQeMQMsgObject.DEF_OFFSET).
Throws:
java.lang.Exception.
java.lang.Exception

getOriginalLength

public java.lang.Integer getOriginalLength()
                                    throws java.lang.Exception
Deprecated. 
Gets the value of the original length - this corresponds to a field in the WMQ standard message header.

Returns:
The original length if present, otherwise the value new Integer(MQeMQMsgObject.DEF_ORIGINAL_LENGTH).
Throws:
java.lang.Exception.
java.lang.Exception

getPersistence

public java.lang.Integer getPersistence()
                                 throws java.lang.Exception
Deprecated. 
Gets the value of the persistence - this corresponds to a field in the WMQ standard message header.

Returns:
The persistence if present, otherwise the value new Integer(MQeMQMsgObject.DEF_PERSISTENCE).
Throws:
java.lang.Exception.
java.lang.Exception

getPriority

public java.lang.Integer getPriority()
                              throws java.lang.Exception
Deprecated. 
Gets the message priority - this corresponds to a field in the WMQ standard message header.

Returns:
The message priority if present, otherwise the value new Integer(MQeMQMsgObject.DEF_PRIORITY).
Throws:
java.lang.Exception.
java.lang.Exception

getPutApplicationName

public java.lang.String getPutApplicationName()
                                       throws java.lang.Exception
Deprecated. 
Gets the put application name - this corresponds to a field in the WMQ standard message header.

Returns:
The put application name if present, otherwise the value MQeMQMsgObject.DEF_PUT_APPLICATION_NAME.
Throws:
java.lang.Exception.
java.lang.Exception

getPutApplicationType

public java.lang.Integer getPutApplicationType()
                                        throws java.lang.Exception
Deprecated. 
Gets the put application type - this corresponds to a field in the WMQ standard message header.

Returns:
The put application type if present, otherwise the value new Integer(MQeMQMsgObject.DEF_PUT_APPLICATION_TYPE).
Throws:
java.lang.Exception.
java.lang.Exception

getPutDate

public java.lang.String getPutDate()
                            throws java.lang.Exception
Deprecated. 
Gets the value of the put date - this corresponds to a field in the WMQ standard message header.

Returns:
The put date if present, otherwise null.
Throws:
java.lang.Exception.
java.lang.Exception

getPutTime

public java.lang.String getPutTime()
                            throws java.lang.Exception
Deprecated. 
Gets the value of the put time - this corresponds to a field in the WMQ standard message header.

Returns:
The put time if present, otherwise null.
Throws:
java.lang.Exception.
java.lang.Exception

getReplyToQueueManagerName

public java.lang.String getReplyToQueueManagerName()
                                            throws java.lang.Exception
Deprecated. 
Gets the reply-to queue manager name - this corresponds to a field in the WMQ standard message header.

Returns:
The reply-to queue manager name if present, otherwise the value MQeMQMsgObject.DEF_REPLY_TO_QUEUE_MANAGER_NAME.
Throws:
java.lang.Exception.
java.lang.Exception

getReplyToQueueName

public java.lang.String getReplyToQueueName()
                                     throws java.lang.Exception
Deprecated. 
Gets the reply-to queue name - this corresponds to a field in the WMQ standard message header.

Returns:
The reply-to queue name if present, otherwise the value MQeMQMsgObject.DEF_REPLY_TO_QUEUE_NAME.
Throws:
java.lang.Exception.
java.lang.Exception

getReport

public java.lang.Integer getReport()
                            throws java.lang.Exception
Deprecated. 
Gets the report value - this corresponds to a field in the WMQ standard message header.

Returns:
The report value if present, otherwise the value new Integer(MQeMQMsgObject.DEF_REPORT).
Throws:
java.lang.Exception.
java.lang.Exception

getStrucId

public java.lang.String getStrucId()
                            throws java.lang.Exception
Deprecated. 
Gets the value of the structure id - this corresponds to a field in the WMQ RFH2 message header. Note that the MQeMbTransformer does not set this value.

Returns:
The structure id if present, otherwise the value DEF_STRUC_ID.
Throws:
java.lang.Exception.
java.lang.Exception

getUserId

public java.lang.String getUserId()
                           throws java.lang.Exception
Deprecated. 
Gets the value of the user id - this corresponds to a field in the WMQ standard message header.

Returns:
The user id if present, otherwise the value MQeMQMsgObject.DEF_USER_ID.
Throws:
java.lang.Exception.
java.lang.Exception

getVersion

public java.lang.Integer getVersion()
                             throws java.lang.Exception
Deprecated. 
Gets the version number - this corresponds to a field in the WMQ RFH2 message header. Note that the MQeMbTransformer does not set this value.

Returns:
The version number if present, otherwise the value new Integer(DEF_VERSION).
Throws:
java.lang.Exception.
java.lang.Exception

setAccountingToken

public void setAccountingToken(byte[] accountingToken)
                        throws java.lang.Exception
Deprecated. 
Sets the value of the accounting token - this corresponds to a field in the WMQ standard message header.

Parameters:
accountingToken - The accounting token. If not set, the accounting token defaults to MQeMQMsgObject.DEF_ACCOUNTING_TOKEN.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setApplicationIdData

public void setApplicationIdData(java.lang.String applicationIdData)
                          throws java.lang.Exception
Deprecated. 
Sets the value of the application id data - this corresponds to a field in the WMQ standard message header.

Parameters:
applicationIdData - The application id data.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setApplicationOriginData

public void setApplicationOriginData(java.lang.String applicationOriginData)
                              throws java.lang.Exception
Deprecated. 
Sets the value of the application origin data - this corresponds to a field in the WMQ standard message header.

Parameters:
applicationOriginData - The application origin data.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setBackoutCount

public void setBackoutCount(int backoutCount)
                     throws java.lang.Exception
Deprecated. 
Sets the value of the backount count - this corresponds to a field in the WMQ standard message header.

Parameters:
backoutCount - The backout count.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setCodedCharacterSetId

public void setCodedCharacterSetId(int characterSetId)
                            throws java.lang.Exception
Deprecated. 
Sets the value if the character set id - this corresponds to a field in the WMQ standard message header.

Parameters:
characterSetId - The character set id.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setCorrelationId

public void setCorrelationId(byte[] correlationId)
                      throws java.lang.Exception
Deprecated. 
Sets the value of the correlation id - this corresponds to a field in the WMQ standard message header.

Parameters:
correlationId - The correlation id. If not set, the correlation id defaults to MQeMQMsgObject.DEF_CORRELATION_ID.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setData

public void setData(byte[] data)
             throws java.lang.Exception
Deprecated. 
Sets the user data - this corresponds to the payload of the WMQ message.

Parameters:
data - The user data.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setDestQueueMgr

public void setDestQueueMgr(java.lang.String destQueueMgr)
                     throws java.lang.Exception
Deprecated. 
Sets the destination queue manager name - this corresponds to a field in the WMQ standard message header.

Parameters:
destQueueMgr - The destination queue manager name; null values are ignored.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setDestQueueName

public void setDestQueueName(java.lang.String destQueueName)
                      throws java.lang.Exception
Deprecated. 
Sets the destination queue name - this corresponds to a field in the WMQ standard message header.

Parameters:
destQueueName - The destination queue name; null values are ignored.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setEncoding

public void setEncoding(int encoding)
                 throws java.lang.Exception
Deprecated. 
Sets the encoding value - this corresponds to a field in the WMQ standard message header.

Parameters:
encoding - The encoding value.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setExpiry

public void setExpiry(int expiry)
               throws java.lang.Exception
Deprecated. 

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.

Parameters:
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).
Returns:
void
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setFeedback

public void setFeedback(int feedback)
                 throws java.lang.Exception
Deprecated. 
Sets the value of feedback - this corresponds to a field in the WMQ standard message header.

Parameters:
feedback - The WMQ feedback.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setFormat

public void setFormat(java.lang.String format)
               throws java.lang.Exception
Deprecated. 
Sets the value of the format - this corresponds to a field in the WMQ standard message header.

Parameters:
format - The WMQ format.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setGroupId

public void setGroupId(byte[] groupId)
                throws java.lang.Exception
Deprecated. 
Sets the value of the group id - this corresponds to a field in the WMQ standard message header.

Parameters:
groupId - The group id.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setMessageFlags

public void setMessageFlags(int flags)
                     throws java.lang.Exception
Deprecated. 
Sets the value of the message flags - this corresponds to a field in the WMQ standard message header.

Parameters:
flags - The message flags.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setMessageId

public void setMessageId(byte[] messageId)
                  throws java.lang.Exception
Deprecated. 
Sets the value of the message id - this corresponds to a field in the WMQ standard message header.

Parameters:
messageId - The message id. If not set, the message id defaults to MQeMQMsgObject.DEF_MESSAGE_ID.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setMessageSequenceNumber

public void setMessageSequenceNumber(int seqNo)
                              throws java.lang.Exception
Deprecated. 
Sets the value of the message sequence number - this corresponds to a field in the WMQ standard message header.

Parameters:
seqNo - The message sequence number.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setMessageType

public void setMessageType(int messageType)
                    throws java.lang.Exception
Deprecated. 
Sets the message type(i.e. datagram, reply, request, report) - this corresponds to a field in the WMQ standard message header.

Parameters:
messageType - The WMQ message type.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setOffset

public void setOffset(int offset)
               throws java.lang.Exception
Deprecated. 
Sets the value of the offset - this corresponds to a field in the WMQ standard message header.

Parameters:
offset - The offset.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setOriginalLength

public void setOriginalLength(int len)
                       throws java.lang.Exception
Deprecated. 
Sets the value of the original length - this corresponds to a field in the WMQ standard message header.

Parameters:
len - The original length.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setPersistence

public void setPersistence(int persistence)
                    throws java.lang.Exception
Deprecated. 
Sets the value of persistence - this corresponds to a field in the WMQ standard message header.

Parameters:
persistence - The persistence.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setPriority

public void setPriority(int priority)
                 throws java.lang.Exception
Deprecated. 
Sets the message priority - this corresponds to a field in the WMQ standard message header.

Parameters:
priority - The message priority, an int between the values 0 and 9.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setPutApplicationName

public void setPutApplicationName(java.lang.String putApplicationName)
                           throws java.lang.Exception
Deprecated. 
Sets the put application name - this corresponds to a field in the WMQ standard message header.

Parameters:
putApplicationName - The put application name.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setPutApplicationType

public void setPutApplicationType(int putApplicationType)
                           throws java.lang.Exception
Deprecated. 
Sets the put application type - this corresponds to a field in the WMQ standard message header.

Parameters:
putApplicationType - The put application type.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setPutDate

public void setPutDate(java.util.GregorianCalendar calendar)
                throws java.lang.Exception
Deprecated. 
Sets the put date - this corresponds to a field in the WMQ standard message header.

Parameters:
calendar - The put date.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setPutTime

public void setPutTime(java.util.GregorianCalendar calendar)
                throws java.lang.Exception
Deprecated. 
Sets the put time - this corresponds to a field in the WMQ standard message header.

Parameters:
calendar - The put time.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setReplyToQueueManagerName

public void setReplyToQueueManagerName(java.lang.String replyToQMName)
                                throws java.lang.Exception
Deprecated. 
Sets the reply-to queue manager name - this corresponds to a field in the WMQ standard message header.

Parameters:
replyToQMName - The reply-to queue manager name.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setReplyToQueueName

public void setReplyToQueueName(java.lang.String replyToQueueName)
                         throws java.lang.Exception
Deprecated. 
Sets the reply-to queue name - this corresponds to a field in the WMQ standard message header.

Parameters:
replyToQueueName - The reply-to queue name.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setReport

public void setReport(int report)
               throws java.lang.Exception
Deprecated. 
Sets the report value - this corresponds to a field in the WMQ standard message header.

Parameters:
report - The report value.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setStrucId

public void setStrucId(java.lang.String strucId)
                throws java.lang.Exception
Deprecated. 
Sets the structure id - this corresponds to a field in the WMQ RFH2 message header. Although this value is set in the message, any such setting is ignored by the MQeMbTransformer.

Parameters:
strucId - The structure id.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setUserId

public void setUserId(java.lang.String userId)
               throws java.lang.Exception
Deprecated. 
Sets the value of the user id - this corresponds to a field in the WMQ standard message header.

Parameters:
userId - The user id.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

setVersion

public void setVersion(int version)
                throws java.lang.Exception
Deprecated. 
Sets the version number - this corresponds to a field in the WMQ RFH2 message header. Although this value is set in the message, any such setting is ignored by the MQeMbTransformer.

Parameters:
version - The version number.
Throws:
java.lang.Exception - if there is an error setting the value in the message object.

toMQePubSubMsgObject

public MQePubSubMsgObject toMQePubSubMsgObject()
Deprecated. 
Returns an MQePubSubMsgObject message of equivalent content.

Returns:
An MQePubSubMsgObject message of equivalent content. In the event of errors, an attempt is made to return the maximum information content.

Websphere MQ Everyplace