AQjmsMessage - Oracle 9i

Syntax

Direct Known Subclasses

AQjmsAdtMessage, AQjmsBytesMessage, AQjmsMapMessage,
AQjmsObjectMessage, AQjmsStreamMessage, AQjmsTextMessage

All Implemented Interfaces

javax.jms.Message

Description

This class implements the Message interface. This is the superclass of all JMS messages

AQjmsMessageAQjmsMessageAQjmsMessageAQjmsMessage

Fields inherited from interface javax.jms.Message

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

Specified By

javax.jms.Message.clearBody() in interface javax.jms.Message

Throws

JMSException - if JMS fails to clear message

clearProperties()

public void clearProperties()

Clear a message's properties.

Specified By

javax.jms.Message.clearProperties() in interface javax.jms.Message

Throws

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

getBooleanProperty(String)

public boolean getBooleanProperty(java.lang.String name)

Return the boolean property value with the given name.

Specified By

javax.jms.Message.getBooleanProperty (java.lang.String) in interface javax.jms.Message

Parameters

name - the name of the boolean property

Returns
the boolean property value with the given name.

Throws

JMSException - if JMS fails to get Property MessageFormatException - if this type conversion is invalid.

getByteProperty(String)

public byte getByteProperty(java.lang.String name)

Return the byte property value with the given name.

Specified By

javax.jms.Message.getByteProperty (java.lang.String) in interface javax.jms.Message

Parameters

name - the name of the byte property

Returns
the byte property value with the given name.

Throws

JMSException - if JMS fails to get Property MessageFormatException - if this type conversion is invalid.

getDoubleProperty(String)

public double getDoubleProperty(java.lang.String name)

Return the double property value with the given name.

Specified By
javax.jms.Message.getDoubleProperty(java.lang.String) in interface javax.jms.Message

Parameters

name - the name of the double property

Returns
the double property value with the given name.

Throws

JMSException - if JMS fails to get Property MessageFormatException - if this type conversion is invalid.

getFloatProperty(String)

public float getFloatProperty(java.lang.String name)

Return the float property value with the given name.

Specified By

javax.jms.Message.getFloatProperty (java.lang.String) in interface javax.jms.Message

Parameters

name - the name of the float property

Returns
the float property value with the given name.

Throws

JMSException - if JMS fails to get Property MessageFormatException - if this type conversion is invalid.

getIntProperty(String)

public int getIntProperty(java.lang.String name)

Return the integer property value with the given name.

Specified By

javax.jms.Message.getIntProperty (java.lang.String) in interface javax.jms.Message

Parameters

name - the name of the integer property

Returns
the integer property value with the given name.

Throws

JMSException - if JMS fails to get Property MessageFormatException - if this type conversion is invalid.

getJMSCorrelationID()

public java.lang.String getJMSCorrelationID()

Get the correlation ID for the message.

Specified By

javax.jms.Message.getJMSCorrelationID() in interface javax.jms.Message

Returns
the correlation ID of a message as a String.

Throws

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

getJMSCorrelationIDAsBytes()

public byte[] getJMSCorrelationIDAsBytes()

Get the correlation ID as an array of bytes for the message.

Specified By

javax.jms.Message.getJMSCorrelationIDAsBytes() in interface javax.jms.Message

Returns
the correlation ID of a message as an array of bytes.

Throws

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

getJMSDeliveryMode()

public int getJMSDeliveryMode()

Get the delivery mode for this message.

Specified By

javax.jms.Message.getJMSDeliveryMode() in interface javax.jms.Message

Returns
the delivery mode of this message. In the current version this will always return
DeliveryMode.PERSISTENT

Throws

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

getJMSDestination()

public javax.jms.Destination getJMSDestination()

Get the destination for this message. The destination field contains the destination to which the message is being sent. When a message is sent this value is ignored. After completion of the send method it holds the destination specified by the send. When a message is received, its destination value must be equivalent to the value assigned when it was sent.

Specified By

javax.jms.Message.getJMSDestination() in interface javax.jms.Message

Returns
the destination of this message.

Throws

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

getJMSExpiration()

public long getJMSExpiration()

Get the message's expiration value. When a message is sent, expiration is left unassigned. After completion of the send method, it holds the expiration time of the message. This is the sum of the time-to-live value specified by the client and the GMT at the time of the send. If the time-to-live is specified as zero, expiration is set to zero which indicates the message does not expire. When a message's expiration time is reached, the message is moved to the exception queue corresponding to the destination queue/topic

Specified By

javax.jms.Message.getJMSExpiration() in interface javax.jms.Message

Returns
the time the message expires. It is the sum of the time-to-live value specified by the client, and the GMT at the time of the send.

Throws

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

See Also

javax.jms.Message#setJMSExpiration()

getJMSMessageID()

public java.lang.String getJMSMessageID()

Get the message ID. The messageID header field contains a value that uniquely identifies each message sent by a provider. When the send method returns it contains a provider-assigned value. All JMSMessageID string values start with the prefix `ID:'

Specified By

javax.jms.Message.getJMSMessageID() in interface javax.jms.Message

Returns
the message ID as a string (prefixed with 'ID:')

Throws

JMSException - if JMS fails to get the message Id due to internal JMS error.

getJMSMessageIDAsBytes()

public byte[] getJMSMessageIDAsBytes()

Get the message ID.

Returns
the message ID as a byte array

Throws

JMSException - if JMS fails to get the message Id due to internal JMS error.

getJMSPriority()

public int getJMSPriority()

Get the message priority. JMS defines a ten level priority value with 0 as the lowest priority and 9 as the highest.

Specified By

javax.jms.Message.getJMSPriority() in interface javax.jms.Message

Returns
the default message priority

getJMSRedelivered()

public boolean getJMSRedelivered()

Get an indication of whether this message is being redelivered.
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

Specified By

javax.jms.Message.getJMSRedelivered() in interface javax.jms.Message

Returns
set to true if this message is being redelivered.

Throws

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

getJMSReplyTo()

public javax.jms.Destination getJMSReplyTo()

Get the replyTo field for this message

Specified By

javax.jms.Message.getJMSReplyTo() in interface javax.jms.Message

Returns
replyTo destination (the format is a AQjmsAgent)

getJMSTimestamp()

public long getJMSTimestamp()

Get the message timestamp. The JMSTimestamp header field contains the time a message was handed off to a provider to be sent. When a message is sent, JMSTimestamp is ignored. When the send is complete - this method will contain the time the message was enqueued.

Specified By

javax.jms.Message.getJMSTimestamp() in interface javax.jms.Message

Throws

JMSException - if JMS fails to get the Timestamp

getJMSType()

public java.lang.String getJMSType()

Get the message type.

Specified By

javax.jms.Message.getJMSType() in interface javax.jms.Message

Returns
the message type

Throws

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

getLongProperty(String)

public long getLongProperty(java.lang.String name)

Return the long property value with the given name.

Specified By
javax.jms.Message.getLongProperty(java.lang.String) in interface javax.jms.Message

Parameters

name - the name of the long property

Returns
the long property value with the given name.

Throws

JMSException - if JMS fails to get Property MessageFormatException - if this type conversion is invalid

getObjectProperty(String)

public java.lang.Object getObjectProperty(java.lang.String name)

Return the Java object property value with the given name. 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 method.

Specified By
javax.jms.Message.getObjectProperty(java.lang.String) in interface javax.jms.Message

Parameters

name - the name of the Java object property

Returns
the Java object property value with the given name, in objectified format (i.e. if it set as an int, then a Integer is returned). If there is no property by this name, a null value is returned.

Throws

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

getPropertyNames()

public synchronized java.util.Enumeration getPropertyNames()

Return an Enumeration of all the property names.

Specified By

javax.jms.Message.getPropertyNames() in interface javax.jms.Message

Returns
an enumeration of all the names of property values.

Throws

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

getSenderID()

public AQjmsAgent getSenderID()

Get the message's senderID. This value is available only if it was set by the sender before sending the message

Throws

JMSException - if JMS fails to get SenderID

getShortProperty(String)

public short getShortProperty(java.lang.String name)

Return the short property value with the given name.

Specified By
javax.jms.Message.getShortProperty(java.lang.String) in interface javax.jms.Message

Parameters

name - the name of the short property

Returns
the short property value with the given name.

Throws

JMSException - if JMS fails to get Property MessageFormatException - if this type conversion is invalid.

getStringProperty(String)

public java.lang.String getStringProperty(java.lang.String name)

Return the String property value with the given name.

Specified By
javax.jms.Message.getStringProperty(java.lang.String) in interface javax.jms.Message

Parameters

name - the name of the String property

Returns
the String property value with the given name. If there is no property by this name, a null value is returned.

Throws

JMSException - if JMS fails to get Property MessageFormatException - if this type conversion is invalid.

propertyExists(String)

public boolean propertyExists(java.lang.String name) Check if a property value exists.

Specified By
javax.jms.Message.propertyExists(java.lang.String) in interface javax.jms.Message

Parameters

name - the name of the property to test

Returns
true if the property does exist.

Throws

JMSException - if JMS fails to check if property exists due to some internal JMS error.

setBooleanProperty(String, boolean)

public void setBooleanProperty (java.lang.String name, boolean value)

Set a boolean property value with the given name, into the Message.

Specified By

javax.jms.Message.setBooleanProperty (java.lang.String, boolean) in interface javax.jms.Message

Parameters

name - the name of the boolean property value - the boolean property value to set in the Message.

Throws

JMSException - if JMS fails to set Property MessageNotWriteableException - if properties are read-only

setByteProperty(String, byte)

public void setByteProperty(java.lang.String name, byte value)

Set a byte property value with the given name, into the Message.

Specified By

javax.jms.Message.setByteProperty (java.lang.String, byte) in interface javax.jms.Message

Parameters

name - the name of the byte property value - the byte property value to set in the Message.

Throws

JMSException - if JMS fails to set Property MessageNotWriteableException - if properties are read-only

setDoubleProperty(String, double)

public void setDoubleProperty(java.lang.String name, double value)

Set a double property value with the given name, into the Message.

Specified By

javax.jms.Message.setDoubleProperty (java.lang.String, double) in interface javax.jms.Message

Parameters

name - the name of the double property value - the double property value to set in the Message.

Throws

JMSException - if JMS fails to set Property MessageNotWriteableException - if properties are read-only

setFloatProperty(String, float)

public void setFloatProperty(java.lang.String name, float value)

Set a float property value with the given name, into the Message.

Specified By
javax.jms.Message.setFloatProperty(java.lang.String, float) in interface javax.jms.Message

Parameters

name - the name of the float property value - the float property value to set in the Message.

Throws

JMSException - if JMS fails to set Property MessageNotWriteableException - if properties are read-only

setIntProperty(String, int)

public void setIntProperty(java.lang.String name, int value)

Set an integer property value with the given name, into the Message.

Specified By

javax.jms.Message.setIntProperty (java.lang.String, int) in interface javax.jms.Message

Parameters

name - the name of the integer property value - the integer property value to set in the Message.

Throws

JMSException - if JMS fails to set Property MessageNotWriteableException - if properties are read-only

setJMSCorrelationID(String)

public void setJMSCorrelationID(java.lang.String correlationID)

Set the correlation ID for the message. A client can use the JMSCorrelationID header field to link one message with another.

Specified By

javax.jms.Message.setJMSCorrelationID (java.lang.String) in interface javax.jms.Message

Parameters
correlationID - the message ID of a message being referred to.

Throws

JMSException - if JMS fails to set correlationId due to some internal JMS error.

setJMSCorrelationIDAsBytes(byte[])

public void setJMSCorrelationIDAsBytes(byte[] correlationID)

Set the correlation ID as an array of bytes for the message.

Specified By

javax.jms.Message.setJMSCorrelationIDAsBytes(byte[]) in interface javax.jms.Message

Parameters

correlationID - the correlation ID value as an array of bytes.

Throws

JMSException - if JMS fails to set correlationId due to some internal JMS error.

setJMSDestination(Destination)

public void setJMSDestination(javax.jms.Destination destination)

Set the destination for this message. Providers set this field when a message is sent.

Specified By

javax.jms.Message.setJMSDestination (javax.jms.Destination) in interface javax.jms.Message

Parameters

destination - the destination for this message.

Throws

JMSException - if JMS fails to set JMS Destination due to some internal JMS error.

setJMSExpiration(long)

public void setJMSExpiration(long expiration)

Set the message's expiration value Providers set this field when a message is sent.

Specified By

javax.jms.Message.setJMSExpiration(long) in interface javax.jms.Message

Parameters

expiration - the message's expiration time

Throws

JMSException - if JMS fails to set JMS message expiration due to some internal JMS error.

setJMSMessageID(String)

public void setJMSMessageID(java.lang.String id)

Set the message ID. Providers set this field when a message is sent.

Specified By

javax.jms.Message.setJMSMessageID (java.lang.String) in interface javax.jms.Message

Parameters

id - the ID of the message

Throws

JMSException - if JMS fails to set the message Id due to internal JMS error.

setJMSPriority(int)

public void setJMSPriority(int priority)

Set the priority for this message. Providers set this field when a message is sent.

Specified By

javax.jms.Message.setJMSPriority(int) in interface javax.jms.Message

Parameters

priority - the priority of this message

Throws

JMSException - if JMS fails to set JMS message priority due to some internal JMS error.

setJMSRedelivered(boolean)

public void setJMSRedelivered(boolean redelivered)

Set to indicate whether this message is being redelivered. This field is set at the time the message is delivered.

Specified By

javax.jms.Message.setJMSRedelivered(boolean) in interface javax.jms.Message

Parameters

redelivered - an indication of whether this message is being redelivered.

Throws

JMSException - if JMS fails to set JMS Redelivered flag due to some internal JMS error.

setJMSReplyTo(Destination)

public void setJMSReplyTo(javax.jms.Destination replyTo)

Set where a reply to this message should be sent.

Specified By

javax.jms.Message.setJMSReplyTo (javax.jms.Destination) in interface javax.jms.Message

Parameters

replyTo - where to send a response to this message. The destination must be specified as an AQjmsAgent (with consumer_name and queue/topic address)

Throws

JMSException - if JMS fails to set ReplyTo Destination due to some internal JMS error.

setJMSTimestamp(long)

public void setJMSTimestamp(long timestamp)

Set the message timestamp. Providers set this field when a message is sent.

Specified By

javax.jms.Message.setJMSTimestamp (long) in interface javax.jms.Message

Parameters

timestamp - the timestamp for this message

Throws

JMSException - if JMS fails to set the timestamp due to some internal JMS error.

setJMSType(String)

public void setJMSType(java.lang.String type)

Set the message type.

Specified By

javax.jms.Message.setJMSType (java.lang.String) in interface javax.jms.Message

Parameters

type - of the message

Throws

JMSException - if JMS fails to set JMS message type due to some internal JMS error.

setLongProperty(String, long)

public void setLongProperty(java.lang.String name, long value)

Set a long property value with the given name, into the Message.

Specified By

javax.jms.Message.setLongProperty (java.lang.String, long) in interface javax.jms.Message

Parameters

name - the name of the long property value - the long property value to set in the Message.

Throws

JMSException - if JMS fails to set Property MessageNotWriteableException - if properties are read-only

setObjectProperty(String, Object)

public void setObjectProperty(java.lang.String name, java.lang.Object value)

Set a Java object property value with the given name, into the Message. Note that this method only works for the objectified primitive object types (Integer, Double, Long ...) and String's.

Specified By

javax.jms.Message.setObjectProperty (java.lang.String, java.lang.Object) in interface javax.jms.Message

Parameters

name - the name of the Java object property. value - the Java object property value to set in the Message.

Throws

JMSException - if JMS fails to set Property MessageFormatException - if object is invalid MessageNotWriteableException - if properties are read-only

setSenderID(AQjmsAgent)

public void setSenderID(AQjmsAgent sender)

Set the message's senderID.

Throws
JMSException - if JMS fails to set SenderID

setShortProperty(String, short)

public void setShortProperty(java.lang.String name, short value)

Set a short property value with the given name, into the Message.

Specified By
javax.jms.Message.setShortProperty(java.lang.String, short) in interface javax.jms.Message

Parameters

name - the name of the short property value - the short property value to set in the Message.

Throws

JMSException - if JMS fails to set Property MessageNotWriteableException - if properties are read-only

setStringProperty(String, String)

public void setStringProperty(java.lang.String name, java.lang.String value)

Set a String property value with the given name, into the Message.

Specified By

javax.jms.Message.setStringProperty (java.lang.String, java.lang.String) in interface javax.jms.Message

Parameters

name - the name of the String property value - the String property value to set in the Message.

Throws

JMSException - if JMS fails to set Property MessageNotWriteableException - if properties are read-only

All rights reserved © 2018 Wisdom IT Services India Pvt. Ltd DMCA.com Protection Status

Oracle 9i Topics