|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectweblogic.messaging.runtime.MessageInfo
weblogic.jms.extensions.JMSMessageInfo
public class 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.
cd
- An open data representation of a JMSMessageInfo instance.
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. Valid message states are:
visible
- The message is visible on the destination and may be consumed.
send
- The message is pending because it is associated with an in progress send operation.
receive
- The message is pending because it has been received by a consumer but not yet acknowledged.
transaction
- The message is associated with a transactional "send" or "receive" operation that is in progress.
ordered
- The message belongs to a Unit-of-Order (UOO).
delayed
- The message is pending because it has a scheduled delivery time or is otherwise delayed.
expired
- The message has expired and is no longer available for consumption.
redelivery-count-exceeded
- The message has exceeded the redelivery count set for the destination and is no longer available for consumption.
paused
- The message is pending because of a destination pause operation .
sequenced
- The message that is part of a SAF sequence.
unit-of-work-component
- The message is part of an Unit-of-Work (UOW).
deleted
- The message is marked for deletion.
handle
- The cursor handle of the message.state
- The state of the message.xidString
- The string representation of the associated Xid.sequenceNumber
- The sequence number of the message.consumerID
- Information about the entity consuming the message.message
- A JMS message.destinationName
- The name of the destination where the message exists.bodyIncluded
- Indicates whether the body of the message should is included in
the ComositeData representation.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.
message
- JMSMessageManagementRuntimeMBean.importMessages(CompositeData[],
Boolean)
Method Detail |
---|
protected void initOpenInfo()
initOpenInfo
in class MessageInfo
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 void setMessage(WLMessage message)
message
- A JMS message.public long getMessageSize()
public void setMessageSize(long messageSize)
messageSize
- The message size in bytes.public String getDestinationName()
public void setDestinationName(String destinationName)
destinationName
- The destination name.public boolean isBodyIncluded()
public void setBodyIncluded(boolean bodyIncluded)
bodyIncluded
- Indicates whether to include the message body in the CompositeData
representation.protected void readCompositeData(CompositeData cd) throws OpenDataException
readCompositeData
in class MessageInfo
OpenDataException
protected Map getCompositeDataMap() throws OpenDataException
getCompositeDataMap
in class MessageInfo
OpenDataException
|
Copyright 1996, 2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |