AQjmsMapMessage (Oracle® Streams Advanced Queuing Java API Reference)

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">

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 AQjmsMapMessage

java.lang.Object
  |
  +--oracle.jms.AQjmsMessage
        |
        +--oracle.jms.AQjmsMapMessage

All Implemented Interfaces:: MapMessage, Message

public class AQjmsMapMessage
extends AQjmsMessage
implements MapMessage

Oracle class implementing javax.jms.MapMessage

Field Summary

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Method Summary
`void`	`clearBody()` Clear out the message body.
`void`	`clearProperties()` Clear a message's properties.
`protected void`	`closeContainer()`
`boolean`	`getBoolean(java.lang.String name)` Return the boolean value with the given name.
`byte`	`getByte(java.lang.String name)` Return the byte value with the given name.
`byte[]`	`getBytes(java.lang.String name)` Return the byte array value with the given name.
`char`	`getChar(java.lang.String name)` Return the Unicode character value with the given name.
`double`	`getDouble(java.lang.String name)` Return the double value with the given name.
`float`	`getFloat(java.lang.String name)` Return the float value with the given name.
`int`	`getInt(java.lang.String name)` Return the integer value with the given name.
`long`	`getLong(java.lang.String name)` Return the long value with the given name.
`java.util.Enumeration`	`getMapNames()` Return an Enumeration of all the Map message's names.
`protected oracle.sql.ORAData`	`getMessageCont()`
`java.lang.Object`	`getObject(java.lang.String name)` Return the Java object value with the given name.
`short`	`getShort(java.lang.String name)` Return the short value with the given name.
`java.lang.String`	`getString(java.lang.String name)` Returns the `String` value with the specified name.
`boolean`	`itemExists(java.lang.String name)` Check if an item exists in this MapMessage.
`protected void`	`populateMessageContainer(oracle.jdbc.OracleConnection db_conn, boolean usetemplob)`
`void`	`setBoolean(java.lang.String name, boolean value)` Set a boolean value with the given name, into the Map.
`void`	`setByte(java.lang.String name, byte value)` Set a byte value with the given name, into the Map.
`void`	`setBytes(java.lang.String name, byte[] value)` Set a byte array value with the given name, into the Map.
`void`	`setBytes(java.lang.String name, byte[] value, int offset, int length)` Set a portion of the byte array value with the given name, into the Map.
`void`	`setChar(java.lang.String name, char value)` Set a Unicode character value with the given name, into the Map.
`void`	`setDouble(java.lang.String name, double value)` Set a double value with the given name, into the Map.
`void`	`setFloat(java.lang.String name, float value)` Set a float value with the given name, into the Map.
`void`	`setInt(java.lang.String name, int value)` Set an integer value with the given name, into the Map.
`void`	`setLong(java.lang.String name, long value)` Set a long value with the given name, into the Map.
`void`	`setObject(java.lang.String name, java.lang.Object value)` Set a Java object value with the given name, into the Map.
`void`	`setShort(java.lang.String name, short value)` Set a short value with the given name, into the Map.
`void`	`setString(java.lang.String name, java.lang.String value)` Set a String value with the given name, into the Map.
`protected void`	`write_lob(java.sql.Connection db_conn, java.lang.String q_table, byte[] msg_id, boolean gen_pload, boolean is_anydata_dest)`

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

clearProperties

public void clearProperties()
                     throws JMSException

Clear a message's properties.

Specified by:: clearProperties in interface Message
Overrides:: clearProperties in class AQjmsMessage

Throws:: JMSException - if JMS fails to clear JMS message properties due to some internal JMS error.

setBoolean

public void setBoolean(java.lang.String name,
                       boolean value)
                throws JMSException

Set a boolean value with the given name, into the Map.

Specified by:: setBoolean in interface MapMessage

Parameters:: name - the name of the boolean; value - the boolean value to set in the Map.
Throws:: JMSException - if JMS fails to write message due to some internal JMS error.; MessageNotWriteableException - if message in read-only mode.

setByte

public void setByte(java.lang.String name,
                    byte value)
             throws JMSException

Set a byte value with the given name, into the Map.

Specified by:: setByte in interface MapMessage

Parameters:: name - the name of the byte; value - the byte value to set in the Map.
Throws:: JMSException - if JMS fails to write message due to some internal JMS error.; MessageNotWriteableException - if message in read-only mode.

setShort

public void setShort(java.lang.String name,
                     short value)
              throws JMSException

Set a short value with the given name, into the Map.

Specified by:: setShort in interface MapMessage

Parameters:: name - the name of the short; value - the short value to set in the Map.
Throws:: JMSException - if JMS fails to write message due to some internal JMS error.; MessageNotWriteableException - if message in read-only mode.

setChar

public void setChar(java.lang.String name,
                    char value)
             throws JMSException

Set a Unicode character value with the given name, into the Map.

Specified by:: setChar in interface MapMessage

Parameters:: name - the name of the Unicode character; value - the Unicode character value to set in the Map.
Throws:: JMSException - if JMS fails to write message due to some internal JMS error.; MessageNotWriteableException - if message in read-only mode.

setDouble

public void setDouble(java.lang.String name,
                      double value)
               throws JMSException

Set a double value with the given name, into the Map.

Specified by:: setDouble in interface MapMessage

Parameters:: name - the name of the double; value - the double value to set in the Map.
Throws:: JMSException - if JMS fails to write message due to some internal JMS error.; MessageNotWriteableException - if message in read-only mode.

setFloat

public void setFloat(java.lang.String name,
                     float value)
              throws JMSException

Set a float value with the given name, into the Map.

Specified by:: setFloat in interface MapMessage

Parameters:: name - the name of the float; value - the float value to set in the Map.
Throws:: JMSException - if JMS fails to write message due to some internal JMS error.; MessageNotWriteableException - if message in read-only mode.

setInt

public void setInt(java.lang.String name,
                   int value)
            throws JMSException

Set an integer value with the given name, into the Map.

Specified by:: setInt in interface MapMessage

Parameters:: name - the name of the integer; value - the integer value to set in the Map.
Throws:: JMSException - if JMS fails to write message due to some internal JMS error.; MessageNotWriteableException - if message in read-only mode.

setLong

public void setLong(java.lang.String name,
                    long value)
             throws JMSException

Set a long value with the given name, into the Map.

Specified by:: setLong in interface MapMessage

Parameters:: name - the name of the long; value - the long value to set in the Map.
Throws:: JMSException - if JMS fails to write message due to some internal JMS error.; MessageNotWriteableException - if message in read-only mode.

setString

public void setString(java.lang.String name,
                      java.lang.String value)
               throws JMSException

Set a String value with the given name, into the Map.

Specified by:: setString in interface MapMessage

Parameters:: name - the name of the String; value - the String value to set in the Map.
Throws:: JMSException - if JMS fails to write message due to some internal JMS error.; MessageNotWriteableException - if message in read-only mode.

setObject

public void setObject(java.lang.String name,
                      java.lang.Object value)
               throws JMSException

Set a Java object value with the given name, into the Map.

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

Specified by:: setObject in interface MapMessage

Parameters:: name - the name of the Java object; value - the Java object value to set in the Map.
Throws:: JMSException - if JMS fails to write message due to some internal JMS error.; MessageFormatException - if object is invalid; MessageNotWriteableException - if message in read-only mode.

setBytes

public void setBytes(java.lang.String name,
                     byte[] value)
              throws JMSException

Set a byte array value with the given name, into the Map.

Specified by:: setBytes in interface MapMessage

Parameters:: name - the name of the byte array; value - the byte array value to set in the Map.
Throws:: JMSException - if JMS fails to write message due to some internal JMS error.; MessageNotWriteableException - if message in read-only mode.

setBytes

public void setBytes(java.lang.String name,
                     byte[] value,
                     int offset,
                     int length)
              throws JMSException

Set a portion of the byte array value with the given name, into the Map.

Specified by:: setBytes in interface MapMessage

Parameters:: name - the name of the byte array; value - the byte array value to set in the Map.; offset - the initial offset within the byte array.; length - the number of bytes to use.
Throws:: JMSException - if JMS fails to write message due to some internal JMS error.; MessageNotWriteableException - if message in read-only mode.

getBoolean

public boolean getBoolean(java.lang.String name)
                   throws JMSException

Return the boolean value with the given name.

Specified by:: getBoolean in interface MapMessage

Parameters:: name - the name of the boolean
Returns:: the boolean value with the given name.
Throws:: JMSException - if JMS fails to read message due to some internal JMS error.; MessageFormatException - if this type conversion is invalid.

getByte

public byte getByte(java.lang.String name)
             throws JMSException

Return the byte value with the given name.

Specified by:: getByte in interface MapMessage

Parameters:: name - the name of the byte
Returns:: the byte value with the given name.
Throws:: JMSException - if JMS fails to read message due to some internal JMS error.; MessageFormatException - if this type conversion is invalid.

getBytes

public byte[] getBytes(java.lang.String name)
                throws JMSException

Return the byte array value with the given name.

Specified by:: getBytes in interface MapMessage

Parameters:: name - the name of the byte array
Returns:: the byte array value with the given name. If there is no item by this name, a null value is returned.
Throws:: JMSException - if JMS fails to read message due to some internal JMS error.; MessageFormatException - if this type conversion is invalid.

getChar

public char getChar(java.lang.String name)
             throws JMSException

Return the Unicode character value with the given name.

Specified by:: getChar in interface MapMessage

Parameters:: name - the name of the Unicode character
Returns:: the Unicode character value with the given name.
Throws:: JMSException - if JMS fails to read message due to some internal JMS error.; MessageFormatException - if this type conversion is invalid.

getDouble

public double getDouble(java.lang.String name)
                 throws JMSException

Return the double value with the given name.

Specified by:: getDouble in interface MapMessage

Parameters:: name - the name of the double
Returns:: the double value with the given name.
Throws:: JMSException - if JMS fails to read message due to some internal JMS error.; MessageFormatException - if this type conversion is invalid.

getFloat

public float getFloat(java.lang.String name)
               throws JMSException

Return the float value with the given name.

Specified by:: getFloat in interface MapMessage

Parameters:: name - the name of the float
Returns:: the float value with the given name.
Throws:: JMSException - if JMS fails to read message due to some internal JMS error.; MessageFormatException - if this type conversion is invalid.

getInt

public int getInt(java.lang.String name)
           throws JMSException

Return the integer value with the given name.

Specified by:: getInt in interface MapMessage

Parameters:: name - the name of the integer
Returns:: the integer value with the given name.
Throws:: JMSException - if JMS fails to read message due to some internal JMS error.; MessageFormatException - if this type conversion is invalid.

getLong

public long getLong(java.lang.String name)
             throws JMSException

Return the long value with the given name.

Specified by:: getLong in interface MapMessage

Parameters:: name - the name of the long
Returns:: the long value with the given name.
Throws:: JMSException - if JMS fails to read message due to some internal JMS error.; MessageFormatException - if this type conversion is invalid.

getMapNames

public java.util.Enumeration getMapNames()
                                  throws JMSException

Return an Enumeration of all the Map message's names.

Specified by:: getMapNames in interface MapMessage

Returns:: an enumeration of all the names in this Map message.
Throws:: JMSException - if JMS fails to read message due to some internal JMS error.

getObject

public java.lang.Object getObject(java.lang.String name)
                           throws JMSException

Return the Java object value with the given name.

Note that this method can be used to return in objectified format, an object that had been stored in the Map with the equivalent setObject method call, or it's equivalent primitive set<type> method.

Specified by:: getObject in interface MapMessage

Parameters:: name - the name of the Java object
Returns:: the Java object value with the given name, in objectified format (ie. if it set as an int, then a Integer is returned). If there is no item by this name, a null value is returned.
Throws:: JMSException - if JMS fails to read message due to some internal JMS error.

getShort

public short getShort(java.lang.String name)
               throws JMSException

Return the short value with the given name.

Specified by:: getShort in interface MapMessage

Parameters:: name - the name of the short
Returns:: the short value with the given name.
Throws:: JMSException - if JMS fails to read message due to some internal JMS error.; MessageFormatException - if this type conversion is invalid.

getString

public java.lang.String getString(java.lang.String name)
                           throws JMSException

Description copied from interface: MapMessage

Returns the String value with the specified name.

Specified by:: getString in interface MapMessage

Parameters:: name - the name of the String
Returns:: the String value with the specified name; if there is no item by this name, a null value is returned
Throws:: JMSException - if the JMS provider fails to read the message due to some internal error.

itemExists

public boolean itemExists(java.lang.String name)
                   throws JMSException

Check if an item exists in this MapMessage.

Specified by:: itemExists in interface MapMessage

Parameters:: name - the name of the item to test
Returns:: true if the item does exist.
Throws:: JMSException - if a JMS error occurs.

clearBody

public void clearBody()
               throws JMSException

Clear out the message body. All other parts of the message are left untouched. The message can now be both read and written to.

Specified by:: clearBody in interface Message
Overrides:: clearBody in class AQjmsMessage

Throws:: JMSException - if JMS fails to due to some internal JMS error.

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

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 AQjmsMapMessage

clearProperties

setBoolean

setByte

setShort

setChar

setDouble

setFloat

setInt

setLong

setString

setObject

setBytes

setBytes

getBoolean

getByte

getBytes

getChar

getDouble

getFloat

getInt

getLong

getMapNames

getObject

getShort

getString

itemExists

clearBody

getMessageCont

closeContainer

populateMessageContainer

write_lob

oracle.jms
Class AQjmsMapMessage