com.sun.jbi.framework

Interface EventNotifierCommon

All Superinterfaces:

EventNotifierBase

public interface EventNotifierCommon
extends EventNotifierBase

This interface defines the methods that are used to emit notifications for events affecting the state of JBI runtime. Methods are provided for emitting notifications for all applicable events in the runtime, such as startup and shutdown of the runtime, installation or uninstallation of a component or shared library, deployment or undeployment of a service assembly or service unit, and all life cycle operations on components, service assemblies, and service units. This interface is implemented by the EventNotifier MBean in the runtime.

Author:

Mark S White

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.jbi.EventNotifierBase

EventNotifierBase.EventType, EventNotifierBase.SourceType

Field Summary

Fields inherited from interface com.sun.jbi.EventNotifierBase

COMPONENT_NAME_KEY, EVENT_TYPE_KEY, JBI_PREFIX, NOTIFICATION_CLASS_NAME, NOTIFICATION_DESCRIPTION, NOTIFICATION_TYPES, SERVICE_ASSEMBLY_NAME_KEY, SERVICE_UNIT_NAME_KEY, SOURCE_NAME_KEY, SOURCE_TYPE_KEY, TARGET_NAME_KEY

Method Summary

Methods

Modifier and Type	Method and Description
Notification	emitComponentNotification(EventNotifierBase.EventType eventType, EventNotifierBase.SourceType sourceType, String componentName, String msg) This method is called to emit a notification for an event on either a binding component or a service engine.
Notification	emitRuntimeNotification(EventNotifierBase.EventType eventType, String msg) This method is called to emit a notification for an event on the JBI runtime.
Notification	emitServiceAssemblyNotification(EventNotifierBase.EventType eventType, String serviceAssemblyName, String msg) This method is called to emit a notification for an event on a service assembly.
Notification	emitServiceUnitNotification(EventNotifierBase.EventType eventType, String serviceUnitName, String serviceAssemblyName, String componentName, String msg) This method is called to emit a notification for an event on a service unit.
Notification	emitSharedLibraryNotification(EventNotifierBase.EventType eventType, String sharedLibraryName, String msg) This method is called to emit a notification for an event on a shared library.

Method Detail

emitRuntimeNotification

Notification emitRuntimeNotification(EventNotifierBase.EventType eventType,
                                   String msg)

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.

Parameters:

eventType - the type of event that occurred.

msg - a message associated with the event.

Returns:

the actual Notification sent.

emitComponentNotification

Notification emitComponentNotification(EventNotifierBase.EventType eventType,
                                     EventNotifierBase.SourceType sourceType,
                                     String componentName,
                                     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.

Parameters:

eventType - the type of event that occurred.

sourceType - the type of component on which the event occurred.

componentName - the name of the component on which the event occurred.

msg - a message associated with the event.

Returns:

the actual Notification sent.

emitSharedLibraryNotification

Notification emitSharedLibraryNotification(EventNotifierBase.EventType eventType,
                                         String sharedLibraryName,
                                         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.

Parameters:

eventType - the type of event that occurred.

sharedLibraryName - the name of the shared library on which the event occurred.

msg - a message associated with the event.

Returns:

the actual Notification sent.

emitServiceAssemblyNotification

Notification emitServiceAssemblyNotification(EventNotifierBase.EventType eventType,
                                           String serviceAssemblyName,
                                           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.

Parameters:

eventType - the type of event that occurred.

serviceAssemblyName - the name of the service assembly on which the event occurred.

msg - a message associated with the event.

Returns:

the actual Notification sent.

emitServiceUnitNotification

Notification emitServiceUnitNotification(EventNotifierBase.EventType eventType,
                                       String serviceUnitName,
                                       String serviceAssemblyName,
                                       String componentName,
                                       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.

Parameters:

eventType - the type of event that occurred.

serviceUnitName - the name of the service unit on which the event occurred.

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.

msg - a message associated with the event.

Returns:

the actual Notification sent.