OC4J 10g (10.1.3) 方法文档：创建简单的 JMX MBean

该 Bean 的主要方面包括：

1. MBean 如何通知 MBeanServer 它想广播的通知。这可以通过实现 getNotificationInfo 方法来实现。该方法将返回一个数组，为该 MBean 可能发送的每个通知指出了通知的 Java 类的名称和通知类型。
   
2. 使用 sendNotification 方法发送通知。

SimpleNotifier.java

public class SimpleNotifier
       extends NotificationBroadcasterSupport
       implements SimpleNotifierMBean
{
  /**
   * The notification set.
   */
  private String notifications[] =
  {
    "increment", "decrement", "reset"
  };

  public MBeanNotificationInfo[] getNotificationInfo()
  {
    MBeanNotificationInfo[] info = {
      new MBeanNotificationInfo(notifications,
                                "javax.management.Notification",
                                "Notification set for SimpleNotifier")
    };
    return info;
  }

  public void increment()
  {
    //perform the increment task
    sendNotification(Notification(notifications[0],this,System.currentTimeMillis(),"Count=" + getCount()));

  }

  ...
}

orion-application.xml 包含一个用来静态注册该 MBean 的条目。<jmx-mbean> 标记包含注册 MBean 时使用的属性，以及 MBean 的完全限定名。

<jmx-mbean objectname=":name=SimpleNotifier" class="demo.oc4j.jmx.notification.SimpleNotifier">
<description>An example of the Simple MBean but now with Notifications</description>
</jmx-mbean>

MBeanServer 通过调用 getNotificationInfo 方法来发现通知。当某个 MBean 的通知出现在 Notifications 选项卡上时，Application Server Control 会列出它们。

单击 SimpleNotifier MBean 链接以访问它。

选择 Notifications 选项卡，查看通知列表。

列出 SimpleNotifier MBean 的通知。此处显示的值是由 MBeanServer 在 MBean 上调用 getNotificationInfo 方法而获得的，然后返回该 MBean 支持的通知列表 — 递增，递减和重置。

Application Server Control 可以接收来自 MBean 的通知。要订阅通知，请选择感兴趣的通知旁边的 Subscribed 复选框。

在我们的 SimpleNotification 示例中，在执行操作（递增、递减和重置）后发送一个通知。使用 Application Server Control 多次调用这些操作。

当 Application Server Control 接收到通知后， 主页上会显示一个指示器（显示通知数量）。

单击该链接将显示已接收的所有通知。在下面的示例中，您可以看到递增操作被调用了三次，然后是一个递减操作，然后进行重置。

单击特定通知将下钻到该通知的特定详细信息。

SimpleExtended — 提供 StandardMBean 的元数据

该 Bean 的源代码位于 src/demo/oc4j/jmx/extendstandard 目录下。

通过使用 StandardMBean，为应用程序提供管理接口成为一个比较直接的机制。由于 MBean 服务器使用反射类型方法，因此它可以发现 MBean 的属性（基于 set/get JavaBean 术语）以及操作，然后在 JMX 代理层公开。

此方法的一个小缺点是，可在 Application Server Control 中显示的方法不提供有用的描述。例如，Application Server Control 中显示了当前 SimpleStandard 示例 MBean，如下所示。其显示的内容包括通用整体描述，以及其操作的每个参数的通用描述。

使用动态和模型 MBean，可以轻松地提供元数据来描述 MBean，从而提供有关属性和操作的更多详细信息。通过直接对 javax.management.StandardMBean 类划分子类并覆盖 getMBeanInfo 方法，可以使用 StandardMBean 来实现相同的操作。MBeanServer 调用该方法以获得有关 MBean 本身的信息。

结合使用最简单的 MBean 方法和 StandardMBean 时，MBean 本身并不直接实现该方法，这意味着所提供的信息只是最佳猜测，通常在本质上非常普通。

该 MBean 示例基于相同的简单 Counter 示例。已经对其进行了扩展，可以提供它自己的元数据来描述其属性和操作。

该 MBean 的主要方面包括：

1. 它直接划分 javax.management.StandardMBean 类的子类。这要求 MBean 提供自己的构造函数，调用父对象的 构造函数，并向该构造函数传递 MBean 接口。
   
2. 覆盖 getMBeanInfo 方法。该方法实现将构建一个新的 MBeanInfo 对象，并用有关该 MBean 的信息（属性、操作）填充它，从而允许提供有意义的描述。

SimpleStandardExtend.java:

