Design Details

Event Notifier MBean Names

The DAS Event Notifier MBean name is: com.sun.jbi:Target=domain,ServiceName=Framework,ServiceType=Notification

The instance Event Notifier MBean name is: com.sun.jbi:JbiName=instance-name,ServiceName=Framework,ControlType=Notification,ComponentType=System
where instance-name is the name of the instance.

Event Notifier API For JBI Runtime

An MBean interface named EventNotifierMBean will be added to the runtime.base service in the com.sun.jbi.framework package. The implementing class EventNotifier will be added to the runtime.framework service in the com.sun.jbi.framework package.

The com.sun.jbi.framework.EventNotifierMBean interface provides some enumerators for event and source types, along with methods for emitting notifications:

    /**
     * Events that generate notifications.
     */
    enum EventType {
        Installed,
        Upgraded,
        Uninstalled,
        Deployed,
        Undeployed,
        Ready,
        Started,
        Stopped,
        ShutDown
    }

    /**
     * Sources of notifications.
     */
    enum SourceType {
        JBIRuntime,
        BindingComponent,
        ServiceEngine,
        SharedLibrary,
        ServiceUnit,
        ServiceAssembly
    }

    /**
     * This method is called to emit a notification for an event on the JBI
     * runtime. The caller provides information that determines the content of
     * the notification. The event type for a JBI runtime notification can be
     * Ready, Started, or Stopped. The source type is always JBIRuntime.
     *
     * @param eventType the type of event that occurred.
     * @param msg a message associated with the event.
     * @return the actual Notification sent.
     */
    Notification emitRuntimeNotification(EventType eventType, String msg);

    /**
     * This method is called to emit a notification for an event on either a
     * binding component or a service engine. The caller provides information
     * that determines the content of the notification. The event type for a
     * component notification can be Installed, Uninstalled, Started, Stopped,
     * or ShutDown. The source type is either BindingComponent or ServiceEngine.
     *
     * @param eventType the type of event that occurred.
     * @param sourceType the type of component on which the event occurred.
     * @param componentName the name of the component on which the event
     * occurred.
     * @param msg a message associated with the event.
     * @return the actual Notification sent.
     */
    Notification emitComponentNotification(EventType eventType,
        SourceType sourceType, String componentName, String msg);

    /**
     * This method is called to emit a notification for an event on a shared
     * library. The caller provides information that determines the content of
     * the notification. The event type for a shared library notification can be
     * either Installed or Uninstalled. The source type is always SharedLibrary.
     *
     * @param eventType the type of event that occurred.
     * @param sharedLibraryName the name of the shared library on which the
     * event occurred.
     * @param msg a message associated with the event.
     * @return the actual Notification sent.
     */
    Notification emitSharedLibraryNotification(EventType eventType,
        String sharedLibraryName, String msg);

    /**
     * This method is called to emit a notification for an event on a service
     * assembly. The caller provides information that determines the content
     * of the notification. The event type for a service assembly notification
     * can be Deployed, Undeployed, Started, Stopped, or ShutDown. The source
     * type is always ServiceAssembly.
     *
     * @param eventType the type of event that occurred.
     * @param serviceAssemblyName the name of the service assembly on which the
     * event occurred.
     * @param msg a message associated with the event.
     * @return the actual Notification sent.
     */
    Notification emitServiceAssemblyNotification(EventType eventType,
        String serviceAssemblyName, String msg);

    /**
     * This method is called to emit a notification for an event on a service
     * unit. The caller provides information that determines the content of the
     * notification. The event type for a service unit notification can be
     * Deployed, Undeployed, Started, Stopped, or ShutDown. The source type is
     * always ServiceUnit.
     *
     * @param eventType the type of event that occurred.
     * @param serviceUnitName the name of the service unit on which the event
     * occurred.
     * @param serviceAssemblyName the name of the service assembly to which the
     * service unit belongs.
     * @param componentName the name of the component to which the service unit
     * is deployed.
     * @param msg a message associated with the event.
     * @return the actual Notification sent.
     */
    Notification emitServiceUnitNotification(EventType eventType,
        String serviceUnitName, String serviceAssemblyName,
        String componentName, String msg);

The com.sun.jbi.framework.EventNotifier class implements the above interface, and is a subclass of javax.management.NotificationBroadcasterSupport, which provides the basic implementation necessary for emitting notifications. Any code in the runtime that needs to emit notifications can call the methods on this class directly. The com.sun.jbi.framework.EnvironmentContext class provides a method for obtaining a reference to the MBean that any runtime code can call through the com.sun.jbi.EnvironmentContext interface.

One important implementation detail is that all issuing of notifications must be done on separate threads to prevent a notification listener (over which the runtime has no control) from causing performance degradation of the runtime. This is easily achieved using the java.util.concurrent package.

DAS Event Notifier MBean

An MBean interface named RuntimeNotificationMBean will be added to the runtime.esb-manage service in the com.sun.jbi.management.facade package. This interface will be implemented by the RuntimeNotification class in the same package. The RuntimeNotification class also implements javax.management.NotificationListener and com.sun.jbi.platform.PlatformEventListener and is a subclass of javax.management.NotificationBroadcasterSupport. This class registers itself as a notification listener for each com.sun.jbi.framework.EventNotifier MBean in the domain. Implementing the com.sun.jbi.platform.PlatformEventListener interface allows it to be notified whenever an instance is deleted or created, so that it can keep its notification listener registrations updated. This MBean is registered with the DAS MBean Server by the Management Runtime Service.

Notification Points

The following table lists the methods on com.sun.jbi.framework.EventNotifier and which methods call them:

• emitRuntimeNotification()
  • called by com.sun.jbi.framework.JBIFramework start(), ready(), and shutdown() methods
• emitComponentNotification()
  • called by com.sun.jbi.framework.ComponentFramework installComponent(), uninstallComponent(), startComponent(), stopComponent(), and shutDownComponent() methods
• emitSharedLibraryNotification()
  • called by com.sun.jbi.framework.ComponentFramework installSharedLibrary() and uninstallSharedLibrary() methods
• emitServiceAssemblyNotification()
  • called by com.sun.jbi.management.system.DeploymentService deploy(), undeploy(), start(), stop(), and shutDown() methods
• emitServiceUnitNotification()
  • called by com.sun.jbi.framework.ServiceUnitFramework startServiceUnit(), stopServiceUnit(), and shutDownServiceUnit() methods
  • called by com.sun.jbi.framework.Deployer deploy() and undeploy() methods

Details on Notification UserData

The CompositeData that is passed in the UserData field of the notifications can have either of two formats. The first format is for all notifications except for those for Service Unit events; the second format is for Service Unit events only. The following fields are present in both formats:

Key	Value
EventType	the type of event: "Installed", "Uninstalled", Deployed, Undeployed, Started, Ready, Stopped, or ShutDown
SourceType	the type of source of the event: JBIRuntime, BindingComponent, ServiceEngine, SharedLibrary, ServiceAssembly, or ServiceUnit
TargetName	the name of the target where the event originated: either "server" or "clustername-instancename"
SourceName	the name of the source of the event: "JBIFramework", component name, shared library name, service assembly name, or service unit name

The following fields are present only in the UserData for a Service Unit event:

Key	Value
ServiceAssemblyName	the name of the service assembly to which the service unit belongs
ComponentName	the name of the component to which the service unit is deployed