<!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 class implementing javax.jms.Message
Field Summary |
Fields inherited from interface javax.jms.Message |
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE |
Method Summary | |
void |
acknowledge() Acknowlege message receipt when using the CLIENT_ACKNOWLEDGE mode |
void |
clearBody() Clear out the message body. |
void |
clearProperties() Clear a message's properties. |
protected void |
closeContainer() |
int |
getAttempts() Get the retry count for the message |
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 |
getJMSCorrelationID() Get the correlation ID for the message. |
byte[] |
getJMSCorrelationIDAsBytes() Get the correlation ID as an array of bytes for the message. |
int |
getJMSDeliveryMode() Get the delivery mode for this message. |
javax.jms.Destination |
getJMSDestination() Get the destination for this message. |
long |
getJMSExpiration() Get the message's expiration value. |
java.lang.String |
getJMSMessageID() Get the message ID. |
byte[] |
getJMSMessageIDAsBytes() Get the message ID. |
int |
getJMSPriority() Get the message priority. |
boolean |
getJMSRedelivered() Get an indication of whether this message is being redelivered. |
javax.jms.Destination |
getJMSReplyTo() Get the replyTo field for this message |
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. |
protected oracle.sql.ORAData |
getMessageCont() |
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. |
oracle.jms.AQjmsAgent |
getSenderID() Get the message's senderID. |
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. |
java.util.Enumeration |
getUserPropertyNames() Return a enumeration of user property names set on this message |
protected void |
populateMessageContainer(oracle.jdbc.OracleConnection db_conn, boolean usetemplob) |
boolean |
propertyExists(java.lang.String name) Check if a property value exists. |
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 |
setJMSCorrelationID(java.lang.String correlationID) Set the correlation ID for the message. |
void |
setJMSCorrelationIDAsBytes(byte[] correlationID) Set the correlation ID as an array of bytes for the message. |
void |
setJMSDeliveryMode(int deliveryMode) Set the delivery mode for this message. |
void |
setJMSDestination(javax.jms.Destination destination) Set the destination for this message. |
void |
setJMSExpiration(long expiration) Set the message's expiration value Providers set this field when a message is sent. |
void |
setJMSMessageID(java.lang.String id) Set the message ID. |
void |
setJMSPriority(int priority) Set the priority for this message. |
void |
setJMSRedelivered(boolean redelivered) Set to indicate whether this message is being redelivered. |
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 |
setSenderID(oracle.jms.AQjmsAgent sender) Set the message's senderID. |
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. |
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public java.lang.String getJMSMessageID() throws JMSException
getJMSMessageID
in interface Message
JMSException
- if JMS fails to get the message Id due to internal JMS error.Message.setJMSMessageID(String)
, MessageProducer.setDisableMessageID(boolean)
public byte[] getJMSMessageIDAsBytes() throws JMSException
JMSException
- if JMS fails to get the message Id due to internal JMS error.public void setJMSMessageID(java.lang.String id) throws JMSException
setJMSMessageID
in interface Message
id
- the ID of the messageJMSException
- if JMS fails to set the message Id due to internal JMS error.Message.getJMSMessageID()
public long getJMSTimestamp() throws JMSException
getJMSTimestamp
in interface Message
JMSException
- if JMS fails to get the TimestampMessage.setJMSTimestamp(long)
, MessageProducer.setDisableMessageTimestamp(boolean)
public void setJMSTimestamp(long timestamp) throws JMSException
setJMSTimestamp
in interface Message
timestamp
- the timestamp for this messageJMSException
- if JMS fails to set the timestamp due to some internal JMS error.Message.getJMSTimestamp()
public byte[] getJMSCorrelationIDAsBytes() throws JMSException
getJMSCorrelationIDAsBytes
in interface Message
JMSException
- if JMS fails to get correlationId due to some internal JMS error.Message.setJMSCorrelationID(String)
, Message.getJMSCorrelationID()
, Message.setJMSCorrelationIDAsBytes(byte[])
public void setJMSCorrelationIDAsBytes(byte[] correlationID) throws JMSException
setJMSCorrelationIDAsBytes
in interface Message
correlationID
- the correlation ID value as an array of bytes.JMSException
- if JMS fails to set correlationId due to some internal JMS error.Message.setJMSCorrelationID(String)
, Message.getJMSCorrelationID()
, Message.getJMSCorrelationIDAsBytes()
public void setJMSCorrelationID(java.lang.String correlationID) throws JMSException
setJMSCorrelationID
in interface Message
correlationID
- the message ID of a message being referred to.JMSException
- if JMS fails to set correlationId due to some internal JMS error.Message.getJMSCorrelationID()
, Message.getJMSCorrelationIDAsBytes()
, Message.setJMSCorrelationIDAsBytes(byte[])
public java.lang.String getJMSCorrelationID() throws JMSException
getJMSCorrelationID
in interface Message
JMSException
- if JMS fails to get correlationId due to some internal JMS error.Message.setJMSCorrelationID(String)
, Message.getJMSCorrelationIDAsBytes()
, Message.setJMSCorrelationIDAsBytes(byte[])
public javax.jms.Destination getJMSReplyTo() throws JMSException
getJMSReplyTo
in interface Message
JMSException
- if the JMS provider fails to get the JMSReplyTo
destination due to some internal error.Message.setJMSReplyTo(Destination)
public void setJMSReplyTo(javax.jms.Destination replyTo) throws JMSException
setJMSReplyTo
in interface Message
replyTo
- where to send a response to this message. The destination must be specified as an AQjmsAgent (with consumer_name and queue/topic address)JMSException
- if JMS fails to set ReplyTo Destination due to some internal JMS error.Message.getJMSReplyTo()
public javax.jms.Destination getJMSDestination() throws JMSException
getJMSDestination
in interface Message
JMSException
- if JMS fails to get JMS Destination due to some internal JMS error.Message.setJMSDestination(Destination)
public void setJMSDestination(javax.jms.Destination destination) throws JMSException
setJMSDestination
in interface Message
destination
- the destination for this message.JMSException
- if JMS fails to set JMS Destination due to some internal JMS error.Message.getJMSDestination()
public int getJMSDeliveryMode() throws JMSException
getJMSDeliveryMode
in interface Message
JMSException
- if JMS fails to get JMS DeliveryMode due to some internal JMS error.Message.setJMSDeliveryMode(int)
, DeliveryMode
public void setJMSDeliveryMode(int deliveryMode) throws JMSException
setJMSDeliveryMode
in interface Message
deliveryMode
- the delivery mode for this message.JMSException
- if JMS fails to set JMS DeliveryMode due to some internal JMS error.Message.getJMSDeliveryMode()
, DeliveryMode
public boolean getJMSRedelivered() throws JMSException
If a client receives a message with the redelivered indicator set, it is likely, but not guaranteed, that this message was delivered to the client earlier but the client did not commit the transaction
getJMSRedelivered
in interface Message
JMSException
- if JMS fails to get JMS Redelivered flag due to some internal JMS error.Message.setJMSRedelivered(boolean)
public void setJMSRedelivered(boolean redelivered) throws JMSException
setJMSRedelivered
in interface Message
redelivered
- an indication of whether this message is being redelivered.JMSException
- if JMS fails to set JMS Redelivered flag due to some internal JMS error.Message.getJMSRedelivered()
public java.lang.String getJMSType() throws JMSException
getJMSType
in interface Message
JMSException
- if JMS fails to get JMS message type due to some internal JMS error.Message.setJMSType(String)
public void setJMSType(java.lang.String type) throws JMSException
setJMSType
in interface Message
type
- of the messageJMSException
- if JMS fails to set JMS message type due to some internal JMS error.Message.getJMSType()
public long getJMSExpiration() throws JMSException
getJMSExpiration
in interface Message
JMSException
- if JMS fails to get JMS message expiration due to some internal JMS error.Message.setJMSExpiration(long)
public void setJMSExpiration(long expiration) throws JMSException
setJMSExpiration
in interface Message
expiration
- the message's expiration timeJMSException
- if JMS fails to set JMS message expiration due to some internal JMS error.Message.getJMSExpiration()
public int getJMSPriority() throws JMSException
getJMSPriority
in interface Message
JMSException
- if the JMS provider fails to get the message priority due to some internal error.Message.setJMSPriority(int)
public void setJMSPriority(int priority) throws JMSException
setJMSPriority
in interface Message
priority
- the priority of this messageJMSException
- if JMS fails to set JMS message priority due to some internal JMS error.Message.getJMSPriority()
public void clearProperties() throws JMSException
clearProperties
in interface Message
JMSException
- if JMS fails to clear JMS message properties due to some internal JMS error.public boolean propertyExists(java.lang.String name) throws JMSException
propertyExists
in interface Message
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
name
- the name of the boolean propertyJMSException
- if JMS fails to get PropertyMessageFormatException
- if this type conversion is invalid.public byte getByteProperty(java.lang.String name) throws JMSException
getByteProperty
in interface Message
name
- the name of the byte propertyJMSException
- if JMS fails to get PropertyMessageFormatException
- if this type conversion is invalid.public short getShortProperty(java.lang.String name) throws JMSException
getShortProperty
in interface Message
name
- the name of the short propertyJMSException
- if JMS fails to get PropertyMessageFormatException
- if this type conversion is invalid.public int getIntProperty(java.lang.String name) throws JMSException
getIntProperty
in interface Message
name
- the name of the integer propertyJMSException
- if JMS fails to get PropertyMessageFormatException
- if this type conversion is invalid.public long getLongProperty(java.lang.String name) throws JMSException
getLongProperty
in interface Message
name
- the name of the long propertyJMSException
- if JMS fails to get PropertyMessageFormatException
- if this type conversion is invalid.public float getFloatProperty(java.lang.String name) throws JMSException
getFloatProperty
in interface Message
name
- the name of the float propertyJMSException
- if JMS fails to get PropertyMessageFormatException
- if this type conversion is invalid.public double getDoubleProperty(java.lang.String name) throws JMSException
getDoubleProperty
in interface Message
name
- the name of the double propertyJMSException
- if JMS fails to get PropertyMessageFormatException
- if this type conversion is invalid.public java.lang.String getStringProperty(java.lang.String name) throws JMSException
getStringProperty
in interface Message
name
- the name of the String propertyJMSException
- if JMS fails to get PropertyMessageFormatException
- if this type conversion is invalid.public java.lang.Object getObjectProperty(java.lang.String name) throws JMSException
setObject
method call, or it's equivalent primitive set<type> method.getObjectProperty
in interface Message
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
JMSException
- if JMS fails to get Property names due to some internal JMS error.public java.util.Enumeration getUserPropertyNames() throws JMSException
JMSException
public void setBooleanProperty(java.lang.String name, boolean value) throws JMSException
setBooleanProperty
in interface Message
name
- the name of the boolean propertyvalue
- the boolean property value to set in the Message.JMSException
- if JMS fails to set PropertyMessageNotWriteableException
- if properties are read-onlypublic void setByteProperty(java.lang.String name, byte value) throws JMSException
setByteProperty
in interface Message
name
- the name of the byte propertyvalue
- the byte property value to set in the Message.JMSException
- if JMS fails to set PropertyMessageNotWriteableException
- if properties are read-onlypublic void setShortProperty(java.lang.String name, short value) throws JMSException
setShortProperty
in interface Message
name
- the name of the short propertyvalue
- the short property value to set in the Message.JMSException
- if JMS fails to set PropertyMessageNotWriteableException
- if properties are read-onlypublic void setIntProperty(java.lang.String name, int value) throws JMSException
setIntProperty
in interface Message
name
- the name of the integer propertyvalue
- the integer property value to set in the Message.JMSException
- if JMS fails to set PropertyMessageNotWriteableException
- if properties are read-onlypublic void setLongProperty(java.lang.String name, long value) throws JMSException
setLongProperty
in interface Message
name
- the name of the long propertyvalue
- the long property value to set in the Message.JMSException
- if JMS fails to set PropertyMessageNotWriteableException
- if properties are read-onlypublic void setFloatProperty(java.lang.String name, float value) throws JMSException
setFloatProperty
in interface Message
name
- the name of the float propertyvalue
- the float property value to set in the Message.JMSException
- if JMS fails to set PropertyMessageNotWriteableException
- if properties are read-onlypublic void setDoubleProperty(java.lang.String name, double value) throws JMSException
setDoubleProperty
in interface Message
name
- the name of the double propertyvalue
- the double property value to set in the Message.JMSException
- if JMS fails to set PropertyMessageNotWriteableException
- if properties are read-onlypublic void setStringProperty(java.lang.String name, java.lang.String value) throws JMSException
setStringProperty
in interface Message
name
- the name of the String propertyvalue
- the String property value to set in the Message.JMSException
- if JMS fails to set PropertyMessageNotWriteableException
- if properties are read-onlypublic void setObjectProperty(java.lang.String name, java.lang.Object value) throws JMSException
setObjectProperty
in interface Message
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 PropertyMessageFormatException
- if object is invalidMessageNotWriteableException
- if properties are read-onlypublic void acknowledge() throws JMSException
acknowledge
in interface Message
AQjmsException
- if SQL exceptions occur during transaction commitJMSException
- if the JMS provider fails to acknowledge the messages due to some internal error.Session.CLIENT_ACKNOWLEDGE
public void clearBody() throws JMSException
clearBody
in interface Message
JMSException
- if JMS fails to clear messagepublic oracle.jms.AQjmsAgent getSenderID() throws JMSException
JMSException
- if JMS fails to get SenderIDpublic void setSenderID(oracle.jms.AQjmsAgent sender) throws JMSException
JMSException
- if JMS fails to set SenderIDpublic int getAttempts() throws JMSException
JMSException
protected oracle.sql.ORAData getMessageCont()
protected void populateMessageContainer(oracle.jdbc.OracleConnection db_conn, boolean usetemplob) throws JMSException, java.sql.SQLException
JMSException
java.sql.SQLException
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
JMSException
protected void closeContainer()
|
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 |