<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
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 |
java.lang.Object | +--oracle.jms.AQjmsMessage | +--oracle.jms.AQjmsAdtMessage
Oracle class implementing oracle.jms.AdtMessage 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 | |
void |
clearBody() Clear out the message body. |
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. |
boolean |
getBooleanProperty(java.lang.String name) Return the boolean property value with the given name. |
byte |
getByteProperty(java.lang.String name) Return the byte property value with the given name. |
double |
getDoubleProperty(java.lang.String name) Return the double property value with the given name. |
float |
getFloatProperty(java.lang.String name) Return the float property value with the given name. |
int |
getIntProperty(java.lang.String name) Return the integer property value with the given name. |
java.lang.String |
getJMSMessageID() Get the message ID. |
javax.jms.Destination |
getJMSReplyTo() Get where a reply to this message should be sent. |
long |
getJMSTimestamp() Get the message timestamp. |
java.lang.String |
getJMSType() Get the message type. |
long |
getLongProperty(java.lang.String name) Return the long property value with the given name. |
java.lang.Object |
getObjectProperty(java.lang.String name) Return the Java object property value with the given name. |
java.util.Enumeration |
getPropertyNames() Return an Enumeration of all the property names. |
short |
getShortProperty(java.lang.String name) Return the short property value with the given name. |
java.lang.String |
getStringProperty(java.lang.String name) Return the String property value with the given name. |
boolean |
propertyExists(java.lang.String name) Check if a property value exists. |
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.sql.ORAData payload) set the ORAData object containing this Adt message's data |
void |
setBooleanProperty(java.lang.String name, boolean value) Set a boolean property value with the given name, into the Message. |
void |
setByteProperty(java.lang.String name, byte value) Set a byte property value with the given name, into the Message. |
void |
setDoubleProperty(java.lang.String name, double value) Set a double property value with the given name, into the Message. |
void |
setFloatProperty(java.lang.String name, float value) Set a float property value with the given name, into the Message. |
void |
setIntProperty(java.lang.String name, int value) Set an integer property value with the given name, into the Message. |
void |
setJMSReplyTo(javax.jms.Destination replyTo) Set where a reply to this message should be sent. |
void |
setJMSTimestamp(long timestamp) Set the message timestamp. |
void |
setJMSType(java.lang.String type) Set the message type. |
void |
setLongProperty(java.lang.String name, long value) Set a long property value with the given name, into the Message. |
void |
setObjectProperty(java.lang.String name, java.lang.Object value) Set a Java object property value with the given name, into the Message. |
void |
setShortProperty(java.lang.String name, short value) Set a short property value with the given name, into the Message. |
void |
setStringProperty(java.lang.String name, java.lang.String value) Set a String property value with the given name, into the Message. |
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, clearProperties, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSPriority, getJMSRedelivered, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered |
Method Detail |
public java.lang.String getJMSMessageID() throws JMSException
getJMSMessageID
in interface Message
getJMSMessageID
in class AQjmsMessage
JMSException
- if JMS fails to get the message Id due to internal JMS error.Message.setJMSMessageID(String)
, MessageProducer.setDisableMessageID(boolean)
public javax.jms.Destination getJMSReplyTo() throws JMSException
getJMSReplyTo
in interface Message
getJMSReplyTo
in class AQjmsMessage
Destination
to which to send a response to this messageJMSException
- NOT_SUPPORTED for AdtMessageMessage.setJMSReplyTo(Destination)
public void setJMSReplyTo(javax.jms.Destination replyTo) throws JMSException
setJMSReplyTo
in interface Message
setJMSReplyTo
in class AQjmsMessage
replyTo
- Destination
to which to send a response to this messageJMSException
- NOT_SUPPORTED for AdtMessageMessage.getJMSReplyTo()
public java.lang.String getJMSType() throws JMSException
getJMSType
in interface Message
getJMSType
in class AQjmsMessage
JMSException
- NOT_SUPPORTED for AdtMessageMessage.setJMSType(String)
public void setJMSType(java.lang.String type) throws JMSException
setJMSType
in interface Message
setJMSType
in class AQjmsMessage
type
- of the messageJMSException
- NOT_SUPPORTED for AdtMessageMessage.getJMSType()
public long getJMSTimestamp() throws JMSException
getJMSTimestamp
in interface Message
getJMSTimestamp
in class AQjmsMessage
JMSException
- if JMS fails to get the TimestampMessage.setJMSTimestamp(long)
, MessageProducer.setDisableMessageTimestamp(boolean)
public void setJMSTimestamp(long timestamp) throws JMSException
setJMSTimestamp
in interface Message
setJMSTimestamp
in class AQjmsMessage
timestamp
- the timestamp for this messageJMSException
- if JMS fails to set the timestamp due to some internal JMS error.Message.getJMSTimestamp()
public boolean propertyExists(java.lang.String name) throws JMSException
propertyExists
in interface Message
propertyExists
in class AQjmsMessage
name
- the name of the property to testJMSException
- if JMS fails to check if property exists due to some internal JMS error.public boolean getBooleanProperty(java.lang.String name) throws JMSException
getBooleanProperty
in interface Message
getBooleanProperty
in class AQjmsMessage
name
- the name of the boolean propertyJMSException
- if JMS fails to get Property due to some internal JMS error.MessageFormatException
- if this type conversion is invalid.public byte getByteProperty(java.lang.String name) throws JMSException
getByteProperty
in interface Message
getByteProperty
in class AQjmsMessage
name
- the name of the byte propertyJMSException
- if JMS fails to get Property due to some internal JMS error.MessageFormatException
- if this type conversion is invalid.public short getShortProperty(java.lang.String name) throws JMSException
getShortProperty
in interface Message
getShortProperty
in class AQjmsMessage
name
- the name of the short propertyJMSException
- if JMS fails to get Property due to some internal JMS error.MessageFormatException
- if this type conversion is invalid.public int getIntProperty(java.lang.String name) throws JMSException
getIntProperty
in interface Message
getIntProperty
in class AQjmsMessage
name
- the name of the integer propertyJMSException
- if JMS fails to get Property due to some internal JMS error.MessageFormatException
- if this type conversion is invalid.public long getLongProperty(java.lang.String name) throws JMSException
getLongProperty
in interface Message
getLongProperty
in class AQjmsMessage
name
- the name of the long propertyJMSException
- if JMS fails to get Property due to some internal JMS error.MessageFormatException
- if this type conversion is invalid.public float getFloatProperty(java.lang.String name) throws JMSException
getFloatProperty
in interface Message
getFloatProperty
in class AQjmsMessage
name
- the name of the float propertyJMSException
- if JMS fails to get Property due to some internal JMS error.MessageFormatException
- if this type conversion is invalid.public double getDoubleProperty(java.lang.String name) throws JMSException
getDoubleProperty
in interface Message
getDoubleProperty
in class AQjmsMessage
name
- the name of the double propertyJMSException
- if JMS fails to get Property due to some internal JMS error.MessageFormatException
- if this type conversion is invalid.public java.lang.String getStringProperty(java.lang.String name) throws JMSException
getStringProperty
in interface Message
getStringProperty
in class AQjmsMessage
name
- the name of the String propertyJMSException
- if JMS fails to get Property due to some internal JMS error.MessageFormatException
- if this type conversion is invalid.public java.lang.Object getObjectProperty(java.lang.String name) throws JMSException
Note that this method can be used to return in objectified format, an object that had been stored as a property in the Message with the equivalent setObject
method call, or it's equivalent primitive set<type> method.
getObjectProperty
in interface Message
getObjectProperty
in class AQjmsMessage
name
- the name of the Java object propertyJMSException
- if JMS fails to get Property due to some internal JMS error.public java.util.Enumeration getPropertyNames() throws JMSException
getPropertyNames
in interface Message
getPropertyNames
in class AQjmsMessage
JMSException
- if JMS fails to get Property names due to some internal JMS error.public void setBooleanProperty(java.lang.String name, boolean value) throws JMSException
setBooleanProperty
in interface Message
setBooleanProperty
in class AQjmsMessage
name
- the name of the boolean propertyvalue
- the boolean property value to set in the Message.JMSException
- if JMS fails to set Property due to some internal JMS error.MessageNotWriteableException
- if properties are read-onlypublic void setByteProperty(java.lang.String name, byte value) throws JMSException
setByteProperty
in interface Message
setByteProperty
in class AQjmsMessage
name
- the name of the byte propertyvalue
- the byte property value to set in the Message.JMSException
- if JMS fails to set Property due to some internal JMS error.MessageNotWriteableException
- if properties are read-onlypublic void setShortProperty(java.lang.String name, short value) throws JMSException
setShortProperty
in interface Message
setShortProperty
in class AQjmsMessage
name
- the name of the short propertyvalue
- the short property value to set in the Message.JMSException
- if JMS fails to set Property due to some internal JMS error.MessageNotWriteableException
- if properties are read-onlypublic void setIntProperty(java.lang.String name, int value) throws JMSException
setIntProperty
in interface Message
setIntProperty
in class AQjmsMessage
name
- the name of the integer propertyvalue
- the integer property value to set in the Message.JMSException
- if JMS fails to set Property due to some internal JMS error.MessageNotWriteableException
- if properties are read-onlypublic void setLongProperty(java.lang.String name, long value) throws JMSException
setLongProperty
in interface Message
setLongProperty
in class AQjmsMessage
name
- the name of the long propertyvalue
- the long property value to set in the Message.JMSException
- if JMS fails to set Property due to some internal JMS error.MessageNotWriteableException
- if properties are read-onlypublic void setFloatProperty(java.lang.String name, float value) throws JMSException
setFloatProperty
in interface Message
setFloatProperty
in class AQjmsMessage
name
- the name of the float propertyvalue
- the float property value to set in the Message.JMSException
- if JMS fails to set Property due to some internal JMS error.MessageNotWriteableException
- if properties are read-onlypublic void setDoubleProperty(java.lang.String name, double value) throws JMSException
setDoubleProperty
in interface Message
setDoubleProperty
in class AQjmsMessage
name
- the name of the double propertyvalue
- the double property value to set in the Message.JMSException
- if JMS fails to set Property due to some internal JMS error.MessageNotWriteableException
- if properties are read-onlypublic void setStringProperty(java.lang.String name, java.lang.String value) throws JMSException
setStringProperty
in interface Message
setStringProperty
in class AQjmsMessage
name
- the name of the String propertyvalue
- the String property value to set in the Message.JMSException
- if JMS fails to set Property due to some internal JMS error.MessageNotWriteableException
- if properties are read-onlypublic void setObjectProperty(java.lang.String name, java.lang.Object value) throws JMSException
Note that this method only works for the objectified primitive object types (Integer, Double, Long ...) and String's.
setObjectProperty
in interface Message
setObjectProperty
in class AQjmsMessage
name
- the name of the Java object property.value
- the Java object property value to set in the Message.JMSException
- if JMS fails to set Property due to some internal JMS error.MessageFormatException
- if object is invalidMessageNotWriteableException
- if properties are read-onlypublic void clearBody() throws JMSException
clearBody
in interface Message
clearBody
in class AQjmsMessage
JMSException
- if JMS fails to due to some internal JMS error.public void setAdtPayload(oracle.sql.CustomDatum payload) throws JMSException
AdtMessage
Important: CustomDatum support (and hence this method) will be deprecated in a future release.
Use setAdtPayload (ORAData payload) instead.
setAdtPayload
in interface AdtMessage
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 typeJMSException
- if JMS fails to set the adt payloadAdtMessage.setAdtPayload(ORAData)
public void setAdtPayload(oracle.sql.ORAData payload) throws JMSException
AdtMessage
setAdtPayload
in interface AdtMessage
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 typeJMSException
- if JMS fails to set the adt payloadpublic java.lang.Object getAdtPayload() throws JMSException
AdtMessage
Important: CustomDatum support will be deprecated in a future release.
getAdtPayload
in interface AdtMessage
JMSException
- if JMS fails to get object due to some internal JMS error.
|
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 |