public class SimpleStandardExtend
       extends StandardMBean
       implements SimpleStandardExtendMBean
{

  // Note that the constructor calls the super class and passes in a parameter
  // which specifies the interface of this MBean.
  public SimpleStandardExtend() throws NotCompliantMBeanException
  {
    super(SimpleStandardExtendMBean.class);
  }

  public MBeanInfo getMBeanInfo()
  {
    // Create meta-data for the Attributes of this bean, we have only one in this case.
    MBeanAttributeInfo[] matts =
    {
      new MBeanAttributeInfo("Count","int","The counter",true,true,false),
    };

    // Create meta-data for each of the operations of this bean
    MBeanOperationInfo[] mops =
    {
      new MBeanOperationInfo("increment","increments the count by 1",null,"void",MBeanOperationInfo.ACTION_INFO),
      new MBeanOperationInfo("decrement","decrements the count by 1",null,"void",MBeanOperationInfo.ACTION_INFO),
      new MBeanOperationInfo("reset","Resets the counter to 0",null,"void",MBeanOperationInfo.ACTION_INFO)
    };

    // Create meta-data for the constructor, use reflection to get the constructor details in this case
    Class c = this.getClass();
    Constructor[] theConstructors = c.getConstructors();
    MBeanConstructorInfo[] mcons =
    {
      new MBeanConstructorInfo("The default constructor",theConstructors[0])
    };

    // Now create the actual MBeanInfo object, using our new meta-data objects
    // The null parameter is for the notifications -- this MBean doesn't have any
    MBeanInfo myInfo = new MBeanInfo(
      this.getClass().getName(),
      "A somewhat silly example of providing meta-data for a Standard MBean, but you get the idea",
      matts, mcons, mops, null);

  return myInfo;
}

orion-application.xml 包含一个用来静态注册该 MBean 的条目。<jmx-mbean> 标记包含注册 MBean 时使用的属性，以及 MBean 的完全限定名。

<jmx-mbean objectname=":name=SimpleExtends" class="demo.oc4j.jmx.extendstandard.SimpleStandardExtend">
<description>A simple example of an MBean that extends StandardMBean to provide its own MBeanInfo</description>
</jmx-mbean>

该 MBean 示例在 Application Server Control 中显示为 SimpleExtends。

现在，当 SimpleExtends MBean 在应用程序 MBean 浏览器中显示时，MBeanInfo 对象中提供的描述就会显示在 MBean 的 Description 域中，而且操作也会包含有用的描述。

使用 StandardMBean 的该方法使 MBean 可以告诉管理员更多有关它正在进行的操作的内容，而不是通过使用反射模型获得的简单描述。唯一需要注意的是，getMBeanInfo 方法需要与 MBean 的管理接口完全同步。

SimpleTimer — 使用 TimerMBean

该 Bean 的源代码位于 src/demo/oc4j/jmx/timer 目录下。

JMX 规范通过 javax.management.timer.TimerBean 提供了一个标准的计时器机制。TimerMBean 可以通过 MBeanServer 进行注册，并配置为在特定日期和时间广播通知。Java 对象注册到 TimerMBean，并指定它们对 TimerMBean 广播的哪些通知感兴趣。监听器对象实现 javax.management.NotificationListener 接口。

SimpleTimer MBean 示例将使用“MyTimerBean”名称动态注册一个 TimerMBean。然后，使用该 TimerMBean 注册一个 SimpleTimerListener 对象实例来接收通知。SimpleTimerMBean 公开了一个操作，以允许将新通知添加到计时器。一个通知定义一个要发生的事件。在本示例中，我们通过为事件指定一些数据来定义通知，例如，指定事件的首次触发时间、两个事件之间的间隔以及事件发生的总次数。

该 MBean 示例还使用 SimpleExtended MBean 中描述的方法来提供有关 MBean 的元数据。这是该方法的一个很好的用例，因为 addNotification 操作需要提供大量参数。如果没有其他描述性信息，使用 MBean 操作将非常困难。

该示例的监听器对象是 SimpleTimerListener 类。它实现 NotificationListener 接口，并将接收到的通知的详细信息输出到控制台。

该示例的主要方面包括：

1. 注册 TimerMBean
   
2. 向 TimerMBean 添加 SimpleTimerListener 对象
   
3. 向 TimerMBean 添加新的通知事件

SimpleTimer.java

public class SimpleTimer
       extends StandardMBean
       implements SimpleTimerMBean
{

  public SimpleTimer() throws NotCompliantMBeanException
  {
    super(SimpleTimerMBean.class);
    try
    {
      // Create the new Timer object and start it
      _timer = new Timer();
      _timer.start();
  
      // Register the timer object with the MBeanServer if it is not already registered.
      if(!_mbeanServer.isRegistered(new ObjectName(_timerName)))
      {
        _mbeanServer.registerMBean(_timer,new ObjectName(_timerName));
      }

      // Add a notification listener to the newly registered timer
      _mbeanServer.addNotificationListener(
        new ObjectName(_timerName),new SimpleTimerListener(),null,null);
    }
    catch(Exception e)
    {
      e.printStackTrace();
    }
  }

  /**
   * Registers a new notification using the supplied information with the
   * Timer MBean.The notification listener will receive messages based on
   * the timeoffset, the period and the ntimes settings.
   *
   * @param type - the message type, any string will do
   * @param message - the message text, any string will do
   * @param timeoffset - the amount of time (sec) before the first notification
   * @param period - the interval (sec) between notifications
   * @param ntimes - how many notifications to send
   * @return the ID of the registered Notification
   */
  public Integer addNotification(String type, String message, int timeoffset, int period, int ntimes)
  {
    Integer result = null;
    try
    {
      // Add a notification to the timer object we have registered
      result = _timer.addNotification(type, message, null,
       (new Date(System.currentTimeMillis()+(timeoffset*Timer.ONE_SECOND))),
       (period*Timer.ONE_SECOND),ntimes,true);
    }
    catch(Exception e)
    {
      e.printStackTrace();
    }
    return result;
  }

  ...
}

SimpleTimerListener.java

public class SimpleTimerListener implements NotificationListener
{

  /**
   * Method called when a notification is received.
   * @param notification - the notification event
   * @param src - the callback object
   */
  public void handleNotification(Notification notification, Object src)
  {
    // Just dump out the details of the notification to stdout
    System.out.println("\n----------------------------");
    System.out.println("\nNew Message Received:");
    System.out.println("\tDate:" + (new Date(notification.getTimeStamp())).toString());
    System.out.println("\tSeq#:" + notification.getSequenceNumber());
    System.out.println("\tType:" + notification.getType());
    System.out.println("\tMessage:" + notification.getMessage());
    System.out.println("" );
    System.out.flush();
  }
}

orion-application.xml 包含一个用来静态注册该 MBean 的条目。<jmx-mbean> 标记包含注册 MBean 时使用的属性，以及 MBean 的完全限定名。

<jmx-mbean objectname=":name=SimpleTimer" class="demo.oc4j.jmx.timer.SimpleTimer">
<description>An example of using an MBean Timer to receive notification events</description>
</jmx-mbean>

使用 Application Server Control，可以为动态注册的 TimerMBean 设置新的通知事件。MBean 是用 SimpleTimer 名称注册的。

SimpleTimer MBean 公开一个操作，该操作允许管理员向 MyTimerMBean 添加通知。

addNotification 操作接受许多用于定义新通知的参数。例如，通知类型和消息、通知开始前的时间间隔、发送通知的时间间隔、用于定义通知的已发送通知数量等。

在本示例中，向 MyTimerMBean 添加一个消息，以提醒管理员每隔五分钟有一杯咖啡（这是一个联网的管理员）。

当通知从 MyTimerMBean 中发出后，利用 MyTimerMBean 注册的 SimpleTimerListener 会接收通知并在控制台上进行显示。控制台输出会显示这些通知的发送时间以及通知的内容。下面显示的内容显示了 SimpleTimerListener 对象接收到的两个连续通知，这两个通知间隔 5 分钟（300 秒），并按递增顺序发出。

在 Application Server Control 中的默认命名空间下可以看到利用该 MBean 示例动态注册的实际 TimerMBean。

由于它只是一个 MBean，Application Server Control 可以与 TimerMBean 本身进行交互，并显示其属性和操作。

调用 MyTimerMBean 的 getNotificationMessage 操作， 并向其传递 Coffee 通知的 ID，MBean 将返回该通知消息的值。注意，该值与控制台上通过 SimpleTimerListener 显示的值相同。

使用 TimerMBean 可以方便地计划 JMX 环境中将要发生的事件。

总结

该方法示例演示提供了许多 JMX MBean（它们演示了 JMX API 和可用服务的各个基本方面），并演示了 Application Server Control 如何允许管理员操作系统级别和应用程序级别的 MBean。