|
Joram ${version} | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.objectweb.joram.client.jms.Message
Implements the javax.jms.Message
interface.
A Joram message wraps a proprietary MOM message which is actually the effective MOM transport facility for the JMS operations.
Field Summary | |
protected Message |
momMsg
The wrapped MOM message. |
protected Session |
sess
If the message is actually consumed, the session that consumes it, null otherwise. |
Fields inherited from interface javax.jms.Message |
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE |
Method Summary | |
void |
acknowledge()
API method. |
void |
clearBody()
API method. |
void |
clearProperties()
API method. |
boolean |
getBooleanProperty(java.lang.String name)
API method. |
byte |
getByteProperty(java.lang.String name)
API method. |
double |
getDoubleProperty(java.lang.String name)
API method. |
float |
getFloatProperty(java.lang.String name)
API method. |
int |
getIntProperty(java.lang.String name)
API method. |
java.lang.String |
getJMSCorrelationID()
API method. |
byte[] |
getJMSCorrelationIDAsBytes()
API method. |
int |
getJMSDeliveryMode()
API method. |
javax.jms.Destination |
getJMSDestination()
API method. |
long |
getJMSExpiration()
API method. |
java.lang.String |
getJMSMessageID()
API method. |
int |
getJMSPriority()
API method. |
boolean |
getJMSRedelivered()
API method. |
javax.jms.Destination |
getJMSReplyTo()
API method. |
long |
getJMSTimestamp()
API method. |
java.lang.String |
getJMSType()
API method. |
long |
getLongProperty(java.lang.String name)
API method. |
java.lang.Object |
getObjectProperty(java.lang.String name)
API method. |
java.util.Enumeration |
getPropertyNames()
API method. |
short |
getShortProperty(java.lang.String name)
API method. |
java.lang.String |
getStringProperty(java.lang.String name)
API method. |
protected void |
prepare()
Method preparing the message for sending; resets header values, and serializes the body (done in subclasses). |
boolean |
propertyExists(java.lang.String name)
API method. |
void |
setBooleanProperty(java.lang.String name,
boolean value)
API method. |
void |
setByteProperty(java.lang.String name,
byte value)
API method. |
void |
setDoubleProperty(java.lang.String name,
double value)
API method. |
void |
setFloatProperty(java.lang.String name,
float value)
API method. |
void |
setIntProperty(java.lang.String name,
int value)
API method. |
void |
setJMSCorrelationID(java.lang.String correlationID)
API method. |
void |
setJMSCorrelationIDAsBytes(byte[] correlationID)
API method. |
void |
setJMSDeliveryMode(int deliveryMode)
API method. |
void |
setJMSDestination(javax.jms.Destination dest)
API method. |
void |
setJMSExpiration(long expiration)
API method. |
void |
setJMSMessageID(java.lang.String id)
API method. |
void |
setJMSPriority(int priority)
API method. |
void |
setJMSRedelivered(boolean redelivered)
API method. |
void |
setJMSReplyTo(javax.jms.Destination replyTo)
API method. |
void |
setJMSTimestamp(long timestamp)
API method. |
void |
setJMSType(java.lang.String type)
API method. |
void |
setLongProperty(java.lang.String name,
long value)
API method. |
void |
setObjectProperty(java.lang.String name,
java.lang.Object value)
API method. |
void |
setShortProperty(java.lang.String name,
short value)
API method. |
void |
setStringProperty(java.lang.String name,
java.lang.String value)
API method. |
static Message |
wrapMomMessage(Session sess,
Message momMsg)
Wraps a given MOM message in the appropriate Joram message. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected Message momMsg
protected Session sess
null
otherwise.
Method Detail |
public void acknowledge() throws javax.jms.JMSException
acknowledge
in interface javax.jms.Message
javax.jms.IllegalStateException
- If the session is closed.
javax.jms.JMSException
- If the acknowledgement fails for any other
reason.public void clearBody() throws javax.jms.JMSException
clearBody
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public void clearProperties() throws javax.jms.JMSException
clearProperties
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public boolean propertyExists(java.lang.String name) throws javax.jms.JMSException
propertyExists
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public java.util.Enumeration getPropertyNames() throws javax.jms.JMSException
getPropertyNames
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public void setJMSMessageID(java.lang.String id) throws javax.jms.JMSException
setJMSMessageID
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public void setJMSPriority(int priority) throws javax.jms.JMSException
setJMSPriority
in interface javax.jms.Message
javax.jms.JMSException
- If the priority value is incorrect.public void setJMSDestination(javax.jms.Destination dest) throws javax.jms.JMSException
setJMSDestination
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public void setJMSExpiration(long expiration) throws javax.jms.JMSException
setJMSExpiration
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public void setJMSRedelivered(boolean redelivered) throws javax.jms.JMSException
setJMSRedelivered
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public void setJMSReplyTo(javax.jms.Destination replyTo) throws javax.jms.JMSException
setJMSReplyTo
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public void setJMSTimestamp(long timestamp) throws javax.jms.JMSException
setJMSTimestamp
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public void setJMSCorrelationID(java.lang.String correlationID) throws javax.jms.JMSException
setJMSCorrelationID
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public void setJMSCorrelationIDAsBytes(byte[] correlationID)
setJMSCorrelationIDAsBytes
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public void setJMSType(java.lang.String type) throws javax.jms.JMSException
setJMSType
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public void setJMSDeliveryMode(int deliveryMode) throws javax.jms.JMSException
setJMSDeliveryMode
in interface javax.jms.Message
javax.jms.JMSException
- If the delivery mode is incorrect.public java.lang.String getJMSMessageID() throws javax.jms.JMSException
getJMSMessageID
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public int getJMSPriority() throws javax.jms.JMSException
getJMSPriority
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public int getJMSDeliveryMode() throws javax.jms.JMSException
getJMSDeliveryMode
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public javax.jms.Destination getJMSDestination() throws javax.jms.JMSException
getJMSDestination
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public long getJMSExpiration() throws javax.jms.JMSException
getJMSExpiration
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public boolean getJMSRedelivered() throws javax.jms.JMSException
getJMSRedelivered
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public javax.jms.Destination getJMSReplyTo() throws javax.jms.JMSException
getJMSReplyTo
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public long getJMSTimestamp() throws javax.jms.JMSException
getJMSTimestamp
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public java.lang.String getJMSType() throws javax.jms.JMSException
getJMSType
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public java.lang.String getJMSCorrelationID() throws javax.jms.JMSException
getJMSCorrelationID
in interface javax.jms.Message
javax.jms.JMSException
- Actually never thrown.public byte[] getJMSCorrelationIDAsBytes() throws javax.jms.JMSException
getJMSCorrelationIDAsBytes
in interface javax.jms.Message
javax.jms.MessageFormatException
- In case of a problem while retrieving
the field.
javax.jms.JMSException
public void setBooleanProperty(java.lang.String name, boolean value) throws javax.jms.JMSException
setBooleanProperty
in interface javax.jms.Message
javax.jms.MessageNotWriteableException
- If the message is read-only.
javax.jms.JMSException
- If the property name is invalid.public void setByteProperty(java.lang.String name, byte value) throws javax.jms.JMSException
setByteProperty
in interface javax.jms.Message
javax.jms.MessageNotWriteableException
- If the message is read-only.
javax.jms.JMSException
- If the property name is invalid.public void setDoubleProperty(java.lang.String name, double value) throws javax.jms.JMSException
setDoubleProperty
in interface javax.jms.Message
javax.jms.MessageNotWriteableException
- If the message is read-only.
javax.jms.JMSException
- If the property name is invalid.public void setFloatProperty(java.lang.String name, float value) throws javax.jms.JMSException
setFloatProperty
in interface javax.jms.Message
javax.jms.MessageNotWriteableException
- If the message is read-only.
javax.jms.JMSException
- If the property name is invalid.public void setIntProperty(java.lang.String name, int value) throws javax.jms.JMSException
setIntProperty
in interface javax.jms.Message
javax.jms.MessageNotWriteableException
- If the message is read-only.
javax.jms.JMSException
- If the property name is invalid.public void setLongProperty(java.lang.String name, long value) throws javax.jms.JMSException
setLongProperty
in interface javax.jms.Message
javax.jms.MessageNotWriteableException
- If the message is read-only.
javax.jms.JMSException
- If the property name is invalid.public void setObjectProperty(java.lang.String name, java.lang.Object value) throws javax.jms.JMSException
setObjectProperty
in interface javax.jms.Message
javax.jms.MessageNotWriteableException
- If the message is read-only.
javax.jms.JMSException
- If the property name is invalid, or if the
object is invalid.public void setShortProperty(java.lang.String name, short value) throws javax.jms.JMSException
setShortProperty
in interface javax.jms.Message
javax.jms.MessageNotWriteableException
- If the message is read-only.
javax.jms.JMSException
- If the property name is invalid.public void setStringProperty(java.lang.String name, java.lang.String value) throws javax.jms.JMSException
setStringProperty
in interface javax.jms.Message
javax.jms.MessageNotWriteableException
- If the message is read-only.
javax.jms.JMSException
- If the property name is invalid.public boolean getBooleanProperty(java.lang.String name) throws javax.jms.JMSException
getBooleanProperty
in interface javax.jms.Message
javax.jms.MessageFormatException
- If the property type is invalid.
javax.jms.JMSException
- If the name is invalid.public byte getByteProperty(java.lang.String name) throws javax.jms.JMSException
getByteProperty
in interface javax.jms.Message
javax.jms.MessageFormatException
- If the property type is invalid.
javax.jms.JMSException
- If the name is invalid.public double getDoubleProperty(java.lang.String name) throws javax.jms.JMSException
getDoubleProperty
in interface javax.jms.Message
javax.jms.MessageFormatException
- If the property type is invalid.
javax.jms.JMSException
- If the name is invalid.public float getFloatProperty(java.lang.String name) throws javax.jms.JMSException
getFloatProperty
in interface javax.jms.Message
javax.jms.MessageFormatException
- If the property type is invalid.
javax.jms.JMSException
- If the name is invalid.public int getIntProperty(java.lang.String name) throws javax.jms.JMSException
getIntProperty
in interface javax.jms.Message
javax.jms.MessageFormatException
- If the property type is invalid.
javax.jms.JMSException
- If the name is invalid.public long getLongProperty(java.lang.String name) throws javax.jms.JMSException
getLongProperty
in interface javax.jms.Message
javax.jms.MessageFormatException
- If the property type is invalid.
javax.jms.JMSException
- If the name is invalid.public java.lang.Object getObjectProperty(java.lang.String name) throws javax.jms.JMSException
getObjectProperty
in interface javax.jms.Message
javax.jms.JMSException
- If the name is invalid.public short getShortProperty(java.lang.String name) throws javax.jms.JMSException
getShortProperty
in interface javax.jms.Message
javax.jms.MessageFormatException
- If the property type is invalid.
javax.jms.JMSException
- If the name is invalid.public java.lang.String getStringProperty(java.lang.String name) throws javax.jms.JMSException
getStringProperty
in interface javax.jms.Message
javax.jms.JMSException
- If the name is invalid.public static Message wrapMomMessage(Session sess, Message momMsg) throws javax.jms.JMSException
This method is actually called by a session consuming a MOM message for wrapping it in a Joram message before handing it to the consumer.
javax.jms.JMSException
- If an error occurs while building the message.protected void prepare() throws java.lang.Exception
java.lang.Exception
- If an error occurs while serializing.
|
Joram ${version} | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |