This class is used for monitoring a WebLogic JMS destination (topic or queue).
| Fully Qualified Interface Name | If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.runtime.JMSDestinationRuntimeMBean
|
||
| Factory Methods | No factory methods. Instances of this MBean are created automatically. | ||
| Access Points |
You can access this MBean from the following MBean attributes:
|
||
| Access Points Inherited from RuntimeMBean |
Because this MBean extends or implements RuntimeMBean, you can also access this MBean by retrieving RuntimeMBeans. The following attributes contain RuntimeMBeans and its subtypes:
|
This section describes attributes that provide access to other MBeans.
|
|
An array of durable subscriber run-time MBeans for this destination.
| Factory Methods | No explicit creator method. The child shares the lifecycle of its parent. |
| Privileges | Read only |
| Type | JMSDurableSubscriberRuntimeMBean[] |
| Relationship type: | Containment. |
This section describes the following attributes:
The current number of bytes stored in the destination. This does not include the pending bytes.
| Privileges | Read only |
| Type | long |
The peak number of bytes stored in the destination since the last reset.
| Privileges | Read only |
| Type | long |
The number of pending bytes stored in the destination.
Pending bytes are over and above the current number of bytes.
| Privileges | Read only |
| Type | long |
The number of bytes received in this destination since the last reset.
| Privileges | Read only |
| Type | long |
The amount of time in the threshold condition since the last reset.
| Privileges | Read only |
| Type | long |
Private property that disables caching in proxies.
This attribute is not dynamic and requires a server restart to take effect.
| Privileges | Read only |
| Type | boolean |
The current number of consumers accessing this destination.
| Privileges | Read only |
| Type | long |
The peak number of consumers accessing this destination since the last reset.
| Privileges | Read only |
| Type | long |
The total number of consumers accessing this destination since the last reset.
| Privileges | Read only |
| Type | long |
Indicates the consumption Pause state of the destination.
| Privileges | Read only |
| Type | boolean |
The current consumption pause state of the destination.
| Privileges | Read only |
| Type | java.lang.String |
Returns information about this destination in JMX open data representation.
For more information, see:
| Privileges | Read only |
| Type | javax.management.openmbean.CompositeData |
The destination type, either
weblogic.management.configuration.JMSConstants.DESTINATION_TYPE_QUEUE
or
weblogic.management.configuration.JMSConstants.DESTINATION_TYPE_TOPIC
depending upon whether the destination is a queue or topic.
| Privileges | Read only |
| Type | java.lang.String |
Indicates the InsertionPause state of the destination.
| Privileges | Read only |
| Type | boolean |
The current insertion pause state of the destination.
| Privileges | Read only |
| Type | java.lang.String |
Returns the MBean info for this MBean.
This attribute is not dynamic and requires a server restart to take effect.
Deprecated.
| Privileges | Read only |
| Type | javax.management.MBeanInfo |
The current number of messages in the destination. This does not include the pending messages.
| Privileges | Read only |
| Type | long |
Returns the number of messages that have been deleted from the destination.
For more information, see:
| Privileges | Read only |
| Type | java.lang.Long |
The peak number of messages in the destination since the last reset.
| Privileges | Read only |
| Type | long |
Returns the number of messages that have been moved from the destination.
| Privileges | Read only |
| Type | java.lang.Long |
The number of pending messages in the destination.
Pending messages are over and above the current number of messages. A pending message is one that has either been sent in a transaction and not committed, or that has been received and not committed or acknowledged.
| Privileges | Read only |
| Type | long |
The number of messages received in this destination since the last reset.
| Privileges | Read only |
| Type | long |
The amount of time in the threshold condition since the last reset.
| Privileges | Read only |
| Type | long |
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.
| Privileges | Read only |
| Type | java.lang.String |
Returns the ObjectName under which this MBean is registered in the MBean server.
This attribute is not dynamic and requires a server restart to take effect.
Deprecated.
| Privileges | Read only |
| Type | weblogic.management.WebLogicObjectName |
Return the immediate parent for this MBean
This attribute is not dynamic and requires a server restart to take effect.
| Privileges | Read/Write |
| Type |
Indicates whether or not the destination is paused at the current time.
Deprecated.
| Privileges | Read only |
| Type | boolean |
Indicates the ProductionPause state of the destination.
| Privileges | Read only |
| Type | boolean |
The current production pause state of the destination.
| Privileges | Read only |
| Type | java.lang.String |
Returns false if the MBean represented by this object has been unregistered.
This attribute is not dynamic and requires a server restart to take effect.
Deprecated.
| Privileges | Read only |
| Type | boolean |
The operational state of the destination as a String.
| Privileges | Read only |
| Type | java.lang.String |
The effective messages limit on topic subscriptions (not applicable to queues). A '-1' indicates that no limit is configured or active.
| Privileges | Read only |
| Type | long |
Returns the type of the MBean.
This attribute is not dynamic and requires a server restart to take effect.
| Privileges | Read only |
| Type | java.lang.String |
This section describes the following operations:
Releases the server-side resources associated with the cursor and removes the runtime MBean instance.
| Operation Name | "closeCursor" |
| Parameters | Object [] { cursorHandle }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | Void
|
| Exceptions |
|
Creates a durable subscriber on the destination with the specified client ID and subscription name. A message selector and no-local flag may also be specified.
| Operation Name | "createDurableSubscriber" |
| Parameters | Object [] { ClientID, subscriptionName, selector, noLocal }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String",
"java.lang.String",
"java.lang.Boolean" } |
| Returns |
void
|
| Exceptions |
|
Deletes the set of messages from the destination that are qualified by the specified JMS message selector.
| Operation Name | "deleteMessages" |
| Parameters | Object [] { selector }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | Integer
|
| Exceptions |
|
Returns the cursor end position in the result set.
| Operation Name | "getCursorEndPosition" |
| Parameters | Object [] { cursorHandle }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | Long
|
| Exceptions |
|
Returns the number of items in the result set.
| Operation Name | "getCursorSize" |
| Parameters | Object [] { cursorHandle }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | Long
|
| Exceptions |
|
Returns the cursor start position in the result set.
| Operation Name | "getCursorStartPosition" |
| Parameters | Object [] { cursorHandle }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | Long
|
| Exceptions |
|
Returns an array of items from the specified cursor location. The new cursor start position will be the location after the old cursor end position. The size of the array returned is determined by the count argument. An array smaller than the "count" value is returned if there are fewer items from the specified start position to the end of the result set. A null value is returned if the size of the return array is zero. In this case, the cursor position will not change.
For more information, see:
| Operation Name | "getItems" |
| Parameters | Object [] { cursorHandle, start, count }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Long",
"java.lang.Integer" } |
| Returns |
class |
| Exceptions |
|
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.
| Operation Name | "getMessage" |
| Parameters | Object [] { messageID }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns | CompositeData |
| Exceptions |
|
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.
For more information, see:
| Operation Name | "getMessage" |
| Parameters | Object [] { cursorHandle, messageID }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.String" } |
| Returns | CompositeData |
| Exceptions |
|
Returns the message associated with the specified cursor handle.
For more information, see:
| Operation Name | "getMessage" |
| Parameters | Object [] { cursorHandle, messageHandle }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Long" } |
| Returns | CompositeData |
| Exceptions |
|
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.
For more information, see:
| Operation Name | "getMessages" |
| Parameters | Object [] { selector, timeout, state }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer",
"java.lang.Integer" } |
| Returns | String
|
| Exceptions |
|
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.
For more information, see:
| Operation Name | "getMessages" |
| Parameters | Object [] { selector, timeout }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns | String
|
| Exceptions |
|
Returns an array of items starting from the current cursor end position. The new cursor start position is set to be the location of the first item returned to the caller. The new cursor end position is set according to the size of the array returned, which is determined by the count argument. An array smaller than the "count" value is returned if there are fewer items from the specified start position to the end of the result set. A null value is returned if the size of the array is zero. In this case, the cursor position will not change.
For more information, see:
| Operation Name | "getNext" |
| Parameters | Object [] { cursorHandle, count }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns |
class |
| Exceptions |
|
Returns an array of items up to the current cursor start position. The new start position will be placed at the location of the first item in the set returned to the caller. The new cursor end position will be placed at the location after the last item in the set that is returned.
For more information, see:
| Operation Name | "getPrevious" |
| Parameters | Object [] { cursorHandle, count }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Integer" } |
| Returns |
class |
| Exceptions |
|
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.
| Operation Name | "importMessages" |
| Parameters | Object [] { messages, replaceOnly }
where:
|
| Signature | String [] {
"[Ljavax.management.openmbean.CompositeData;",
"java.lang.Boolean" } |
| Returns | Void
|
| Exceptions |
|
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.
| Operation Name | "importMessages" |
| Parameters | Object [] { messages, replaceOnly, applyOverrides }
where:
|
| Signature | String [] {
"[Ljavax.management.openmbean.CompositeData;",
"java.lang.Boolean",
"java.lang.Boolean" } |
| Returns | Void
|
| Exceptions |
|
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.
| Operation Name | "moveMessages" |
| Parameters | Object [] { selector, targetDestination }
where:
|
| Signature | String [] {
"java.lang.String",
"javax.management.openmbean.CompositeData" } |
| Returns | Integer
|
| Exceptions |
|
| Operation Name | "moveMessages" |
| Parameters | Object [] { }
where: |
| Signature | String [] {
"java.lang.String",
"javax.management.openmbean.CompositeData",
"java.lang.Integer" } |
| Returns | Integer
|
| Exceptions |
|
Pauses the destination so that new messages are not accepted.
Deprecated.
| Operation Name | "pause" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
Pauses the consumption on the destination.
| Operation Name | "pauseConsumption" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
Pauses the insertion on the destination.
| Operation Name | "pauseInsertion" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
Pauses the production on the destination.
| Operation Name | "pauseProduction" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
Resumes the destination so that new messages are accepted.
Deprecated.
| Operation Name | "resume" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
Resumes the consumption operations on the destination.
| Operation Name | "resumeConsumption" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
Resumes the insertion operations on the destination.
| Operation Name | "resumeInsertion" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
Resumes the production operations on the destination.
| Operation Name | "resumeProduction" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
| Exceptions |
|
Sorts the entire message result set managed by the cursor according to the JMS header attributes specified. The cursor position is set to the new position of the message corresponding to the "start" location before the sort is performed. The method returns the new cursor position.
For more information, see:
| Operation Name | "sort" |
| Parameters | Object [] { cursorHandle, start, fields, ascending }
where:
|
| Signature | String [] {
"java.lang.String",
"java.lang.Long",
"[Ljava.lang.String;",
"[Ljava.lang.Boolean;" } |
| Returns | Long
|
| Exceptions |
|