org.ow2.joram.jakarta.jms.admin

Class AdminMessage

java.lang.Object

org.ow2.joram.jakarta.jms.Message

org.ow2.joram.jakarta.jms.admin.AdminMessage

All Implemented Interfaces:

jakarta.jms.Message

public class AdminMessage
extends Message

The class AdminMessage allows to send and receive administration messages. It defines a proprietary JMS message type, the body is serialized through a proprietary encoding.

Field Summary

Fields inherited from class org.ow2.joram.jakarta.jms.Message

jmsDest, logger, momMsg, propertiesRO, RObody, session

Fields inherited from interface jakarta.jms.Message

DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Constructor and Description
AdminMessage() Instantiates a bright new AdminMessage.
AdminMessage(Session session, org.objectweb.joram.shared.messages.Message momMsg) Instantiates an AdminMessage wrapping a consumed MOM message containing a Admin message.

Method Summary

Modifier and Type	Method and Description
org.objectweb.joram.shared.admin.AbstractAdminMessage	getAdminMessage() get the AbstractAdminMessage body of the message.
void	setAdminMessage(org.objectweb.joram.shared.admin.AbstractAdminMessage adminMsg) Sets an AbstractAdminMessage as the body of the message.

Methods inherited from class org.ow2.joram.jakarta.jms.Message

acknowledge, clearBody, clearProperties, convertJMSMessage, dumpBody, dumpBody, getBody, getBooleanProperty, getByteProperty, getCompressedMinSize, getCompressionLevel, getDoubleProperty, getEffectiveBody, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getMomMsg, getObjectProperty, getProperties, getPropertyNames, getRawBody, getShortProperty, getStringProperty, isBodyAssignableTo, isCompressed, prepare, prepareJMSMessage, propertyExists, resetPropertiesRO, setBooleanProperty, setByteProperty, setCompressedMinSize, setCompressionLevel, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty, toString, toString, wrapMomMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AdminMessage

public AdminMessage()

Instantiates a bright new AdminMessage.

AdminMessage

public AdminMessage(Session session,
                    org.objectweb.joram.shared.messages.Message momMsg)

Instantiates an AdminMessage wrapping a consumed MOM message containing a Admin message.

Parameters:

session - The consuming session.

momMsg - The MOM message to wrap.

Method Detail

setAdminMessage

public void setAdminMessage(org.objectweb.joram.shared.admin.AbstractAdminMessage adminMsg)
                     throws jakarta.jms.MessageNotWriteableException,
                            jakarta.jms.MessageFormatException

Sets an AbstractAdminMessage as the body of the message.

Parameters:

adminMsg - admin message

Throws:

jakarta.jms.MessageNotWriteableException

jakarta.jms.MessageFormatException

getAdminMessage

public org.objectweb.joram.shared.admin.AbstractAdminMessage getAdminMessage()
                                                                      throws jakarta.jms.MessageFormatException

get the AbstractAdminMessage body of the message.

Returns:

AbstractAdminMessage body of the message.

Throws:

jakarta.jms.MessageFormatException