weblogic.management.runtime
Interface JMSMessageManagementRuntimeMBean

All Superinterfaces:

CursorRuntimeMBean, DynamicMBean, JMSMessageCursorRuntimeMBean, MBeanRegistration, MessageCursorRuntimeMBean, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

All Known Subinterfaces:

JMSDestinationRuntimeMBean, JMSDurableSubscriberRuntimeMBean

public interface JMSMessageManagementRuntimeMBean
extends JMSMessageCursorRuntimeMBean

This interface defines the common management functionality for both Queues and Topics

getMessagesMovedCurrentCount

Long getMessagesMovedCurrentCount()

Returns the number of messages that have been moved from the destination.

getMessagesDeletedCurrentCount

Long getMessagesDeletedCurrentCount()

Returns the number of messages that have been deleted from the destination.

See Also:

JMSMessageManagementRuntimeMBean.deleteMessages(String)

getMessages

String getMessages(String selector,
                   Integer timeout)
                   throws ManagementException

Queries messages on the queue according to the provided message selector and returns a message cursor representing the result set. The timeout parameter specifies the amount of time in seconds for which the cursor is valid. Upon timeout expiration the cursor is invalidated and the associated resources released.

Parameters:

selector - A valid JMS message selector.

timeout - The last access timeout for the cursor. The cursor resources will be reclaimed if it is not accessed within the specified time interval. A value of 0 indicates no timeout.

Throws:

ManagementException - Thrown when the provided message selector contains invalid syntax, or when an internal error is encountered.

See Also:

JMSMessageCursorRuntimeMBean

getMessages

String getMessages(String selector,
                   Integer timeout,
                   Integer state)
                   throws ManagementException

Queries messages on the queue according to the provided message selector and state bitmask and returns a message cursor representing the result set. The timeout parameter specifies the amount of time in seconds for which the cursor is valid. Upon timeout expiration the cursor is invalidated and the associated resources released.

Parameters:

selector - A valid JMS message selector.

timeout - The last access timeout for the cursor. The cursor resources will be reclaimed if it is not accessed within the specified time interval. A value of 0 indicates no timeout.

state - A messaging kernel state bitmask. Refer to the messaging kernel MessageElement interface for a description of the various message states.

Throws:

ManagementException - Thrown when the provided message selector contains invalid syntax, or when an internal error is encountered.

See Also:

JMSMessageCursorRuntimeMBean

getMessage

CompositeData getMessage(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:

messageID - The JMS message ID of the requested message.

Returns:

The message corresponding to the specified message ID or null if one does not exist.

Throws:

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

moveMessages

Integer moveMessages(String selector,
                     CompositeData targetDestination)
                     throws ManagementException

Moves the set of messages that match the specified selector to the target destination. The move operation is guaranteed to be atomic for the selected messages.

Parameters:

selector - A JMS message selector that identifies the messages to move.

targetDestination - A JMS destination that the messages will be moved to.

Returns:

The number of messages affected.

Throws:

ManagementException - Thrown if an error occurs will processing the request. The selected messages will remain on the source destination.

moveMessages

Integer moveMessages(String selector,
                     CompositeData targetDestination,
                     Integer timeout)
                     throws ManagementException

Throws:

ManagementException

deleteMessages

Integer deleteMessages(String selector)
                       throws ManagementException

Deletes the set of messages from the destination that are qualified by the specified JMS message selector.

Parameters:

selector - A JMS message selector to identify which messages to delete.

Returns:

The number of messages affected.

Throws:

ManagementException - Thrown if an error occurs will processing the request. The selected messages will remain on the source destination.

importMessages

Void importMessages(CompositeData[] messages,
                    Boolean replaceOnly)
                    throws ManagementException

Imports an array of messages into the destination. If the message ID of the message being imported matches a message already on the destination, then the existing message will be replaced. If an existing message does not exist, then the message will be produced on the destination. A produced message is subject to quota limitations.

Parameters:

messages - An array of messages in CompositeData representation to be imported.

replaceOnly - When set to true an excetion will be thrown if the message ID does not exist on the target destination.

Throws:

ManagementException - Thrown if an error occurs will processing the request. The selected messages will remain on the source destination.