Overview  Package   Class  Tree  Deprecated  Index  Help 
 Oracle® Streams Advanced Queuing Java API Reference
Release 1 (10.1)
B12023-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.jms
Class AQjmsBytesMessage

java.lang.Object
  |
  +--oracle.jms.AQjmsMessage
        |
        +--oracle.jms.AQjmsBytesMessage
All Implemented Interfaces:
BytesMessage, Message
public class AQjmsBytesMessage
extends AQjmsMessage
implements BytesMessage

Oracle class implementing javax.jms.BytesMessage

Field Summary

 

Fields inherited from interface javax.jms.Message
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

 

Method Summary
 void clearBody()
          Clears out the message body.
 void clearProperties()
          Clears a message's properties.
protected  void closeContainer()
           
 long getBodyLength()
          Gets the number of bytes of the message body when the message is in read-only mode.
protected  oracle.sql.ORAData getMessageCont()
           
protected  void populateMessageContainer(oracle.jdbc.OracleConnection db_conn, boolean usetemplob)
           
 boolean readBoolean()
          Read a boolean from the stream message.
 byte readByte()
          Read a signed 8-bit value from the stream message.
 int readBytes(byte[] value)
          Read a byte array from the stream message.
 int readBytes(byte[] value, int length)
          Read a portion of the bytes message.
 char readChar()
          Read a Unicode character value from the stream message.
 double readDouble()
          Read a double from the stream message.
 float readFloat()
          Read a float from the stream message.
 int readInt()
          Read a signed 32-bit integer from the stream message.
 long readLong()
          Read a signed 64-bit integer from the stream message.
 short readShort()
          Reads a signed 16-bit number from the bytes message stream.
 int readUnsignedByte()
          Read an unsigned 8-bit number from the stream message.
 int readUnsignedShort()
          Read an unsigned 16-bit number from the stream message.
 java.lang.String readUTF()
          Read in a string that has been encoded using a modified UTF-8 format from the stream message.
 void reset()
          Put the message in read-only mode, and reposition the stream of bytes to the beginning.
protected  void write_lob(java.sql.Connection db_conn, java.lang.String q_table, byte[] msg_id, boolean gen_pload, boolean is_anydata_dest)
           
 void writeBoolean(boolean value)
          Write a boolean to the stream message as a 1-byte value.
 void writeByte(byte value)
          Write out a byte to the stream message as a 1-byte value.
 void writeBytes(byte[] value)
          Write a byte array to the stream message.
 void writeBytes(byte[] value, int offset, int length)
          Write a portion of a byte array to the stream message.
 void writeChar(char value)
          Write a char to the stream message as a 2-byte value, high byte first.
 void writeDouble(double value)
          Convert the double argument to a long using the doubleToLongBits method in class Double, and then writes that long value to the stream message as an 8-byte quantity, high byte first.
 void writeFloat(float value)
          Convert the float argument to an int using the floatToIntBits method in class Float, and then writes that int value to the stream message as a 4-byte quantity, high byte first.
 void writeInt(int value)
          Write an int to the stream message as four bytes, high byte first.
 void writeLong(long value)
          Write a long to the stream message as eight bytes, high byte first.
 void writeObject(java.lang.Object value)
          Write a Java object to the stream message.
 void writeShort(short value)
          Write a short to the stream message as two bytes, high byte first.
 void writeUTF(java.lang.String value)
          Write a string to the stream message using UTF-8 encoding in a machine-independent manner.

 

Methods inherited from class oracle.jms.AQjmsMessage
acknowledge, getAttempts, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSMessageIDAsBytes, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getSenderID, getShortProperty, getStringProperty, getUserPropertyNames, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setSenderID, setShortProperty, setStringProperty

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface javax.jms.Message
acknowledge, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty

 

Method Detail

clearBody

public void clearBody()
               throws JMSException
Description copied from interface: Message
Clears out the message body. Clearing a message's body does not clear its header values or property entries.

If this message body was read-only, calling this method leaves the message body in the same state as an empty body in a newly created message.

Specified by:
clearBody in interface Message
Overrides:
clearBody in class AQjmsMessage
Throws:
JMSException - if the JMS provider fails to clear the message body due to some internal error.

clearProperties

public void clearProperties()
                     throws JMSException
Description copied from interface: Message
Clears a message's properties.

The message's header fields and body are not cleared.

Specified by:
clearProperties in interface Message
Overrides:
clearProperties in class AQjmsMessage
Throws:
JMSException - if the JMS provider fails to clear the message properties due to some internal error.

readBoolean

public boolean readBoolean()
                    throws JMSException
Read a boolean from the stream message.
Specified by:
readBoolean in interface BytesMessage
Returns:
the boolean value read.
Throws:
MessageNotReadableException - if message in write-only mode.
JMSException - if JMS fails to read message due to some internal JMS error.
MessageEOFException - if end of message stream

readByte

public byte readByte()
              throws JMSException
Read a signed 8-bit value from the stream message.
Specified by:
readByte in interface BytesMessage
Returns:
the next byte from the stream message as a signed 8-bit byte.
Throws:
MessageNotReadableException - if message in write-only mode.
MessageEOFException - if end of message stream
JMSException - if JMS fails to read message due to some internal JMS error.

readUnsignedByte

public int readUnsignedByte()
                     throws JMSException
Read an unsigned 8-bit number from the stream message.
Specified by:
readUnsignedByte in interface BytesMessage
Returns:
the next byte from the stream message, interpreted as an unsigned 8-bit number.
Throws:
MessageNotReadableException - if message in write-only mode.
MessageEOFException - if end of message stream
JMSException - if JMS fails to read message due to some internal JMS error.

readShort

public short readShort()
                throws JMSException
Description copied from interface: BytesMessage
Reads a signed 16-bit number from the bytes message stream.
Specified by:
readShort in interface BytesMessage
Returns:
the next two bytes from the bytes message stream, interpreted as a signed 16-bit number
Throws:
JMSException - if the JMS provider fails to read the message due to some internal error.

readUnsignedShort

public int readUnsignedShort()
                      throws JMSException
Read an unsigned 16-bit number from the stream message.
Specified by:
readUnsignedShort in interface BytesMessage
Returns:
the next two bytes from the stream message, interpreted as an unsigned 16-bit integer.
Throws:
MessageNotReadableException - if message in write-only mode.
MessageEOFException - if end of message stream
JMSException - if JMS fails to read message due to some internal JMS error.

readChar

public char readChar()
              throws JMSException
Read a Unicode character value from the stream message.
Specified by:
readChar in interface BytesMessage
Returns:
the next two bytes from the stream message as a Unicode character.
Throws:
MessageNotReadableException - if message in write-only mode.
MessageEOFException - if end of message stream
JMSException - if JMS fails to read message due to some internal JMS error.

readInt

public int readInt()
            throws JMSException
Read a signed 32-bit integer from the stream message.
Specified by:
readInt in interface BytesMessage
Returns:
the next four bytes from the stream message, interpreted as an int.
Throws:
MessageNotReadableException - if message in write-only mode.
MessageEOFException - if end of message stream
JMSException - if JMS fails to read message due to some internal JMS error.

readLong

public long readLong()
              throws JMSException
Read a signed 64-bit integer from the stream message.
Specified by:
readLong in interface BytesMessage
Returns:
the next eight bytes from the stream message, interpreted as a long.
Throws:
MessageNotReadableException - if message in write-only mode.
MessageEOFException - if end of message stream
JMSException - if JMS fails to read message due to some internal JMS error.

readFloat

public float readFloat()
                throws JMSException
Read a float from the stream message.
Specified by:
readFloat in interface BytesMessage
Returns:
the next four bytes from the stream message, interpreted as a float.
Throws:
MessageNotReadableException - if message in write-only mode.
MessageEOFException - if end of message stream
JMSException - if JMS fails to read message due to some internal JMS error.

readDouble

public double readDouble()
                  throws JMSException
Read a double from the stream message.
Specified by:
readDouble in interface BytesMessage
Returns:
the next eight bytes from the stream message, interpreted as a double.
Throws:
MessageNotReadableException - if message in write-only mode.
MessageEOFException - if end of message stream
JMSException - if JMS fails to read message due to some internal JMS error.

readUTF

public java.lang.String readUTF()
                         throws JMSException
Read in a string that has been encoded using a modified UTF-8 format from the stream message.
Specified by:
readUTF in interface BytesMessage
Returns:
a Unicode string from the stream message.
Throws:
MessageNotReadableException - if message in write-only mode.
MessageEOFException - if end of message stream
JMSException - if JMS fails to read message due to some internal JMS error.

readBytes

public int readBytes(byte[] value)
              throws JMSException
Read a byte array from the stream message.
Specified by:
readBytes in interface BytesMessage
Parameters:
value - the buffer into which the data is read.
Returns:
the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.
Throws:
MessageNotReadableException - if message in write-only mode.
MessageEOFException - if end of message stream
JMSException - if JMS fails to read message due to some internal JMS error.

readBytes

public int readBytes(byte[] value,
                     int length)
              throws JMSException
Read a portion of the bytes message.
Specified by:
readBytes in interface BytesMessage
Parameters:
value - the buffer into which the data is read.
length - the number of bytes to read.
Returns:
the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.
Throws:
MessageNotReadableException - if message in write-only mode.
MessageEOFException - if end of message stream
JMSException - if JMS fails to read message due to some internal JMS error.

writeBoolean

public void writeBoolean(boolean value)
                  throws JMSException
Write a boolean to the stream message as a 1-byte value. The value true is written out as the value (byte)1; the value false is written out as the value (byte)0.
Specified by:
writeBoolean in interface BytesMessage
Parameters:
value - the boolean value to be written.
Throws:
MessageNotWriteableException - if message in read-only mode.
JMSException - if JMS fails to write message due to some internal JMS error.

writeByte

public void writeByte(byte value)
               throws JMSException
Write out a byte to the stream message as a 1-byte value.
Specified by:
writeByte in interface BytesMessage
Parameters:
value - the byte value to be written.
Throws:
MessageNotWriteableException - if message in read-only mode.
JMSException - if JMS fails to write message due to some internal JMS error.

writeShort

public void writeShort(short value)
                throws JMSException
Write a short to the stream message as two bytes, high byte first.
Specified by:
writeShort in interface BytesMessage
Parameters:
value - the short to be written.
Throws:
MessageNotWriteableException - if message in read-only mode.
JMSException - if JMS fails to write message due to some internal JMS error.

writeChar

public void writeChar(char value)
               throws JMSException
Write a char to the stream message as a 2-byte value, high byte first.
Specified by:
writeChar in interface BytesMessage
Parameters:
value - the char value to be written.
Throws:
MessageNotWriteableException - if message in read-only mode.
JMSException - if JMS fails to write message due to some internal JMS error.

writeInt

public void writeInt(int value)
              throws JMSException
Write an int to the stream message as four bytes, high byte first.
Specified by:
writeInt in interface BytesMessage
Parameters:
value - the int to be written.
Throws:
MessageNotWriteableException - if message in read-only mode.
JMSException - if JMS fails to write message due to some internal JMS error.

writeLong

public void writeLong(long value)
               throws JMSException
Write a long to the stream message as eight bytes, high byte first.
Specified by:
writeLong in interface BytesMessage
Parameters:
value - the long to be written.
Throws:
MessageNotWriteableException - if message in read-only mode.
JMSException - if JMS fails to write message due to some internal JMS error.

writeFloat

public void writeFloat(float value)
                throws JMSException
Convert the float argument to an int using the floatToIntBits method in class Float, and then writes that int value to the stream message as a 4-byte quantity, high byte first.
Specified by:
writeFloat in interface BytesMessage
Parameters:
value - the float value to be written.
Throws:
MessageNotWriteableException - if message in read-only mode.
JMSException - if JMS fails to write message due to some internal JMS error.

writeDouble

public void writeDouble(double value)
                 throws JMSException
Convert the double argument to a long using the doubleToLongBits method in class Double, and then writes that long value to the stream message as an 8-byte quantity, high byte first.
Specified by:
writeDouble in interface BytesMessage
Parameters:
value - the double value to be written.
Throws:
MessageNotWriteableException - if message in read-only mode.
JMSException - if JMS fails to write message due to some internal JMS error.

writeUTF

public void writeUTF(java.lang.String value)
              throws JMSException
Write a string to the stream message using UTF-8 encoding in a machine-independent manner.
Specified by:
writeUTF in interface BytesMessage
Parameters:
value - the String value to be written.
Throws:
MessageNotWriteableException - if message in read-only mode.
JMSException - if JMS fails to write message due to some internal JMS error.

writeBytes

public void writeBytes(byte[] value)
                throws JMSException
Write a byte array to the stream message.
Specified by:
writeBytes in interface BytesMessage
Parameters:
value - the byte array to be written.
Throws:
MessageNotWriteableException - if message in read-only mode.
JMSException - if JMS fails to write message due to some internal JMS error.

writeBytes

public void writeBytes(byte[] value,
                       int offset,
                       int length)
                throws JMSException
Write a portion of a byte array to the stream message.
Specified by:
writeBytes in interface BytesMessage
Parameters:
value - the byte array value to be written.
offset - the initial offset within the byte array.
length - the number of bytes to use.
Throws:
MessageNotWriteableException - if message in read-only mode.
JMSException - if JMS fails to write message due to some internal JMS error.

writeObject

public void writeObject(java.lang.Object value)
                 throws JMSException
Write a Java object to the stream message.

Note that this method only works for the objectified primitive object types (Integer, Double, Long ...), String's and byte arrays.

Specified by:
writeObject in interface BytesMessage
Parameters:
value - the Java object to be written.
Throws:
MessageNotWriteableException - if message in read-only mode.
MessageFormatException - if object is invalid type.
JMSException - if JMS fails to write message due to some internal JMS error.

reset

public void reset()
           throws JMSException
Put the message in read-only mode, and reposition the stream of bytes to the beginning.
Specified by:
reset in interface BytesMessage
Throws:
JMSException - if JMS fails to reset the message due to some internal JMS error.
MessageFormatException - if message has an invalid format

getMessageCont

protected oracle.sql.ORAData getMessageCont()
Overrides:
getMessageCont in class AQjmsMessage

closeContainer

protected void closeContainer()
Overrides:
closeContainer in class AQjmsMessage

populateMessageContainer

protected void populateMessageContainer(oracle.jdbc.OracleConnection db_conn,
                                        boolean usetemplob)
                                 throws JMSException,
                                        java.sql.SQLException
Overrides:
populateMessageContainer in class AQjmsMessage
JMSException
java.sql.SQLException

write_lob

protected void write_lob(java.sql.Connection db_conn,
                         java.lang.String q_table,
                         byte[] msg_id,
                         boolean gen_pload,
                         boolean is_anydata_dest)
                  throws JMSException
Overrides:
write_lob in class AQjmsMessage
JMSException

getBodyLength

public long getBodyLength()
                   throws JMSException
Gets the number of bytes of the message body when the message is in read-only mode. The value returned can be used to allocate a byte array. The value returned is the entire length of the message body, regardless of where the pointer for reading the message is currently located.
Specified by:
getBodyLength in interface BytesMessage
Returns:
number of bytes in the message
Throws:
JMSException - if the JMS provider fails to read the message due to some internal error.
MessageNotReadableException - if the message is in write-only mode.
Since:
1.1
Overview  Package   Class  Tree  Deprecated  Index  Help 
 Oracle® Streams Advanced Queuing Java API Reference
Release 1 (10.1)
B12023-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2003, Oracle. All Rights Reserved.