|
BEA Systems, Inc. | |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object weblogic.messaging.runtime.MessageInfo weblogic.jms.extensions.JMSMessageInfo
This class encapsulates a JMS message and meta-data that describes the context of the message as it exists in the server at a given point in time. Instances of this class are created by the JMX message management APIs that are used for the browsing and manipulation of messages. These APIs return a CompositeData representation of this object. This object may also be used by a management client to import a message.
CompositeData
,
JMSDestinationRuntimeMBean
,
JMSServerRuntimeMBean
,
JMSDurableSubscriberRuntimeMBean
Field Summary |
Fields inherited from class weblogic.messaging.runtime.MessageInfo |
consumerID, handle, ITEM_CONSUMER_ID, ITEM_HANDLE, ITEM_SEQUENCE_NUMBER, ITEM_STATE, ITEM_XID_STRING, openItemDescriptions, openItemNames, openItemTypes, sequenceNumber, state, STATE_DELAYED, STATE_EXPIRED, STATE_ORDERED, STATE_PAUSED, STATE_RECEIVE, STATE_REDELIVERY_COUNT_EXCEEDED, STATE_SEND, STATE_TRANSACTION, STATE_VISIBLE, stateString, xidString |
Constructor Summary | |
JMSMessageInfo(CompositeData cd)
Creates an instance from a CompositeData represenation. |
|
JMSMessageInfo(long handle,
int state,
String xidString,
long sequenceNumber,
String consumerID,
WLMessage message,
String destinationName,
boolean bodyIncluded)
Construct an instance with the specified attributes. |
|
JMSMessageInfo(WLMessage message)
Constructs an object with only the WLMessage attribute. |
Method Summary | |
protected Map |
getCompositeDataMap()
|
String |
getDestinationName()
Returns the name of the destination that is hosting the message. |
WLMessage |
getMessage()
Returns the JMS message attribute. |
long |
getMessageSize()
Returns the size of the message including the body. |
protected void |
initOpenInfo()
|
boolean |
isBodyIncluded()
Returns true if the message body is included in the CompositeData representation. |
protected void |
readCompositeData(CompositeData cd)
|
void |
setBodyIncluded(boolean bodyIncluded)
Sets the BodyIncluded attribute. |
void |
setDestinationName(String destinationName)
Sets the DestinationName attribute. |
void |
setMessage(WLMessage message)
Sets the message attribute. |
void |
setMessageSize(long messageSize)
Sets the MessageSize attribute. |
Methods inherited from class weblogic.messaging.runtime.MessageInfo |
getCompositeType, getConsumerID, getHandle, getSequenceNumber, getState, getStateString, getStateString, getXidString, setConsumerID, setHandle, setSequenceNumber, setState, setXidString, toCompositeData |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public JMSMessageInfo(CompositeData cd) throws OpenDataException
Creates an instance from a CompositeData represenation.
OpenDataException
- An error occurred while extracting attributes from the
CompositeData representation.public JMSMessageInfo(long handle, int state, String xidString, long sequenceNumber, String consumerID, WLMessage message, String destinationName, boolean bodyIncluded)
Construct an instance with the specified attributes.
public JMSMessageInfo(WLMessage message)
Constructs an object with only the WLMessage attribute. The resulting CompositeData is intended for use with the message import feature. This constructor will include the message body in the CompositeData representation.
JMSMessageManagementRuntimeMBean.importMessages(CompositeData[],
Boolean)
Method Detail |
protected Map getCompositeDataMap() throws OpenDataException
OpenDataException
public String getDestinationName()
public WLMessage getMessage()
Returns the JMS message attribute. Note that if the JMSMessageInfo instance was created from a CompositeData representation where the bodyIncluded attribute is set to false, the message type returned may differ from the original message type.
public long getMessageSize()
protected void initOpenInfo()
public boolean isBodyIncluded()
protected void readCompositeData(CompositeData cd) throws OpenDataException
OpenDataException
public void setBodyIncluded(boolean bodyIncluded)
bodyIncluded
- Indicates whether to include the message body in the CompositeData
representation.public void setDestinationName(String destinationName)
destinationName
- The destination name.public void setMessage(WLMessage message)
message
- A JMS message.public void setMessageSize(long messageSize)
messageSize
- The message size in bytes.
|
Documentation is available at http://download.oracle.com/docs/cd/E13222_01/wls/docs91 Copyright 2005 BEA Systems Inc. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |