Package weblogic.management.runtime

Interface JMSMessageManagementRuntimeMBean

All Superinterfaces:

CursorRuntimeMBean, javax.management.DynamicMBean, JMSMessageCursorRuntimeMBean, javax.management.MBeanRegistration, MessageCursorRuntimeMBean, javax.management.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

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	deleteMessages(java.lang.String selector)	Deletes the set of messages from the destination that are qualified by the specified JMS message selector.
JMSMessageManagementTaskRuntimeMBean	exportMessages(java.lang.String selector, java.lang.String file, int timeout)	Exports the messages matching the selector to the specified file in XML representation.
JMSMessageVBean	getJMSMessage(java.lang.String messageID)	Given a JMS message ID this method returns the corresponding message from the queue.
JMSMessagesVBean	getJMSMessages(java.lang.String selector, int max, java.lang.String[] sortOn, java.lang.Boolean[] ascending)	Returns an array of JMSMessageVBean objects that match the specified JMS message selector.
JMSTextMessageVBean	getJMSTextMessage(java.lang.String messageID)	Returns the JMS TextMessage (with body) that corresponds to the specified message ID.
javax.management.openmbean.CompositeData	getMessage(java.lang.String messageID)	Given a JMS message ID this method returns the corresponding message from the queue.
java.lang.String	getMessages(java.lang.String selector, java.lang.Integer timeout)	Queries messages on the queue according to the provided message selector and returns a message cursor representing the result set.
java.lang.String	getMessages(java.lang.String selector, java.lang.Integer timeout, java.lang.Integer state)	Queries messages on the queue according to the provided message selector and state bitmask and returns a message cursor representing the result set.
java.lang.Long	getMessagesDeletedCurrentCount()	Returns the number of messages that have been deleted from the destination.
java.lang.Long	getMessagesMovedCurrentCount()	Returns the number of messages that have been moved from the destination.
JMSMessageManagementTaskRuntimeMBean[]	getTasks()	Returns JMS message management tasks.
JMSMessageManagementTaskRuntimeMBean	importMessages(java.lang.String file, boolean applyOverrides)	Imports the messages from the specified file into the destination.
java.lang.Void	importMessages(javax.management.openmbean.CompositeData[] messages, java.lang.Boolean replaceOnly)	Imports an array of messages into the destination.
java.lang.Void	importMessages(javax.management.openmbean.CompositeData[] messages, java.lang.Boolean replaceOnly, java.lang.Boolean applyOverrides)	Imports an array of messages into the destination.
JMSMessageManagementTaskRuntimeMBean	moveMessages(java.lang.String selector, java.lang.String destinationID, int timeout)	Moves the set of messages that match the specified selector to the target destination.
java.lang.Integer	moveMessages(java.lang.String selector, javax.management.openmbean.CompositeData targetDestination)	Moves the set of messages that match the specified selector to the target destination.
java.lang.Integer	moveMessages(java.lang.String selector, javax.management.openmbean.CompositeData targetDestination, java.lang.Integer timeout)
void	produceTextMessage(java.lang.String type, java.lang.String correlationID, long expiration, int priority, int deliveryMode, java.lang.String[] propertyNames, java.lang.String[] propertyTypes, java.lang.String[] propertyValues, java.lang.String text)	Produces a TextMessage with the specified text body and JMS message header attributes on the destination.

Methods inherited from interface weblogic.management.runtime.CursorRuntimeMBean

closeCursor, getCursorEndPosition, getCursorSize, getCursorStartPosition, getItems, getNext, getPrevious

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface weblogic.management.runtime.JMSMessageCursorRuntimeMBean

sort

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface weblogic.management.runtime.MessageCursorRuntimeMBean

getMessage, getMessage

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Method Detail

getMessagesMovedCurrentCount

java.lang.Long getMessagesMovedCurrentCount()

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

getMessagesDeletedCurrentCount

java.lang.Long getMessagesDeletedCurrentCount()

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

See Also:

deleteMessages(String)

getMessages

java.lang.String getMessages(java.lang.String selector,
                             java.lang.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

java.lang.String getMessages(java.lang.String selector,
                             java.lang.Integer timeout,
                             java.lang.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

javax.management.openmbean.CompositeData getMessage(java.lang.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

java.lang.Integer moveMessages(java.lang.String selector,
                               javax.management.openmbean.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

java.lang.Integer moveMessages(java.lang.String selector,
                               javax.management.openmbean.CompositeData targetDestination,
                               java.lang.Integer timeout)
                        throws ManagementException

Throws:

ManagementException

deleteMessages

java.lang.Integer deleteMessages(java.lang.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

java.lang.Void importMessages(javax.management.openmbean.CompositeData[] messages,
                              java.lang.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 exception 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.

importMessages

java.lang.Void importMessages(javax.management.openmbean.CompositeData[] messages,
                              java.lang.Boolean replaceOnly,
                              java.lang.Boolean applyOverrides)
                       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 exception will be thrown if the message ID does not exist on the target destination.

applyOverrides - when set to true will apply destination overrides to the imported messages

Throws:

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

getJMSMessages

JMSMessagesVBean getJMSMessages(java.lang.String selector,
                                int max,
                                java.lang.String[] sortOn,
                                java.lang.Boolean[] ascending)
                         throws ManagementException

Returns an array of JMSMessageVBean objects that match the specified JMS message selector. When the sortOn parameter is specified the array is ordered by the message header field.

Parameters:

selector - The JMS message selector

max - The maximum number of messages to return

sortOn - The JMS header fields to sort on. Values can include message attributes JMSMessageID, JMSTimestamp, JMSDeliveryTime, JMSType, JMSCorrelationID, JMSExpiration, JMSRedelivered, JMSPriority, JMS_BEA_Size, JMS_BEA_UnitOfOrder, JMS_BEA_Xid, JMS_BEA_State, JMS_BEA_SequenceNumber, and arbitrary message property names.

ascending - Indicates whether sort order is ascending or descending

Returns:

An JMSMessageVBean object that contains messages matching the specified selector

Throws:

ManagementException - An error occurred processing the query.

getJMSMessage

JMSMessageVBean getJMSMessage(java.lang.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.

getJMSTextMessage

JMSTextMessageVBean getJMSTextMessage(java.lang.String messageID)
                               throws ManagementException

Returns the JMS TextMessage (with body) that corresponds to the specified message ID.

Parameters:

messageID - The JMS message ID of the requested message.

Returns:

The JMS TextMessage (with body) that corresponds to the specified message ID, or null.

Throws:

ManagementException - An error occurred.

moveMessages

JMSMessageManagementTaskRuntimeMBean moveMessages(java.lang.String selector,
                                                  java.lang.String destinationID,
                                                  int timeout)
                                           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. Message header state, such as expiration time, time-to-deliver, JMSXUserID, delivery mode, unit-of-order, priority and destination are preserved.

Parameters:

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

destinationID - The identifier of the target JMS destination.

timeout - The timeout value for the move operation transaction.

Returns:

A JMSMessageManagementTaskRuntimeMBean

Throws:

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

See Also:

JMSDestinationRuntimeMBean.getDestinationID(), weblogic.management.runtime.JMSDurableSubscribernRuntimeMBean#getDestinationID()

exportMessages

JMSMessageManagementTaskRuntimeMBean exportMessages(java.lang.String selector,
                                                    java.lang.String file,
                                                    int timeout)
                                             throws ManagementException

Exports the messages matching the selector to the specified file in XML representation.

Parameters:

selector - A JMS message selector.

file - The absolute path of the file to which the matching messages will be written.

timeout - The maximum amount of time in seconds to perform the export operation. A value of 0 indicates no timeout applies.

Returns:

A JMSMessageManagementTaskRuntimeMBean

Throws:

ManagementException - An error occurred.

See Also:

Message

importMessages

JMSMessageManagementTaskRuntimeMBean importMessages(java.lang.String file,
                                                    boolean applyOverrides)
                                             throws ManagementException

Imports the messages from the specified file into the destination.

Parameters:

file - The absolute path of the file from which to import messages.

applyOverrides - When set to true will apply destination overrides to the imported messages

Returns:

A JMSMessageManagementTaskRuntimeMBean

Throws:

ManagementException - An error occurred.

produceTextMessage

void produceTextMessage(java.lang.String type,
                        java.lang.String correlationID,
                        long expiration,
                        int priority,
                        int deliveryMode,
                        java.lang.String[] propertyNames,
                        java.lang.String[] propertyTypes,
                        java.lang.String[] propertyValues,
                        java.lang.String text)
                 throws ManagementException

Produces a TextMessage with the specified text body and JMS message header attributes on the destination.

Parameters:

type - A JMS message type value.

correlationID - A JMS correlation ID value.

expiration - A JMS expiration time value; GMT time plus time-to-live, or 0 to indicate no expiration.

priority - A JMS message priority value from 0-9.

deliveryMode - A JMS delivery mode value; 1 for non-persistent, 2 for persistent

propertyNames - JMS message property names

propertyTypes - JMS message property types (boolean, byte, short, int, long, float, double, or String)

propertyValues - JMS message property values

text - The text value of the message.

Throws:

ManagementException - An error occurred.

See Also:

Message.getJMSType(), Message.getJMSCorrelationID(), Message.getJMSExpiration(), Message.getJMSPriority(), Message.getJMSDeliveryMode(), TextMessage.getText()

getTasks

JMSMessageManagementTaskRuntimeMBean[] getTasks()

Returns JMS message management tasks.

Returns:

JMS message management tasks