com.ibm.mq

Class MQMessage

  1. java.lang.Object
  2. extended bycom.ibm.mq.jmqi.JmqiObject
  3. extended bycom.ibm.mq.MQMD
  4. extended bycom.ibm.mq.MQMessage
All implemented interfaces:
java.io.DataInput, java.io.DataOutput
  1. public class MQMessage
  2. extends MQMD
  3. implements java.io.DataInput, java.io.DataOutput
MQMessage represents both the message descriptor and the data for a WebSphere MQ message. It has a group of methods for reading data from a message and a group of methods for writing data into a message. The format of numbers and strings used by these read and write methods is controlled by the encodingand characterSet fields. The remaining fields contain control information that accompanies the application message data when a message travels between sending and receiving applications.

Field Summary

Fields inherited from class com.ibm.mq.MQMD
accountingToken, applicationIdData, applicationOriginData, backoutCount, characterSet, correlationId, encoding, expiry, feedback, format, groupId, messageFlags, messageId, messageSequenceNumber, messageType, offset, originalLength, persistence, priority, putApplicationName, putApplicationType, putDateTime, replyToQueueManagerName, replyToQueueName, report, userId
Fields inherited from class com.ibm.mq.jmqi.JmqiObject
COMP_JM, COMP_JN, COMP_JO

Constructor Summary

Constructor and Description
MQMessage()
The default constructor.

Method Summary

Modifier and Type Method and Description
  1. void
 clearMessage()
Discards any data in the message buffer and sets the cursor position to zero.
  1. void
 deleteProperty(java.lang.String nameP)
Deletes a property with the specified name from the message.
  1. boolean
 getBooleanProperty(java.lang.String name)
Returns the value of the boolean property with the specified name.
  1. boolean
 getBooleanProperty(java.lang.String name,MQPropertyDescriptor descriptor)
Returns the value of the boolean property with the specified name, filling in the specified property descriptor.
  1. byte
 getByteProperty(java.lang.String name)
Returns the value of the byte property with the specified name.
  1. byte
 getByteProperty(java.lang.String name,MQPropertyDescriptor descriptor)
Returns the value of the byte property with the specified name, filling in the specified property descriptor.
  1. byte[]
 getBytesProperty(java.lang.String name)
Returns the value of the byte array property with the specified name.
  1. byte[]
 getBytesProperty(java.lang.String name,MQPropertyDescriptor descriptor)
Returns the value of the byte array property with the specified name, filling in the specified property descriptor.
  1. int
 getDataLength()
Gets the number of bytes of message data remaining to be read.
  1. int
 getDataOffset()
Returns the current cursor position within the message data (the point at which read and write operations take effect).
  1. double
 getDoubleProperty(java.lang.String name)
Returns the value of the double property with the specified name.
  1. double
 getDoubleProperty(java.lang.String name,MQPropertyDescriptor descriptor)
Returns the value of the double property with the specified name, filling in the specified property descriptor.
  1. float
 getFloatProperty(java.lang.String name)
Returns the value of the float property with the specified name.
  1. float
 getFloatProperty(java.lang.String name,MQPropertyDescriptor descriptor)
Returns the value of the float property with the specified name, filling in the specified property descriptor.
  1. short
 getInt2Property(java.lang.String name)
Synonym for getShortProperty(String), provided for cross-language WebSphere MQ API compatibility.
  1. short
 getInt2Property(java.lang.String name,MQPropertyDescriptor descriptor)
Synonym for getShortProperty(String, MQPropertyDescriptor), provided for cross-language WebSphere MQ API compatibility.
  1. int
 getInt4Property(java.lang.String name)
Synonym for getIntProperty(String), provided for cross-language WebSphere MQ API compatibility.
  1. int
 getInt4Property(java.lang.String name,MQPropertyDescriptor descriptor)
Synonym for getIntProperty(String, MQPropertyDescriptor), provided for cross-language WebSphere MQ API compatibility.
  1. long
 getInt8Property(java.lang.String name)
Synonym for getLongProperty(String), provided for cross-language WebSphere MQ API compatibility.
  1. long
 getInt8Property(java.lang.String name,MQPropertyDescriptor descriptor)
Synonym for getLongProperty(String, MQPropertyDescriptor), provided for cross-language WebSphere MQ API compatibility.
  1. int
 getIntProperty(java.lang.String name)
Returns the value of the int property with the specified name.
  1. int
 getIntProperty(java.lang.String name,MQPropertyDescriptor descriptor)
Returns the value of the int property with the specified name, filling in the specified property descriptor.
  1. long
 getLongProperty(java.lang.String name)
Returns the value of the long property with the specified name.
  1. long
 getLongProperty(java.lang.String name,MQPropertyDescriptor descriptor)
Returns the value of the long property with the specified name, filling in the specified property descriptor.
  1. int
 getMessageLength()
Gets the number of bytes of message data in this message.
  1. java.lang.Object
 getObjectProperty(java.lang.String name)
Returns the value of the Java object property with the specified name.
  1. java.lang.Object
 getObjectProperty(java.lang.String name,MQPropertyDescriptor descriptor)
Returns the value of the Java object property with the specified name, filling in the specified property descriptor.
  1. java.util.Enumeration<java.lang.String>
 getPropertyNames(java.lang.String nameP)
Returns an Enumeration of all the property names matching the specified name.
  1. int
 getPropertyValidation()
Specifies whether validation of properties should take place when a property of the message is set.
  1. short
 getShortProperty(java.lang.String name)
Returns the value of the short property with the specified name.
  1. short
 getShortProperty(java.lang.String name,MQPropertyDescriptor descriptor)
Returns the value of the short property with the specified name, filling in the specified property descriptor.
  1. java.lang.String
 getStringProperty(java.lang.String name)
Returns the value of the String property with the specified name.
  1. java.lang.String
 getStringProperty(java.lang.String name,MQPropertyDescriptor descriptor)
Returns the value of the String property with the specified name, filling in the specified property descriptor.
  1. int
 getTotalMessageLength()
Gets the total number of bytes in the message as stored on the message queue on which this message was held.
  1. boolean
 readBoolean()
Reads a boolean from the current position in the message buffer.
  1. byte
 readByte()
Reads a byte from the current position in the message buffer.
  1. char
 readChar()
Reads a character from the current position in the message buffer.
  1. short
 readDecimal2()
Reads a 2-byte packed decimal number in the range -999 to 999.
  1. int
 readDecimal4()
Reads a 4-byte packed decimal number in the range -9,999,999 to 9,999,999.
  1. long
 readDecimal8()
Reads an 8-byte packed decimal number in the range -999,999,999,999,999 to 999,999,999,999,999.
  1. double
 readDouble()
Reads a double from the current position in the message buffer.
  1. float
 readFloat()
Reads a float from the current position in the message buffer.
  1. void
 readFully(byte[] b)
Fills a byte array with data from the message buffer.
  1. void
 readFully(byte[] b,int off,int len)
Partly fills a byte array with data from the message buffer.
  1. int
 readInt()
Reads an integer from the current position in the message buffer.
  1. short
 readInt2()
Identical to readShort().
  1. int
 readInt4()
Synonym for readInt(), provided for cross-language WMQ API compatibility.
  1. long
 readInt8()
Identical to readLong().
  1. java.lang.String
 readLine()
Reads a line of text from the message.
  1. long
 readLong()
Reads an integer from the current position in the message buffer.
  1. java.lang.Object
 readObject()
Reads an object carried in the message.
  1. short
 readShort()
Reads a short from the current position in the message buffer.
  1. java.lang.String
 readString(int length)
Deprecated. use readStringOfCharLength(int)method instead.
  1. java.lang.String
 readStringOfByteLength(int numberOfBytes)
Reads a specified number of bytes and uses them to construct a new string using the character set specified by characterSet.
  1. java.lang.String
 readStringOfCharLength(int numberOfChars)
Reads a string in the codeset identified by characterSetand converts it into Unicode.
  1. int
 readUInt2()
Identical to readUnsignedShort(), provided for cross-language WMQ API compatibility.
  1. int
 readUnsignedByte()
Reads an unsigned byte from the current position in the message buffer.
  1. int
 readUnsignedShort()
Reads an unsigned short from the current position in the message buffer.
  1. java.lang.String
 readUTF()
Reads a UTF format String from the current position in the message buffer.
  1. void
 resizeBuffer(int size)
Indicates to the MQMessage class the size of buffer that might be required.
  1. void
 seek(int seekOffset)
Moves the cursor to a new absolute position in the message buffer.
  1. void
 setBooleanProperty(java.lang.String name,boolean value)
Sets a boolean property value with the specified name into the message, with the default property descriptor.
  1. void
 setBooleanProperty(java.lang.String name,MQPropertyDescriptor descriptor,boolean value)
Sets a boolean property value with the specified name into the message, with the specified property descriptor.
  1. void
 setByteProperty(java.lang.String name,byte value)
Sets a byte property value with the specified name into the message, with the default property descriptor.
  1. void
 setByteProperty(java.lang.String name,MQPropertyDescriptor descriptor,byte value)
Sets a byte property value with the specified name into the message, with the specified property descriptor.
  1. void
 setBytesProperty(java.lang.String name,byte[] value)
Sets a byte array property value with the specified name into the message, with the default property descriptor.
  1. void
 setBytesProperty(java.lang.String name,MQPropertyDescriptor descriptor,byte[] value)
Sets a byte array property value with the specified name into the message, with the specified property descriptor.
  1. void
 setDataOffset(int offset)
Moves the cursor to a new absolute position in the message buffer.
  1. void
 setDoubleProperty(java.lang.String name,double value)
Sets a double property value with the specified name into the message, with the default property descriptor.
  1. void
 setDoubleProperty(java.lang.String name,MQPropertyDescriptor descriptor,double value)
Sets a double property value with the specified name into the message, with the specified property descriptor.
  1. void
 setFloatProperty(java.lang.String name,float value)
Sets a float property value with the specified name into the message, with the default property descriptor.
  1. void
 setFloatProperty(java.lang.String name,MQPropertyDescriptor descriptor,float value)
Sets a float property value with the specified name into the message, with the specified property descriptor.
  1. void
 setInt2Property(java.lang.String name,MQPropertyDescriptor descriptor,short value)
Synonym for setShortProperty(String, MQPropertyDescriptor, short), provided for cross-language WebSphere MQ API compatibility.
  1. void
 setInt2Property(java.lang.String name,short value)
Synonym for setShortProperty(String, short), provided for cross-language WebSphere MQ API compatibility.
  1. void
 setInt4Property(java.lang.String name,int value)
Synonym for setIntProperty(String, int), provided for cross-language WebSphere MQ API compatibility.
  1. void
 setInt4Property(java.lang.String name,MQPropertyDescriptor descriptor,int value)
Synonym for setIntProperty(String, MQPropertyDescriptor, int), provided for cross-language WebSphere MQ API compatibility.
  1. void
 setInt8Property(java.lang.String name,long value)
Synonym for setLongProperty(String, long), provided for cross-language WebSphere MQ API compatibility.
  1. void
 setInt8Property(java.lang.String name,MQPropertyDescriptor descriptor,long value)
Synonym for setLongProperty(String, MQPropertyDescriptor, long), provided for cross-language WebSphere MQ API compatibility.
  1. void
 setIntProperty(java.lang.String name,int value)
Sets a int property value with the specified name into the message, with the default property descriptor.
  1. void
 setIntProperty(java.lang.String name,MQPropertyDescriptor descriptor,int value)
Sets a int property value with the specified name into the message, with the specified property descriptor.
  1. void
 setLongProperty(java.lang.String name,long value)
Sets a long property value with the specified name into the message, with the default property descriptor.
  1. void
 setLongProperty(java.lang.String name,MQPropertyDescriptor descriptor,long value)
Sets a long property value with the specified name into the message, with the specified property descriptor.
  1. void
 setObjectProperty(java.lang.String name,MQPropertyDescriptor descriptor,java.lang.Object value)
Sets a Java object property value with the specified name into the message, with the specified property descriptor.
  1. void
 setObjectProperty(java.lang.String name,java.lang.Object value)
Sets a Java object property value with the specified name into the message, with the default property descriptor.
  1. void
 setPropertyValidation(int propertyValidation)
Specifies whether validation of properties should take place when a property of the message is set.
  1. void
 setShortProperty(java.lang.String name,MQPropertyDescriptor descriptor,short value)
Sets a short property value with the specified name into the message, with the specified property descriptor.
  1. void
 setShortProperty(java.lang.String name,short value)
Sets a short property value with the specified name into the message, with the default property descriptor.
  1. void
 setStringProperty(java.lang.String name,MQPropertyDescriptor descriptor,java.lang.String value)
Sets a String property value with the specified name into the message, with the specified property descriptor.
  1. void
 setStringProperty(java.lang.String name,java.lang.String value)
Sets a String property value with the specified name into the message, with the default property descriptor.
  1. int
 skipBytes(int n)
Moves the cursor forward in the message buffer.
  1. void
 write(byte[] b)
Writes an array of bytes into the message buffer at the current position.
  1. void
 write(byte[] b,int off,int len)
Writes a series of bytes into the message buffer at the current position.
  1. void
 write(int b)
Writes a byte into the message buffer at the current position.
  1. void
 writeBoolean(boolean v)
Writes a boolean into the message buffer at the current position.
  1. void
 writeByte(int v)
Writes a byte into the message buffer at the current position.
  1. void
 writeBytes(java.lang.String s)
Deprecated. This implements the DataOutput.writeBytes(String) method which is not a general string writing routine - it writes the low-order bytes from the characters in the String to the Message, discarding the high-order bytes. (In MQ, it is hard to see where behaviour would be desirable, but it is mandatory as MQMessage implements the DataOutput interface.)
No data conversion is performed by this method. If you wish to write a string to the message with appropriate handling of the character set currently in force, use writeString(String) instead of this method.
  1. void
 writeChar(int v)
Writes a Unicode character into the message buffer at the current position.
  1. void
 writeChars(java.lang.String s)
Writes a String as a sequence of Unicode characters into the message buffer at the current position.
  1. void
 writeDecimal2(short v)
Writes a 2-byte packed decimal format number into the message buffer at the current position.
  1. void
 writeDecimal4(int v)
Writes a 4-byte packed decimal format number into the message buffer at the current position.
  1. void
 writeDecimal8(long v)
Writes an 8-byte packed decimal format number into the message buffer at the current position.
  1. void
 writeDouble(double v)
Writes a double into the message buffer at the current position.
  1. void
 writeFloat(float v)
Writes a float into the message buffer at the current position.
  1. void
 writeInt(int v)
Writes an int into the message buffer at the current position.
  1. void
 writeInt2(int v)
Identical to writeShort(), provided for cross-language WMQ API compatibility.
  1. void
 writeInt4(int v)
Synonym for writeInt(), provided for cross-language WMQ API compatibility.
  1. void
 writeInt8(long v)
Synonym for writeLong(), provided for cross-language WMQ API compatibility.
  1. void
 writeLong(long v)
Writes a long into the message buffer at the current position.
  1. void
 writeObject(java.lang.Object obj)
Writes an Object into the message.
  1. void
 writeShort(int v)
Writes a short into the message buffer at the current position.
  1. void
 writeString(java.lang.String s)
Writes a String into the message buffer at the current position, converting it to the codeset identified by characterSet.
  1. void
 writeUTF(java.lang.String str)
Writes a String in UTF format into the message buffer at the current position.
Methods inherited from class com.ibm.mq.MQMD
getVersion, setVersion
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MQMessage

  1. public MQMessage()
The default constructor. This creates a message with default message descriptor information and an empty message buffer.

Method Detail

getTotalMessageLength

  1. public int getTotalMessageLength( )
Gets the total number of bytes in the message as stored on the message queue on which this message was held. This method reports the total size of the message on the queue when an MQQueue.get()method fails with an error code that indicates that the message has been truncated.
Returns:
the total number of bytes in the message

getMessageLength

  1. public int getMessageLength()
  2. throws java.io.IOException
Gets the number of bytes of message data in this message.
Returns:
the number of bytes.
Throws:
java.io.IOException - if there is a problem with IO.

getDataLength

  1. public int getDataLength()
  2. throws java.io.IOException
Gets the number of bytes of message data remaining to be read.
Returns:
int the number of bytes remaining
Throws:
java.io.IOException - if there is a problem with IO.

seek

  1. public void seek(int seekOffset)
  2. throws java.io.EOFException
Moves the cursor to a new absolute position in the message buffer. Subsequent reads and writes will start from this position in the buffer.
Parameters:
seekOffset - the new value of the cursor position.
Throws:
java.io.EOFException - if offset takes cursor outside the message data.

setDataOffset

  1. public void setDataOffset(int offset)
  2. throws java.io.EOFException
Moves the cursor to a new absolute position in the message buffer. This method is identical to seek(), and is provided for cross-language compatibility with the other WMQ APIs.
Parameters:
offset - the new value of the cursor position.
Throws:
java.io.EOFException - if offset takes cursor outside the message data.

getDataOffset

  1. public int getDataOffset()
  2. throws java.io.IOException
Returns the current cursor position within the message data (the point at which read and write operations take effect).
Returns:
the cursor position.
Throws:
java.io.IOException - if there is a problem with IO.

clearMessage

  1. public void clearMessage()
  2. throws java.io.IOException
Discards any data in the message buffer and sets the cursor position to zero.
Throws:
java.io.IOException - if there is a problem with IO.

resizeBuffer

  1. public void resizeBuffer(int size)
  2. throws java.io.IOException
Indicates to the MQMessage class the size of buffer that might be required. If the message currently contains message data and the new size is less than the current size, the message data is truncated. If this message is subsequently used with MQQueue.get(MQMessage, MQGetMessageOptions) , then this is the size of buffer allocated for the get request.
Parameters:
size - the new size of the buffer
Throws:
java.io.IOException - if there is a problem with IO.

readBoolean

  1. public boolean readBoolean()
  2. throws java.io.IOException
  3. java.io.EOFException
Reads a boolean from the current position in the message buffer.
Specified by:
readBoolean in interface java.io.DataInput
Returns:
the boolean.
Throws:
java.io.IOException - if there is a problem with IO.
java.io.EOFException - if the read goes beyond the end of file.

readByte

  1. public byte readByte()
  2. throws java.io.IOException
  3. java.io.EOFException
Reads a byte from the current position in the message buffer.
Specified by:
readByte in interface java.io.DataInput
Returns:
the (signed) byte.
Throws:
java.io.IOException - if there is a problem with IO.
java.io.EOFException - if the read goes beyond the end of file.

readChar

  1. public char readChar()
  2. throws java.io.IOException
  3. java.io.EOFException
Reads a character from the current position in the message buffer.
Specified by:
readChar in interface java.io.DataInput
Returns:
the Unicode character.
Throws:
java.io.IOException - if there is a problem with IO.
java.io.EOFException - if the read goes beyond the end of file.

readDouble

  1. public double readDouble()
  2. throws java.io.IOException
  3. java.io.EOFException
Reads a double from the current position in the message buffer.
Specified by:
readDouble in interface java.io.DataInput
Returns:
a big-endian double if encodingis equal to MQConstants.MQENC_INTEGER_NORMAL, or a little-endian double if it is equal to MQConstants.MQENC_INTEGER_REVERSED.
Throws:
java.io.IOException - if encoding is not equal to either of these values.
java.io.EOFException - if the read goes beyond the end of file.

readFloat

  1. public float readFloat()
  2. throws java.io.IOException
  3. java.io.EOFException
Reads a float from the current position in the message buffer.
Specified by:
readFloat in interface java.io.DataInput
Returns:
a big-endian float if encodingequals MQConstants.MQENC_INTEGER_NORMAL, a little-endian float if it equals MQConstants.MQENC_INTEGER_REVERSED, or a zSeries format floating point number if it equals MQConstants.MQENC_FLOAT_S390.
Throws:
java.io.IOException - if encoding is none of these.
java.io.EOFException - if the read goes beyond the end of file.

readFully

  1. public void readFully(byte[] b)
  2. throws java.io.IOException
Fills a byte array with data from the message buffer.
Specified by:
readFully in interface java.io.DataInput
Parameters:
b - the byte array.
Throws:
java.io.IOException - if there is a problem with IO.

readFully

  1. public void readFully(byte[] b,
  2. int off,
  3. int len)
  4. throws java.io.IOException
Partly fills a byte array with data from the message buffer.
Specified by:
readFully in interface java.io.DataInput
Parameters:
b - the byte array.
off - the offset into the message buffer where the reading starts.
len - the number of bytes to be read.
Throws:
java.io.IOException - if there is a problem with IO.

readStringOfByteLength

  1. public java.lang.String readStringOfByteLength( int numberOfBytes)
  2. throws java.io.IOException
  3. java.io.EOFException
Reads a specified number of bytes and uses them to construct a new string using the character set specified by characterSet. When the given bytes are not valid in the given charset, the behavior of this method is dependant on the implementation of the JRE.

Where the byte length of a string is known, the entire String should be read in a single invocation of this method, thus avoiding problems where byte and char boundaries do not coincide.

Parameters:
numberOfBytes - The number of bytes to read.
Returns:
the string.
Throws:
java.io.IOException - if there is a problem with IO.
java.io.EOFException - if the read goes beyond the end of file.

readStringOfCharLength

  1. public java.lang.String readStringOfCharLength( int numberOfChars)
  2. throws java.io.IOException
  3. java.io.EOFException
Reads a string in the codeset identified by characterSetand converts it into Unicode.
Parameters:
numberOfChars - The number of characters to read (which might differ from the number of bytes according to the codeset, because some codesets use more than one byte per character).
Returns:
the string.
Throws:
java.io.IOException - if there is a problem with IO.
java.io.EOFException - if the read goes beyond the end of file.

readInt

  1. public int readInt()
  2. throws java.io.IOException
Reads an integer from the current position in the message buffer.
Specified by:
readInt in interface java.io.DataInput
Returns:
a big-endian integer if encodingis equal to MQConstants.MQENC_INTEGER_NORMAL, or a little-endian integer if it is equal to MQConstants.MQENC_INTEGER_REVERSED.
Throws:
java.io.IOException - if there is a problem with IO.

readInt4

  1. public int readInt4()
  2. throws java.io.IOException
Synonym for readInt(), provided for cross-language WMQ API compatibility.
Returns:
int The integer read
Throws:
java.io.IOException - if there is a problem with IO.

readLine

  1. public java.lang.String readLine( )
  2. throws java.io.IOException
Reads a line of text from the message. Converts from the codeset identified in characterSet, and then reads in a line that has been terminated by \n, \r, \r\n, EOF or the end of a UTF string.
Specified by:
readLine in interface java.io.DataInput
Returns:
the returned string, in Unicode.
Throws:
java.io.IOException - if there is a problem with IO.

readLong

  1. public long readLong()
  2. throws java.io.IOException
Reads an integer from the current position in the message buffer.
Specified by:
readLong in interface java.io.DataInput
Returns:
a big-endian long if encodingis equal to MQConstants.MQENC_INTEGER_NORMAL, or a little-endian long if it is equal to MQConstants.MQENC_INTEGER_REVERSED.
Throws:
java.io.IOException - if encoding is not equal to either of these values.

readInt8

  1. public long readInt8()
  2. throws java.io.IOException
Identical to readLong(). Provided for cross-language WMQ API compatibility.
Returns:
a big-endian long if encodingis equal to MQConstants.MQENC_INTEGER_NORMAL, or a little-endian long if it is equal to MQConstants.MQENC_INTEGER_REVERSED.
Throws:
java.io.IOException - if encoding is not equal to either of these values.

readShort

  1. public short readShort()
  2. throws java.io.IOException
Reads a short from the current position in the message buffer.
Specified by:
readShort in interface java.io.DataInput
Returns:
a big-endian short if encodingis equal to MQConstants.MQENC_INTEGER_NORMAL, or a little-endian short if it is equal to MQConstants.MQENC_INTEGER_REVERSED.
Throws:
java.io.IOException - if encoding is not equal to either of these values.

readInt2

  1. public short readInt2()
  2. throws java.io.IOException
Identical to readShort(). Provided for cross-language MQ API compatibility.
Returns:
a big-endian short if encodingis equal to MQConstants.MQENC_INTEGER_NORMAL, or a little-endian short if it is equal to MQConstants.MQENC_INTEGER_REVERSED.
Throws:
java.io.IOException - if there is a problem with IO.

readUTF

  1. public java.lang.String readUTF( )
  2. throws java.io.IOException
Reads a UTF format String from the current position in the message buffer.
Specified by:
readUTF in interface java.io.DataInput
Returns:
the String.
Throws:
java.io.IOException - if there is a problem with IO.

readUnsignedByte

  1. public int readUnsignedByte()
  2. throws java.io.IOException
Reads an unsigned byte from the current position in the message buffer.
Specified by:
readUnsignedByte in interface java.io.DataInput
Returns:
an int that contains the value.
Throws:
java.io.IOException - if there is a problem with IO.

readUnsignedShort

  1. public int readUnsignedShort()
  2. throws java.io.IOException
Reads an unsigned short from the current position in the message buffer.
Specified by:
readUnsignedShort in interface java.io.DataInput
Returns:
an int that contains a big-endian short if encodingis equal to MQConstants.MQENC_INTEGER_NORMAL, or a little-endian short if it is equal to MQConstants.MQENC_INTEGER_REVERSED.
Throws:
java.io.IOException - if encoding is not equal to either of these values.

readUInt2

  1. public int readUInt2()
  2. throws java.io.IOException
Identical to readUnsignedShort(), provided for cross-language WMQ API compatibility.
Returns:
an int that contains a big-endian short if encodingis equal to MQConstants.MQENC_INTEGER_NORMAL, or a little-endian short if it is equal to MQConstants.MQENC_INTEGER_REVERSED.
Throws:
java.io.IOException - if there is a problem with IO.

readString

  1. @Deprecated
  2. public java.lang.String readString( int length)
  3. throws java.io.IOException
Deprecated. use readStringOfCharLength(int)method instead.
Reads a string in the codeset identified by characterSetand converts it into Unicode.
Parameters:
length - The number of characters to read (which might differ from the number of bytes according to the codeset, since some codesets use more than one byte per character).
Returns:
a String in the appropriate codeset
Throws:
java.io.IOException

readDecimal2

  1. public short readDecimal2()
  2. throws java.io.IOException
Reads a 2-byte packed decimal number in the range -999 to 999.
Returns:
a big-endian short if encodingequals MQConstants.MQENC_DECIMAL_NORMAL or a little-endian short if it equals MQConstants.MQENC_DECIMAL_REVERSED.
Throws:
java.io.IOException - if there is a problem with IO.

readDecimal4

  1. public int readDecimal4()
  2. throws java.io.IOException
Reads a 4-byte packed decimal number in the range -9,999,999 to 9,999,999.
Returns:
a big-endian int if encodingequals MQConstants.MQENC_DECIMAL_NORMAL or a little-endian int if it equals MQConstants.MQENC_DECIMAL_REVERSED.
Throws:
java.io.IOException - if there is a problem with IO.

readDecimal8

  1. public long readDecimal8()
  2. throws java.io.IOException
Reads an 8-byte packed decimal number in the range -999,999,999,999,999 to 999,999,999,999,999.
Returns:
a big-endian long if encodingequals MQConstants.MQENC_DECIMAL_NORMAL or a little-endian long if it equals MQConstants.MQENC_DECIMAL_REVERSED.
Throws:
java.io.IOException - if there is a problem with IO.

readObject

  1. public java.lang.Object readObject( )
  2. throws java.lang.ClassNotFoundException
  3. java.io.InvalidClassException
  4. java.io.StreamCorruptedException
  5. java.io.OptionalDataException
  6. java.io.IOException
Reads an object carried in the message.
Returns:
the Object.
Throws:
java.lang.ClassNotFoundException
java.io.InvalidClassException
java.io.StreamCorruptedException
java.io.OptionalDataException
java.io.IOException

skipBytes

  1. public int skipBytes(int n)
  2. throws java.io.IOException
  3. java.io.EOFException
Moves the cursor forward in the message buffer.
Specified by:
skipBytes in interface java.io.DataInput
Parameters:
n - the number of bytes to move.
Returns:
the number of bytes actually moved.
Throws:
java.io.IOException - if there is a problem with IO.
java.io.EOFException - if the skip goes beyond the end of file.

write

  1. public void write(int b)
  2. throws java.io.IOException
Writes a byte into the message buffer at the current position.
Specified by:
write in interface java.io.DataOutput
Parameters:
b - the byte to be written
Throws:
java.io.IOException - if there is a problem with IO.

write

  1. public void write(byte[] b)
  2. throws java.io.IOException
Writes an array of bytes into the message buffer at the current position.
Specified by:
write in interface java.io.DataOutput
Parameters:
b - the array to be written.
Throws:
java.io.IOException - if there is a problem with IO.

write

  1. public void write(byte[] b,
  2. int off,
  3. int len)
  4. throws java.io.IOException
Writes a series of bytes into the message buffer at the current position.
Specified by:
write in interface java.io.DataOutput
Parameters:
b - the array from which the bytes are written.
off - the offset to the first byte in the array to be written.
len - the number of bytes to be written.
Throws:
java.io.IOException - if there is a problem with IO.

writeBoolean

  1. public void writeBoolean(boolean v)
  2. throws java.io.IOException
Writes a boolean into the message buffer at the current position.
Specified by:
writeBoolean in interface java.io.DataOutput
Parameters:
v - the boolean to be written.
Throws:
java.io.IOException - if there is a problem with IO.

writeByte

  1. public void writeByte(int v)
  2. throws java.io.IOException
Writes a byte into the message buffer at the current position.
Specified by:
writeByte in interface java.io.DataOutput
Parameters:
v - the byte to be written.
Throws:
java.io.IOException - if there is a problem with IO.

writeBytes

  1. @Deprecated
  2. public void writeBytes( java.lang.String s)
  3. throws java.io.IOException
Deprecated. This implements the DataOutput.writeBytes(String) method which is not a general string writing routine - it writes the low-order bytes from the characters in the String to the Message, discarding the high-order bytes. (In MQ, it is hard to see where behaviour would be desirable, but it is mandatory as MQMessage implements the DataOutput interface.)
No data conversion is performed by this method. If you wish to write a string to the message with appropriate handling of the character set currently in force, use writeString(String) instead of this method.
Writes a String as a sequence of bytes into the message buffer at the current position.

Specified by:
writeBytes in interface java.io.DataOutput
Parameters:
s - the String to be written.
Throws:
java.io.IOException - if there is a problem with IO.

writeChar

  1. public void writeChar(int v)
  2. throws java.io.IOException
Writes a Unicode character into the message buffer at the current position.
Specified by:
writeChar in interface java.io.DataOutput
Parameters:
v - the character to be written, expressed as an int.
Throws:
java.io.IOException - if there is a problem with IO.

writeChars

  1. public void writeChars(java.lang.String s)
  2. throws java.io.IOException
Writes a String as a sequence of Unicode characters into the message buffer at the current position.
Specified by:
writeChars in interface java.io.DataOutput
Parameters:
s - the String to be written.
Throws:
java.io.IOException - if there is a problem with IO.

writeDouble

  1. public void writeDouble(double v)
  2. throws java.io.IOException
Writes a double into the message buffer at the current position. The behavior of this method is determined by encoding.

Values of MQConstants.MQENC_FLOAT_IEEE_NORMAL and MQENC_IEEE_FLOAT_REVERSED write IEEE standard floats in big-endian and little-endian formats respectively.

A value of MQConstants.MQENC_FLOAT_S390 writes a zSeries format floating point number. Note that the range of IEEE doubles is greater than the range of zSeries double precision floating point numbers, and that very large numbers cannot be converted.

Specified by:
writeDouble in interface java.io.DataOutput
Parameters:
v - the double to be written.
Throws:
java.io.IOException - if there is a problem with IO.

writeFloat

  1. public void writeFloat(float v)
  2. throws java.io.IOException
Writes a float into the message buffer at the current position. The behavior of this method is determined by encoding.

Values of MQConstants.MQENC_FLOAT_IEEE_NORMAL and MQENC_IEEE_FLOAT_REVERSED write IEEE standard floats in big-endian and little-endian formats respectively.

A value of MQConstants.MQENC_FLOAT_S390 writes a zSeries format floating point number. Note that the range of IEEE doubles is greater than the range of zSeries double precision floating point numbers, and that very large numbers cannot be converted.

Specified by:
writeFloat in interface java.io.DataOutput
Parameters:
v - the float to be written.
Throws:
java.io.IOException - if there is a problem with IO.

writeInt

  1. public void writeInt(int v)
  2. throws java.io.IOException
Writes an int into the message buffer at the current position. The behavior of this method is determined by encoding.

Values of MQConstants.MQENC_INTEGER_NORMAL and MQConstants.MQENC_INTEGER_REVERSED write integers in big-endian and little-endian formats respectively.

Specified by:
writeInt in interface java.io.DataOutput
Parameters:
v - the int to be written.
Throws:
java.io.IOException - if there is a problem with IO.

writeInt4

  1. public void writeInt4(int v)
  2. throws java.io.IOException
Synonym for writeInt(), provided for cross-language WMQ API compatibility.
Parameters:
v - the int to be written
Throws:
java.io.IOException - if there is a problem with IO.

writeLong

  1. public void writeLong(long v)
  2. throws java.io.IOException
Writes a long into the message buffer at the current position. The behavior of this method is determined by encoding.

Values of MQConstants.MQENC_INTEGER_NORMAL and MQConstants.MQENC_INTEGER_REVERSED write longs in big-endian and little-endian formats respectively.

Specified by:
writeLong in interface java.io.DataOutput
Parameters:
v - the long to be written.
Throws:
java.io.IOException - if there is a problem with IO.

writeInt8

  1. public void writeInt8(long v)
  2. throws java.io.IOException
Synonym for writeLong(), provided for cross-language WMQ API compatibility.
Parameters:
v - the long to be written
Throws:
java.io.IOException - if there is a problem with IO.

writeShort

  1. public void writeShort(int v)
  2. throws java.io.IOException
Writes a short into the message buffer at the current position. The behavior of this method is determined by encoding.

Values of MQConstants.MQENC_INTEGER_NORMAL and MQConstants.MQENC_INTEGER_REVERSED write shorts in big-endian and little-endian formats respectively.

A value of MQConstants.MQENC_FLOAT_S390 writes a zSeries format floating point number.

Specified by:
writeShort in interface java.io.DataOutput
Parameters:
v - the short to be written.
Throws:
java.io.IOException - if there is a problem with IO.

writeInt2

  1. public void writeInt2(int v)
  2. throws java.io.IOException
