Oracle Fusion Middleware
Oracle WebLogic Server 10.3.1 MBean API Reference
11g Release 1 (10.3.1)

Part Number E13945-02

weblogic.management.runtime
Interface MessageDrivenEJBRuntimeMBean

All Superinterfaces:
EJBRuntimeMBean

public interface MessageDrivenEJBRuntimeMBean
extends EJBRuntimeMBean

This interface contains accessor methods for all EJB runtime information collected for a Message Driven Bean.

Deprecation of MBeanHome and Type-Safe Interfaces

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://www.oracle.com/technology/products/weblogic/index.html.


Method Summary
 String getConnectionStatus()
          Provides the connection status for the Message Driven Bean.
 String getDestination()
          Provides a count of the Message Driven Bean destination
 HealthState getHealthState()
          The health state of this MDB.
 String getJmsClientID()
          Provides a count of the Message Driven Bean jmsClientID
 Throwable getLastException()
          Provides the last exception this MDB encountered
 String getLastExceptionAsString()
          Provides the last exception as String this MDB encountered
 String getMDBStatus()
          Provides the Message Driven Bean status.
 EJBPoolRuntimeMBean getPoolRuntime()
          Provides runtime information about the free pool for this EJB.
 long getProcessedMessageCount()
          Provides a count of the total number of messages processed by this Message Driven Bean.
 int getSuspendCount()
          Provides a count of the total number of times this MDB is suspended by the user or the EJB container.
 EJBTimerRuntimeMBean getTimerRuntime()
          Provides runtime information about any EJB Timers created, for this EJB.
 boolean isJMSConnectionAlive()
          Provides information about whether the Message Driven Bean is currently connected to the JMS destination it is mapped to.
 boolean resume()
          Resumes the specific type of MDB by calling start on the JMS Connection.
 boolean suspend()
          Suspends the specific type of MDB by calling stop on the JMS Connection.
 
Methods inherited from interface weblogic.management.runtime.EJBRuntimeMBean
getEJBName, getResources, getTransactionRuntime
 

Method Detail

getHealthState

HealthState getHealthState()

The health state of this MDB.

Returns:
The healthState value

getPoolRuntime

EJBPoolRuntimeMBean getPoolRuntime()

Provides runtime information about the free pool for this EJB.

Returns:
The poolRuntime value

getTimerRuntime

EJBTimerRuntimeMBean getTimerRuntime()

Provides runtime information about any EJB Timers created, for this EJB. If the bean class for this EJB does not implement javax.ejb.TimedObject, null will be returned.

Returns:
The timerRuntime value or null if TimedObject not implemented

isJMSConnectionAlive

boolean isJMSConnectionAlive()

Provides information about whether the Message Driven Bean is currently connected to the JMS destination it is mapped to.

Returns whether the Message Driven Bean is currently connected to the JMS destination it is mapped to.

Returns:
The jMSConnectionAlive value

getConnectionStatus

String getConnectionStatus()

Provides the connection status for the Message Driven Bean. ConnectionStatus can be Connected or Reconnecting.

Returns:
The connectionStatus value

getDestination

String getDestination()

Provides a count of the Message Driven Bean destination

Returns:
The destination value

getJmsClientID

String getJmsClientID()

Provides a count of the Message Driven Bean jmsClientID

Returns:
The jmsClientID value

getMDBStatus

String getMDBStatus()

Provides the Message Driven Bean status. MDBStatus is used after the MDB is connected to the destination. MDBStatus can be Running or Suspended.

Returns:
The MDBStatus value

getProcessedMessageCount

long getProcessedMessageCount()

Provides a count of the total number of messages processed by this Message Driven Bean.

Returns:
The Processed Message Count

getSuspendCount

int getSuspendCount()

Provides a count of the total number of times this MDB is suspended by the user or the EJB container.

Returns:
The suspendCount value

getLastException

Throwable getLastException()

Provides the last exception this MDB encountered

Returns:
The lastException

getLastExceptionAsString

String getLastExceptionAsString()

Provides the last exception as String this MDB encountered

Returns:
The lastException as String

suspend

boolean suspend()
                throws ManagementException

Suspends the specific type of MDB by calling stop on the JMS Connection.

Throws:
ManagementException

resume

boolean resume()
               throws ManagementException

Resumes the specific type of MDB by calling start on the JMS Connection.

Throws:
ManagementException

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-02