JMSMessageInfo
public abstract class MessageInfo
extends java.lang.Object
This class encapsulates message meta-data that describes the context of a 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 in the system. These APIs return a CompositeData representation of the object.
CompositeData
,
MessageCursorRuntimeMBean
Modifier and Type | Field | Description |
---|---|---|
protected java.lang.String |
consumerID |
|
protected java.lang.Long |
handle |
|
protected static java.lang.String |
ITEM_CONSUMER_ID |
|
protected static java.lang.String |
ITEM_HANDLE |
|
protected static java.lang.String |
ITEM_SEQUENCE_NUMBER |
|
protected static java.lang.String |
ITEM_STATE |
|
protected static java.lang.String |
ITEM_XID_STRING |
|
protected java.util.ArrayList |
openItemDescriptions |
|
protected java.util.ArrayList |
openItemNames |
|
protected java.util.ArrayList |
openItemTypes |
|
protected long |
sequenceNumber |
|
protected int |
state |
|
static int |
STATE_DELAYED |
Indicates that the message exists on the destination but is classified as
pending because it has a scheduled delivery time or is delayed.
|
static int |
STATE_EXPIRED |
Indicates that the message has expired and is no longer available for
consumption.
|
static int |
STATE_ORDERED |
Indicates that the message belongs to a Unit of Order.
|
static int |
STATE_PAUSED |
Indicates that the message exists on the destination but is being held in a
pending state because of a pause operation.
|
static int |
STATE_RECEIVE |
Indicates that the message exists on the destination but is classified as
pending because it has been received but not acknowledged.
|
static int |
STATE_REDELIVERY_COUNT_EXCEEDED |
Indicates that the message has exceeded the redelivery count set for the
destination and is no longer available for consumption.
|
static int |
STATE_SEND |
Indicates that the message exists on the destination but is classified as
pending because it is part of a send operation that is in progress.
|
static int |
STATE_TRANSACTION |
Indicates that the message exists on the destination but is classified as
pending because it is part of a send or receive operation that is being
performed as part of a global transaction.
|
static int |
STATE_VISIBLE |
Indicates that the message is visible on the destination.
|
protected java.lang.String |
stateString |
|
protected java.lang.String |
xidString |
Modifier and Type | Method | Description |
---|---|---|
protected java.util.Map |
getCompositeDataMap() |
|
protected javax.management.openmbean.CompositeType |
getCompositeType() |
|
java.lang.String |
getConsumerID() |
Returns the consumer ID for the message.
|
java.lang.Long |
getHandle() |
Returns the cursor handle associated with this message.
|
long |
getSequenceNumber() |
Returns the sequence number of the message.
|
int |
getState() |
Returns the state of the message at the time the runtime query was
performed as a bitmask of state constants defined above.
|
java.lang.String |
getStateString() |
Returns a string representation of the state of the message.
|
static java.lang.String |
getStateString(int state) |
Returns the string representation of the specified state bitmask.
|
java.lang.String |
getXidString() |
Returns the Xid of the global transaction that the message was associated
with at the time the management operation was performed.
|
protected void |
initOpenInfo() |
|
protected void |
readCompositeData(javax.management.openmbean.CompositeData cd) |
|
void |
setConsumerID(java.lang.String consumerID) |
Sets the consumer ID attribute.
|
void |
setHandle(java.lang.Long handle) |
Sets the cursor handle attribute.
|
void |
setSequenceNumber(long sequenceNumber) |
Sets the sequence number attribute.
|
void |
setState(int state) |
Sets the state of the message.
|
void |
setXidString(java.lang.String xidString) |
Sets the Xid attribute.
|
javax.management.openmbean.CompositeData |
toCompositeData() |
Converts the instance to a CompositeData representation.
|
public static final int STATE_VISIBLE
Indicates that the message is visible on the destination.
getState()
,
Constant Field Valuespublic static final int STATE_ORDERED
Indicates that the message belongs to a Unit of Order.
getState()
,
Constant Field Valuespublic static final int STATE_DELAYED
Indicates that the message exists on the destination but is classified as pending because it has a scheduled delivery time or is delayed.
getState()
,
Constant Field Valuespublic static final int STATE_RECEIVE
Indicates that the message exists on the destination but is classified as pending because it has been received but not acknowledged. The actual state may also include STATE_TRANSACTION if the receive operation was performed as part of a transaction.
getState()
,
STATE_TRANSACTION
,
Constant Field Valuespublic static final int STATE_SEND
Indicates that the message exists on the destination but is classified as pending because it is part of a send operation that is in progress. The actual state may also include STATE_TRANSACTION if the send operation was perfromed as part of a transaction.
getState()
,
STATE_TRANSACTION
,
Constant Field Valuespublic static final int STATE_TRANSACTION
Indicates that the message exists on the destination but is classified as pending because it is part of a send or receive operation that is being performed as part of a global transaction.
getState()
,
STATE_RECEIVE
,
STATE_SEND
,
Constant Field Valuespublic static final int STATE_PAUSED
Indicates that the message exists on the destination but is being held in a pending state because of a pause operation.
getState()
,
Constant Field Valuespublic static final int STATE_REDELIVERY_COUNT_EXCEEDED
Indicates that the message has exceeded the redelivery count set for the destination and is no longer available for consumption.
getState()
,
Constant Field Valuespublic static final int STATE_EXPIRED
Indicates that the message has expired and is no longer available for consumption.
getState()
,
Constant Field Valuesprotected java.util.ArrayList openItemNames
protected java.util.ArrayList openItemDescriptions
protected java.util.ArrayList openItemTypes
protected static final java.lang.String ITEM_HANDLE
protected static final java.lang.String ITEM_STATE
protected static final java.lang.String ITEM_XID_STRING
protected static final java.lang.String ITEM_SEQUENCE_NUMBER
protected static final java.lang.String ITEM_CONSUMER_ID
protected java.lang.Long handle
protected int state
protected java.lang.String stateString
protected java.lang.String xidString
protected long sequenceNumber
protected java.lang.String consumerID
public javax.management.openmbean.CompositeData toCompositeData() throws javax.management.openmbean.OpenDataException
Converts the instance to a CompositeData representation.
javax.management.openmbean.OpenDataException
- Thrown when an error occurs while constructing the CompositeData
representation.public java.lang.Long getHandle()
Returns the cursor handle associated with this message.
public void setHandle(java.lang.Long handle)
Sets the cursor handle attribute.
handle
- The handle.public int getState()
Returns the state of the message at the time the runtime query was performed as a bitmask of state constants defined above.
STATE_DELAYED
,
STATE_EXPIRED
,
STATE_ORDERED
,
STATE_PAUSED
,
STATE_RECEIVE
,
STATE_REDELIVERY_COUNT_EXCEEDED
,
STATE_SEND
,
STATE_TRANSACTION
,
STATE_VISIBLE
public void setState(int state)
Sets the state of the message.
state
- The state of the message.public java.lang.String getStateString()
Returns a string representation of the state of the message.
getState()
public java.lang.String getXidString()
Returns the Xid of the global transaction that the message was associated with at the time the management operation was performed.
public void setXidString(java.lang.String xidString)
Sets the Xid attribute.
xidString
- An Xid in WebLogic JTA Xid toString format.public long getSequenceNumber()
Returns the sequence number of the message. The sequence number identifies the message's position in the arrival order for the underlying destination.
public void setSequenceNumber(long sequenceNumber)
Sets the sequence number attribute.
sequenceNumber
- A sequence number.public java.lang.String getConsumerID()
Returns the consumer ID for the message. The consumer ID identifies the consumer of the message at the time the management operation was invoked.
public void setConsumerID(java.lang.String consumerID)
Sets the consumer ID attribute.
consumerID
- The consumerID to set.public static java.lang.String getStateString(int state)
Returns the string representation of the specified state bitmask.
state
- A state bitmaskprotected void initOpenInfo()
protected void readCompositeData(javax.management.openmbean.CompositeData cd) throws javax.management.openmbean.OpenDataException
javax.management.openmbean.OpenDataException
protected java.util.Map getCompositeDataMap() throws javax.management.openmbean.OpenDataException
javax.management.openmbean.OpenDataException
protected javax.management.openmbean.CompositeType getCompositeType() throws javax.management.openmbean.OpenDataException
javax.management.openmbean.OpenDataException