AQjmsAdtMessage - Oracle 9i

Syntax

public class AQjmsAdtMessage extends AQjmsMessage implements AdtMessage

All Implemented Interfaces

AdtMessage, javax.jms.Message

Description

This class implements the AdtMessage interface. An AdtMessage is used to send a message containing Oracle object type payloads

Methods
clearBody()

public void clearBody()
Clear out the message body. All other parts of the message are left untouched.

Specified By

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

Specified By

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

Overrides

clearBody() in class AQjmsMessage

Throws

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

getAdtPayload()

public oracle.sql.CustomDatum getAdtPayload()

Get the CustomDatum object containing this Adt message's data.

Specified By

getAdtPayload() in interface AdtMessage

Returns

the object containing this message's data

Throws

JMSException - if JMS fails to get object 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

Overrides

getBooleanProperty(String) in class AQjmsMessage

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 due to some internal JMS error.
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

Overrides

getByteProperty(String) in class AQjmsMessage

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 due to some internal JMS error.
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

Overrides

getDoubleProperty(String) in class AQjmsMessage

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 due to some internal JMS error.
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

Overrides

getFloatProperty(String) in class AQjmsMessage

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 due to some internal JMS error.
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

Overrides

getIntProperty(String) in class AQjmsMessage

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 due to some internal JMS error.
MessageFormatException - if this type conversion is invalid.

getJMSReplyTo()

public javax.jms.Destination getJMSReplyTo()
Get where a reply to this message should be sent.

This method is not supported for AdtMessages in this release

Specified By

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

Overrides

getJMSReplyTo() in class AQjmsMessage

Throws

JMSException - NOT_SUPPORTED for AdtMessage

getJMSType()

public java.lang.String getJMSType()
Get the message type.

This method is not supported for AdtMessages in this release

Specified By

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

Overrides

getJMSType() in class AQjmsMessage

Returns

the message type

Throws

JMSException - NOT_SUPPORTED for AdtMessage

getLongProperty(String)

public long getLongProperty(java.lang.String name)
Return the long property value with the given name.

Specified By

Overrides

getLongProperty(String) in class AQjmsMessage

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 due to some internal JMS error.
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

Overrides

getObjectProperty(String) in class AQjmsMessage

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

Overrides

getPropertyNames() in class AQjmsMessage

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.

getShortProperty(String)

public short getShortProperty(java.lang.String name)
Return the short property value with the given name.

Specified By

Overrides

getShortProperty(String) in class AQjmsMessage

Parameters

name - the name of the short property

Returns

short property value with the given name.

Throws

JMSException - if JMS fails to get Property due to some internal JMS error.
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

Overrides

getStringProperty(String) in class AQjmsMessage

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 due to some internal JMS error.
MessageFormatException - if this type conversion is invalid.

propertyExists(String)

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

Specified By

Overrides

propertyExists(String) in class AQjmsMessage

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.

setAdtPayload(CustomDatum)

public void setAdtPayload(oracle.sql.CustomDatum payload)
set the CustomDatum object containing this Adt message's data

Specified By

setAdtPayload(CustomDatum) in interface AdtMessage

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.

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

Overrides

setBooleanProperty(String, boolean) in class AQjmsMessage

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 due to some internal JMS error.
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

Overrides

setByteProperty(String, byte) in class AQjmsMessage

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 due to some internal JMS error.
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

Overrides

setDoubleProperty(String, double) in class AQjmsMessage

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 due to some internal JMS error.
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

Overrides

setFloatProperty(String, float) in class AQjmsMessage

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 due to some internal JMS error.
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

Overrides

setItProperty(String, int) in class AQjmsMessage

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 due to some internal JMS error.
MessageNotWriteableException - if properties are read-only

setJMSReplyTo(Destination)

Public void setJMSReplyTo(javax.jms.Destination replyTo)
Set where a reply to this message should be sent.

This method is not supported for AdtMessage in this release

Specified By

Overrides

GetJMSReplyTo(Destination) in class AQjmsMessage

Throws

JMSException - NOT_SUPPORTED for AdtMessage

setJMSType(String)

This method is not supported for AdtMessages in this release

Specified By

Overrides

setJMSType(String) in class AQjmsMessage

Parameters

type - of the message

Throws

MSException - NOT_SUPPORTED for AdtMessage

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

Overrides

getLongProperty(String, long) in class AQjmsMessage 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 due to some internal JMS error. 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.

Specified By

Overrides

setObjectProperty(String, Object) in class AQjmsMessage

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 due to some internal JMS error.
MessageFormatException - if object is invalid
MessageNotWriteableException - if properties are read-only

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

Overrides

setShortProperty(String, short) in class AQjmsMessage

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 due to some internal JMS error.
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

Overrides

setStringProperty(String, String) in class AQjmsMessage

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 due to some internal JMS error.
MessageNotWriteableException - if properties are read-only

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

Oracle 9i Topics