|
Oracle Fusion Middleware Oracle WebLogic Server 10.3.1 MBean API Reference 11g Release 1 (10.3.1) Part Number E13945-01 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JMSDurableSubscriberRuntimeMBean
This class is used for monitoring a WebLogic JMS durable subscriber.
This is a type-safe interface for a
WebLogic Server MBean, which you can import into your client
classes and access through
weblogic.management.MBeanHome
. As of 9.0, the
MBeanHome
interface and all type-safe interfaces for
WebLogic Server MBeans are deprecated. Instead, client classes that
interact with WebLogic Server MBeans should use standard JMX design
patterns in which clients use the
javax.management.MBeanServerConnection
interface to
discover MBeans, attributes, and attribute types at runtime. For
more information, see "Developing Manageable Applications with JMX"
on http://edocs.bea.com.
Method Summary | |
---|---|
void |
destroy()
Completely removes this durable subscriber (and all messages associated with this durable subscription). |
long |
getBytesCurrentCount()
The number of bytes received by this durable subscriber. |
long |
getBytesPendingCount()
The number of bytes pending by this durable subscriber. |
String |
getClientID()
A unique client identifier for this durable subscriber. |
CompositeData |
getCurrentConsumerInfo()
Returns information about the current consumer. |
CompositeData |
getDestinationInfo()
Returns information about the durable subscriber's internal destination in JMX open data representation. |
JMSDestinationRuntimeMBean |
getDestinationRuntime()
Returns the runtime MBean of the Topic to which this durable subscriber is associated. |
long |
getMessagesCurrentCount()
The number of messages still available by this durable subscriber. |
long |
getMessagesHighCount()
Returns the peak number of messages for the durable subscriber since the last reset. |
long |
getMessagesPendingCount()
The number of messages pending (uncommitted and unacknowledged) by this durable subscriber. |
long |
getMessagesReceivedCount()
Returns the number of messages received by the durable subscriber since that reset. |
String |
getSelector()
The message selector defined for this durable subscriber. |
String |
getSubscriptionName()
The subscription name for this durable subscriber. |
boolean |
isActive()
Indicates whether this subscription is being used by a durable subscriber. |
boolean |
isNoLocal()
Specifies whether this durable subscriber recieves local messages it has published itself. |
void |
purge()
Deprecated. As of WLS 9.0. Use #deleteMessages(String) |
Method Detail |
---|
String getClientID()
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, of course, set the client ID to the WebLogic Server username, if it is appropriate for your JMS application.
String getSubscriptionName()
The subscription name for this durable subscriber. This name must be unique per client ID.
Valid durable subscription names cannot include the following characters: comma ",", equals "=", colon ":", asterisk "*", percent "%", or question mark"?".
boolean isNoLocal()
Specifies whether this durable subscriber recieves local messages it has published itself.
To prevent this, set the noLocal
parameter to true
.
boolean isActive() throws RemoteException
Indicates whether this subscription is being used by a durable subscriber.
RemoteException
String getSelector()
The message selector defined for this durable subscriber.
long getMessagesPendingCount()
The number of messages pending (uncommitted and unacknowledged) by this durable subscriber.
long getMessagesCurrentCount()
The number of messages still available by this durable subscriber.
long getMessagesHighCount()
Returns the peak number of messages for the durable subscriber since the last reset.
long getMessagesReceivedCount()
Returns the number of messages received by the durable subscriber since that reset.
long getBytesPendingCount()
The number of bytes pending by this durable subscriber.
long getBytesCurrentCount()
The number of bytes received by this durable subscriber.
void purge()
#deleteMessages(String)
Purges all the pending and current messages for this durable subscriber.
JMSDestinationRuntimeMBean getDestinationRuntime()
Returns the runtime MBean of the Topic to which this durable subscriber is associated.
CompositeData getCurrentConsumerInfo() throws OpenDataException
Returns information about the current consumer. The information is returned in the form of an OpenMBean CompositeData object.
OpenDataException
- Thrown when an error occurs while constructing the
CompositeData return value.weblogic.jms.extensions.ConsumerInfo
void destroy() throws JMSException
JMSException
CompositeData getDestinationInfo() throws OpenDataException
Returns 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.
OpenDataException
- Thrown when an error occurs while constructing the CompositeData
return value.JMSMessageManagementRuntimeMBean#moveMessages(String, CompositeData)
,
JMSMessageManagementRuntimeMBean#moveMessages(String, CompositeData, Integer)
|
Documentation is available at http://download.oracle.com/docs/cd/E12839_01/web.1111/wls.htm Copyright 1996, 2009, 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 Oracle WebLogic Server 10.3.1 MBean API Reference 11g Release 1 (10.3.1) Part Number E13945-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |