This class is used for monitoring a WebLogic JMS durable subscriber.
| 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.JMSDurableSubscriberRuntimeMBean
|
||
| 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.
|
|
The runtime MBean of the Topic to which this durable subscriber is associated.
| Factory Methods | No explicit creator method. The child shares the lifecycle of its parent. |
| Privileges | Read only |
| Type | JMSDestinationRuntimeMBean |
| Relationship type: | Containment. |
This section describes the following attributes:
Indicates whether this subscription is being used by a durable subscriber.
| Privileges | Read only |
| Type | boolean |
The number of bytes received by this durable subscriber.
| Privileges | Read only |
| Type | long |
The number of bytes pending by this durable subscriber.
| 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 |
A unique client identifier for this durable subscriber.
Note: The client ID is not necessarily equivalent to the WebLogic Server username; that is, a name used to authenticate a user in the WebLogic security realm. You can set the client ID to the WebLogic Server username if it is appropriate for your JMS application.
| Privileges | Read only |
| Type | java.lang.String |
The policy for the client identifier for this durable subscriber.
Note: The client ID policy is either
Restricted or Unrestricted.
| Privileges | Read only |
| Type | java.lang.String |
Specifies information about the current consumer. The information is returned in the form of an OpenMBean CompositeData object.
For more information, see:
| Privileges | Read only |
| Type | javax.management.openmbean.CompositeData |
Specifies information about the durable subscriber's internal destination in JMX open data representation. The resulting object is intended for use in the message management APIs for identifying a target destination.
For more information, see:
| Privileges | Read only |
| Type | javax.management.openmbean.CompositeData |
The time when the last time a subscriber received a message from the subscription. The returned value is a standard java absolute time, which is measured in milliseconds since midnight, January 1, 1970 UTC
This returns the JMS durable subscription boot time if there were no messages that were successfully delivered to any subscriber on this subscription since the subscription was booted. We define the boot time of a durable subscription to be the time the subscription is originally created or recovered during a server reboot or jms migration, which ever is latest.
| Privileges | Read only |
| Type | long |
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 number of messages still available by this durable subscriber.
| 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 for the durable subscriber 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 messages pending (uncommitted and unacknowledged) by this durable subscriber.
| Privileges | Read only |
| Type | long |
The number of messages received by the durable subscriber since that 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 |
Specifies whether this durable subscriber receives local messages that it has published.
To prevent this, set the noLocal parameter to
true.
| Privileges | Read only |
| Type | boolean |
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 |
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 message selector defined for this durable subscriber.
| Privileges | Read only |
| Type | java.lang.String |
The number of subscribers that currently share this subscription.
| Privileges | Read only |
| Type | int |
| Default Value | 0 |
The highest number of subscribers that have shared this subscription at the same time since the creation or the last reboot of the subscription, which ever is later.
| Privileges | Read only |
| Type | int |
| Default Value | 0 |
The total number of subscribers that have accessed this subscription since the creation or the last reboot of the subscription, whichever is later.
| Privileges | Read only |
| Type | int |
| Default Value | 0 |
The number of messages deleted because of a subscription limit.
| Privileges | Read only |
| Type | long |
The subscription name for this durable subscriber. This name must be unique for each client ID.
Valid durable subscription names cannot include the following characters: comma ",", equals "=", colon ":", asterisk "*", percent "%", or question mark"?".
| Privileges | Read only |
| Type | java.lang.String |
The SubscriptionSharingPolicy on this subscriber.
| Privileges | Read only |
| Type | java.lang.String |
| Default Value | Exclusive |
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 |
|
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, applyOverrides }
where:
|
| Signature | String [] {
"[Ljavax.management.openmbean.CompositeData;",
"java.lang.Boolean",
"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 }
where:
|
| Signature | String [] {
"[Ljavax.management.openmbean.CompositeData;",
"java.lang.Boolean" } |
| Returns | Void
|
| Exceptions |
|
| Operation Name | "moveMessages" |
| Parameters | Object [] { }
where: |
| Signature | String [] {
"java.lang.String",
"javax.management.openmbean.CompositeData",
"java.lang.Integer" } |
| Returns | Integer
|
| 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 |
|
Purges all the pending and current messages for this durable subscriber.
Deprecated.
| Operation Name | "purge" |
| Parameters | null |
| Signature | null |
| Returns |
void
|
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 |
|