oracle.jms

Interface AdtMessage

All Superinterfaces:

Message

All Known Implementing Classes:

AQjmsAdtMessage

public interface AdtMessage
extends Message

Adds Oracle® AI Database Advanced Queuing extensions to javax.jms.Message.
Allows use of the JMS api for messages stored in AQ queues containing Oracle ADT payloads.

Field Summary

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAdtPayload() Get the CustomDatum/ORAData object containing this Adt message's data Important: CustomDatum support will be deprecated in a future release.
void	setAdtPayload(oracle.sql.CustomDatum payload) set the CustomDatum object containing this Adt message's data Important: CustomDatum support (and hence this method) will be deprecated in a future release.
void	setAdtPayload(oracle.jdbc.OracleData payload) set the OracleData object containing this Adt message's data
void	setAdtPayload(oracle.sql.ORAData payload) set the ORAData object containing this Adt message's data

Methods inherited from interface javax.jms.Message

acknowledge, clearBody, clearProperties, 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

setAdtPayload

void setAdtPayload(oracle.sql.CustomDatum payload)
            throws JMSException

set the CustomDatum object containing this Adt message's data

Important: CustomDatum support (and hence this method) will be deprecated in a future release.

Use setAdtPayload (OracleData payload) instead.

Parameters:

payload - the message's data (the object must implement the CustomDatum interface). This payload must be a java object that represents the ADT that is defined as the queue/topic payload type

Throws:

JMSException - if JMS fails to set the adt payload

MessageNotWriteableException - if message in read-only mode.

See Also:

AdtMessage.setAdtPayload(OracleData)

setAdtPayload

void setAdtPayload(oracle.jdbc.OracleData payload)
            throws JMSException

set the OracleData object containing this Adt message's data

Parameters:

payload - the message's data (the object must implement the ORAData interface). This payload must be a java object that represents the ADT that is defined as the queue/topic payload type

Throws:

JMSException - if JMS fails to set the adt payload

MessageNotWriteableException - if message in read-only mode.

setAdtPayload

void setAdtPayload(oracle.sql.ORAData payload)
            throws JMSException

set the ORAData object containing this Adt message's data

Parameters:

payload - the message's data (the object must implement the ORAData interface). This payload must be a java object that represents the ADT that is defined as the queue/topic payload type

Throws:

JMSException - if JMS fails to set the adt payload

MessageNotWriteableException - if message in read-only mode.

getAdtPayload

java.lang.Object getAdtPayload()
                        throws JMSException

Get the CustomDatum/ORAData object containing this Adt message's data

Important: CustomDatum support will be deprecated in a future release.

Returns:

the object containing this message's data

Throws:

JMSException - if JMS fails to get object due to some internal JMS error.