|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.3) Part Number E41849-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JMSMessageManagementRuntimeMBean
This interface defines the common management functionality for both Queues and Topics
Method Summary | |
---|---|
Integer |
deleteMessages(String selector)
Deletes the set of messages from the destination that are qualified by the specified JMS message selector. |
CompositeData |
getMessage(String messageID)
Given a JMS message ID this method returns the corresponding message from the queue. |
String |
getMessages(String selector,
Integer timeout)
Queries messages on the queue according to the provided message selector and returns a message cursor representing the result set. |
String |
getMessages(String selector,
Integer timeout,
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. |
Long |
getMessagesDeletedCurrentCount()
Returns the number of messages that have been deleted from the destination. |
Long |
getMessagesMovedCurrentCount()
Returns the number of messages that have been moved from the destination. |
Void |
importMessages(CompositeData[] messages,
Boolean replaceOnly)
Imports an array of messages into the destination. |
Integer |
moveMessages(String selector,
CompositeData targetDestination)
Moves the set of messages that match the specified selector to the target destination. |
Integer |
moveMessages(String selector,
CompositeData targetDestination,
Integer timeout)
|
Methods inherited from interface weblogic.management.runtime.JMSMessageCursorRuntimeMBean |
---|
sort |
Methods inherited from interface weblogic.management.runtime.MessageCursorRuntimeMBean |
---|
getMessage, getMessage |
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 |
---|
Long getMessagesMovedCurrentCount()
Returns the number of messages that have been moved from the destination.
Long getMessagesDeletedCurrentCount()
Returns the number of messages that have been deleted from the destination.
JMSMessageManagementRuntimeMBean.deleteMessages(String)
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.
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
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.
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
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.
messageID
- The JMS message ID of the requested message.
ManagementException
- Thrown when an error occurs while performing the query.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.
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.Integer moveMessages(String selector, CompositeData targetDestination, Integer timeout) throws ManagementException
ManagementException
Integer deleteMessages(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.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.
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.
|
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 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |