weblogic.management.runtime
Interface MessageCursorRuntimeMBean

All Superinterfaces:

CursorRuntimeMBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

All Known Subinterfaces:

JMSDestinationRuntimeMBean, JMSDurableSubscriberRuntimeMBean, JMSMessageCursorRuntimeMBean, JMSMessageManagementRuntimeMBean, JMSRemoteEndpointRuntimeMBean, JMSServerRuntimeMBean, SAFMessageCursorRuntimeMBean, SAFRemoteEndpointRuntimeMBean, WSRMRemoteEndpointRuntimeMBean

public interface MessageCursorRuntimeMBean
extends CursorRuntimeMBean

This interface specifies methods for cursor result sets comprised of messages. Given a cursor handle and an identifier, they return a complete message in CompositeData representation.

See Also:

CompositeData

getMessage

CompositeData getMessage(String cursorHandle,
                         String messageID)
                         throws ManagementException

Given a JMS message ID this method returns the corresponding message from the queue. If no message with the specified message ID exists on the destination, a null value is returned.

Parameters:

cursorHandle - The handle of the cursor.

messageID - The JMS message ID of the requested message.

Returns:

The message in XML text representation corresponding to the specified message ID or null if one does not exist.

Throws:

ManagementException - Thrown when an error occurs while performing the query.

See Also:

CompositeData

getMessage

CompositeData getMessage(String cursorHandle,
                         Long messageHandle)
                         throws ManagementException

Returns the message associated with the specified cursor handle.

Parameters:

cursorHandle - The handle of the cursor.

messageHandle - The handle of the message within the cursor.

Returns:

The message in XML text representation corresponding the specified item handle;

Throws:

ManagementException - Thrown when an error occurs while performing the operation.

See Also:

CompositeData