Identical to writeShort(), provided for cross-language WMQ API compatibility.
Parameters:
v - the long to be written.
Throws:
java.io.IOException - if there is a problem with IO.

writeDecimal2

  1. public void writeDecimal2(short v)
  2. throws java.io.IOException
Writes a 2-byte packed decimal format number into the message buffer at the current position. The behavior of this method is determined by encoding. A value of MQConstants.MQENC_DECIMAL_NORMAL writes a big-endian packed decimal and a value of MQConstants.MQENC_DECIMAL_REVERSED writes a little-endian packed decimal.
Parameters:
v - is the number to be written in the range -999 to 999.
Throws:
java.io.IOException - if there is a problem with IO.

writeDecimal4

  1. public void writeDecimal4(int v)
  2. throws java.io.IOException
Writes a 4-byte packed decimal format number into the message buffer at the current position. The behavior of this method is determined by encoding. A value of MQConstants.MQENC_DECIMAL_NORMAL writes a big-endian packed decimal and a value of MQConstants.MQENC_DECIMAL_REVERSED writes a little-endian packed decimal.
Parameters:
v - is the number to be written in the range -9,999,999 to 9,999,999.
Throws:
java.io.IOException - if there is a problem with IO.

writeDecimal8

  1. public void writeDecimal8(long v)
  2. throws java.io.IOException
Writes an 8-byte packed decimal format number into the message buffer at the current position. The behavior of this method is determined by encoding. A value of MQConstants.MQENC_DECIMAL_NORMAL writes a big-endian packed decimal and a value of MQConstants.MQENC_DECIMAL_REVERSED writes a little-endian packed decimal.
Parameters:
v - is the number to be written int the range -999,999,999,999,999 to 999,999,999,999,999.
Throws:
java.io.IOException - if there is a problem with IO.

writeUTF

  1. public void writeUTF(java.lang.String str)
  2. throws java.io.IOException
Writes a String in UTF format into the message buffer at the current position.
Specified by:
writeUTF in interface java.io.DataOutput
Parameters:
str - the String to be written.
Throws:
java.io.IOException - if there is a problem with IO.

writeString

  1. public void writeString(java.lang.String s)
  2. throws java.io.IOException
Writes a String into the message buffer at the current position, converting it to the codeset identified by characterSet.
Parameters:
s - the String to be written.
Throws:
java.io.IOException - if there is a problem with IO.

writeObject

  1. public void writeObject(java.lang.Object obj)
  2. throws java.io.IOException
Writes an Object into the message.
Parameters:
obj - the Object to be written.
Throws:
java.io.IOException - if there is a problem with IO.

getPropertyValidation

  1. public int getPropertyValidation( )
Specifies whether validation of properties should take place when a property of the message is set. Possible values are:
  • MQCMHO_DEFAULT_VALIDATION, the default
  • MQCMHO_VALIDATE
  • MQCMHO_NO_VALIDATION
Returns:
true if property validation will take place

setPropertyValidation

  1. public void setPropertyValidation( int propertyValidation)
Specifies whether validation of properties should take place when a property of the message is set. Possible values are:
  • MQCMHO_DEFAULT_VALIDATION, the default
  • MQCMHO_VALIDATE
  • MQCMHO_NO_VALIDATION
Parameters:
propertyValidation - set to true if property validation should take place

setBooleanProperty

  1. public void setBooleanProperty( java.lang.String name,
  2. boolean value)
  3. throws MQException
Sets a boolean property value with the specified name into the message, with the default property descriptor.
Parameters:
name - the name of the boolean property.
value - the boolean property value to set.
Throws:
MQException - if the property name is invalid.

setBooleanProperty

  1. public void setBooleanProperty( java.lang.String name,
  2. MQPropertyDescriptor descriptor,
  3. boolean value)
  4. throws MQException
Sets a boolean property value with the specified name into the message, with the specified property descriptor.
Parameters:
name - the name of the boolean property.
descriptor - the attributes of the property itself.
value - the boolean property value to set.
Throws:
MQException - if the property name is invalid.

setBytesProperty

  1. public void setBytesProperty(java.lang.String name,
  2. byte[] value)
  3. throws MQException
Sets a byte array property value with the specified name into the message, with the default property descriptor.
Parameters:
name - the name of the byte array property.
value - the byte array property value to set.
Throws:
MQException - if the property name is invalid.

setBytesProperty

  1. public void setBytesProperty(java.lang.String name,
  2. MQPropertyDescriptor descriptor,
  3. byte[] value)
  4. throws MQException
Sets a byte array property value with the specified name into the message, with the specified property descriptor.
Parameters:
name - the name of the byte array property.
descriptor - the attributes of the property itself.
value - the byte array property value to set.
Throws:
MQException - if the property name is invalid.

setByteProperty

  1. public void setByteProperty(java.lang.String name,
  2. byte value)
  3. throws MQException
Sets a byte property value with the specified name into the message, with the default property descriptor.
Parameters:
name - the name of the byte property.
value - the byte property value to set.
Throws:
MQException - if the property name is invalid.

setByteProperty

  1. public void setByteProperty(java.lang.String name,
  2. MQPropertyDescriptor descriptor,
  3. byte value)
  4. throws MQException
Sets a byte property value with the specified name into the message, with the specified property descriptor.
Parameters:
name - the name of the byte property.
descriptor - the attributes of the property itself.
value - the byte property value to set.
Throws:
MQException - if the property name is invalid.

setShortProperty

  1. public void setShortProperty(java.lang.String name,
  2. short value)
  3. throws MQException
Sets a short property value with the specified name into the message, with the default property descriptor.
Parameters:
name - the name of the short property.
value - the short property value to set.
Throws:
MQException - if the property name is invalid.

setShortProperty

  1. public void setShortProperty(java.lang.String name,
  2. MQPropertyDescriptor descriptor,
  3. short value)
  4. throws MQException
Sets a short property value with the specified name into the message, with the specified property descriptor.
Parameters:
name - the name of the short property.
descriptor - the attributes of the property itself.
value - the short property value to set.
Throws:
MQException - if the property name is invalid.

setInt2Property

  1. public void setInt2Property(java.lang.String name,
  2. short value)
  3. throws MQException
Synonym for setShortProperty(String, short), provided for cross-language WebSphere MQ API compatibility.
Parameters:
name - the name of the short property.
value - the short property value to set.
Throws:
MQException - if the property name is invalid.

setInt2Property

  1. public void setInt2Property(java.lang.String name,
  2. MQPropertyDescriptor descriptor,
  3. short value)
  4. throws MQException
Synonym for setShortProperty(String, MQPropertyDescriptor, short), provided for cross-language WebSphere MQ API compatibility.
Parameters:
name - the name of the short property.
descriptor - the attributes of the property itself.
value - the short property value to set.
Throws:
MQException - if the property name is invalid.

setIntProperty

  1. public void setIntProperty(java.lang.String name,
  2. int value)
  3. throws MQException
Sets a int property value with the specified name into the message, with the default property descriptor.
Parameters:
name - the name of the int property.
value - the int property value to set.
Throws:
MQException - if the property name is invalid.

setIntProperty

  1. public void setIntProperty(java.lang.String name,
  2. MQPropertyDescriptor descriptor,
  3. int value)
  4. throws MQException
Sets a int property value with the specified name into the message, with the specified property descriptor.
Parameters:
name - the name of the int property.
descriptor - the attributes of the property itself.
value - the int property value to set.
Throws:
MQException - if the property name is invalid.

setInt4Property

  1. public void setInt4Property(java.lang.String name,
  2. int value)
  3. throws MQException
Synonym for setIntProperty(String, int), provided for cross-language WebSphere MQ API compatibility.
Parameters:
name - the name of the int property.
value - the int property value to set.
Throws:
MQException - if the property name is invalid.

setInt4Property

  1. public void setInt4Property(java.lang.String name,
  2. MQPropertyDescriptor descriptor,
  3. int value)
  4. throws MQException
Synonym for setIntProperty(String, MQPropertyDescriptor, int), provided for cross-language WebSphere MQ API compatibility.
Parameters:
name - the name of the int property.
descriptor - the attributes of the property itself.
value - the int property value to set.
Throws:
MQException - if the property name is invalid.

setLongProperty

  1. public void setLongProperty(java.lang.String name,
  2. long value)
  3. throws MQException
Sets a long property value with the specified name into the message, with the default property descriptor.
Parameters:
name - the name of the long property.
value - the long property value to set.
Throws:
MQException - if the property name is invalid.

setLongProperty

  1. public void setLongProperty(java.lang.String name,
  2. MQPropertyDescriptor descriptor,
  3. long value)
  4. throws MQException
Sets a long property value with the specified name into the message, with the specified property descriptor.
Parameters:
name - the name of the long property.
descriptor - the attributes of the property itself.
value - the long property value to set.
Throws:
MQException - if the property name is invalid.

setInt8Property

  1. public void setInt8Property(java.lang.String name,
  2. long value)
  3. throws MQException
Synonym for setLongProperty(String, long), provided for cross-language WebSphere MQ API compatibility.
Parameters:
name - the name of the long property.
value - the long property value to set.
Throws:
MQException - if the property name is invalid.

setInt8Property

  1. public void setInt8Property(java.lang.String name,
  2. MQPropertyDescriptor descriptor,
  3. long value)
  4. throws MQException
Synonym for setLongProperty(String, MQPropertyDescriptor, long), provided for cross-language WebSphere MQ API compatibility.
Parameters:
name - the name of the long property.
descriptor - the attributes of the property itself.
value - the long property value to set.
Throws:
MQException - if the property name is invalid.

setFloatProperty

  1. public void setFloatProperty(java.lang.String name,
  2. float value)
  3. throws MQException
Sets a float property value with the specified name into the message, with the default property descriptor.
Parameters:
name - the name of the float property.
value - the float property value to set.
Throws:
MQException - if the property name is invalid.

setFloatProperty

  1. public void setFloatProperty(java.lang.String name,
  2. MQPropertyDescriptor descriptor,
  3. float value)
  4. throws MQException
Sets a float property value with the specified name into the message, with the specified property descriptor.
Parameters:
name - the name of the float property.
descriptor - the attributes of the property itself.
value - the float property value to set.
Throws:
MQException - if the property name is invalid.

setDoubleProperty

  1. public void setDoubleProperty(java.lang.String name,
  2. double value)
  3. throws MQException
Sets a double property value with the specified name into the message, with the default property descriptor.
Parameters:
name - the name of the double property.
value - the double property value to set.
Throws:
MQException - if the property name is invalid.

setDoubleProperty

  1. public void setDoubleProperty(java.lang.String name,
  2. MQPropertyDescriptor descriptor,
  3. double value)
  4. throws MQException
Sets a double property value with the specified name into the message, with the specified property descriptor.
Parameters:
name - the name of the double property.
descriptor - the attributes of the property itself.
value - the double property value to set.
Throws:
MQException - if the property name is invalid.

setStringProperty

  1. public void setStringProperty(java.lang.String name,
  2. java.lang.String value)
  3. throws MQException
Sets a String property value with the specified name into the message, with the default property descriptor.
Parameters:
name - the name of the String property.
value - the String property value to set.
Throws:
MQException - if the property name is invalid.

setStringProperty

  1. public void setStringProperty(java.lang.String name,
  2. MQPropertyDescriptor descriptor,
  3. java.lang.String value)
  4. throws MQException
Sets a String property value with the specified name into the message, with the specified property descriptor.
Parameters:
name - the name of the String property.
descriptor - the attributes of the property itself.
value - the String property value to set.
Throws:
MQException - if the property name is invalid.

setObjectProperty

  1. public void setObjectProperty(java.lang.String name,
  2. java.lang.Object value)
  3. throws MQException
Sets a Java object property value with the specified name into the message, with the default property descriptor. Note that this method works only for the objectified primitive object types (Integer, Double, Long ...) and String objects. The property is set as if the set*Property method had been called directly e.g. Integer leads to an int property value being set, Long leads to a long property value being set etc.
Parameters:
name - the name of the Java object property.
value - the Java object property value to set.
Throws:
MQException - if the property name is invalid.

setObjectProperty

  1. public void setObjectProperty(java.lang.String name,
  2. MQPropertyDescriptor descriptor,
  3. java.lang.Object value)
  4. throws MQException
Sets a Java object property value with the specified name into the message, with the specified property descriptor. Note that this method works only for the objectified primitive object types (Integer, Double, Long ...) and String objects. The property is set as if the set*Property method had been called directly e.g. Integer leads to an int property value being set, Long leads to a long property value being set etc.
Parameters:
name - the name of the Java object property.
descriptor - the attributes of the property itself.
value - the Java object property value to set.
Throws:
MQException - if the property name is invalid.

getBooleanProperty

  1. public boolean getBooleanProperty( java.lang.String name)
  2. throws MQException
Returns the value of the boolean property with the specified name.
Parameters:
name - the name of the boolean property.
Returns:
the boolean property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getBooleanProperty

  1. public boolean getBooleanProperty( java.lang.String name,
  2. MQPropertyDescriptor descriptor)
  3. throws MQException
Returns the value of the boolean property with the specified name, filling in the specified property descriptor.
Parameters:
name - the name of the boolean property.
descriptor - the attributes of the property itself.
Returns:
the boolean property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getBytesProperty

  1. public byte[] getBytesProperty( java.lang.String name)
  2. throws MQException
Returns the value of the byte array property with the specified name.
Parameters:
name - the name of the byte array property.
Returns:
the byte array property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getBytesProperty

  1. public byte[] getBytesProperty( java.lang.String name,
  2. MQPropertyDescriptor descriptor)
  3. throws MQException
Returns the value of the byte array property with the specified name, filling in the specified property descriptor.
Parameters:
name - the name of the byte array property.
descriptor - the attributes of the property itself.
Returns:
the byte array property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getByteProperty

  1. public byte getByteProperty(java.lang.String name)
  2. throws MQException
Returns the value of the byte property with the specified name.
Parameters:
name - the name of the byte property.
Returns:
the byte property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getByteProperty

  1. public byte getByteProperty(java.lang.String name,
  2. MQPropertyDescriptor descriptor)
  3. throws MQException
Returns the value of the byte property with the specified name, filling in the specified property descriptor.
Parameters:
name - the name of the byte property.
descriptor - the attributes of the property itself.
Returns:
the byte property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getShortProperty

  1. public short getShortProperty(java.lang.String name)
  2. throws MQException
Returns the value of the short property with the specified name.
Parameters:
name - the name of the short property.
Returns:
the short property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getShortProperty

  1. public short getShortProperty(java.lang.String name,
  2. MQPropertyDescriptor descriptor)
  3. throws MQException
Returns the value of the short property with the specified name, filling in the specified property descriptor.
Parameters:
name - the name of the short property.
descriptor - the attributes of the property itself.
Returns:
the short property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getInt2Property

  1. public short getInt2Property(java.lang.String name)
  2. throws MQException
Synonym for getShortProperty(String), provided for cross-language WebSphere MQ API compatibility.
Parameters:
name - the name of the short property.
Returns:
the short property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getInt2Property

  1. public short getInt2Property(java.lang.String name,
  2. MQPropertyDescriptor descriptor)
  3. throws MQException
Synonym for getShortProperty(String, MQPropertyDescriptor), provided for cross-language WebSphere MQ API compatibility.
Parameters:
name - the name of the short property.
descriptor - the attributes of the property itself.
Returns:
the short property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getIntProperty

  1. public int getIntProperty(java.lang.String name)
  2. throws MQException
Returns the value of the int property with the specified name.
Parameters:
name - the name of the int property.
Returns:
the int property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getIntProperty

  1. public int getIntProperty(java.lang.String name,
  2. MQPropertyDescriptor descriptor)
  3. throws MQException
Returns the value of the int property with the specified name, filling in the specified property descriptor.
Parameters:
name - the name of the int property.
descriptor - the attributes of the property itself.
Returns:
the int property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getInt4Property

  1. public int getInt4Property(java.lang.String name)
  2. throws MQException
Synonym for getIntProperty(String), provided for cross-language WebSphere MQ API compatibility.
Parameters:
name - the name of the int property.
Returns:
the int property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getInt4Property

  1. public int getInt4Property(java.lang.String name,
  2. MQPropertyDescriptor descriptor)
  3. throws MQException
Synonym for getIntProperty(String, MQPropertyDescriptor), provided for cross-language WebSphere MQ API compatibility.
Parameters:
name - the name of the int property.
descriptor - the attributes of the property itself.
Returns:
the int property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getLongProperty

  1. public long getLongProperty(java.lang.String name)
  2. throws MQException
Returns the value of the long property with the specified name.
Parameters:
name - the name of the long property.
Returns:
the long property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getLongProperty

  1. public long getLongProperty(java.lang.String name,
  2. MQPropertyDescriptor descriptor)
  3. throws MQException
Returns the value of the long property with the specified name, filling in the specified property descriptor.
Parameters:
name - the name of the long property.
descriptor - the attributes of the property itself.
Returns:
the long property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getInt8Property

  1. public long getInt8Property(java.lang.String name)
  2. throws MQException
Synonym for getLongProperty(String), provided for cross-language WebSphere MQ API compatibility.
Parameters:
name - the name of the long property.
Returns:
the long property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getInt8Property

  1. public long getInt8Property(java.lang.String name,
  2. MQPropertyDescriptor descriptor)
  3. throws MQException
Synonym for getLongProperty(String, MQPropertyDescriptor), provided for cross-language WebSphere MQ API compatibility.
Parameters:
name - the name of the long property.
descriptor - the attributes of the property itself.
Returns:
the long property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getFloatProperty

  1. public float getFloatProperty(java.lang.String name)
  2. throws MQException
Returns the value of the float property with the specified name.
Parameters:
name - the name of the float property.
Returns:
the float property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getFloatProperty

  1. public float getFloatProperty(java.lang.String name,
  2. MQPropertyDescriptor descriptor)
  3. throws MQException
Returns the value of the float property with the specified name, filling in the specified property descriptor.
Parameters:
name - the name of the float property.
descriptor - the attributes of the property itself.
Returns:
the float property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getDoubleProperty

  1. public double getDoubleProperty( java.lang.String name)
  2. throws MQException
Returns the value of the double property with the specified name.
Parameters:
name - the name of the double property.
Returns:
the double property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getDoubleProperty

  1. public double getDoubleProperty( java.lang.String name,
  2. MQPropertyDescriptor descriptor)
  3. throws MQException
Returns the value of the double property with the specified name, filling in the specified property descriptor.
Parameters:
name - the name of the double property.
descriptor - the attributes of the property itself.
Returns:
the double property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getStringProperty

  1. public java.lang.String getStringProperty( java.lang.String name)
  2. throws MQException
Returns the value of the String property with the specified name.
Parameters:
name - the name of the String property.
Returns:
the String property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getStringProperty

  1. public java.lang.String getStringProperty( java.lang.String name,
  2. MQPropertyDescriptor descriptor)
  3. throws MQException
Returns the value of the String property with the specified name, filling in the specified property descriptor.
Parameters:
name - the name of the String property.
descriptor - the attributes of the property itself.
Returns:
the String property value for the specified name; if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist or the type conversion is invalid.

getObjectProperty

  1. public java.lang.Object getObjectProperty( java.lang.String name)
  2. throws MQException
Returns the value of the Java object property with the specified name. This method can be used to return, in objectified format, an object that has been stored as a property in the message with the equivalent setObjectProperty(String, Object) method call, or its equivalent primitive #set*Property method.
Parameters:
name - the name of the Java object property.
Returns:
the Java object property value for the specified name, in objectified format (for example, if the property was set as an int, an Integer is returned); if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist

getObjectProperty

  1. public java.lang.Object getObjectProperty( java.lang.String name,
  2. MQPropertyDescriptor descriptor)
  3. throws MQException
Returns the value of the Java object property with the specified name, filling in the specified property descriptor. This method can be used to return, in objectified format, an object that has been stored as a property in the message with the equivalent setObjectProperty(String, Object) method call, or its equivalent primitive #set*Property method.
Parameters:
name - the name of the Java object property.
descriptor - the attributes of the property itself.
Returns:
the Java object property value for the specified name, in objectified format (for example, if the property was set as an int, an Integer is returned); if there is no property by this name, an MQException is thrown.
Throws:
MQException - if property does not exist

getPropertyNames

  1. public java.util.Enumeration<java.lang.String> getPropertyNames( java.lang.String nameP)
  2. throws MQException
Returns an Enumeration of all the property names matching the specified name. The wildcard character "%" can be used at the end of the name to filter the properties of the message, matching on zero or more characters, including the "." character.
Parameters:
nameP - the name of the property to match on.
Returns:
an enumeration of all the names of property values where the property name matches the specified name.
Throws:
MQException - if the property name is invalid.

deleteProperty

  1. public void deleteProperty(java.lang.String nameP)
  2. throws MQException
Deletes a property with the specified name from the message.
Parameters:
nameP - the name of the property to delete.
Throws:
MQException - if the property name is invalid or does not exist.