CursorRuntimeMBean
, javax.management.DynamicMBean
, JMSMessageCursorRuntimeMBean
, javax.management.MBeanRegistration
, MessageCursorRuntimeMBean
, javax.management.NotificationBroadcaster
, RuntimeMBean
, WebLogicMBean
JMSDestinationRuntimeMBean
, JMSDurableSubscriberRuntimeMBean
public interface JMSMessageManagementRuntimeMBean extends JMSMessageCursorRuntimeMBean
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.
|
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.
|
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.
|
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) |
closeCursor, getCursorEndPosition, getCursorSize, getCursorStartPosition, getItems, getNext, getPrevious
getAttribute, getAttributes, invoke, setAttribute, setAttributes
sort
postDeregister, postRegister, preRegister
getMessage, getMessage
addNotificationListener, getNotificationInfo, removeNotificationListener
addPropertyChangeListener, removePropertyChangeListener
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent
java.lang.Long getMessagesMovedCurrentCount()
Returns the number of messages that have been moved from the destination.
java.lang.Long getMessagesDeletedCurrentCount()
Returns the number of messages that have been deleted from the destination.
deleteMessages(String)
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.
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.ManagementException
- Thrown when the provided message selector contains invalid syntax, or when an internal error is encountered.JMSMessageCursorRuntimeMBean
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.
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.ManagementException
- Thrown when the provided message selector contains invalid syntax, or when an internal error is encountered.JMSMessageCursorRuntimeMBean
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.
messageID
- The JMS message ID of the requested message.ManagementException
- Thrown when an error occurs while performing the query.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.
selector
- A JMS message selector that identifies the messages to move.targetDestination
- A JMS destination that the messages will be moved to.ManagementException
- Thrown if an error occurs will processing the request. The selected messages will remain on the source destination.java.lang.Integer moveMessages(java.lang.String selector, javax.management.openmbean.CompositeData targetDestination, java.lang.Integer timeout) throws ManagementException
ManagementException
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.
selector
- A JMS message selector to identify which messages to delete.ManagementException
- Thrown if an error occurs will processing the request. The selected messages will remain on the source destination.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.
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.ManagementException
- Thrown if an error occurs will processing the request. The selected messages will remain on the source destination.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.
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.applyOverrides
- when set to true will apply destination overrides to the imported messagesManagementException
- Thrown if an error occurs will processing the request. The selected messages will remain on the source destination.