Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02

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

Method Summary
 CompositeData getMessage(String cursorHandle, Long messageHandle)
          Returns the message associated with the specified cursor handle.
 CompositeData getMessage(String cursorHandle, String messageID)
          Given a JMS message ID this method returns the corresponding message from the queue.
 
Methods inherited from interface weblogic.management.runtime.CursorRuntimeMBean
closeCursor, getCursorEndPosition, getCursorSize, getCursorStartPosition, getItems, getNext, getPrevious
 
Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
 
Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes
 
Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister
 
Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener
 

Method Detail

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

Copyright 1996, 2014, 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.3)

Part Number E41849-02