weblogic.jms.extensions
Class JMSMessageInfo

java.lang.Object
  weblogic.messaging.runtime.MessageInfo
      weblogic.jms.extensions.JMSMessageInfo

public class JMSMessageInfo
extends weblogic.messaging.runtime.MessageInfo

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.

See Also:

CompositeData, JMSDestinationRuntimeMBean, JMSServerRuntimeMBean, JMSDurableSubscriberRuntimeMBean

JMSMessageInfo

public JMSMessageInfo(CompositeData cd)
               throws OpenDataException

Creates an instance from a CompositeData represenation.

Parameters:

cd - An open data representation of a JMSMessageInfo instance.

Throws:

OpenDataException - An error occurred while extracting attributes from the CompositeData representation.

JMSMessageInfo

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 \x93send\x94 or \x93receive\x94 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.

Parameters:

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.

JMSMessageInfo

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.

Parameters:

message -

See Also:

JMSMessageManagementRuntimeMBean.importMessages(CompositeData[], Boolean)

initOpenInfo

protected void initOpenInfo()

Overrides:

initOpenInfo in class weblogic.messaging.runtime.MessageInfo

getMessage

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.

Returns:

the JMS message.

setMessage

public void setMessage(WLMessage message)

Sets the message attribute.

Parameters:

message - A JMS message.

getMessageSize

public long getMessageSize()

Returns the size of the message including the body.

Returns:

the size of the message in bytes.

setMessageSize

public void setMessageSize(long messageSize)

Sets the MessageSize attribute.

Parameters:

messageSize - The message size in bytes.

getDestinationName

public String getDestinationName()

Returns the name of the destination that is hosting the message. This attribute is used to differentiate messages that are returned from cursors that aggregate messages across destinations.

Returns:

the destination name.

setDestinationName

public void setDestinationName(String destinationName)

Sets the DestinationName attribute.

Parameters:

destinationName - The destination name.

isBodyIncluded

public boolean isBodyIncluded()

Returns true if the message body is included in the CompositeData representation.

Returns:

the value of the BodyIncluded attribute.

setBodyIncluded

public void setBodyIncluded(boolean bodyIncluded)

Sets the BodyIncluded attribute.

Parameters:

bodyIncluded - Indicates whether to include the message body in the CompositeData representation.

readCompositeData

protected void readCompositeData(CompositeData cd)
                          throws OpenDataException

Overrides:

readCompositeData in class weblogic.messaging.runtime.MessageInfo

Throws:

OpenDataException

getCompositeDataMap

protected Map getCompositeDataMap()
                           throws OpenDataException

Overrides:

getCompositeDataMap in class weblogic.messaging.runtime.MessageInfo

Throws:

OpenDataException